105 lines
8.2 KiB
HTML
105 lines
8.2 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
|||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist(1)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm139928635946464"></a>cdist(1)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_synopsis">2. SYNOPSIS</a></span></dt><dt><span class="section"><a href="#_description">3. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_general">4. GENERAL</a></span></dt><dt><span class="section"><a href="#_banner">5. BANNER</a></span></dt><dt><span class="section"><a href="#_config">6. CONFIG</a></span></dt><dt><span class="section"><a href="#_shell">7. SHELL</a></span></dt><dt><span class="section"><a href="#_examples">8. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_environment">9. ENVIRONMENT</a></span></dt><dt><span class="section"><a href="#_exit_status">10. EXIT STATUS</a></span></dt><dt><span class="section"><a href="#_see_also">11. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">12. COPYING</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist - Usable Configuration Management</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_synopsis"></a>2. SYNOPSIS</h2></div></div></div><p>cdist [-h] [-d] [-v] [-V] {banner,config,shell} …</p><p>cdist banner [-h] [-d] [-v]</p><p>cdist config [-h] [-d] [-V] [-c CONF_DIR] [-i MANIFEST] [-p] [-s] host [host …]</p><p>cdist shell [-h] [-d] [-v] [-s SHELL]</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>3. DESCRIPTION</h2></div></div></div><p>cdist is the frontend executable to the cdist configuration management.
|
|||
|
|
cdist supports different subcommands as explained below.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_general"></a>4. GENERAL</h2></div></div></div><p>All commands except the following options:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
-d, --debug
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Set log level to debug
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
-h, --help
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Show the help screen
|
|||
|
|
</dd></dl></div><p>-v, --verbose:
|
|||
|
|
Set log level to info, be more verbose</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
-V, --version
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Show version and exit
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_banner"></a>5. BANNER</h2></div></div></div><p>Displays the cdist banner. Useful for printing
|
|||
|
|
cdist posters - a must have for every office.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_config"></a>6. CONFIG</h2></div></div></div><p>Configure one or more hosts</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
-h, --help
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Show the help screen
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
-c CONF_DIR, --conf-dir CONF_DIR
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Add a configuration directory. Can be specified multiple times.
|
|||
|
|
If configuration directories contain conflicting types, explorers or
|
|||
|
|
manifests, then the last one found is used. Additionally this can also
|
|||
|
|
be configured by setting the CDIST_PATH environment variable to a colon
|
|||
|
|
delimited list of config directories. Directories given with the
|
|||
|
|
--conf-dir argument have higher precedence over those set through the
|
|||
|
|
environment variable.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
-i MANIFEST, --initial-manifest MANIFEST
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Path to a cdist manifest or - to read from stdin
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
-p, --parallel
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Operate on multiple hosts in parallel
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
-s, --sequential
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Operate on multiple hosts sequentially
|
|||
|
|
</dd></dl></div><p>--remote-copy REMOTE_COPY:
|
|||
|
|
Command to use for remote copy (should behave like scp)</p><p>--remote-exec REMOTE_EXEC:
|
|||
|
|
Command to use for remote execution (should behave like ssh)</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_shell"></a>7. SHELL</h2></div></div></div><p>This command allows you to spawn a shell that enables access
|
|||
|
|
to the types as commands. It can be thought as an
|
|||
|
|
"interactive manifest" environment. See below for example
|
|||
|
|
usage. Its primary use is for debugging type parameters.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
-s/--shell
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Select shell to use, defaults to current shell
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>8. EXAMPLES</h2></div></div></div><pre class="screen"># Configure ikq05.ethz.ch with debug enabled
|
|||
|
|
% cdist config -d ikq05.ethz.ch
|
|||
|
|
|
|||
|
|
# Configure hosts in parallel and use a different configuration directory
|
|||
|
|
% cdist config -c ~/p/cdist-nutzung \
|
|||
|
|
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
|
|||
|
|
|
|||
|
|
# Use custom remote exec / copy commands
|
|||
|
|
% cdist config --remote-exec /path/to/my/remote/exec \
|
|||
|
|
--remote-copy /path/to/my/remote/copy \
|
|||
|
|
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
|
|||
|
|
|
|||
|
|
# Display banner
|
|||
|
|
cdist banner
|
|||
|
|
|
|||
|
|
# Show help
|
|||
|
|
% cdist --help
|
|||
|
|
|
|||
|
|
# Show Version
|
|||
|
|
% cdist --version
|
|||
|
|
|
|||
|
|
# Enter a shell that has access to emulated types
|
|||
|
|
% cdist shell
|
|||
|
|
% __git
|
|||
|
|
usage: __git --source SOURCE [--state STATE] [--branch BRANCH]
|
|||
|
|
[--group GROUP] [--owner OWNER] [--mode MODE] object_id</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment"></a>9. ENVIRONMENT</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
TMPDIR, TEMP, TMP
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Setup the base directory for the temporary directory.
|
|||
|
|
See <a class="ulink" href="http://docs.python.org/py3k/library/tempfile.html" target="_top">http://docs.python.org/py3k/library/tempfile.html</a> for
|
|||
|
|
more information. This is rather useful, if the standard
|
|||
|
|
directory used does not allow executables.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
CDIST_LOCAL_SHELL
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Selects shell for local script execution, defaults to /bin/sh
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
CDIST_REMOTE_SHELL
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Selects shell for remote scirpt execution, defaults to /bin/sh
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_exit_status"></a>10. EXIT STATUS</h2></div></div></div><p>The following exit values shall be returned:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
0
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Successful completion
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
1
|
|||
|
|
</span></dt><dd>
|
|||
|
|
One or more host configurations failed
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>11. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
|||
|
|
cdist(7)
|
|||
|
|
</li><li class="listitem">
|
|||
|
|
cdist-reference(7)
|
|||
|
|
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>12. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Nico Schottelius. Free use of this software is
|
|||
|
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|