summaryrefslogtreecommitdiff
path: root/distro/common/html/_sources/knife_client.txt
blob: d9d6ba62a11d2ecb435e8cfea18ab35a4c327149 (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
=====================================================
knife client 
=====================================================

.. include:: ../../includes_knife/includes_knife_client.rst

.. 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_client_bulk_delete.rst

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

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

Examples
-----------------------------------------------------
None.

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

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

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

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

**Create an admin client**

.. include:: ../../step_knife/step_knife_client_create_admin.rst

**Create an admin client for Enterprise Chef**

.. include:: ../../step_knife/step_knife_client_create_hosted_and_private.rst

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

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

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

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

**Delete a client**

.. include:: ../../step_knife/step_knife_client_delete.rst

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

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

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

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

**Edit a client**

.. include:: ../../step_knife/step_knife_client_edit.rst

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

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

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

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

**View a list of clients**

.. include:: ../../step_knife/step_knife_client_list_all.rst

.. include:: ../../step_knife/step_knife_client_list_authenticate.rst

reregister
=====================================================
.. include:: ../../includes_knife/includes_knife_client_reregister.rst

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

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

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

**Reregister clients**

.. include:: ../../step_knife/step_knife_client_reregister.rst

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

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

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

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

**Show clients**

.. include:: ../../step_knife/step_knife_client_show.rst

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