diff options
Diffstat (limited to 'distro/common/html/knife_user.html')
| -rw-r--r-- | distro/common/html/knife_user.html | 242 |
1 files changed, 0 insertions, 242 deletions
diff --git a/distro/common/html/knife_user.html b/distro/common/html/knife_user.html deleted file mode 100644 index b49ddd585d..0000000000 --- a/distro/common/html/knife_user.html +++ /dev/null @@ -1,242 +0,0 @@ -<!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>knife user — chef-client Man Pages</title> - - <link rel="stylesheet" href="_static/guide.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: './', - VERSION: '', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </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> - - - </head> - <body> -<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> -<a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> -</div> - - - - - <div class="document"> - <div class="documentwrapper"> - - <div class="body"> - - <div class="section" id="knife-user"> -<h1>knife user<a class="headerlink" href="#knife-user" title="Permalink to this headline">¶</a></h1> -<p>The <strong>knife user</strong> subcommand is used to manage the list of users and their associated RSA public key-pairs.</p> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This subcommand ONLY works when run against the open source Chef server and will not run against Enterprise Chef (including hosted Enterprise Chef), or Private Chef.</p> -</div> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p> -</div> -<div class="section" id="create"> -<h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the Chef server and the private key will be displayed on <tt class="docutils literal"><span class="pre">STDOUT</span></tt> or written to a named file.</p> -<ul class="simple"> -<li>For the user, the private key should be copied to the system as <tt class="docutils literal"><span class="pre">/etc/chef/client.pem</span></tt>.</li> -<li>For knife, the private key is typically copied to <tt class="docutils literal"><span class="pre">~/.chef/client_name.pem</span></tt> and referenced in the knife.rb configuration file.</li> -</ul> -<div class="section" id="syntax"> -<h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user create USER_NAME <span class="o">(</span>options<span class="o">)</span> -</pre></div> -</div> -</div> -<div class="section" id="options"> -<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--admin</span></tt></dt> -<dd>Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef.</dd> -<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--file</span> <span class="pre">FILE_NAME</span></tt></dt> -<dd>Use to save a private key to the specified file name.</dd> -<dt><tt class="docutils literal"><span class="pre">-p</span> <span class="pre">PASSWORD</span></tt>, <tt class="docutils literal"><span class="pre">--password</span> <span class="pre">PASSWORD</span></tt></dt> -<dd>The user password.</dd> -<dt><tt class="docutils literal"><span class="pre">--user-key</span> <span class="pre">FILE_NAME</span></tt></dt> -<dd>All users are assigned a public key. Use to write the public key to a file.</dd> -</dl> -</div> -<div class="section" id="examples"> -<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Create a user</strong></p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user create <span class="s2">"Radio Birdman"</span> -f /keys/user_name -</pre></div> -</div> -</div> -</div> -<div class="section" id="delete"> -<h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a registered user.</p> -<div class="section" id="id1"> -<h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user delete USER_NAME -</pre></div> -</div> -</div> -<div class="section" id="id2"> -<h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="id3"> -<h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Delete a user</strong></p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user delete <span class="s2">"Steve Danno"</span> -</pre></div> -</div> -</div> -</div> -<div class="section" id="edit"> -<h2>edit<a class="headerlink" href="#edit" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">edit</span></tt> argument is used to edit the details of a user. When this argument is run, knife will open $EDITOR. When finished, knife will update the Chef server with those changes.</p> -<div class="section" id="id4"> -<h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user edit USER_NAME -</pre></div> -</div> -</div> -<div class="section" id="id5"> -<h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="id6"> -<h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> -<p>None.</p> -</div> -</div> -<div class="section" id="list"> -<h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of registered users.</p> -<div class="section" id="id7"> -<h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user list <span class="o">(</span>options<span class="o">)</span> -</pre></div> -</div> -</div> -<div class="section" id="id8"> -<h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt> -<dd>Use to show the corresponding URIs.</dd> -</dl> -</div> -<div class="section" id="id9"> -<h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> -<p>None.</p> -</div> -</div> -<div class="section" id="reregister"> -<h2>reregister<a class="headerlink" href="#reregister" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">reregister</span></tt> argument is used to regenerate an RSA key pair for a user. The public key will be stored on the Chef server and the private key will be displayed on <tt class="docutils literal"><span class="pre">STDOUT</span></tt> or written to a named file.</p> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server.</p> -</div> -<div class="section" id="id10"> -<h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user reregister USER_NAME <span class="o">(</span>options<span class="o">)</span> -</pre></div> -</div> -</div> -<div class="section" id="id11"> -<h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--file</span> <span class="pre">FILE_NAME</span></tt></dt> -<dd>Use to save a private key to the specified file name.</dd> -</dl> -</div> -<div class="section" id="id12"> -<h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Regenerate the RSA key-pair</strong></p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user reregister <span class="s2">"Robert Younger"</span> -</pre></div> -</div> -</div> -</div> -<div class="section" id="show"> -<h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to show the details of a user.</p> -<div class="section" id="id13"> -<h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user show USER_NAME <span class="o">(</span>options<span class="o">)</span> -</pre></div> -</div> -</div> -<div class="section" id="id14"> -<h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ATTR</span></tt>, <tt class="docutils literal"><span class="pre">--attribute</span> <span class="pre">ATTR</span></tt></dt> -<dd>The attribute (or attributes) to show.</dd> -</dl> -</div> -<div class="section" id="id15"> -<h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Show user data</strong></p> -<p>To view a user named <tt class="docutils literal"><span class="pre">Dennis</span> <span class="pre">Teck</span></tt>, enter:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user show <span class="s2">"Dennis Teck"</span> -</pre></div> -</div> -<p>to return something like:</p> -<div class="highlight-bash"><div class="highlight"><pre>chef_type: user -json_class: Chef::User -name: Dennis Teck -public_key: -</pre></div> -</div> -<p><strong>Show user data as JSON</strong></p> -<p>To view information in JSON format, use the <tt class="docutils literal"><span class="pre">-F</span></tt> common option as part of the command like this:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife user show <span class="s2">"Dennis Teck"</span> -F json -</pre></div> -</div> -<p>(Other formats available include <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>, e.g. <tt class="docutils literal"><span class="pre">-F</span> <span class="pre">yaml</span></tt> for YAML.)</p> -</div> -</div> -</div> - - - </div> - - </div> - - - <div class="clearer"></div> - </div> - - - - - </body> -</html>
\ No newline at end of file |