Common Command Options

All the cloud infrastructure CLI commands have one of two common prefixes:

  • akm – Use only for commands related to access keys, for example akm-create-access-key.

  • iaas – Use for all other cloud computing management commands, for example iaas-create-volume.

All the cloud infrastructure CLI commands share some common options. Other options are common for commands with the same prefix. Table 4-1 lists the command options and their descriptions, and indicates whether the option is required for the command.

Table 4-1 Common Command Options

Command Type Option Description Required

akm and iaas

--base-url <base_url>

Base URL of the Enterprise Controller where the Web service is running. https://<EnterpriseControllerhost>.

Yes

akm

--user

The user name for authentication.

Yes

akm

--password-file|-p <pw_file>

Path to the password file for authentication. If this option is not supplied, then the cloud user is prompted for a password.

No

iaas

--access-key-file|-a <access_key_file>

Path of the file storing the access key

Yes

akm and iaas

--help | -h

Explains the command usage and its argument.

No

akm and iaas

--header | -H

Adds a header row to the command output

No

akm and iaas

--sep <separator>

Specifies a column separator character. The default separator is TAB.

No

akm and iaas

--xml

Displays the output in XML format. The default output is in table format.

No

akm and iaas

--verbose | -v

Starts the command in verbose mode

No

akm and iaas

--debug | -D

Starts the command in debug mode

No

Alternatively, the value for some common required options can be specified using the environment variables: IAAS_PASSWORD_FILE, IAAS_BASE_URL, IAAS_USER, and IAAS_ACCESS_KEY_FILE.