<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>knife-role(1) - Group common configuration settings</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
<style type='text/css' media='all'>
/* style: toc */
.man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
.man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
.man-navigation a:hover {color:#111;text-decoration:underline}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#ROLE-SUB-COMMANDS">ROLE SUB-COMMANDS</a>
<a href="#LIST">LIST</a>
<a href="#SHOW">SHOW</a>
<a href="#CREATE">CREATE</a>
<a href="#EDIT">EDIT</a>
<a href="#FROM-FILE">FROM FILE</a>
<a href="#DELETE">DELETE</a>
<a href="#BULK-DELETE">BULK DELETE</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#SEE-ALSO">SEE ALSO</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#DOCUMENTATION">DOCUMENTATION</a>
<a href="#CHEF">CHEF</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>knife-role(1)</li>
<li class='tc'>Chef Manual</li>
<li class='tr'>knife-role(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>knife-role</code> - <span class="man-whatis">Group common configuration settings</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><strong>knife</strong> <strong>role</strong> <em>sub-command</em> <em>(options)</em></p>
<h2 id="ROLE-SUB-COMMANDS">ROLE SUB-COMMANDS</h2>
<p>The following <code>role</code> subcommands are available:</p>
<h2 id="LIST">LIST</h2>
<p><strong>knife role list</strong> <em>(options)</em></p>
<dl>
<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd>
</dl>
<p>List roles.</p>
<h2 id="SHOW">SHOW</h2>
<p><strong>knife role show ROLE</strong> <em>(options)</em></p>
<dl>
<dt><code>-a</code>, <code>--attribute ATTR</code></dt><dd>Show only one attribute</dd>
</dl>
<p>Show a specific role.</p>
<h2 id="CREATE">CREATE</h2>
<p><strong>knife role create ROLE</strong> <em>(options)</em></p>
<dl>
<dt><code>-d</code>, <code>--description</code></dt><dd>The role description</dd>
</dl>
<p>Create a new role.</p>
<h2 id="EDIT">EDIT</h2>
<p><strong>knife role edit ROLE</strong> <em>(options)</em></p>
<p>Edit a role.</p>
<h2 id="FROM-FILE">FROM FILE</h2>
<p><strong>knife role from file FILE</strong> <em>(options)</em></p>
<p>Create or update a role from a role Ruby DSL (<code>.rb</code>) or JSON file.</p>
<h2 id="DELETE">DELETE</h2>
<p><strong>knife role delete ROLE</strong> <em>(options)</em></p>
<p>Delete a role.</p>
<h2 id="BULK-DELETE">BULK DELETE</h2>
<p><strong>knife role bulk delete REGEX</strong> <em>(options)</em></p>
<p>Delete roles on the Chef Server based on a regular expression. The regular expression (<em>REGEX</em>) should be in quotes, not in //'s.</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Roles provide a mechanism to group repeated configuration settings.
Roles are data structures that contain <strong>default_attributes</strong>, and
<strong>override_attributes</strong>, which are nested hashes of configuration
settings, and a <strong>run_list</strong>, which is an ordered list of recipes and
roles that should be applied to a host by chef-client.</p>
<p><strong>default_attributes</strong> will be overridden if they conflict with a value
on a node that includes the role. Conversely, <strong>override_attributes</strong>
will override any values set on nodes that apply them.</p>
<p>When <strong>chef-client</strong>(8) configures a host, it will "expand" the
<strong>run_list</strong> included in that host's node data. The expansion process
will recursively replace any roles in the run_list with that role's
run_list.</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p> <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-environment<span class="s">(1)</span></span></strong>
<a href="http://wiki.opscode.com/display/chef/Roles" data-bare-link="true">http://wiki.opscode.com/display/chef/Roles</a>
<a href="http://wiki.opscode.com/display/chef/Attributes" data-bare-link="true">http://wiki.opscode.com/display/chef/Attributes</a></p>
<h2 id="AUTHOR">AUTHOR</h2>
<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p>
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
<h2 id="CHEF">CHEF</h2>
<p> Knife is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'>Chef 11.10.0.rc.0</li>
<li class='tc'>January 2014</li>
<li class='tr'>knife-role(1)</li>
</ol>
</div>
</body>
</html>