diff options
Diffstat (limited to 'distro/common/html/knife_raw.html')
| -rw-r--r-- | distro/common/html/knife_raw.html | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/distro/common/html/knife_raw.html b/distro/common/html/knife_raw.html new file mode 100644 index 0000000000..bbe3cbca97 --- /dev/null +++ b/distro/common/html/knife_raw.html @@ -0,0 +1,229 @@ + + +<!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 raw — Knife Man Pages</title> + + <link rel="stylesheet" href="_static/chef.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> + <link rel="shortcut icon" href="_static/chef.ico"/> + <link rel="top" title="Knife Man Pages" href="index.html" /> + </head> + <body> +<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> +<a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> +</div> + + <div class="related"> + <h3>Navigation</h3> + <ul> + <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> + <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> + <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> + <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> + <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> + <li><a href="http://docs.opscode.com/">Home</a> »</li> + + </ul> + </div> + + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="knife.html"> + <img class="logo" src="_static/chef_logo.png" alt="Logo"/> + </a></p> + <h3><a href="knife.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">knife raw</a><ul> +<li><a class="reference internal" href="#syntax">Syntax</a></li> +<li><a class="reference internal" href="#options">Options</a><ul> +<li><a class="reference internal" href="#knife-rb-settings">knife.rb Settings</a></li> +</ul> +</li> +<li><a class="reference internal" href="#examples">Examples</a></li> +</ul> +</li> +</ul> + + </div> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="knife-raw"> +<h1>knife raw<a class="headerlink" href="#knife-raw" title="Permalink to this headline">¶</a></h1> +<p>The <strong>knife raw</strong> subcommand is used to send a REST request to a specified path using the Chef Server API.</p> +<div class="section" id="syntax"> +<h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> +<p>This argument has the following syntax:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife raw REQUEST_PATH <span class="o">(</span>options<span class="o">)</span> +</pre></div> +</div> +</div> +<div class="section" id="options"> +<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> +<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> +<p>This subcommand has the following options:</p> +<dl class="docutils"> +<dt><tt class="docutils literal"><span class="pre">-i</span> <span class="pre">FILE</span></tt>, <tt class="docutils literal"><span class="pre">--input</span> <span class="pre">FILE</span></tt></dt> +<dd>The name of a file to be used with the <tt class="docutils literal"><span class="pre">PUT</span></tt> or a <tt class="docutils literal"><span class="pre">POST</span></tt> request.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]pretty</span></tt></dt> +<dd>Use <tt class="docutils literal"><span class="pre">--no-pretty</span></tt> to disable pretty-print output for JSON. Default: <tt class="docutils literal"><span class="pre">--pretty</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">-m</span> <span class="pre">METHOD</span></tt>, <tt class="docutils literal"><span class="pre">--method</span> <span class="pre">METHOD</span></tt></dt> +<dd>The request method: <tt class="docutils literal"><span class="pre">DELETE</span></tt>, <tt class="docutils literal"><span class="pre">GET</span></tt>, <tt class="docutils literal"><span class="pre">POST</span></tt>, or <tt class="docutils literal"><span class="pre">PUT</span></tt>. Default value: <tt class="docutils literal"><span class="pre">GET</span></tt>.</dd> +</dl> +<div class="section" id="knife-rb-settings"> +<h3>knife.rb Settings<a class="headerlink" href="#knife-rb-settings" title="Permalink to this headline">¶</a></h3> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> +</div> +<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">raw</span></tt> settings can be added to the knife.rb file:</p> +<dl class="docutils"> +<dt><tt class="docutils literal"><span class="pre">knife[:chef_repo_path]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--chef-repo-path</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:concurrency]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--concurrency</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:input]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--input</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:method]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--method</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:pretty]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--[no-]pretty</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:repo_mode]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--repo-mode</span></tt> option.</dd> +</dl> +</div> +</div> +<div class="section" id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<p>The following examples show how to use this Knife subcommand:</p> +<p><strong>View a client</strong></p> +<p>To view information about a client:</p> +<div class="highlight-bash"><div class="highlight"><pre>knife raw /clients/<client_name> +</pre></div> +</div> +<p><strong>View a node</strong></p> +<p>To view information about a node:</p> +<div class="highlight-bash"><div class="highlight"><pre>knife raw /nodes/<node_name> +</pre></div> +</div> +<p><strong>Delete a data bag</strong></p> +<p>To delete a data bag, enter a command similar to:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife raw -m DELETE /data/foo +</pre></div> +</div> +<p>to return something similar to:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="o">{</span> + <span class="s2">"name"</span>:<span class="s2">"foo"</span>, + <span class="s2">"json_class"</span>:<span class="s2">"Chef::DataBag"</span>, + <span class="s2">"chef_type"</span>:<span class="s2">"data_bag"</span> +<span class="o">}</span> +</pre></div> +</div> +</div> +</div> + + + </div> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> + <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> + <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> + <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> + <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> + <li><a href="http://docs.opscode.com/">Home</a> »</li> + + </ul> + </div> + + + <div class="footer"> + Documentation for current man pages for Knife. + + Send feedback to <a href="mailto:docs@getchef.com">docs@getchef.com</a>. + This work is licensed under a Creative Commons Attribution 3.0 Unported License. + + </div> + +<!-- Start of Async Google Analytics Code --> +<script type="text/javascript"> +var _gaq = _gaq || []; +var pluginUrl = (('https:' == document.location.protocol) ? 'https://ssl.' : 'http://www.') + 'google-analytics.com/plugins/ga/inpage_linkid.js'; +_gaq.push(['_setAccount', 'UA-6369228-7']); +_gaq.push(['_setDomainName', '.opscode.com']); +_gaq.push(['_setAllowHash', false]); +_gaq.push(['_setAllowLinker', true]); +_gaq.push(['_addIgnoredRef','opscode.com']); +_gaq.push(['_trackPageview']); + +(function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; + ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(ga, s); })(); +</script> +<!-- End of Async Google Analytics Code --> + + + +<!-- Start of Contact Analytics Code --> +<script type="text/javascript"> +(function() { + var didInit = false; + function initMunchkin() { + if(didInit === false) { + didInit = true; + Munchkin.init('255-VFB-268'); + } + } + var s = document.createElement('script'); + s.type = 'text/javascript'; + s.async = true; + s.src = document.location.protocol + '//munchkin.marketo.net/munchkin.js'; + s.onreadystatechange = function() { + if (this.readyState == 'complete' || this.readyState == 'loaded') { + initMunchkin(); + } + }; + s.onload = initMunchkin; + document.getElementsByTagName('head')[0].appendChild(s); +})(); +</script> +<!-- End of Contact Analytics Code --> + + + </body> +</html>
\ No newline at end of file |