www.nico.schottelius.org/software/cdist/man/beta/man1/cdist.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>9. cdist(1) &mdash; cdist 4.4.4-251-g664bce08 documentation</title>
  

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="cdist 4.4.4-251-g664bce08 documentation" href="../index.html"/>
        <link rel="next" title="10. Bootstrap" href="../cdist-bootstrap.html"/>
        <link rel="prev" title="8. Quickstart" href="../cdist-quickstart.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

            <a href="../index.html" class="icon icon-home"> cdist
          

          </a>

          
              <div class="version">
                4.4.4-251-g664bce08
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../cdist-intro.html">1. cdist - usable configuration management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-why.html">2. Why should I use cdist?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-os.html">3. Supported Operating Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-install.html">4. How to install cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-update.html">5. How to update cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-support.html">6. Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-features.html">7. Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-quickstart.html">8. Quickstart</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">9. cdist(1)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#name">9.1. NAME</a></li>
<li class="toctree-l2"><a class="reference internal" href="#synopsis">9.2. SYNOPSIS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#description">9.3. DESCRIPTION</a></li>
<li class="toctree-l2"><a class="reference internal" href="#general">9.4. GENERAL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#banner">9.5. BANNER</a></li>
<li class="toctree-l2"><a class="reference internal" href="#config-install">9.6. CONFIG/INSTALL</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#hostfile-format">9.6.1. HOSTFILE FORMAT</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cache-path-pattern-format">9.6.2. CACHE PATH PATTERN FORMAT</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#inventory">9.7. INVENTORY</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inventory-add-host">9.8. INVENTORY ADD-HOST</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inventory-add-tag">9.9. INVENTORY ADD-TAG</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inventory-del-host">9.10. INVENTORY DEL-HOST</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inventory-del-tag">9.11. INVENTORY DEL-TAG</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inventory-list">9.12. INVENTORY LIST</a></li>
<li class="toctree-l2"><a class="reference internal" href="#preos">9.13. PREOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#preos-debian-devuan">9.14. PREOS DEBIAN/DEVUAN</a></li>
<li class="toctree-l2"><a class="reference internal" href="#preos-ubuntu">9.15. PREOS UBUNTU</a></li>
<li class="toctree-l2"><a class="reference internal" href="#shell">9.16. SHELL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#trigger">9.17. TRIGGER</a></li>
<li class="toctree-l2"><a class="reference internal" href="#files">9.18. FILES</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notes">9.19. NOTES</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">9.20. EXAMPLES</a></li>
<li class="toctree-l2"><a class="reference internal" href="#environment">9.21. ENVIRONMENT</a></li>
<li class="toctree-l2"><a class="reference internal" href="#exit-status">9.22. EXIT STATUS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#authors">9.23. AUTHORS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#caveats">9.24. CAVEATS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#copying">9.25. COPYING</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-bootstrap.html">10. Bootstrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-manifest.html">11. Manifest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-type.html">12. cdist type</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-types.html">13. cdist types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-explorer.html">14. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-messaging.html">15. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-parallelization.html">16. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-inventory.html">17. Inventory</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-trigger.html">18. Trigger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-preos.html">19. PreOS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-reference.html">20. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-best-practice.html">21. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-stages.html">22. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-remote-exec-copy.html">23. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-hacker.html">24. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdist-troubleshooting.html">25. Troubleshooting</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">cdist</a>
        
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
      <li>9. cdist(1)</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/man1/cdist.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="cdist-1">
<h1>9. cdist(1)<a class="headerlink" href="#cdist-1" title="Permalink to this headline">¶</a></h1>
<div class="section" id="name">
<h2>9.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
<p>cdist - Usable Configuration Management</p>
</div>
<div class="section" id="synopsis">
<h2>9.2. SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span> <span class="p">{</span><span class="n">banner</span><span class="p">,</span><span class="n">config</span><span class="p">,</span><span class="n">install</span><span class="p">,</span><span class="n">inventory</span><span class="p">,</span><span class="n">preos</span><span class="p">,</span><span class="n">shell</span><span class="p">,</span><span class="n">trigger</span><span class="p">}</span> <span class="o">...</span>

<span class="n">cdist</span> <span class="n">banner</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span>

<span class="n">cdist</span> <span class="n">config</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span> <span class="n">CACHE_PATH_PATTERN</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONF_DIR</span><span class="p">]</span>
             <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span> <span class="p">[</span><span class="n">JOBS</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">o</span> <span class="n">OUT_PATH</span><span class="p">]</span>
             <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">copy</span> <span class="n">REMOTE_COPY</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">exec</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
             <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">A</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span><span class="p">]</span>
             <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">install</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span> <span class="n">CACHE_PATH_PATTERN</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONF_DIR</span><span class="p">]</span>
              <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span> <span class="p">[</span><span class="n">JOBS</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">o</span> <span class="n">OUT_PATH</span><span class="p">]</span>
              <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">copy</span> <span class="n">REMOTE_COPY</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">exec</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
              <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">A</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span><span class="p">]</span>
              <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span>
                <span class="p">{</span><span class="n">add</span><span class="o">-</span><span class="n">host</span><span class="p">,</span><span class="n">add</span><span class="o">-</span><span class="n">tag</span><span class="p">,</span><span class="k">del</span><span class="o">-</span><span class="n">host</span><span class="p">,</span><span class="k">del</span><span class="o">-</span><span class="n">tag</span><span class="p">,</span><span class="nb">list</span><span class="p">}</span> <span class="o">...</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="n">add</span><span class="o">-</span><span class="n">host</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span>
                         <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span>
                         <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="n">add</span><span class="o">-</span><span class="n">tag</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span>
                        <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">T</span> <span class="n">TAGFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TAGLIST</span><span class="p">]</span>
                        <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="k">del</span><span class="o">-</span><span class="n">host</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span>
                         <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span>
                         <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="k">del</span><span class="o">-</span><span class="n">tag</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span>
                        <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">T</span> <span class="n">TAGFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TAGLIST</span><span class="p">]</span>
                        <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">inventory</span> <span class="nb">list</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span> <span class="n">INVENTORY_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span>
                     <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">HOSTFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">H</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span><span class="p">]</span>
                     <span class="p">[</span><span class="n">host</span> <span class="p">[</span><span class="n">host</span> <span class="o">...</span><span class="p">]]</span>

<span class="n">cdist</span> <span class="n">preos</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="n">preos</span>

<span class="n">cdist</span> <span class="n">preos</span> <span class="n">debian</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span> <span class="n">ARCH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">B</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CDIST_PARAMS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span> <span class="n">DRIVE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">k</span> <span class="n">KEYFILE</span> <span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span> <span class="n">MIRROR</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">P</span> <span class="n">ROOT_PASSWORD</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PXE_BOOT_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">S</span> <span class="n">SCRIPT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">SUITE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TRIGGER_COMMAND</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">y</span> <span class="n">REMOTE_COPY</span><span class="p">]</span>
                   <span class="n">target_dir</span>

<span class="n">cdist</span> <span class="n">preos</span> <span class="n">devuan</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span> <span class="n">ARCH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">B</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CDIST_PARAMS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span> <span class="n">DRIVE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">k</span> <span class="n">KEYFILE</span> <span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span> <span class="n">MIRROR</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">P</span> <span class="n">ROOT_PASSWORD</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PXE_BOOT_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">S</span> <span class="n">SCRIPT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">SUITE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TRIGGER_COMMAND</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">y</span> <span class="n">REMOTE_COPY</span><span class="p">]</span>
                   <span class="n">target_dir</span>

<span class="n">cdist</span> <span class="n">preos</span> <span class="n">ubuntu</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span> <span class="n">ARCH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">B</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CDIST_PARAMS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span> <span class="n">DRIVE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">k</span> <span class="n">KEYFILE</span> <span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span> <span class="n">MIRROR</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">P</span> <span class="n">ROOT_PASSWORD</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PXE_BOOT_DIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">S</span> <span class="n">SCRIPT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">SUITE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TRIGGER_COMMAND</span><span class="p">]</span>
                   <span class="p">[</span><span class="o">-</span><span class="n">y</span> <span class="n">REMOTE_COPY</span><span class="p">]</span>
                   <span class="n">target_dir</span>

<span class="n">cdist</span> <span class="n">shell</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">SHELL</span><span class="p">]</span>

<span class="n">cdist</span> <span class="n">trigger</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">b</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">C</span> <span class="n">CACHE_PATH_PATTERN</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONF_DIR</span><span class="p">]</span>
              <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">MANIFEST</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span> <span class="p">[</span><span class="n">JOBS</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">o</span> <span class="n">OUT_PATH</span><span class="p">]</span>
              <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">copy</span> <span class="n">REMOTE_COPY</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">remote</span><span class="o">-</span><span class="n">exec</span> <span class="n">REMOTE_EXEC</span><span class="p">]</span>
              <span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">H</span> <span class="n">HTTP_PORT</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>9.3. DESCRIPTION<a class="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>
<div class="section" id="general">
<h2>9.4. GENERAL<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2>
<p>All commands accept the following options:</p>
<dl class="option">
<dt id="cmdoption-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition">¶</a></dt>
<dd><p>Show the help screen</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-d">
<code class="descname">-d</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug (deprecated, use -vvv instead)</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-v">
<code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition">¶</a></dt>
<dd><p>Increase the verbosity level. Every instance of -v increments the verbosity
level by one. Its default value is 0. There are 4 levels of verbosity. The
order of levels from the lowest to the highest are: ERROR (0), WARNING (1),
INFO (2) and DEBUG (3 or higher).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-version">
<code class="descname">-V</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-version" title="Permalink to this definition">¶</a></dt>
<dd><p>Show version and exit</p>
</dd></dl>

</div>
<div class="section" id="banner">
<h2>9.5. BANNER<a class="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>
<div class="section" id="config-install">
<h2>9.6. CONFIG/INSTALL<a class="headerlink" href="#config-install" title="Permalink to this headline">¶</a></h2>
<p>Configure/install one or more hosts.</p>
<dl class="option">
<dt id="cmdoption-a">
<code class="descname">-A</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--all-tagged</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-a" title="Permalink to this definition">¶</a></dt>
<dd><p>use all hosts present in tags db</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-all">
<code class="descname">-a</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--all</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-all" title="Permalink to this definition">¶</a></dt>
<dd><p>list hosts that have all specified tags, if -t/--tag
is specified</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-b">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-b" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-c">
<code class="descname">-C</code><code class="descclassname"> CACHE_PATH_PATTERN</code><code class="descclassname">, </code><code class="descname">--cache-path-pattern</code><code class="descclassname"> CACHE_PATH_PATTERN</code><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt>
<dd><p>Sepcify custom cache path pattern. It can also be set by
CDIST_CACHE_PATH_PATTERN environment variable. If it is not set then
default hostdir is used. For more info on format see
<strong>CACHE PATH PATTERN FORMAT</strong> below.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-conf-dir">
<code class="descname">-c</code><code class="descclassname"> CONF_DIR</code><code class="descclassname">, </code><code class="descname">--conf-dir</code><code class="descclassname"> CONF_DIR</code><a class="headerlink" href="#cmdoption-conf-dir" 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>

<dl class="option">
<dt id="cmdoption-f">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="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
<strong>HOSTFILE FORMAT</strong> below.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-i">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#cmdoption-i" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>

<dl class="option">
<dt id="cmdoption-initial-manifest">
<code class="descname">-i</code><code class="descclassname"> MANIFEST</code><code class="descclassname">, </code><code class="descname">--initial-manifest</code><code class="descclassname"> MANIFEST</code><a class="headerlink" href="#cmdoption-initial-manifest" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to a cdist manifest or - to read from stdin</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-j">
<code class="descname">-j</code><code class="descclassname"> [JOBS]</code><code class="descclassname">, </code><code class="descname">--jobs</code><code class="descclassname"> [JOBS]</code><a class="headerlink" href="#cmdoption-j" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the maximum number of parallel jobs. Global
explorers, object prepare and object run are supported
(currently in beta).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-n">
<code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--dry-run</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-n" title="Permalink to this definition">¶</a></dt>
<dd><p>Do not execute code</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-o">
<code class="descname">-o</code><code class="descclassname"> OUT_PATH</code><code class="descclassname">, </code><code class="descname">--out-dir</code><code class="descclassname"> OUT_PATH</code><a class="headerlink" href="#cmdoption-o" title="Permalink to this definition">¶</a></dt>
<dd><p>Directory to save cdist output in</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-p">
<code class="descname">-p</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--parallel</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition">¶</a></dt>
<dd><p>Operate on multiple hosts in parallel</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-s">
<code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--sequential</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
<dd><p>Operate on multiple hosts sequentially (default)</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-remote-copy">
<code class="descname">--remote-copy</code><code class="descclassname"> REMOTE_COPY</code><a class="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>

<dl class="option">
<dt id="cmdoption-remote-exec">
<code class="descname">--remote-exec</code><code class="descclassname"> REMOTE_EXEC</code><a class="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>

<dl class="option">
<dt id="cmdoption-t">
<code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--tag</code><code class="descclassname"></code><a class="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 class="section" id="hostfile-format">
<h3>9.6.1. HOSTFILE FORMAT<a class="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 class="section" id="cache-path-pattern-format">
<h3>9.6.2. CACHE PATH PATTERN FORMAT<a class="headerlink" href="#cache-path-pattern-format" title="Permalink to this headline">¶</a></h3>
<p>Cache path pattern specifies path for a cache directory subdirectory.
In the path, '%N' will be substituted by the target host, '%h' will
be substituted by the calculated host directory, '%P' will be substituted
by the current process id. All format codes that
<strong>python</strong> <strong>datetime.strftime()</strong> function supports, except
'%h', are supported. These date/time directives format cdist config/install
start time.</p>
<p>If empty pattern is specified then default calculated host directory
is used.</p>
<p>Calculated host directory is a hash of a host cdist operates on.</p>
<p>Resulting path is used to specify cache path subdirectory under which
current host cache data are saved.</p>
</div>
</div>
<div class="section" id="inventory">
<h2>9.7. INVENTORY<a class="headerlink" href="#inventory" title="Permalink to this headline">¶</a></h2>
<p>Manage inventory database.
Currently in beta with all sub-commands.</p>
</div>
<div class="section" id="inventory-add-host">
<h2>9.8. INVENTORY ADD-HOST<a class="headerlink" href="#inventory-add-host" title="Permalink to this headline">¶</a></h2>
<p>Add host(s) to inventory database.</p>
<dl class="option">
<dt id="cmdoption-arg-host">
<code class="descname">host</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-arg-host" title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to add</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-beta">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-beta" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities. Beta functionalities
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-file">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="headerlink" href="#cmdoption-file" 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>

<dl class="option">
<dt id="cmdoption-help">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-help" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-inventory">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#cmdoption-inventory" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>
<div class="section" id="inventory-add-tag">
<h2>9.9. INVENTORY ADD-TAG<a class="headerlink" href="#inventory-add-tag" title="Permalink to this headline">¶</a></h2>
<p>Add tag(s) to inventory database.</p>
<dl class="option">
<dt id="id1">
<code class="descname">host</code><code class="descclassname"></code><a class="headerlink" href="#id1" title="Permalink to this definition">¶</a></dt>
<dd><p>list of host(s) for which tags are added</p>
</dd></dl>

<dl class="option">
<dt id="id2">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id2" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities. Beta functionalities
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="id3">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="headerlink" href="#id3" 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>

<dl class="option">
<dt id="id4">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#id4" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>

<dl class="option">
<dt id="cmdoption-tag-file">
<code class="descname">-T</code><code class="descclassname"> TAGFILE</code><code class="descclassname">, </code><code class="descname">--tag-file</code><code class="descclassname"> TAGFILE</code><a class="headerlink" href="#cmdoption-tag-file" 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>

<dl class="option">
<dt id="cmdoption-taglist">
<code class="descname">-t</code><code class="descclassname"> TAGLIST</code><code class="descclassname">, </code><code class="descname">--taglist</code><code class="descclassname"> TAGLIST</code><a class="headerlink" href="#cmdoption-taglist" 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>
<div class="section" id="inventory-del-host">
<h2>9.10. INVENTORY DEL-HOST<a class="headerlink" href="#inventory-del-host" title="Permalink to this headline">¶</a></h2>
<p>Delete host(s) from inventory database.</p>
<dl class="option">
<dt id="id5">
<code class="descname">host</code><code class="descclassname"></code><a class="headerlink" href="#id5" title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to delete</p>
</dd></dl>

<dl class="option">
<dt id="id6">
<code class="descname">-a</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--all</code><code class="descclassname"></code><a class="headerlink" href="#id6" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all hosts</p>
</dd></dl>

<dl class="option">
<dt id="id7">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id7" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities. Beta functionalities
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="id8">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="headerlink" href="#id8" 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>

<dl class="option">
<dt id="id9">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#id9" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>
<div class="section" id="inventory-del-tag">
<h2>9.11. INVENTORY DEL-TAG<a class="headerlink" href="#inventory-del-tag" title="Permalink to this headline">¶</a></h2>
<p>Delete tag(s) from inventory database.</p>
<dl class="option">
<dt id="id10">
<code class="descname">host</code><code class="descclassname"></code><a class="headerlink" href="#id10" title="Permalink to this definition">¶</a></dt>
<dd><p>list of host(s) for which tags are deleted</p>
</dd></dl>

<dl class="option">
<dt id="id11">
<code class="descname">-a</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--all</code><code class="descclassname"></code><a class="headerlink" href="#id11" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all tags for specified host(s)</p>
</dd></dl>

<dl class="option">
<dt id="id12">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id12" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities. Beta functionalities
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="id13">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="headerlink" href="#id13" 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>

<dl class="option">
<dt id="id14">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#id14" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>

<dl class="option">
<dt id="id15">
<code class="descname">-T</code><code class="descclassname"> TAGFILE</code><code class="descclassname">, </code><code class="descname">--tag-file</code><code class="descclassname"> TAGFILE</code><a class="headerlink" href="#id15" 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>

<dl class="option">
<dt id="id16">
<code class="descname">-t</code><code class="descclassname"> TAGLIST</code><code class="descclassname">, </code><code class="descname">--taglist</code><code class="descclassname"> TAGLIST</code><a class="headerlink" href="#id16" 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>
<div class="section" id="inventory-list">
<h2>9.12. INVENTORY LIST<a class="headerlink" href="#inventory-list" title="Permalink to this headline">¶</a></h2>
<p>List inventory database.</p>
<dl class="option">
<dt id="id17">
<code class="descname">host</code><code class="descclassname"></code><a class="headerlink" href="#id17" title="Permalink to this definition">¶</a></dt>
<dd><p>host(s) to list</p>
</dd></dl>

<dl class="option">
<dt id="id18">
<code class="descname">-a</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--all</code><code class="descclassname"></code><a class="headerlink" href="#id18" title="Permalink to this definition">¶</a></dt>
<dd><p>list hosts that have all specified tags, if -t/--tag
is specified</p>
</dd></dl>

<dl class="option">
<dt id="id19">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id19" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities. Beta functionalities
include inventory command with all sub-commands and
all options; config sub-command options: -j/--jobs,
-t/--tag, -a/--all.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="id20">
<code class="descname">-f</code><code class="descclassname"> HOSTFILE</code><code class="descclassname">, </code><code class="descname">--file</code><code class="descclassname"> HOSTFILE</code><a class="headerlink" href="#id20" 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>

<dl class="option">
<dt id="cmdoption-host-only">
<code class="descname">-H</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--host-only</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-host-only" title="Permalink to this definition">¶</a></dt>
<dd><p>Suppress tags listing</p>
</dd></dl>

<dl class="option">
<dt id="id21">
<code class="descname">-I</code><code class="descclassname"> INVENTORY_DIR</code><code class="descclassname">, </code><code class="descname">--inventory</code><code class="descclassname"> INVENTORY_DIR</code><a class="headerlink" href="#id21" title="Permalink to this definition">¶</a></dt>
<dd><p>Use specified custom inventory directory. Inventory
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>

<dl class="option">
<dt id="cmdoption-tag">
<code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--tag</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-tag" 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>
<div class="section" id="preos">
<h2>9.13. PREOS<a class="headerlink" href="#preos" title="Permalink to this headline">¶</a></h2>
<p>Create PreOS. Currently, the following PreOS-es are supported:</p>
<ul class="simple">
<li>debian</li>
<li>ubuntu</li>
<li>devuan</li>
</ul>
</div>
<div class="section" id="preos-debian-devuan">
<h2>9.14. PREOS DEBIAN/DEVUAN<a class="headerlink" href="#preos-debian-devuan" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-arg-target-dir">
<code class="descname">target_dir</code><code class="descclassname"></code><a class="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>

<dl class="option">
<dt id="cmdoption-arch">
<code class="descname">-a</code><code class="descclassname"> ARCH</code><code class="descclassname">, </code><code class="descname">--arch</code><code class="descclassname"> ARCH</code><a class="headerlink" href="#cmdoption-arch" title="Permalink to this definition">¶</a></dt>
<dd><p>target debootstrap architecture, by default 'amd64'</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-bootstrap">
<code class="descname">-B</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--bootstrap</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-bootstrap" title="Permalink to this definition">¶</a></dt>
<dd><p>do bootstrap step</p>
</dd></dl>

<dl class="option">
<dt id="id22">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id22" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-configure">
<code class="descname">-C</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--configure</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-configure" title="Permalink to this definition">¶</a></dt>
<dd><p>do configure step</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-cdist-params">
<code class="descname">-c</code><code class="descclassname"> CDIST_PARAMS</code><code class="descclassname">, </code><code class="descname">--cdist-params</code><code class="descclassname"> CDIST_PARAMS</code><a class="headerlink" href="#cmdoption-cdist-params" 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>

<dl class="option">
<dt id="cmdoption-drive-boot">
<code class="descname">-D</code><code class="descclassname"> DRIVE</code><code class="descclassname">, </code><code class="descname">--drive-boot</code><code class="descclassname"> DRIVE</code><a class="headerlink" href="#cmdoption-drive-boot" title="Permalink to this definition">¶</a></dt>
<dd><p>create bootable PreOS on specified drive</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-debug">
<code class="descname">-d</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-debug" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-e">
<code class="descname">-e</code><code class="descclassname"> REMOTE_EXEC</code><code class="descclassname">, </code><code class="descname">--remote-exec</code><code class="descclassname"> REMOTE_EXEC</code><a class="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>

<dl class="option">
<dt id="id23">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#id23" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-init-manifest">
<code class="descname">-i</code><code class="descclassname"> MANIFEST</code><code class="descclassname">, </code><code class="descname">--init-manifest</code><code class="descclassname"> MANIFEST</code><a class="headerlink" href="#cmdoption-init-manifest" 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>

<dl class="option">
<dt id="cmdoption-k">
<code class="descname">-k</code><code class="descclassname"> KEYFILE</code><code class="descclassname">, </code><code class="descname">--keyfile</code><code class="descclassname"> KEYFILE</code><a class="headerlink" href="#cmdoption-k" title="Permalink to this definition">¶</a></dt>
<dd><p>ssh key files that will be added to cdist config;
'<code class="docutils literal"><span class="pre">__ssh_authorized_keys</span> <span class="pre">root</span> <span class="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-m">
<code class="descname">-m</code><code class="descclassname"> MIRROR</code><code class="descclassname">, </code><code class="descname">--mirror</code><code class="descclassname"> MIRROR</code><a class="headerlink" href="#cmdoption-m" title="Permalink to this definition">¶</a></dt>
<dd><p>use specified mirror for debootstrap</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-root-password">
<code class="descname">-P</code><code class="descclassname"> ROOT_PASSWORD</code><code class="descclassname">, </code><code class="descname">--root-password</code><code class="descclassname"> ROOT_PASSWORD</code><a class="headerlink" href="#cmdoption-root-password" title="Permalink to this definition">¶</a></dt>
<dd><p>Set specified password for root, generated by default</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-pxe-boot-dir">
<code class="descname">-p</code><code class="descclassname"> PXE_BOOT_DIR</code><code class="descclassname">, </code><code class="descname">--pxe-boot-dir</code><code class="descclassname"> PXE_BOOT_DIR</code><a class="headerlink" href="#cmdoption-pxe-boot-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>PXE boot directory</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-r">
<code class="descname">-r</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--rm-bootstrap-dir</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition">¶</a></dt>
<dd><p>remove target directory after finishing</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-script">
<code class="descname">-S</code><code class="descclassname"> SCRIPT</code><code class="descclassname">, </code><code class="descname">--script</code><code class="descclassname"> SCRIPT</code><a class="headerlink" href="#cmdoption-script" title="Permalink to this definition">¶</a></dt>
<dd><p>use specified script for debootstrap</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-suite">
<code class="descname">-s</code><code class="descclassname"> SUITE</code><code class="descclassname">, </code><code class="descname">--suite</code><code class="descclassname"> SUITE</code><a class="headerlink" href="#cmdoption-suite" title="Permalink to this definition">¶</a></dt>
<dd><p>suite used for debootstrap, by default 'stable'</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-trigger-command">
<code class="descname">-t</code><code class="descclassname"> TRIGGER_COMMAND</code><code class="descclassname">, </code><code class="descname">--trigger-command</code><code class="descclassname"> TRIGGER_COMMAND</code><a class="headerlink" href="#cmdoption-trigger-command" title="Permalink to this definition">¶</a></dt>
<dd><p>trigger command that will be added to cdist config;
'<code class="docutils literal"><span class="pre">__cdist_preos_trigger</span> <span class="pre">http</span> <span class="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-verbose">
<code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-y">
<code class="descname">-y</code><code class="descclassname"> REMOTE_COPY</code><code class="descclassname">, </code><code class="descname">--remote-copy</code><code class="descclassname"> REMOTE_COPY</code><a class="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>
<div class="section" id="preos-ubuntu">
<h2>9.15. PREOS UBUNTU<a class="headerlink" href="#preos-ubuntu" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="id24">
<code class="descname">target_dir</code><code class="descclassname"></code><a class="headerlink" href="#id24" title="Permalink to this definition">¶</a></dt>
<dd><p>target directory where PreOS will be bootstrapped</p>
</dd></dl>

<dl class="option">
<dt id="id25">
<code class="descname">-a</code><code class="descclassname"> ARCH</code><code class="descclassname">, </code><code class="descname">--arch</code><code class="descclassname"> ARCH</code><a class="headerlink" href="#id25" title="Permalink to this definition">¶</a></dt>
<dd><p>target debootstrap architecture, by default 'amd64'</p>
</dd></dl>

<dl class="option">
<dt id="id26">
<code class="descname">-B</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--bootstrap</code><code class="descclassname"></code><a class="headerlink" href="#id26" title="Permalink to this definition">¶</a></dt>
<dd><p>do bootstrap step</p>
</dd></dl>

<dl class="option">
<dt id="id27">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id27" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="id28">
<code class="descname">-C</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--configure</code><code class="descclassname"></code><a class="headerlink" href="#id28" title="Permalink to this definition">¶</a></dt>
<dd><p>do configure step</p>
</dd></dl>

<dl class="option">
<dt id="id29">
<code class="descname">-c</code><code class="descclassname"> CDIST_PARAMS</code><code class="descclassname">, </code><code class="descname">--cdist-params</code><code class="descclassname"> CDIST_PARAMS</code><a class="headerlink" href="#id29" 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>

<dl class="option">
<dt id="id30">
<code class="descname">-D</code><code class="descclassname"> DRIVE</code><code class="descclassname">, </code><code class="descname">--drive-boot</code><code class="descclassname"> DRIVE</code><a class="headerlink" href="#id30" title="Permalink to this definition">¶</a></dt>
<dd><p>create bootable PreOS on specified drive</p>
</dd></dl>

<dl class="option">
<dt id="id31">
<code class="descname">-d</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#id31" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>

<dl class="option">
<dt id="id32">
<code class="descname">-e</code><code class="descclassname"> REMOTE_EXEC</code><code class="descclassname">, </code><code class="descname">--remote-exec</code><code class="descclassname"> REMOTE_EXEC</code><a class="headerlink" href="#id32" 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>

<dl class="option">
<dt id="id33">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#id33" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>

<dl class="option">
<dt id="id34">
<code class="descname">-i</code><code class="descclassname"> MANIFEST</code><code class="descclassname">, </code><code class="descname">--init-manifest</code><code class="descclassname"> MANIFEST</code><a class="headerlink" href="#id34" 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>

<dl class="option">
<dt id="cmdoption-keyfile">
<code class="descname">-k</code><code class="descclassname"> KEYFILE</code><code class="descclassname">, </code><code class="descname">--keyfile</code><code class="descclassname"> KEYFILE</code><a class="headerlink" href="#cmdoption-keyfile" title="Permalink to this definition">¶</a></dt>
<dd><p>ssh key files that will be added to cdist config;
'<code class="docutils literal"><span class="pre">__ssh_authorized_keys</span> <span class="pre">root</span> <span class="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-mirror">
<code class="descname">-m</code><code class="descclassname"> MIRROR</code><code class="descclassname">, </code><code class="descname">--mirror</code><code class="descclassname"> MIRROR</code><a class="headerlink" href="#cmdoption-mirror" title="Permalink to this definition">¶</a></dt>
<dd><p>use specified mirror for debootstrap</p>
</dd></dl>

<dl class="option">
<dt id="id35">
<code class="descname">-P</code><code class="descclassname"> ROOT_PASSWORD</code><code class="descclassname">, </code><code class="descname">--root-password</code><code class="descclassname"> ROOT_PASSWORD</code><a class="headerlink" href="#id35" title="Permalink to this definition">¶</a></dt>
<dd><p>Set specified password for root, generated by default</p>
</dd></dl>

<dl class="option">
<dt id="id36">
<code class="descname">-p</code><code class="descclassname"> PXE_BOOT_DIR</code><code class="descclassname">, </code><code class="descname">--pxe-boot-dir</code><code class="descclassname"> PXE_BOOT_DIR</code><a class="headerlink" href="#id36" title="Permalink to this definition">¶</a></dt>
<dd><p>PXE boot directory</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-rm-bootstrap-dir">
<code class="descname">-r</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--rm-bootstrap-dir</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-rm-bootstrap-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>remove target directory after finishing</p>
</dd></dl>

<dl class="option">
<dt id="id37">
<code class="descname">-S</code><code class="descclassname"> SCRIPT</code><code class="descclassname">, </code><code class="descname">--script</code><code class="descclassname"> SCRIPT</code><a class="headerlink" href="#id37" title="Permalink to this definition">¶</a></dt>
<dd><p>use specified script for debootstrap</p>
</dd></dl>

<dl class="option">
<dt id="id38">
<code class="descname">-s</code><code class="descclassname"> SUITE</code><code class="descclassname">, </code><code class="descname">--suite</code><code class="descclassname"> SUITE</code><a class="headerlink" href="#id38" title="Permalink to this definition">¶</a></dt>
<dd><p>suite used for debootstrap, by default 'xenial'</p>
</dd></dl>

<dl class="option">
<dt id="id39">
<code class="descname">-t</code><code class="descclassname"> TRIGGER_COMMAND</code><code class="descclassname">, </code><code class="descname">--trigger-command</code><code class="descclassname"> TRIGGER_COMMAND</code><a class="headerlink" href="#id39" title="Permalink to this definition">¶</a></dt>
<dd><p>trigger command that will be added to cdist config;
'<code class="docutils literal"><span class="pre">__cdist_preos_trigger</span> <span class="pre">http</span> <span class="pre">...</span></code>' type is appended to initial manifest</p>
</dd></dl>

<dl class="option">
<dt id="id40">
<code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#id40" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>

<dl class="option">
<dt id="id41">
<code class="descname">-y</code><code class="descclassname"> REMOTE_COPY</code><code class="descclassname">, </code><code class="descname">--remote-copy</code><code class="descclassname"> REMOTE_COPY</code><a class="headerlink" href="#id41" 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>
<div class="section" id="shell">
<h2>9.16. SHELL<a class="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
&quot;interactive manifest&quot; environment. See below for example
usage. Its primary use is for debugging type parameters.</p>
<dl class="option">
<dt id="cmdoption-shell">
<code class="descname">-s</code><code class="descclassname"> SHELL</code><code class="descclassname">, </code><code class="descname">--shell</code><code class="descclassname"> SHELL</code><a class="headerlink" href="#cmdoption-shell" 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>
<div class="section" id="trigger">
<h2>9.17. TRIGGER<a class="headerlink" href="#trigger" title="Permalink to this headline">¶</a></h2>
<p>Start trigger (simple http server) that waits for connections. When host
connects then it triggers config or install command and then cdist
config/install is executed which configures/installs host.
When triggered cdist will try to reverse DNS lookup for host name and if
host name is dervied then it is used for running cdist config. If no
host name is resolved then IP address is used.
Request path recognizes following requests:</p>
<ul class="simple">
<li><strong>/cdist/config/.*</strong> for config</li>
<li><strong>/cdist/install/.*</strong> for install.</li>
</ul>
<p>This command returns the following response codes to client requests:</p>
<ul class="simple">
<li>200 for success</li>
<li>599 for cdist run errors</li>
<li>500 for cdist/server errors.</li>
</ul>
<dl class="option">
<dt id="cmdoption-6">
<code class="descname">-6</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--ipv6</code><code class="descclassname"></code><a class="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>

<dl class="option">
<dt id="id42">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--beta</code><code class="descclassname"></code><a class="headerlink" href="#id42" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable beta functionalities.</p>
<p>Can also be enabled using CDIST_BETA env var.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-cache-path-pattern">
<code class="descname">-C</code><code class="descclassname"> CACHE_PATH_PATTERN</code><code class="descclassname">, </code><code class="descname">--cache-path-pattern</code><code class="descclassname"> CACHE_PATH_PATTERN</code><a class="headerlink" href="#cmdoption-cache-path-pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>Sepcify custom cache path pattern. It can also be set by
CDIST_CACHE_PATH_PATTERN environment variable. If it is not set then
default hostdir is used. For more info on format see
<strong>CACHE PATH PATTERN FORMAT</strong> below.</p>
</dd></dl>

<dl class="option">
<dt id="id43">
<code class="descname">-c</code><code class="descclassname"> CONF_DIR</code><code class="descclassname">, </code><code class="descname">--conf-dir</code><code class="descclassname"> CONF_DIR</code><a class="headerlink" href="#id43" title="Permalink to this definition">¶</a></dt>
<dd><p>Add configuration directory (can be repeated, last one wins)</p>
</dd></dl>

<dl class="option">
<dt id="id44">
<code class="descname">-d</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#id44" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to debug</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-http-port">
<code class="descname">-H</code><code class="descclassname"> HTTP_PORT</code><code class="descclassname">, </code><code class="descname">--http-port</code><code class="descclassname"> HTTP_PORT</code><a class="headerlink" href="#cmdoption-http-port" title="Permalink to this definition">¶</a></dt>
<dd><p>Create trigger listener via http on specified port</p>
</dd></dl>

<dl class="option">
<dt id="id45">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#id45" title="Permalink to this definition">¶</a></dt>
<dd><p>show this help message and exit</p>
</dd></dl>

<dl class="option">
<dt id="id46">
<code class="descname">-i</code><code class="descclassname"> MANIFEST</code><code class="descclassname">, </code><code class="descname">--initial-manifest</code><code class="descclassname"> MANIFEST</code><a class="headerlink" href="#id46" title="Permalink to this definition">¶</a></dt>
<dd><p>path to a cdist manifest or '-' to read from stdin.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-jobs">
<code class="descname">-j</code><code class="descclassname"> [JOBS]</code><code class="descclassname">, </code><code class="descname">--jobs</code><code class="descclassname"> [JOBS]</code><a class="headerlink" href="#cmdoption-jobs" 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>

<dl class="option">
<dt id="cmdoption-dry-run">
<code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--dry-run</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-dry-run" title="Permalink to this definition">¶</a></dt>
<dd><p>do not execute code</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-out-dir">
<code class="descname">-o</code><code class="descclassname"> OUT_PATH</code><code class="descclassname">, </code><code class="descname">--out-dir</code><code class="descclassname"> OUT_PATH</code><a class="headerlink" href="#cmdoption-out-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>directory to save cdist output in</p>
</dd></dl>

<dl class="option">
<dt id="id47">
<code class="descname">--remote-copy</code><code class="descclassname"> REMOTE_COPY</code><a class="headerlink" href="#id47" title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote copy (should behave like scp)</p>
</dd></dl>

<dl class="option">
<dt id="id48">
<code class="descname">--remote-exec</code><code class="descclassname"> REMOTE_EXEC</code><a class="headerlink" href="#id48" title="Permalink to this definition">¶</a></dt>
<dd><p>Command to use for remote execution (should behave like ssh)</p>
</dd></dl>

<dl class="option">
<dt id="id49">
<code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#id49" title="Permalink to this definition">¶</a></dt>
<dd><p>Set log level to info, be more verbose</p>
</dd></dl>

</div>
<div class="section" id="files">
<h2>9.18. FILES<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2>
<dl class="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>
<div class="section" id="notes">
<h2>9.19. NOTES<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
<p>cdist detects if host is specified by IPv6 address. If so then remote_copy
command is executed with host address enclosed in square brackets
(see <strong>scp</strong>(1)).</p>
</div>
<div class="section" id="examples">
<h2>9.20. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Configure ikq05.ethz.ch with debug enabled</span>
% cdist config -d ikq05.ethz.ch

<span class="c1"># Configure hosts in parallel and use a different configuration directory</span>
% cdist config -c ~/p/cdist-nutzung <span class="se">\</span>
    -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch

<span class="c1"># Use custom remote exec / copy commands</span>
% cdist config --remote-exec /path/to/my/remote/exec <span class="se">\</span>
    --remote-copy /path/to/my/remote/copy <span class="se">\</span>
    -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch

<span class="c1"># Configure hosts read from file loadbalancers</span>
% cdist config -f loadbalancers

<span class="c1"># Configure hosts read from file web.hosts using 16 parallel jobs</span>
<span class="c1"># (beta functionality)</span>
% cdist config -b -j <span class="m">16</span> -f web.hosts

<span class="c1"># Display banner</span>
cdist banner

<span class="c1"># Show help</span>
% cdist --help

<span class="c1"># Show Version</span>
% cdist --version

<span class="c1"># Enter a shell that has access to emulated types</span>
% cdist shell
% __git
usage: __git --source SOURCE <span class="o">[</span>--state STATE<span class="o">]</span> <span class="o">[</span>--branch BRANCH<span class="o">]</span>
             <span class="o">[</span>--group GROUP<span class="o">]</span> <span class="o">[</span>--owner OWNER<span class="o">]</span> <span class="o">[</span>--mode MODE<span class="o">]</span> object_id

<span class="c1"># Install ikq05.ethz.ch with debug enabled</span>
% cdist install -d ikq05.ethz.ch

<span class="c1"># List inventory content</span>
% cdist inventory list -b

<span class="c1"># List inventory for specified host localhost</span>
% cdist inventory list -b localhost

<span class="c1"># List inventory for specified tag loadbalancer</span>
% cdist inventory list -b -t loadbalancer

<span class="c1"># Add hosts to inventory</span>
% cdist inventory add-host -b web1 web2 web3

<span class="c1"># Delete hosts from file old-hosts from inventory</span>
% cdist inventory del-host -b -f old-hosts

<span class="c1"># Add tags to specifed hosts</span>
% cdist inventory add-tag -b -t europe,croatia,web,static web1 web2

<span class="c1"># Add tag to all hosts in inventory</span>
% cdist inventory add-tag -b -t vm

<span class="c1"># Delete all tags from specified host</span>
% cdist inventory del-tag -b -a localhost

<span class="c1"># Delete tags read from stdin from hosts specified by file hosts</span>
% cdist inventory del-tag -b -T - -f hosts

<span class="c1"># Configure hosts from inventory with any of specified tags</span>
% cdist config -b -t web dynamic

<span class="c1"># Configure hosts from inventory with all specified tags</span>
% cdist config -b -t -a web dynamic

<span class="c1"># Configure all hosts from inventory db</span>
$ cdist config -b -A

<span class="c1"># Create default debian PreOS in debug mode with config</span>
<span class="c1"># trigger command</span>
$ cdist preos debian /preos/preos-debian -b -d -C <span class="se">\</span>
    -k ~/.ssh/id_rsa.pub -p /preos/pxe-debian <span class="se">\</span>
    -t <span class="s2">&quot;/usr/bin/curl 192.168.111.5:3000/config/&quot;</span>

<span class="c1"># Create ubuntu PreOS with install trigger command</span>
$ cdist preos ubuntu /preos/preos-ubuntu -b -C <span class="se">\</span>
    -k ~/.ssh/id_rsa.pub -p /preos/pxe-ubuntu <span class="se">\</span>
    -t <span class="s2">&quot;/usr/bin/curl 192.168.111.5:3000/install/&quot;</span>

<span class="c1"># Create ubuntu PreOS on drive /dev/sdb with install trigger command</span>
<span class="c1"># and set root password to &#39;password&#39;.</span>
$ cdist preos ubuntu /mnt -b -B -C <span class="se">\</span>
    -k ~/.ssh/id_rsa.pub -D /dev/sdb <span class="se">\</span>
    -t <span class="s2">&quot;/usr/bin/curl 192.168.111.5:3000/install/&quot;</span> <span class="se">\</span>
    -P password

<span class="c1"># Start trigger in verbose mode that will configure host using specified</span>
<span class="c1"># init manifest</span>
% cdist trigger -b -v -i ~/.cdist/manifest/init-for-triggered
</pre></div>
</div>
</div>
<div class="section" id="environment">
<h2>9.21. ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>TMPDIR, TEMP, TMP</dt>
<dd>Setup the base directory for the temporary directory.
See <a class="reference external" href="http://docs.python.org/py3k/library/tempfile.html">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>CDIST_PATH</dt>
<dd>Colon delimited list of config directories.</dd>
<dt>CDIST_LOCAL_SHELL</dt>
<dd>Selects shell for local script execution, defaults to /bin/sh.</dd>
<dt>CDIST_REMOTE_SHELL</dt>
<dd>Selects shell for remote script execution, defaults to /bin/sh.</dd>
<dt>CDIST_OVERRIDE</dt>
<dd>Allow overwriting type parameters.</dd>
<dt>CDIST_ORDER_DEPENDENCY</dt>
<dd>Create dependencies based on the execution order.</dd>
<dt>CDIST_REMOTE_EXEC</dt>
<dd>Use this command for remote execution (should behave like ssh).</dd>
<dt>CDIST_REMOTE_COPY</dt>
<dd>Use this command for remote copy (should behave like scp).</dd>
<dt>CDIST_INVENTORY_DIR</dt>
<dd>Use this directory as inventory directory.</dd>
<dt>CDIST_BETA</dt>
<dd>Enable beta functionalities.</dd>
<dt>CDIST_CACHE_PATH_PATTERN</dt>
<dd>Custom cache path pattern.</dd>
</dl>
</div>
<div class="section" id="exit-status">
<h2>9.22. EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2>
<p>The following exit values shall be returned:</p>
<p>0   Successful completion.</p>
<p>1   One or more host configurations failed.</p>
</div>
<div class="section" id="authors">
<h2>9.23. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
<p>Originally written by Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;
and Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;.</p>
</div>
<div class="section" id="caveats">
<h2>9.24. CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline">¶</a></h2>
<p>When operating in parallel, either by operating in parallel for each host
(-p/--parallel) or by parallel jobs within a host (-j/--jobs), and depending
on target SSH server and its configuration you may encounter connection drops.
This is controlled with sshd <strong>MaxStartups</strong> configuration options.
You may also encounter session open refusal. This happens with ssh multiplexing
when you reach maximum number of open sessions permitted per network
connection. In this case ssh will disable multiplexing.
This limit is controlled with sshd <strong>MaxSessions</strong> configuration
options. For more details refer to <strong>sshd_config</strong>(5).</p>
<p>When requirements for the same object are defined in different manifests (see
example below), for example, in init manifest and in some other type manifest
and those requirements differ then dependency resolver cannot detect
dependencies right. This happens because cdist cannot prepare all objects first
and run all objects afterwards. Some object can depend on the result of type
explorer(s) and explorers are executed during object run. cdist will detect
such case and write warning message. Example for such a case:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>init manifest:
    __a a
    <span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__e/e&quot;</span> __b b
    <span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__f/f&quot;</span> __c c
    __e e
    __f f
    <span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__c/c&quot;</span> __d d
    __g g
    __h h

<span class="nb">type</span> __g manifest:
    <span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__c/c __d/d&quot;</span> __a a

Warning message:
    WARNING: cdisttesthost: Object __a/a already exists with requirements:
    /usr/home/darko/ungleich/cdist/cdist/test/config/fixtures/manifest/init-deps-resolver /tmp/tmp.cdist.test.ozagkg54/local/759547ff4356de6e3d9e08522b0d0807/data/conf/type/__g/manifest: set<span class="o">()</span>
    /tmp/tmp.cdist.test.ozagkg54/local/759547ff4356de6e3d9e08522b0d0807/data/conf/type/__g/manifest: <span class="o">{</span><span class="s1">&#39;__c/c&#39;</span>, <span class="s1">&#39;__d/d&#39;</span><span class="o">}</span>
    Dependency resolver could not handle dependencies as expected.
</pre></div>
</div>
</div>
<div class="section" id="copying">
<h2>9.25. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline">¶</a></h2>
<p>Copyright (C) 2011-2017 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).</p>
</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../cdist-bootstrap.html" class="btn btn-neutral float-right" title="10. Bootstrap" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="../cdist-quickstart.html" class="btn btn-neutral" title="8. Quickstart" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright .

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'4.4.4-251-g664bce08',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>

  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>