[edit on GitHub]

The knife org subcommand is used to manage organizations and users in Chef Infra Server.

Required Permissions

• Administrator permissions are required to add, remove, or edit users.
• The pivotal key is required to manage organizations, or change a user’s assignment to an organization.

The knife common options are available to this (and all) knife subcommands and plugins.

config.rb Setup

Unlike other knife subcommands the subcommands in the knife-org plugin make API calls to the root of your Chef Infra Server API endpoints.

The chef_server_url for your Chef Infra Server installation typically looks 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 defaults to https://chef.yourdomain.com/.

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 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 org create acme2 "The Other Acme" -a arno
-----BEGIN RSA PRIVATE KEY-----
[...]
-----BEGIN RSA PRIVATE KEY-----

org list

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

Syntax

This argument has the following syntax:

knife 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 org list -w -a
acme: https://chef-server.fqdn/organizations/acme

org show

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

Syntax

This argument has the following syntax:

knife org show ORG_NAME

Example

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

org edit

Edits the given Chef Infra Server organization.

Syntax

This argument has the following syntax:

knife org edit ORG_NAME

Example

knife org edit Acme -e nano
{"name"=>"Acme", "full_name"=>"Acme Z", "guid"=>"dea05074c4566f81d9d3228f4ad9bcd3"}
Saved Acme.

org delete

Deletes the given Chef Infra Server organization.

Syntax

This argument has the following syntax:

knife org delete ORG_NAME

Example

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

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 org user add ORG_NAME USER_NAME

Options

This argument has the following options:

-a, --admin

Add user to admin group.

Example

knife org user add acme2 alice

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 org user remove ORG_NAME USER_NAME

Options

This argument has the following options:

-f, --force

Force removal of user from the organization’s admins and billing-admins group.

Example

knife org user remove acme2 alice