summaryrefslogtreecommitdiff
path: root/distro/common/html/_sources/knife_role.txt
blob: edd218ddc63bd9e06c3a40adaa4687801b83c42a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
=====================================================
knife role 
=====================================================

.. include:: ../../includes_role/includes_role.rst

.. include:: ../../includes_knife/includes_knife_role.rst

.. note:: To add a role to a node and then build out the run-list for that node, use the :doc:`knife node </knife_node>` sub-command and its ``run_list add`` argument.

.. note:: Review the list of :doc:`common options </knife_common_options>` available to this (and all) |knife| subcommands and plugins.

bulk delete
=====================================================
.. include:: ../../includes_knife/includes_knife_role_bulk_delete.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_bulk_delete_syntax.rst

Options
-----------------------------------------------------
|no_options|

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Bulk delete roles**

.. include:: ../../step_knife/step_knife_role_bulk_delete.rst

create
=====================================================
.. include:: ../../includes_knife/includes_knife_role_create.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_create_syntax.rst

Options
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_create_options.rst

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Create a role**

.. include:: ../../step_knife/step_knife_role_create.rst

delete
=====================================================
.. include:: ../../includes_knife/includes_knife_role_delete.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_delete_syntax.rst

Options
-----------------------------------------------------
|no_options|

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Delete a role**

.. include:: ../../step_knife/step_knife_role_delete.rst

edit
=====================================================
.. include:: ../../includes_knife/includes_knife_role_edit.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_edit_syntax.rst

Options
-----------------------------------------------------
|no_options|

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Edit a role**

.. include:: ../../step_knife/step_knife_role_edit.rst

from file
=====================================================
.. include:: ../../includes_knife/includes_knife_role_from_file.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_from_file_syntax.rst

Options
-----------------------------------------------------
|no_options|

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Create a role using JSON data**

.. include:: ../../step_knife/step_knife_role_from_file.rst

list
=====================================================
.. include:: ../../includes_knife/includes_knife_role_list.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_list_syntax.rst

Options
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_list_options.rst

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**View a list of roles**

.. include:: ../../step_knife/step_knife_role_list.rst

show
=====================================================
.. include:: ../../includes_knife/includes_knife_role_show.rst

Syntax
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_show_syntax.rst

Options
-----------------------------------------------------
.. include:: ../../includes_knife/includes_knife_role_show_options.rst

Examples
-----------------------------------------------------
The following examples show how to use this |knife| subcommand:

**Show as JSON data**

.. include:: ../../step_knife/step_knife_common_view_json.rst

**Show as raw JSON data**

.. include:: ../../step_knife/step_knife_common_view_json_raw.rst