Command Line Interface Reference

--version

Show program’s version number and exit

-v, --verbose

Increase verbosity of output. can be repeated.

-q, --quiet

Suppress output except warnings and errors.

--log-file LOG_FILE

Specify a file to log output. disabled by default.

-h, --help

Show help message and exit.

--debug

Show tracebacks on errors.

--os-cloud <cloud-config-name>

Cloud name in clouds.yaml (Env: OS_CLOUD)

--os-region-name <auth-region-name>

Authentication region name (Env: OS_REGION_NAME)

--os-cacert <ca-bundle-file>

CA certificate bundle file (Env: OS_CACERT)

--os-cert <certificate-file>

Client certificate bundle file (Env: OS_CERT)

--os-key <key-file>

Client certificate key file (env: os_key)

--verify

Verify server certificate (default)

--insecure

Disable server certificate verification

--os-default-domain <auth-domain>

Default domain ID, default=default. (Env: OS_DEFAULT_DOMAIN)

--os-interface <interface>

Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE)

--os-service-provider <service_provider>

Authenticate with and perform the command on a service provider using Keystone-to-keystone federation. Must also specify the remote project option.

--os-remote-project-name <remote_project_name>

Project name when authenticating to a service provider if using Keystone-to-Keystone federation.

--os-remote-project-id <remote_project_id>

Project ID when authenticating to a service provider if using Keystone-to-Keystone federation.

--os-remote-project-domain-name <remote_project_domain_name>

Domain name of the project when authenticating to a service provider if using Keystone-to-Keystone federation.

--os-remote-project-domain-id <remote_project_domain_id>

Domain ID of the project when authenticating to a service provider if using Keystone-to-Keystone federation.

--timing

Print api call timing info

--os-beta-command

Enable beta commands which are subject to change

--os-profile hmac-key

HMAC key for encrypting profiling context data

--os-compute-api-version <compute-api-version>

Compute API version, default=2.1 (Env: OS_COMPUTE_API_VERSION)

--os-network-api-version <network-api-version>

Network API version, default=2.0 (Env: OS_NETWORK_API_VERSION)

--os-image-api-version <image-api-version>

Image API version, default=2 (Env: OS_IMAGE_API_VERSION)

--os-volume-api-version <volume-api-version>

Volume API version, default=2 (Env: OS_VOLUME_API_VERSION)

--os-identity-api-version <identity-api-version>

Identity API version, default=3 (Env: OS_IDENTITY_API_VERSION)

--os-object-api-version <object-api-version>

Object API version, default=1 (Env: OS_OBJECT_API_VERSION)

--os-metrics-api-version <metrics-api-version>

Metrics API version, default=1 (Env: OS_METRICS_API_VERSION)

--os-key-manager-api-version <key-manager-api-version>

Barbican API version, default=1 (Env: OS_KEY_MANAGER_API_VERSION)

--os-dns-api-version <dns-api-version>

DNS API version, default=2 (Env: OS_DNS_API_VERSION)

--os-orchestration-api-version <orchestration-api-version>

Orchestration API version, default=1 (Env: OS_ORCHESTRATION_API_VERSION)

--os-queues-api-version <queues-api-version>

Queues API version, default=2 (Env: OS_QUEUES_API_VERSION)

--os-workflow-api-version <workflow-api-version>

Workflow API version, default=2 (Env: OS_WORKFLOW_API_VERSION)

--os-database-api-version <database-api-version>

Database API version, default=1 (Env: OS_DATABASE_API_VERSION)

--os-alarming-api-version <alarming-api-version>

Queues API version, default=2 (Env: OS_ALARMING_API_VERSION)

--inspector-api-version INSPECTOR_API_VERSION

inspector API version, only 1 is supported now (env: INSPECTOR_VERSION).

--inspector-url INSPECTOR_URL

inspector URL, defaults to localhost (env: INSPECTOR_URL).

--os-container-infra-api-version <container-infra-api-version>

Container-Infra API version, default=1 (Env: OS_CONTAINER_INFRA_API_VERSION)

--os-loadbalancer-api-version <loadbalancer-api-version>

OSC Plugin API version, default=2.0 (Env: OS_LOADBALANCER_API_VERSION)

--os-data-processing-api-version <data-processing-api-version>

Data processing API version, default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION)

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing API URL, (Env: OS_DATA_PROCESSING_API_URL)

--os-baremetal-api-version <baremetal-api-version>

Bare metal API version, default="latest" (the maximum version supported by both the client and the server). (Env: OS_BAREMETAL_API_VERSION)

--os-auth-type <auth-type>

Select an authentication type. Available types: v2token, v3adfspassword, admin_token, v2password, v3password, v3tokenlessauth, v3token, v3oauth1, v3oidcauthcode, v3samlpassword, token_endpoint, v1password, v3totp, aodh-noauth, v3oidcclientcredentials, gnocchi-basic, gnocchi- noauth, password, none, v3oidcaccesstoken, v3oidcpassword, token, v3applicationcredential, noauth. Default: selected based on --os-username/--os- token (Env: OS_AUTH_TYPE)

--os-project-domain-id <auth-project-domain-id>

With v3adfspassword: Domain ID containing project With v3password: Domain ID containing project With v3tokenlessauth: Domain ID containing project With v3token: Domain ID containing project With v3oidcauthcode: Domain ID containing project With v3samlpassword: Domain ID containing project With v3totp: Domain ID containing project With v3oidcclientcredentials: Domain ID containing project With password: Domain ID containing project With v3oidcaccesstoken: Domain ID containing project With v3oidcpassword: Domain ID containing project With token: Domain ID containing project With v3applicationcredential: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID)

--os-protocol <auth-protocol>

With v3adfspassword: Protocol for federated plugin With v3oidcauthcode: Protocol for federated plugin With v3samlpassword: Protocol for federated plugin With v3oidcclientcredentials: Protocol for federated plugin With v3oidcaccesstoken: Protocol for federated plugin With v3oidcpassword: Protocol for federated plugin (Env: OS_PROTOCOL)

--os-project-name <auth-project-name>

With v3adfspassword: Project name to scope to With v3password: Project name to scope to With v3tokenlessauth: Project name to scope to With v3token: Project name to scope to With v3oidcauthcode: Project name to scope to With v3samlpassword: Project name to scope to With v1password: Swift account to use With v3totp: Project name to scope to With v3oidcclientcredentials: Project name to scope to With password: Project name to scope to With v3oidcaccesstoken: Project name to scope to With v3oidcpassword: Project name to scope to With token: Project name to scope to With v3applicationcredential: Project name to scope to (Env: OS_PROJECT_NAME)

--os-trust-id <auth-trust-id>

With v2token: Trust ID With v3adfspassword: Trust ID With v2password: Trust ID With v3password: Trust ID With v3token: Trust ID With v3oidcauthcode: Trust ID With v3samlpassword: Trust ID With v3totp: Trust ID With v3oidcclientcredentials: Trust ID With password: Trust ID With v3oidcaccesstoken: Trust ID With v3oidcpassword: Trust ID With token: Trust ID With v3applicationcredential: Trust ID (Env: OS_TRUST_ID)

--os-consumer-key <auth-consumer-key>

With v3oauth1: OAuth Consumer ID/Key (Env: OS_CONSUMER_KEY)

--os-domain-name <auth-domain-name>

With v3adfspassword: Domain name to scope to With v3password: Domain name to scope to With v3tokenlessauth: Domain name to scope to With v3token: Domain name to scope to With v3oidcauthcode: Domain name to scope to With v3samlpassword: Domain name to scope to With v3totp: Domain name to scope to With v3oidcclientcredentials: Domain name to scope to With password: Domain name to scope to With v3oidcaccesstoken: Domain name to scope to With v3oidcpassword: Domain name to scope to With token: Domain name to scope to With v3applicationcredential: Domain name to scope to (Env: OS_DOMAIN_NAME)

--os-access-secret <auth-access-secret>

With v3oauth1: OAuth Access Secret (Env: OS_ACCESS_SECRET)

--os-user-domain-id <auth-user-domain-id>

With v3password: User’s domain id With v3totp: User’s domain id With password: User’s domain id With v3applicationcredential: User’s domain id (Env: OS_USER_DOMAIN_ID)

--os-access-token-type <auth-access-token-type>

With v3oidcauthcode: OAuth 2.0 Authorization Server Introspection token type, it is used to decide which type of token will be used when processing token introspection. Valid values are: "access_token" or "id_token" With v3oidcclientcredentials: OAuth 2.0 Authorization Server Introspection token type, it is used to decide which type of token will be used when processing token introspection. Valid values are: "access_token" or "id_token" With v3oidcpassword: OAuth 2.0 Authorization Server Introspection token type, it is used to decide which type of token will be used when processing token introspection. Valid values are: "access_token" or "id_token" (Env: OS_ACCESS_TOKEN_TYPE)

--os-code <auth-code>

With v3oidcauthcode: OAuth 2.0 Authorization Code (Env: OS_CODE)

--os-application-credential-name <auth-application-credential-name>

With v3applicationcredential: Application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

--os-identity-provider-url <auth-identity-provider-url>

With v3adfspassword: An Identity Provider URL, where the SAML authentication request will be sent. With v3samlpassword: An Identity Provider URL, where the SAML2 authentication request will be sent. (Env: OS_IDENTITY_PROVIDER_URL)

--os-aodh-endpoint <auth-aodh-endpoint>

With aodh-noauth: Aodh endpoint (Env: OS_AODH_ENDPOINT)

--os-service-provider-endpoint <auth-service-provider-endpoint>

With v3adfspassword: Service Provider’s Endpoint (Env: OS_SERVICE_PROVIDER_ENDPOINT)

--os-access-token <auth-access-token>

With v3oidcaccesstoken: OAuth 2.0 Access Token (Env: OS_ACCESS_TOKEN)

--os-domain-id <auth-domain-id>

With v3adfspassword: Domain ID to scope to With v3password: Domain ID to scope to With v3tokenlessauth: Domain ID to scope to With v3token: Domain ID to scope to With v3oidcauthcode: Domain ID to scope to With v3samlpassword: Domain ID to scope to With v3totp: Domain ID to scope to With v3oidcclientcredentials: Domain ID to scope to With password: Domain ID to scope to With v3oidcaccesstoken: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With token: Domain ID to scope to With v3applicationcredential: Domain ID to scope to (Env: OS_DOMAIN_ID)

--os-user-domain-name <auth-user-domain-name>

With v3password: User’s domain name With v3totp: User’s domain name With password: User’s domain name With v3applicationcredential: User’s domain name (Env: OS_USER_DOMAIN_NAME)

--os-openid-scope <auth-openid-scope>

With v3oidcauthcode: OpenID Connect scope that is requested from authorization server. Note that the OpenID Connect specification states that "openid" must be always specified. With v3oidcclientcredentials: OpenID Connect scope that is requested from authorization server. Note that the OpenID Connect specification states that "openid" must be always specified. With v3oidcpassword: OpenID Connect scope that is requested from authorization server. Note that the OpenID Connect specification states that "openid" must be always specified. (Env: OS_OPENID_SCOPE)

--os-user-id <auth-user-id>

With v2password: User ID to login with With v3password: User ID With v3totp: User ID With aodh- noauth: User ID With gnocchi-noauth: User ID With password: User id With v3applicationcredential: User ID With noauth: User ID (Env: OS_USER_ID)

--os-application-credential-secret <auth-application-credential-secret>

With v3applicationcredential: Application credential auth secret (Env: OS_APPLICATION_CREDENTIAL_SECRET)

--os-identity-provider <auth-identity-provider>

With v3adfspassword: Identity Provider’s name With v3oidcauthcode: Identity Provider’s name With v3samlpassword: Identity Provider’s name With v3oidcclientcredentials: Identity Provider’s name With v3oidcaccesstoken: Identity Provider’s name With v3oidcpassword: Identity Provider’s name (Env: OS_IDENTITY_PROVIDER)

--os-username <auth-username>

With v3adfspassword: Username With v2password: Username to login with With v3password: Username With v3samlpassword: Username With v1password: Username to login with With v3totp: Username With password: Username With v3oidcpassword: Username With v3applicationcredential: Username (Env: OS_USERNAME)

--os-auth-url <auth-auth-url>

With v2token: Authentication URL With v3adfspassword: Authentication URL With v2password: Authentication URL With v3password: Authentication URL With v3tokenlessauth: Authentication URL With v3token: Authentication URL With v3oauth1: Authentication URL With v3oidcauthcode: Authentication URL With v3samlpassword: Authentication URL With v1password: Authentication URL With v3totp: Authentication URL With v3oidcclientcredentials: Authentication URL With password: Authentication URL With v3oidcaccesstoken: Authentication URL With v3oidcpassword: Authentication URL With token: Authentication URL With v3applicationcredential: Authentication URL (Env: OS_AUTH_URL)

--os-client-secret <auth-client-secret>

With v3oidcauthcode: OAuth 2.0 Client Secret With v3oidcclientcredentials: OAuth 2.0 Client Secret With v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)

--os-access-token-endpoint <auth-access-token-endpoint>

With v3oidcauthcode: OpenID Connect Provider Token Endpoint. Note that if a discovery document is being passed this option will override the endpoint provided by the server in the discovery document. With v3oidcclientcredentials: OpenID Connect Provider Token Endpoint. Note that if a discovery document is being passed this option will override the endpoint provided by the server in the discovery document. With v3oidcpassword: OpenID Connect Provider Token Endpoint. Note that if a discovery document is being passed this option will override the endpoint provided by the server in the discovery document. (Env: OS_ACCESS_TOKEN_ENDPOINT)

--os-default-domain-id <auth-default-domain-id>

With password: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. With token: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. (Env: OS_DEFAULT_DOMAIN_ID)

--os-discovery-endpoint <auth-discovery-endpoint>

With v3oidcauthcode: OpenID Connect Discovery Document URL. The discovery document will be used to obtain the values of the access token endpoint and the authentication endpoint. This URL should look like https://idp.example.org/.well-known/openid- configuration With v3oidcclientcredentials: OpenID Connect Discovery Document URL. The discovery document will be used to obtain the values of the access token endpoint and the authentication endpoint. This URL should look like https://idp.example.org/.well-known /openid-configuration With v3oidcpassword: OpenID Connect Discovery Document URL. The discovery document will be used to obtain the values of the access token endpoint and the authentication endpoint. This URL should look like https://idp.example.org/.well-known /openid-configuration (Env: OS_DISCOVERY_ENDPOINT)

--os-client-id <auth-client-id>

With v3oidcauthcode: OAuth 2.0 Client ID With v3oidcclientcredentials: OAuth 2.0 Client ID With v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)

--os-default-domain-name <auth-default-domain-name>

With password: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. With token: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. (Env: OS_DEFAULT_DOMAIN_NAME)

--os-project-domain-name <auth-project-domain-name>

With v3adfspassword: Domain name containing project With v3password: Domain name containing project With v3tokenlessauth: Domain name containing project With v3token: Domain name containing project With v3oidcauthcode: Domain name containing project With v3samlpassword: Domain name containing project With v3totp: Domain name containing project With v3oidcclientcredentials: Domain name containing project With password: Domain name containing project With v3oidcaccesstoken: Domain name containing project With v3oidcpassword: Domain name containing project With token: Domain name containing project With v3applicationcredential: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME)

--os-service-provider-entity-id <auth-service-provider-entity-id>

With v3adfspassword: Service Provider’s SAML Entity ID (Env: OS_SERVICE_PROVIDER_ENTITY_ID)

--os-access-key <auth-access-key>

With v3oauth1: OAuth Access Key (Env: OS_ACCESS_KEY)

--os-password <auth-password>

With v3adfspassword: Password With v2password: Password to use With v3password: User’s password With v3samlpassword: Password With v1password: Password to use With password: User’s password With v3oidcpassword: Password (Env: OS_PASSWORD)

--os-redirect-uri <auth-redirect-uri>

With v3oidcauthcode: OpenID Connect Redirect URL (Env: OS_REDIRECT_URI)

--os-endpoint <auth-endpoint>

With admin_token: The endpoint that will always be used With gnocchi-basic: Gnocchi endpoint With gnocchi-noauth: Gnocchi endpoint With none: The endpoint that will always be used With noauth: Cinder endpoint (Env: OS_ENDPOINT)

--os-roles <auth-roles>

With aodh-noauth: Roles With gnocchi-noauth: Roles (Env: OS_ROLES)

--os-url <auth-url>

With token_endpoint: specific service endpoint to use (Env: OS_URL)

--os-consumer-secret <auth-consumer-secret>

With v3oauth1: OAuth Consumer Secret (Env: OS_CONSUMER_SECRET)

--os-token <auth-token>

With v2token: Token With admin_token: The token that will always be used With v3token: Token to authenticate with With token_endpoint: Authentication token to use With token: Token to authenticate with (Env: OS_TOKEN)

--os-application-credential-id <auth-application-credential-id>

With v3applicationcredential: Application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

--os-passcode <auth-passcode>

With v3totp: User’s TOTP passcode (Env: OS_PASSCODE)

--os-system-scope <auth-system-scope>

With v3adfspassword: Scope for system operations With v3password: Scope for system operations With v3token: Scope for system operations With v3oidcauthcode: Scope for system operations With v3samlpassword: Scope for system operations With v3totp: Scope for system operations With v3oidcclientcredentials: Scope for system operations With password: Scope for system operations With v3oidcaccesstoken: Scope for system operations With v3oidcpassword: Scope for system operations With token: Scope for system operations With v3applicationcredential: Scope for system operations (Env: OS_SYSTEM_SCOPE)

--os-project-id <auth-project-id>

With v3adfspassword: Project ID to scope to With v3password: Project ID to scope to With v3tokenlessauth: Project ID to scope to With v3token: Project ID to scope to With v3oidcauthcode: Project ID to scope to With v3samlpassword: Project ID to scope to With v3totp: Project ID to scope to With aodh- noauth: Project ID With v3oidcclientcredentials: Project ID to scope to With gnocchi-noauth: Project ID With password: Project ID to scope to With v3oidcaccesstoken: Project ID to scope to With v3oidcpassword: Project ID to scope to With token: Project ID to scope to With v3applicationcredential: Project ID to scope to With noauth: Project ID (Env: OS_PROJECT_ID)

--os-user <auth-user>

With gnocchi-basic: User (Env: OS_USER)

URI

The uri reference for the secret or container.

-h, --help

Show this help message and exit

URI

The uri reference for the secret or container.

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

URI

The uri reference for the secret or container.

-h, --help

Show this help message and exit

--user [USERS], -u [USERS]

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

--operation-type {read}, -o {read}

Type of Barbican operation ACL is set for

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

URI

The uri reference for the secret or container.

-h, --help

Show this help message and exit

--user [USERS], -u [USERS]

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

--operation-type {read}, -o {read}

Type of Barbican operation ACL is set for

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

URI

The uri reference for the secret or container.

-h, --help

Show this help message and exit

--user [USERS], -u [USERS]

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

--operation-type {read}, -o {read}

Type of Barbican operation ACL is set for

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

definition

Action definition file

-h, --help

Show this help message and exit

--public

With this flag action will be marked as "public".

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

name

Action name

-h, --help

Show this help message and exit

action

Name or id of action(s).

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--filter FILTERS

Filters. can be repeated.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

action

Action (name or id)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

definition

Action definition file

-h, --help

Show this help message and exit

--id ID

Action id.

--public

With this flag action will be marked as "public".

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

action_execution

Id of action execution identifier(s).

-h, --help

Show this help message and exit

id

Action execution id.

-h, --help

Show this help message and exit

task_execution_id

Task execution id.

-h, --help

Show this help message and exit

--limit [LIMIT]

Maximum number of action-executions to return in a single result. limit is set to 100 by default. Use

--limit -1 to fetch the full result set.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

id

Action execution id.

-h, --help

Show this help message and exit

name

Action name to execute.

input

Action input.

-h, --help

Show this help message and exit

-s, --save-result

Save the result into db.

--run-sync

Run the action synchronously.

-t TARGET, --target TARGET

Action will be executed on <target> executor.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

action_execution

Action execution id.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

id

Action execution id.

-h, --help

Show this help message and exit

--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED}

Action execution state

--output OUTPUT

Action execution output

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<name>

New address scope name

-h, --help

Show this help message and exit

--ip-version {4,6}

Ip version (default is 4)

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects (default)

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<address-scope>

Address scope(s) to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

List only address scopes of given name in output

--ip-version <ip-version>

List address scopes of given IP version networks (4 or 6)

--project <project>

List address scopes according to their project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--share

List address scopes shared between projects

--no-share

List address scopes not shared between projects

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

<address-scope>

Address scope to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Set address scope name

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects

<address-scope>

Address scope to display (name or id)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<aggregate>

Aggregate (name or id)

<host>

Host to add to <aggregate>

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<name>

New aggregate name

-h, --help

Show this help message and exit

--zone <availability-zone>

Availability zone name

--property <key=value>

Property to add to this aggregate (repeat option to set multiple properties)

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<aggregate>

Aggregate(s) to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--long

List additional fields in output

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

<aggregate>

Aggregate (name or id)

<host>

Host to remove from <aggregate>

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<aggregate>

Aggregate to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Set aggregate name

--zone <availability-zone>

Set availability zone name

--property <key=value>

Property to set on <aggregate> (repeat option to set multiple properties)

--no-property

Remove all properties from <aggregate> (specify both

--property and --no-property to overwrite the current

properties)

<aggregate>

Aggregate to display (name or id)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<aggregate>

Aggregate to modify (name or id)

-h, --help

Show this help message and exit

--property <key>

Property to remove from aggregate (repeat option to remove multiple properties)

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

-t <TYPE>, --type <TYPE>

Type of alarm, should be one of: event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.

--project-id <PROJECT_ID>

Project to associate with alarm (configurable by admin users only)

--user-id <USER_ID>

User to associate with alarm (configurable by admin users only)

--description <DESCRIPTION>

Free text description of the alarm

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True

False}

True if alarm evaluation is enabled

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--repeat-actions {True

False}

True if actions should be repeatedly notified while alarm remains in target state

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--query <QUERY>

For alarms of type event: key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. For alarms of type gnocchi_aggregation_by_resources_threshold: need to specify a complex query json string, like: {"and": [{"=": {"ended_at": null}}, …​]}.

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--threshold <THRESHOLD>

Threshold to evaluate against.

--event-type <EVENT_TYPE>

Event type to evaluate against

--granularity <GRANULARITY>

The time range in seconds over which to query.

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--metric <METRIC>, --metrics <METRIC>

The metric id or name depending of the alarm type

--resource-type <RESOURCE_TYPE>

The type of resource.

--resource-id <RESOURCE_ID>

The id of a resource.

--composite-rule <COMPOSITE_RULE>

Composite threshold rule with JSON format, the form can be a nested dict which combine gnocchi rules by "and", "or". For example, the form is like: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}.

<ALARM ID or NAME>

Id or name of an alarm.

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

--query QUERY

Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar

--filter <KEY1=VALUE1;KEY2=VALUE2…​>

Filter parameters to apply on returned alarms.

--limit <LIMIT>

Number of resources to return (default is server default)

--marker <MARKER>

Last item of the previous listing. return the next results after this value,the supported marker is alarm_id.

--sort <SORT_KEY:SORT_DIR>

Sort of resource attribute, e.g. name:asc

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

<ALARM ID or NAME>

Id or name of an alarm.

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<ALARM ID or NAME>

Id or name of an alarm.

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<ALARM ID or NAME>

Id or name of an alarm.

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<ALARM ID or NAME>

Id or name of an alarm.

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

-t <TYPE>, --type <TYPE>

Type of alarm, should be one of: event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.

--project-id <PROJECT_ID>

Project to associate with alarm (configurable by admin users only)

--user-id <USER_ID>

User to associate with alarm (configurable by admin users only)

--description <DESCRIPTION>

Free text description of the alarm

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True

False}

True if alarm evaluation is enabled

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--repeat-actions {True

False}

True if actions should be repeatedly notified while alarm remains in target state

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--query <QUERY>

For alarms of type event: key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. For alarms of type gnocchi_aggregation_by_resources_threshold: need to specify a complex query json string, like: {"and": [{"=": {"ended_at": null}}, …​]}.

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt']

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--threshold <THRESHOLD>

Threshold to evaluate against.

--event-type <EVENT_TYPE>

Event type to evaluate against

--granularity <GRANULARITY>

The time range in seconds over which to query.

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--metric <METRIC>, --metrics <METRIC>

The metric id or name depending of the alarm type

--resource-type <RESOURCE_TYPE>

The type of resource.

--resource-id <RESOURCE_ID>

The id of a resource.

--composite-rule <COMPOSITE_RULE>

Composite threshold rule with JSON format, the form can be a nested dict which combine gnocchi rules by "and", "or". For example, the form is like: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}.

-h, --help

Show this help message and exit

--query QUERY

Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

alarm_id

Id of an alarm

-h, --help

Show this help message and exit

--limit <LIMIT>

Number of resources to return (default is server default)

--marker <MARKER>

Last item of the previous listing. return the next results after this value,the supported marker is event_id.

--sort <SORT_KEY:SORT_DIR>

Sort of resource attribute. e.g. timestamp:desc

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

-h, --help

Show this help message and exit

--compute

List compute availability zones

--network

List network availability zones

--volume

List volume availability zones

--long

List additional fields in output

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

-h, --help

Show this help message and exit

--description <description>

Description for the chassis

--extra <key=value>

Record arbitrary key/value metadata. can be specified multiple times.

--uuid <uuid>

Unique uuid of the chassis

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<chassis>

Uuids of chassis to delete

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--fields <field> [<field> …​]

One or more chassis fields. Only these fields will be fetched from the server. Cannot be used when '--long' is specified.

--limit <limit>

Maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.

--long

Show detailed information about the chassis

--marker <chassis>

Chassis uuid (for example, of the last chassis in the list from a previous request). Returns the list of chassis after this UUID.

--sort <key>[:<direction>]

Sort output by specified chassis fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

<chassis>

Uuid of the chassis

-h, --help

Show this help message and exit

--description <description>

Set the description of the chassis

--extra <key=value>

Extra to set on this chassis (repeat option to set multiple extras)

<chassis>

Uuid of the chassis

-h, --help

Show this help message and exit

--fields <field> [<field> …​]

One or more chassis fields. Only these fields will be fetched from the server.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<chassis>

Uuid of the chassis

-h, --help

Show this help message and exit

--description

Clear the chassis description

--extra <key>

Extra to unset on this chassis (repeat option to unset multiple extras)

<file>

File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--type <type>

Type of driver ("classic" or "dynamic"). the default is to list all of them.

--long

Show detailed information about the drivers.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--noindent

Whether to disable indenting the json

--quote {all,minimal,none,nonnumeric}