Skip to main content

knife opc

[edit on GitHub]

The knife opc subcommand is used to manage organizations and users in Chef Server 12.

Note

Administrator permissions are required to add, remove, or edit users. To manage organizations, or change a user’s assignment to an organization, the pivotal key is required. To grant a user administrator permissions, use chef-server-ctl grant-server-admin-permissions USER_NAME on the Chef Infra Server. See chef-server-ctl for details.

Note

Review the list of common options available to this (and all) knife subcommands and plugins.

config.rb Configuration

Unlike other knife subcommands the subcommands in the knife-opc plugin make API calls against the root of your Chef Infra Server installation’s API endpoint.

Typically the chef_server_url for your Chef Infra Server installation may look like this:

chef_server_url 'https://chef.yourdomain.com/organizations/ORG_NAME'

To configure knife-opc, set the chef_server_root option to the root of your Chef Infra Server installation:

chef_server_root 'https://chef.yourdomain.com/'

If your chef_server_url configuration ends with /organizations/ORG_NAME (as shown above), this setting will default to https://chef.yourdomain.com/.

Note

On Chef Server 12, the majority of the commands provided by this plugin can be accessed via chef-server-ctl wrapper commands. See chef-server-ctl for details.

opc user list

Show a list of all users in your Chef Infra Server installation.

Syntax

This argument has the following syntax:

knife opc user list (options)

Options

This argument has the following options:

-w, --with-uri

Show corresponding URIs.

Example

knife opc user list
alice
pivotal
knife opc user list -w
alice: https://chef-server.fqdn/users/alice
pivotal: https://chef-server.fqdn/users/pivotal

opc user show

Shows the details of a user in your Chef Infra Server installation.

Syntax

This argument has the following syntax:

knife opc user show USER_NAME (options)

Options

This argument has the following options:

-l, --with-orgs

Show the organizations of which the user is a member.

Example

knife opc user show alice -l
display_name:  Alice Schmidt
email:         alice@chef.io
first_name:    Alice
last_name:     Schmidt
middle_name:
organizations: acme
public_key:    -----BEGIN PUBLIC KEY-----
[...]
-----END PUBLIC KEY-----


username:     alice

opc user create

Creates a new user in your Chef Infra Server installation. The user’s private key will be returned in response.

Syntax

This argument has the following syntax:

knife opc user create USER_NAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL PASSWORD (options)

Options

This argument has the following options:

-f FILENAME, --filename FILENAME

Write private key to FILENAME rather than STDOUT.

Example

knife opc user create arno arno schmidt arno@chef.io password
-----BEGIN RSA PRIVATE KEY-----
[...]
-----END RSA PRIVATE KEY-----

opc user delete

Deletes the given OPC user.

Syntax

This argument has the following syntax:

knife opc user delete USER_NAME [-d] [-R]

Options

This argument has the following options:

-d, --no-disassociate-user

Don’t disassociate the user first.

-R, --remove-from-admin-groups

If the user is a member of any org admin groups, attempt to remove from those groups. Ignored if --no-disassociate-user is set.

Example

knife opc user delete arno
Do you want to delete the user arno? (Y/N) Y
Checking organization memberships...
Deleting user arno.

opc user edit

Will open $EDITOR to edit a user. When finished editing, knife will update the given Chef Infra Server user.

Syntax

This argument has the following syntax:

knife opc user edit USER_NAME

Example

EDITOR=ed knife opc user edit arno
639
1,%p
{
  "username": "arno",
  "email": "arno@chef.io",
  "display_name": "arno schmidt",
  "first_name": "arno",
  "last_name": "schmidt",
  "middle_name": "",
  "public_key": "-----BEGIN PUBLIC KEY-----\n[...]\n-----END PUBLIC KEY-----\n\n"
}
/email/s/chef.io/opscode.com/p
"email": "arno@opscode.com",
wq
643
Saved arno.
knife opc user show arno
display_name: arno schmidt
email:        arno@opscode.io
first_name:   arno
last_name:    schmidt
middle_name:
public_key:   -----BEGIN PUBLIC KEY-----
[...]
-----END PUBLIC KEY-----


username:     arno

opc user password

Command for managing password and authentication for a user.

Syntax

This argument has the following syntax:

knife opc user password USER_NAME [PASSWORD | --enable_external_auth]

The last argument should either be a string to use as password or --enable_external_auth instead of a password to enable external authentication for this user.

Example

knife opc user password arno newpassword
{"username"=>"arno", "email"=>"arno@opscode.com", "display_name"=>"arno schmidt", "first_name"=>"arno", "last_name"=>"schmidt", "middle_name"=>"", "public_key"=>"-----BEGIN PUBLIC KEY-----\n[...]\n-----END PUBLIC KEY-----\n\n", "password"=>"newpassword", "recovery_authentication_enabled"=>true}
Authentication info updated for arno.

opc org list

Show a list of all organizations in your Chef Infra Server installation.

Syntax

This argument has the following syntax:

knife opc org list (options)

Options

This argument has the following options:

-w, --with-uri

Show corresponding URIs.

-a, --all-orgs

Display auto-generated hidden orgs.

Example

knife opc org list -w -a
acme: https://chef-server.fqdn/organizations/acme

opc org show

Shows the details of an organization in your Chef Infra Server installation.

Syntax

This argument has the following syntax:

knife opc org show ORG_NAME

Example

knife opc org show acme
full_name: Acme
guid:      cc9f9d0d4f6e7e35272e327e22e7affc
name:      acme

opc org create

Creates a new Chef Infra Server organization. The private key for the organization’s validator client is returned.

Syntax

This argument has the following syntax:

knife opc org create ORG_NAME ORG_FULL_NAME (options)

Options

This argument has the following options:

-f FILENAME, --filename FILENAME

Write private key to FILENAME rather than STDOUT.

-a USER_NAME, --association_user USER_NAME

Associate USER_NAME with the organization after creation.

Example

knife opc org create acme2 "The Other Acme" -a arno
-----BEGIN RSA PRIVATE KEY-----
[...]
-----BEGIN RSA PRIVATE KEY-----

opc org delete

Deletes the given Chef Infra Server organization.

Syntax

This argument has the following syntax:

knife opc org delete ORG_NAME

Example

knife opc org delete acme2
Do you want to delete the organization acme2? (Y/N) Y
full_name: The Other Acme
guid:      2adec1140cf777a15d82d9099304da71
name:      acme2

opc org user add

Adds a user to an organization. Requires that the named organization and user both exist.

Syntax

This argument has the following syntax:

knife opc org user add ORG_NAME USER_NAME

Example

knife opc org user add acme2 alice

opc org user remove

Removes a user from an organization. Requires that the named organization and user both exist, and that the user is currently associated with the organization.

Syntax

This argument has the following syntax:

knife opc org user remove ORG_NAME USER_NAME

Example

knife opc org user remove acme2 alice