<h2>9.3. DESCRIPTION<aclass="headerlink"href="#description"title="Permalink to this headline">¶</a></h2>
<p>cdist is the frontend executable to the cdist configuration management.
It supports different subcommands as explained below.</p>
<p>It is written in Python so it requires <strong>python</strong>(1) to be installed.
It requires a minimal Python version 3.2.</p>
</div>
<divclass="section"id="general">
<h2>9.4. GENERAL<aclass="headerlink"href="#general"title="Permalink to this headline">¶</a></h2>
<p>All commands accept the following options:</p>
<dlclass="option">
<dtid="cmdoption-h">
<spanid="cmdoption--help"></span><codeclass="descname">-h</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--help</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-h"title="Permalink to this definition">¶</a></dt>
<dd><p>Show the help screen</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-d">
<spanid="cmdoption--debug"></span><codeclass="descname">-d</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--debug</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-d"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-v">
<spanid="cmdoption--verbose"></span><codeclass="descname">-v</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--verbose</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-v"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-V">
<spanid="cmdoption--version"></span><codeclass="descname">-V</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--version</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-V"title="Permalink to this definition">¶</a></dt>
<dd><p>Show version and exit</p>
</dd></dl>
</div>
<divclass="section"id="banner">
<h2>9.5. BANNER<aclass="headerlink"href="#banner"title="Permalink to this headline">¶</a></h2>
<p>Displays the cdist banner. Useful for printing
cdist posters - a must have for every office.</p>
</div>
<divclass="section"id="config-install">
<h2>9.6. CONFIG/INSTALL<aclass="headerlink"href="#config-install"title="Permalink to this headline">¶</a></h2>
<p>Configure/install one or more hosts.</p>
<dlclass="option">
<dtid="cmdoption-A">
<spanid="cmdoption--all-tagged"></span><codeclass="descname">-A</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--all-tagged</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-A"title="Permalink to this definition">¶</a></dt>
<dd><p>use all hosts present in tags db</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--all"></span><codeclass="descname">-a</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--all</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>list hosts that have all specified tags, if -t/--tag
is specified</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-c">
<spanid="cmdoption--conf-dir"></span><codeclass="descname">-c</code><codeclass="descclassname"> CONF_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--conf-dir</code><codeclass="descclassname"> CONF_DIR</code><aclass="headerlink"href="#cmdoption-c"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to operate on from specified file
or from stdin if '-' (each host on separate line).
If no host or host file is specified then, by default,
read hosts from stdin. For the file format see below.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdit/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-i">
<spanid="cmdoption--initial-manifest"></span><codeclass="descname">-i</code><codeclass="descclassname"> MANIFEST</code><codeclass="descclassname">, </code><codeclass="descname">--initial-manifest</code><codeclass="descclassname"> MANIFEST</code><aclass="headerlink"href="#cmdoption-i"title="Permalink to this definition">¶</a></dt>
<dd><p>Path to a cdist manifest or - to read from stdin</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-j">
<spanid="cmdoption--jobs"></span><codeclass="descname">-j</code><codeclass="descclassname"> [JOBS]</code><codeclass="descclassname">, </code><codeclass="descname">--jobs</code><codeclass="descclassname"> [JOBS]</code><aclass="headerlink"href="#cmdoption-j"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the maximum number of parallel jobs; currently only
global explorers are supported (currently in beta)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-n">
<spanid="cmdoption--dry-run"></span><codeclass="descname">-n</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--dry-run</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-n"title="Permalink to this definition">¶</a></dt>
<dd><p>Do not execute code</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-o">
<spanid="cmdoption--out-dir"></span><codeclass="descname">-o</code><codeclass="descclassname"> OUT_PATH</code><codeclass="descclassname">, </code><codeclass="descname">--out-dir</code><codeclass="descclassname"> OUT_PATH</code><aclass="headerlink"href="#cmdoption-o"title="Permalink to this definition">¶</a></dt>
<dd><p>Directory to save cdist output in</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-p">
<spanid="cmdoption--parallel"></span><codeclass="descname">-p</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--parallel</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-p"title="Permalink to this definition">¶</a></dt>
<dd><p>Operate on multiple hosts in parallel</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-s">
<spanid="cmdoption--sequential"></span><codeclass="descname">-s</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--sequential</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-s"title="Permalink to this definition">¶</a></dt>
<dd><p>Operate on multiple hosts sequentially (default)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption--remote-copy">
<codeclass="descname">--remote-copy</code><codeclass="descclassname"> REMOTE_COPY</code><aclass="headerlink"href="#cmdoption--remote-copy"title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote copy (should behave like scp)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption--remote-exec">
<codeclass="descname">--remote-exec</code><codeclass="descclassname"> REMOTE_EXEC</code><aclass="headerlink"href="#cmdoption--remote-exec"title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote execution (should behave like ssh)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--tag"></span><codeclass="descname">-t</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--tag</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>host is specified by tag, not hostname/address; list
all hosts that contain any of specified tags</p>
</dd></dl>
<divclass="section"id="hostfile-format">
<h3>9.6.1. HOSTFILE FORMAT<aclass="headerlink"href="#hostfile-format"title="Permalink to this headline">¶</a></h3>
<p>HOSTFILE contains hosts per line.
All characters after and including '#' until the end of line is a comment.
In a line, all leading and trailing whitespace characters are ignored.
Empty lines are ignored/skipped.</p>
<p>Hostfile line is processed like the following. First, all comments are
removed. Then all leading and trailing whitespace characters are stripped.
If such a line results in empty line it is ignored/skipped. Otherwise,
host string is used.</p>
</div>
</div>
<divclass="section"id="inventory">
<h2>9.7. INVENTORY<aclass="headerlink"href="#inventory"title="Permalink to this headline">¶</a></h2>
<p>Manage inventory database.
Currently in beta with all sub-commands.</p>
</div>
<divclass="section"id="inventory-add-host">
<h2>9.8. INVENTORY ADD-HOST<aclass="headerlink"href="#inventory-add-host"title="Permalink to this headline">¶</a></h2>
<p>Add host(s) to inventory database.</p>
<dlclass="option">
<dtid="cmdoption-arg-host">
<codeclass="descname">host</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-host"title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to add</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to add from specified file or
from stdin if '-' (each host on separate line). If no
host or host file is specified then, by default, read
from stdin. Hostfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-h">
<spanid="cmdoption--help"></span><codeclass="descname">-h</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--help</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-h"title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdist/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
</div>
<divclass="section"id="inventory-add-tag">
<h2>9.9. INVENTORY ADD-TAG<aclass="headerlink"href="#inventory-add-tag"title="Permalink to this headline">¶</a></h2>
<p>Add tag(s) to inventory database.</p>
<dlclass="option">
<dtid="cmdoption-arg-host">
<codeclass="descname">host</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-host"title="Permalink to this definition">¶</a></dt>
<dd><p>list of host(s) for which tags are added</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to add tags from specified file
or from stdin if '-' (each host on separate line). If
no host or host file is specified then, by default,
read from stdin. If no tags/tagfile nor hosts/hostfile
are specified then tags are read from stdin and are
added to all hosts. Hostfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdist/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-T">
<spanid="cmdoption--tag-file"></span><codeclass="descname">-T</code><codeclass="descclassname"> TAGFILE</code><codeclass="descclassname">, </code><codeclass="descname">--tag-file</code><codeclass="descclassname"> TAGFILE</code><aclass="headerlink"href="#cmdoption-T"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional tags to add from specified file or
from stdin if '-' (each tag on separate line). If no
tag or tag file is specified then, by default, read
from stdin. If no tags/tagfile nor hosts/hostfile are
specified then tags are read from stdin and are added
to all hosts. Tagfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--taglist"></span><codeclass="descname">-t</code><codeclass="descclassname"> TAGLIST</code><codeclass="descclassname">, </code><codeclass="descname">--taglist</code><codeclass="descclassname"> TAGLIST</code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>Tag list to be added for specified host(s), comma
separated values</p>
</dd></dl>
</div>
<divclass="section"id="inventory-del-host">
<h2>9.10. INVENTORY DEL-HOST<aclass="headerlink"href="#inventory-del-host"title="Permalink to this headline">¶</a></h2>
<p>Delete host(s) from inventory database.</p>
<dlclass="option">
<dtid="cmdoption-arg-host">
<codeclass="descname">host</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-host"title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to delete</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--all"></span><codeclass="descname">-a</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--all</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all hosts</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to delete from specified file or
from stdin if '-' (each host on separate line). If no
host or host file is specified then, by default, read
from stdin. Hostfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdist/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
</div>
<divclass="section"id="inventory-del-tag">
<h2>9.11. INVENTORY DEL-TAG<aclass="headerlink"href="#inventory-del-tag"title="Permalink to this headline">¶</a></h2>
<p>Delete tag(s) from inventory database.</p>
<dlclass="option">
<dtid="cmdoption-arg-host">
<codeclass="descname">host</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-host"title="Permalink to this definition">¶</a></dt>
<dd><p>list of host(s) for which tags are deleted</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--all"></span><codeclass="descname">-a</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--all</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all tags for specified host(s)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to delete tags for from
specified file or from stdin if '-' (each host on
separate line). If no host or host file is specified
then, by default, read from stdin. If no tags/tagfile
nor hosts/hostfile are specified then tags are read
from stdin and are deleted from all hosts. Hostfile
format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdist/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-T">
<spanid="cmdoption--tag-file"></span><codeclass="descname">-T</code><codeclass="descclassname"> TAGFILE</code><codeclass="descclassname">, </code><codeclass="descname">--tag-file</code><codeclass="descclassname"> TAGFILE</code><aclass="headerlink"href="#cmdoption-T"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional tags from specified file or from stdin
if '-' (each tag on separate line). If no tag or tag
file is specified then, by default, read from stdin.
If no tags/tagfile nor hosts/hostfile are specified
then tags are read from stdin and are added to all
hosts. Tagfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--taglist"></span><codeclass="descname">-t</code><codeclass="descclassname"> TAGLIST</code><codeclass="descclassname">, </code><codeclass="descname">--taglist</code><codeclass="descclassname"> TAGLIST</code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>Tag list to be deleted for specified host(s), comma
separated values</p>
</dd></dl>
</div>
<divclass="section"id="inventory-list">
<h2>9.12. INVENTORY LIST<aclass="headerlink"href="#inventory-list"title="Permalink to this headline">¶</a></h2>
<p>List inventory database.</p>
<dlclass="option">
<dtid="cmdoption-arg-host">
<codeclass="descname">host</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-host"title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to list</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--all"></span><codeclass="descname">-a</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--all</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>list hosts that have all specified tags, if -t/--tag
is specified</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-f">
<spanid="cmdoption--file"></span><codeclass="descname">-f</code><codeclass="descclassname"> HOSTFILE</code><codeclass="descclassname">, </code><codeclass="descname">--file</code><codeclass="descclassname"> HOSTFILE</code><aclass="headerlink"href="#cmdoption-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Read additional hosts to list from specified file or
from stdin if '-' (each host on separate line). If no
host or host file is specified then, by default, list
all. Hostfile format is the same as config hostfile format.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-H">
<spanid="cmdoption--host-only"></span><codeclass="descname">-H</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--host-only</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-H"title="Permalink to this definition">¶</a></dt>
<dd><p>Suppress tags listing</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-I">
<spanid="cmdoption--inventory"></span><codeclass="descname">-I</code><codeclass="descclassname"> INVENTORY_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--inventory</code><codeclass="descclassname"> INVENTORY_DIR</code><aclass="headerlink"href="#cmdoption-I"title="Permalink to this definition">¶</a></dt>
directory is set up by the following rules: if this
argument is set then specified directory is used, if
CDIST_INVENTORY_DIR env var is set then its value is
used, if HOME env var is set then ~/.cdist/inventory is
used, otherwise distribution inventory directory is
used.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--tag"></span><codeclass="descname">-t</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--tag</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>host is specified by tag, not hostname/address; list
all hosts that contain any of specified tags</p>
</dd></dl>
</div>
<divclass="section"id="preos">
<h2>9.13. PREOS<aclass="headerlink"href="#preos"title="Permalink to this headline">¶</a></h2>
<p>Create PreOS. Currently, the following PreOS-es are supported:</p>
<ulclass="simple">
<li>debian</li>
<li>ubuntu</li>
</ul>
</div>
<divclass="section"id="preos-debian">
<h2>9.14. PREOS DEBIAN<aclass="headerlink"href="#preos-debian"title="Permalink to this headline">¶</a></h2>
<dlclass="option">
<dtid="cmdoption-arg-target_dir">
<codeclass="descname">target_dir</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-target_dir"title="Permalink to this definition">¶</a></dt>
<dd><p>target directory where PreOS will be bootstrapped</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--arch"></span><codeclass="descname">-a</code><codeclass="descclassname"> ARCH</code><codeclass="descclassname">, </code><codeclass="descname">--arch</code><codeclass="descclassname"> ARCH</code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>target debootstrap architecture, by default 'amd64'</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-B">
<spanid="cmdoption--bootstrap"></span><codeclass="descname">-B</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--bootstrap</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-B"title="Permalink to this definition">¶</a></dt>
<dd><p>do bootstrap step</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-C">
<spanid="cmdoption--configure"></span><codeclass="descname">-C</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--configure</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-C"title="Permalink to this definition">¶</a></dt>
<dd><p>do configure step</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-c">
<spanid="cmdoption--cdist-params"></span><codeclass="descname">-c</code><codeclass="descclassname"> CDIST_PARAMS</code><codeclass="descclassname">, </code><codeclass="descname">--cdist-params</code><codeclass="descclassname"> CDIST_PARAMS</code><aclass="headerlink"href="#cmdoption-c"title="Permalink to this definition">¶</a></dt>
<dd><p>parameters that will be passed to cdist config, by
default '-v' is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-d">
<spanid="cmdoption--debug"></span><codeclass="descname">-d</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--debug</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-d"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-e">
<spanid="cmdoption--remote-exec"></span><codeclass="descname">-e</code><codeclass="descclassname"> REMOTE_EXEC</code><codeclass="descclassname">, </code><codeclass="descname">--remote-exec</code><codeclass="descclassname"> REMOTE_EXEC</code><aclass="headerlink"href="#cmdoption-e"title="Permalink to this definition">¶</a></dt>
<dd><p>remote exec that cdist config will use, by default
internal script is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-h">
<spanid="cmdoption--help"></span><codeclass="descname">-h</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--help</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-h"title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-i">
<spanid="cmdoption--init-manifest"></span><codeclass="descname">-i</code><codeclass="descclassname"> MANIFEST</code><codeclass="descclassname">, </code><codeclass="descname">--init-manifest</code><codeclass="descclassname"> MANIFEST</code><aclass="headerlink"href="#cmdoption-i"title="Permalink to this definition">¶</a></dt>
<dd><p>init manifest that cdist config will use, by default
internal init manifest is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-k">
<spanid="cmdoption--keyfile"></span><codeclass="descname">-k</code><codeclass="descclassname"> [KEYFILE [KEYFILE ...]]</code><codeclass="descclassname">, </code><codeclass="descname">--keyfile</code><codeclass="descclassname"> [KEYFILE [KEYFILE ...]]</code><aclass="headerlink"href="#cmdoption-k"title="Permalink to this definition">¶</a></dt>
<dd><p>ssh key files that will be added to cdist config;
'<codeclass="docutils literal"><spanclass="pre">__ssh_authorized_keys</span><spanclass="pre">root</span><spanclass="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-m">
<spanid="cmdoption--mirror"></span><codeclass="descname">-m</code><codeclass="descclassname"> MIRROR</code><codeclass="descclassname">, </code><codeclass="descname">--mirror</code><codeclass="descclassname"> MIRROR</code><aclass="headerlink"href="#cmdoption-m"title="Permalink to this definition">¶</a></dt>
<dd><p>use specified mirror for debootstrap</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-p">
<spanid="cmdoption--pxe-boot-dir"></span><codeclass="descname">-p</code><codeclass="descclassname"> PXE_BOOT_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--pxe-boot-dir</code><codeclass="descclassname"> PXE_BOOT_DIR</code><aclass="headerlink"href="#cmdoption-p"title="Permalink to this definition">¶</a></dt>
<dd><p>PXE boot directory</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-r">
<spanid="cmdoption--rm-bootstrap-dir"></span><codeclass="descname">-r</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--rm-bootstrap-dir</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-r"title="Permalink to this definition">¶</a></dt>
<dd><p>remove target directory after finishing</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-S">
<spanid="cmdoption--script"></span><codeclass="descname">-S</code><codeclass="descclassname"> SCRIPT</code><codeclass="descclassname">, </code><codeclass="descname">--script</code><codeclass="descclassname"> SCRIPT</code><aclass="headerlink"href="#cmdoption-S"title="Permalink to this definition">¶</a></dt>
<dd><p>use specified script for debootstrap</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-s">
<spanid="cmdoption--suite"></span><codeclass="descname">-s</code><codeclass="descclassname"> SUITE</code><codeclass="descclassname">, </code><codeclass="descname">--suite</code><codeclass="descclassname"> SUITE</code><aclass="headerlink"href="#cmdoption-s"title="Permalink to this definition">¶</a></dt>
<dd><p>suite used for debootstrap, by default 'stable'</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--trigger-command"></span><codeclass="descname">-t</code><codeclass="descclassname"> TRIGGER_COMMAND</code><codeclass="descclassname">, </code><codeclass="descname">--trigger-command</code><codeclass="descclassname"> TRIGGER_COMMAND</code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>trigger command that will be added to cdist config;
'<codeclass="docutils literal"><spanclass="pre">__cdist_preos_trigger</span><spanclass="pre">http</span><spanclass="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-v">
<spanid="cmdoption--verbose"></span><codeclass="descname">-v</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--verbose</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-v"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-y">
<spanid="cmdoption--remote-copy"></span><codeclass="descname">-y</code><codeclass="descclassname"> REMOTE_COPY</code><codeclass="descclassname">, </code><codeclass="descname">--remote-copy</code><codeclass="descclassname"> REMOTE_COPY</code><aclass="headerlink"href="#cmdoption-y"title="Permalink to this definition">¶</a></dt>
<dd><p>remote copy that cdist config will use, by default
internal script is used</p>
</dd></dl>
</div>
<divclass="section"id="preos-ubuntu">
<h2>9.15. PREOS UBUNTU<aclass="headerlink"href="#preos-ubuntu"title="Permalink to this headline">¶</a></h2>
<dlclass="option">
<dtid="cmdoption-arg-target_dir">
<codeclass="descname">target_dir</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-arg-target_dir"title="Permalink to this definition">¶</a></dt>
<dd><p>target directory where PreOS will be bootstrapped</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-a">
<spanid="cmdoption--arch"></span><codeclass="descname">-a</code><codeclass="descclassname"> ARCH</code><codeclass="descclassname">, </code><codeclass="descname">--arch</code><codeclass="descclassname"> ARCH</code><aclass="headerlink"href="#cmdoption-a"title="Permalink to this definition">¶</a></dt>
<dd><p>target debootstrap architecture, by default 'amd64'</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-B">
<spanid="cmdoption--bootstrap"></span><codeclass="descname">-B</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--bootstrap</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-B"title="Permalink to this definition">¶</a></dt>
<dd><p>do bootstrap step</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-C">
<spanid="cmdoption--configure"></span><codeclass="descname">-C</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--configure</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-C"title="Permalink to this definition">¶</a></dt>
<dd><p>do configure step</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-c">
<spanid="cmdoption--cdist-params"></span><codeclass="descname">-c</code><codeclass="descclassname"> CDIST_PARAMS</code><codeclass="descclassname">, </code><codeclass="descname">--cdist-params</code><codeclass="descclassname"> CDIST_PARAMS</code><aclass="headerlink"href="#cmdoption-c"title="Permalink to this definition">¶</a></dt>
<dd><p>parameters that will be passed to cdist config, by
default '-v' is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-d">
<spanid="cmdoption--debug"></span><codeclass="descname">-d</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--debug</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-d"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-e">
<spanid="cmdoption--remote-exec"></span><codeclass="descname">-e</code><codeclass="descclassname"> REMOTE_EXEC</code><codeclass="descclassname">, </code><codeclass="descname">--remote-exec</code><codeclass="descclassname"> REMOTE_EXEC</code><aclass="headerlink"href="#cmdoption-e"title="Permalink to this definition">¶</a></dt>
<dd><p>remote exec that cdist config will use, by default
internal script is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-h">
<spanid="cmdoption--help"></span><codeclass="descname">-h</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--help</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-h"title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-i">
<spanid="cmdoption--init-manifest"></span><codeclass="descname">-i</code><codeclass="descclassname"> MANIFEST</code><codeclass="descclassname">, </code><codeclass="descname">--init-manifest</code><codeclass="descclassname"> MANIFEST</code><aclass="headerlink"href="#cmdoption-i"title="Permalink to this definition">¶</a></dt>
<dd><p>init manifest that cdist config will use, by default
internal init manifest is used</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-k">
<spanid="cmdoption--keyfile"></span><codeclass="descname">-k</code><codeclass="descclassname"> [KEYFILE [KEYFILE ...]]</code><codeclass="descclassname">, </code><codeclass="descname">--keyfile</code><codeclass="descclassname"> [KEYFILE [KEYFILE ...]]</code><aclass="headerlink"href="#cmdoption-k"title="Permalink to this definition">¶</a></dt>
<dd><p>ssh key files that will be added to cdist config;
'<codeclass="docutils literal"><spanclass="pre">__ssh_authorized_keys</span><spanclass="pre">root</span><spanclass="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-m">
<spanid="cmdoption--mirror"></span><codeclass="descname">-m</code><codeclass="descclassname"> MIRROR</code><codeclass="descclassname">, </code><codeclass="descname">--mirror</code><codeclass="descclassname"> MIRROR</code><aclass="headerlink"href="#cmdoption-m"title="Permalink to this definition">¶</a></dt>
<dd><p>use specified mirror for debootstrap</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-p">
<spanid="cmdoption--pxe-boot-dir"></span><codeclass="descname">-p</code><codeclass="descclassname"> PXE_BOOT_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--pxe-boot-dir</code><codeclass="descclassname"> PXE_BOOT_DIR</code><aclass="headerlink"href="#cmdoption-p"title="Permalink to this definition">¶</a></dt>
<dd><p>PXE boot directory</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-r">
<spanid="cmdoption--rm-bootstrap-dir"></span><codeclass="descname">-r</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--rm-bootstrap-dir</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-r"title="Permalink to this definition">¶</a></dt>
<dd><p>remove target directory after finishing</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-S">
<spanid="cmdoption--script"></span><codeclass="descname">-S</code><codeclass="descclassname"> SCRIPT</code><codeclass="descclassname">, </code><codeclass="descname">--script</code><codeclass="descclassname"> SCRIPT</code><aclass="headerlink"href="#cmdoption-S"title="Permalink to this definition">¶</a></dt>
<dd><p>use specified script for debootstrap</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-s">
<spanid="cmdoption--suite"></span><codeclass="descname">-s</code><codeclass="descclassname"> SUITE</code><codeclass="descclassname">, </code><codeclass="descname">--suite</code><codeclass="descclassname"> SUITE</code><aclass="headerlink"href="#cmdoption-s"title="Permalink to this definition">¶</a></dt>
<dd><p>suite used for debootstrap, by default 'xenial'</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-t">
<spanid="cmdoption--trigger-command"></span><codeclass="descname">-t</code><codeclass="descclassname"> TRIGGER_COMMAND</code><codeclass="descclassname">, </code><codeclass="descname">--trigger-command</code><codeclass="descclassname"> TRIGGER_COMMAND</code><aclass="headerlink"href="#cmdoption-t"title="Permalink to this definition">¶</a></dt>
<dd><p>trigger command that will be added to cdist config;
'<codeclass="docutils literal"><spanclass="pre">__cdist_preos_trigger</span><spanclass="pre">http</span><spanclass="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-v">
<spanid="cmdoption--verbose"></span><codeclass="descname">-v</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--verbose</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-v"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-y">
<spanid="cmdoption--remote-copy"></span><codeclass="descname">-y</code><codeclass="descclassname"> REMOTE_COPY</code><codeclass="descclassname">, </code><codeclass="descname">--remote-copy</code><codeclass="descclassname"> REMOTE_COPY</code><aclass="headerlink"href="#cmdoption-y"title="Permalink to this definition">¶</a></dt>
<dd><p>remote copy that cdist config will use, by default
internal script is used</p>
</dd></dl>
</div>
<divclass="section"id="shell">
<h2>9.16. SHELL<aclass="headerlink"href="#shell"title="Permalink to this headline">¶</a></h2>
<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>
<dlclass="option">
<dtid="cmdoption-s">
<spanid="cmdoption--shell"></span><codeclass="descname">-s</code><codeclass="descclassname"> SHELL</code><codeclass="descclassname">, </code><codeclass="descname">--shell</code><codeclass="descclassname"> SHELL</code><aclass="headerlink"href="#cmdoption-s"title="Permalink to this definition">¶</a></dt>
<dd><p>Select shell to use, defaults to current shell. Used shell should
be POSIX compatible shell.</p>
</dd></dl>
</div>
<divclass="section"id="trigger">
<h2>9.17. TRIGGER<aclass="headerlink"href="#trigger"title="Permalink to this headline">¶</a></h2>
<p>Start trigger (simple http server) that waits for connections. When host
<spanid="cmdoption--ipv6"></span><codeclass="descname">-6</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--ipv6</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-6"title="Permalink to this definition">¶</a></dt>
<dd><p>Listen to both IPv4 and IPv6 (instead of only IPv4)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-b">
<spanid="cmdoption--beta"></span><codeclass="descname">-b</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--beta</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-b"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-c">
<spanid="cmdoption--conf-dir"></span><codeclass="descname">-c</code><codeclass="descclassname"> CONF_DIR</code><codeclass="descclassname">, </code><codeclass="descname">--conf-dir</code><codeclass="descclassname"> CONF_DIR</code><aclass="headerlink"href="#cmdoption-c"title="Permalink to this definition">¶</a></dt>
<dd><p>Add configuration directory (can be repeated, last one wins)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-d">
<spanid="cmdoption--debug"></span><codeclass="descname">-d</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--debug</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-d"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-H">
<spanid="cmdoption--http-port"></span><codeclass="descname">-H</code><codeclass="descclassname"> HTTP_PORT</code><codeclass="descclassname">, </code><codeclass="descname">--http-port</code><codeclass="descclassname"> HTTP_PORT</code><aclass="headerlink"href="#cmdoption-H"title="Permalink to this definition">¶</a></dt>
<dd><p>Create trigger listener via http on specified port</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-h">
<spanid="cmdoption--help"></span><codeclass="descname">-h</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--help</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-h"title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-i">
<spanid="cmdoption--initial-manifest"></span><codeclass="descname">-i</code><codeclass="descclassname"> MANIFEST</code><codeclass="descclassname">, </code><codeclass="descname">--initial-manifest</code><codeclass="descclassname"> MANIFEST</code><aclass="headerlink"href="#cmdoption-i"title="Permalink to this definition">¶</a></dt>
<dd><p>path to a cdist manifest or '-' to read from stdin.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-j">
<spanid="cmdoption--jobs"></span><codeclass="descname">-j</code><codeclass="descclassname"> [JOBS]</code><codeclass="descclassname">, </code><codeclass="descname">--jobs</code><codeclass="descclassname"> [JOBS]</code><aclass="headerlink"href="#cmdoption-j"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the maximum number of parallel jobs, currently
only global explorers are supported</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-n">
<spanid="cmdoption--dry-run"></span><codeclass="descname">-n</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--dry-run</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-n"title="Permalink to this definition">¶</a></dt>
<dd><p>do not execute code</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-o">
<spanid="cmdoption--out-dir"></span><codeclass="descname">-o</code><codeclass="descclassname"> OUT_PATH</code><codeclass="descclassname">, </code><codeclass="descname">--out-dir</code><codeclass="descclassname"> OUT_PATH</code><aclass="headerlink"href="#cmdoption-o"title="Permalink to this definition">¶</a></dt>
<dd><p>directory to save cdist output in</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption--remote-copy">
<codeclass="descname">--remote-copy</code><codeclass="descclassname"> REMOTE_COPY</code><aclass="headerlink"href="#cmdoption--remote-copy"title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote copy (should behave like scp)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption--remote-exec">
<codeclass="descname">--remote-exec</code><codeclass="descclassname"> REMOTE_EXEC</code><aclass="headerlink"href="#cmdoption--remote-exec"title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote execution (should behave like ssh)</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-v">
<spanid="cmdoption--verbose"></span><codeclass="descname">-v</code><codeclass="descclassname"></code><codeclass="descclassname">, </code><codeclass="descname">--verbose</code><codeclass="descclassname"></code><aclass="headerlink"href="#cmdoption-v"title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>
</div>
<divclass="section"id="files">
<h2>9.18. FILES<aclass="headerlink"href="#files"title="Permalink to this headline">¶</a></h2>
<dlclass="docutils">
<dt>~/.cdist</dt>
<dd>Your personal cdist config directory. If exists it will be
automatically used.</dd>
<dt>~/.cdist/inventory</dt>
<dd>The home inventory directory. If ~/.cdist exists it will be used as
default inventory directory.</dd>
<dt>~/.cdist/preos</dt>
<dd>PreOS plugins directory, if existing.</dd>
<dt>cdist/conf</dt>
<dd>The distribution configuration directory. It contains official types and
explorers. This path is relative to cdist installation directory.</dd>
<dt>cdist/inventory</dt>
<dd>The distribution inventory directory.
This path is relative to cdist installation directory.</dd>
<dt>cdist/preos</dt>
<dd>The distribution PreOS plugins directory.</dd>
</dl>
</div>
<divclass="section"id="examples">
<h2>9.19. EXAMPLES<aclass="headerlink"href="#examples"title="Permalink to this headline">¶</a></h2>
<divclass="highlight-sh"><divclass="highlight"><pre><span></span><spanclass="c1"># Configure ikq05.ethz.ch with debug enabled</span>
% cdist config -d ikq05.ethz.ch
<spanclass="c1"># Configure hosts in parallel and use a different configuration directory</span>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
