Users
The following tasks are available for user management in Chef Infra Server:
- Creating users
- Editing a user’s profile
- Changing a password
- Recovering a password
- Regenerating a private key
- Viewing a user’s profile
chef-server-ctl
The Chef Infra Server includes a command-line utility named chef-server-ctl. This command-line tool is used to start and stop individual services, reconfigure the Chef Infra Server, run chef-pedant, and then tail Chef Infra Server log files.
Use the user-create
, user-delete
, user-edit
, user-list
and
user-show
subcommands to manage users.
org-create
The org-create
subcommand is used to create an organization. (The
validation key for the organization is returned to STDOUT
when
creating an organization with this command.)
Syntax
This subcommand has the following syntax:
chef-server-ctl org-create ORG_NAME "ORG_FULL_NAME" (options)
where:
- The name must begin with a lower-case letter or digit, may only
contain lower-case letters, digits, hyphens, and underscores, and
must be between 1 and 255 characters. For example:
chef
. - The full name must begin with a non-white space character and must
be between 1 and 1023 characters. For example:
"Chef Software, Inc."
.
Options
This subcommand has the following options:
-a USER_NAME
,--association_user USER_NAME
Associate a user with an organization and add them to the
admins
andbilling_admins
security groups.-f FILE_NAME
,--filename FILE_NAME
Write the ORGANIZATION-validator.pem to
FILE_NAME
instead of printing it toSTDOUT
.
org-delete
The org-delete
subcommand is used to delete an organization.
Syntax
This subcommand has the following syntax:
chef-server-ctl org-delete ORG_NAME
org-list
The org-list
subcommand is used to list all of the organizations
currently present on the Chef Infra Server.
Syntax
This subcommand has the following syntax:
chef-server-ctl org-list (options)
Options
This subcommand has the following options:
-a
,--all-orgs
Show all organizations.
-w
,--with-uri
Show the corresponding URIs.
org-show
The org-show
subcommand is used to show the details for an
organization.
Syntax
This subcommand has the following syntax:
chef-server-ctl org-show ORG_NAME
org-user-add
Warning
org-associate
. This is the same command, with the exception of the
--admin
flag, which is added to the command (along with the rename)
for the upcoming final release of Chef Server 12.The org-user-add
subcommand is used to add a user to an organization.
Syntax
This subcommand has the following syntax:
chef-server-ctl org-user-add ORG_NAME USER_NAME (options)
Options
This subcommand has the following options:
--admin
Add the user to the
admins
group.
org-user-remove
The org-user-remove
subcommand is used to remove a user from an
organization.
Syntax
This subcommand has the following syntax:
chef-server-ctl org-user-remove ORG_NAME USER_NAME (options)
user-create
The user-create
subcommand is used to create a user. (The validation
key for the organization may be returned to STDOUT
when creating a
user with this command.)
Syntax
This subcommand has the following syntax:
chef-server-ctl user-create USER_NAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL 'PASSWORD' (options)
Options
This subcommand has the following options:
-f FILE_NAME
,--filename FILE_NAME
Write the USER.pem to a file instead of
STDOUT
.
user-delete
The user-delete
subcommand is used to delete a user.
Syntax
This subcommand has the following syntax:
chef-server-ctl user-delete USER_NAME
user-edit
The user-edit
subcommand is used to edit the details for a user. The
data will be made available in the $EDITOR for editing.
Syntax
This subcommand has the following syntax:
chef-server-ctl user-edit USER_NAME
user-list
The user-list
subcommand is used to view a list of users.
Syntax
This subcommand has the following syntax:
chef-server-ctl user-list (options)
Options
This subcommand has the following options:
-w
,--with-uri
Show the corresponding URIs.
user-show
The user-show
subcommand is used to show the details for a user.
Syntax
This subcommand has the following syntax:
chef-server-ctl user-show USER_NAME (options)
Options
This subcommand has the following options:
-l
,--with-orgs
Show all organizations.