79 lines
		
	
	
	
		
			6.3 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
		
		
			
		
	
	
			79 lines
		
	
	
	
		
			6.3 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
								 | 
							
								<?xml version="1.0" encoding="UTF-8"?>
							 | 
						|||
| 
								 | 
							
								<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
							 | 
						|||
| 
								 | 
							
								<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist(1)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.77.0" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp26306064"></a>cdist(1)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_synopsis">2. SYNOPSIS</a></span></dt><dt><span class="section"><a href="#_description">3. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_banner">4. BANNER</a></span></dt><dt><span class="section"><a href="#_config">5. CONFIG</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_environment">7. ENVIRONMENT</a></span></dt><dt><span class="section"><a href="#_exit_status">8. EXIT STATUS</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist - Configuration management</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_synopsis"></a>2. SYNOPSIS</h2></div></div></div><p>cdist [-h] [-V]</p><p>cdist banner</p><p>cdist config [-h] [-d] [-V] [-c CDIST_HOME] [-i MANIFEST] [-p] [-s] host [host …]</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>3. DESCRIPTION</h2></div></div></div><p>cdist is the frontend executable to the cdist configuration management.
							 | 
						|||
| 
								 | 
							
								cdist supports different as explained below. The options to the main
							 | 
						|||
| 
								 | 
							
								program are:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-h, --help
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								   Show the help screen
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-V, --version
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								   Show version and exit
							 | 
						|||
| 
								 | 
							
								</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_banner"></a>4. BANNER</h2></div></div></div><p>Displays the cdist banner.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_config"></a>5. CONFIG</h2></div></div></div><p>Configure a system</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-h, --help
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Show the help screen
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-c CDIST_HOME, --cdist-home CDIST_HOME
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Instead of using the parent of the bin directory as cdist home,
							 | 
						|||
| 
								 | 
							
								    use the specified directory
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-d, --debug
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Enable debug output
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-i MANIFEST, --initial-manifest MANIFEST
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Path to a cdist manifest or - to read from stdin
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-p, --parallel
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Operate on multiple hosts in parallel
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								-s, --sequential
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Operate on multiple hosts sequentially
							 | 
						|||
| 
								 | 
							
								</dd></dl></div><p>--remote-copy REMOTE_COPY:
							 | 
						|||
| 
								 | 
							
								    Command to use for remote copy (should behave like scp)</p><p>--remote-exec REMOTE_EXEC:
							 | 
						|||
| 
								 | 
							
								    Command to use for remote execution (should behave like ssh)</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># Configure ikq05.ethz.ch with debug enabled
							 | 
						|||
| 
								 | 
							
								cdist config -d ikq05.ethz.ch
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								# Configure hosts in parallel and use a different home directory
							 | 
						|||
| 
								 | 
							
								cdist config -c ~/p/cdist-nutzung \
							 | 
						|||
| 
								 | 
							
								    -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								# Use custom remote exec / copy commands
							 | 
						|||
| 
								 | 
							
								cdist config --remote-exec /path/to/my/remote/exec \
							 | 
						|||
| 
								 | 
							
								    --remote-copy /path/to/my/remote/copy \
							 | 
						|||
| 
								 | 
							
								    -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								# Display banner
							 | 
						|||
| 
								 | 
							
								cdist banner
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								# Show help
							 | 
						|||
| 
								 | 
							
								cdist --help
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								# Show Version
							 | 
						|||
| 
								 | 
							
								cdist --version</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment"></a>7. ENVIRONMENT</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								TMPDIR, TEMP, TMP
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								   Setup the base directory for the temporary directory.
							 | 
						|||
| 
								 | 
							
								   See <a class="ulink" href="http://docs.python.org/py3k/library/tempfile.html" target="_top">http://docs.python.org/py3k/library/tempfile.html</a> for
							 | 
						|||
| 
								 | 
							
								   more information. This is rather useful, if the standard
							 | 
						|||
| 
								 | 
							
								   directory used does not allow executables.
							 | 
						|||
| 
								 | 
							
								</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_exit_status"></a>8. EXIT STATUS</h2></div></div></div><p>The following exit values shall be returned:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								0
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    Successful completion
							 | 
						|||
| 
								 | 
							
								</dd><dt><span class="term">
							 | 
						|||
| 
								 | 
							
								1
							 | 
						|||
| 
								 | 
							
								</span></dt><dd>
							 | 
						|||
| 
								 | 
							
								    One or more host configurations failed
							 | 
						|||
| 
								 | 
							
								</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>9. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
							 | 
						|||
| 
								 | 
							
								cdist(7)
							 | 
						|||
| 
								 | 
							
								</li><li class="listitem">
							 | 
						|||
| 
								 | 
							
								cdist-reference(7)
							 | 
						|||
| 
								 | 
							
								</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>10. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
							 | 
						|||
| 
								 | 
							
								granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
							 |