summaryrefslogtreecommitdiff
path: root/distro/common/html/_sources/knife_user.txt
blob: ea1b05505667ce21386df3c7a4eef5e522e94cda (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
=====================================================
knife user 
=====================================================

.. include:: ../../includes_knife/includes_knife_user.rst

.. note:: This subcommand ONLY works when run against the open source |chef server| and will not run against |chef server oec| (including hosted |chef server oec|), or |chef private|.

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

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

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

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

knife.rb Settings
+++++++++++++++++++++++++++++++++++++++++++++++++++++
.. note:: See :doc:`knife.rb </config_rb_knife>` for more information about how to add optional settings to the |knife rb| file.

.. include:: ../../includes_knife/includes_knife_user_create_settings.rst

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

**Create a user**

.. include:: ../../step_knife/step_knife_user_create.rst

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

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

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

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

**Delete a user**

.. include:: ../../step_knife/step_knife_user_delete.rst

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

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

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

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


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

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

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

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

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

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

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

knife.rb Settings
+++++++++++++++++++++++++++++++++++++++++++++++++++++
.. note:: See :doc:`knife.rb </config_rb_knife>` for more information about how to add optional settings to the |knife rb| file.

.. include:: ../../includes_knife/includes_knife_user_reregister_settings.rst

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

**Regenerate the RSA key-pair**

.. include:: ../../step_knife/step_knife_user_reregister.rst

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

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

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

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

**Show user data**

.. include:: ../../step_knife/step_knife_user_show.rst

**Show user data as JSON**

.. include:: ../../step_knife/step_knife_user_show_json.rst