Command Line Interface Reference

Red Hat OpenStack Platform 13

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation Team

OpenStack Documentation Team

Abstract

A reference to the commands available to the unified OpenStack command-line client.

Preface

A reference to the commands available for the unified OpenStack command-line client.

Chapter 1. The OpenStack Client

The openstack client is a common OpenStack command-line interface (CLI). This chapter documents the main options for openstack version 3.14.3 . :leveloffset: +1

Command-line interface to the OpenStack APIs

Usage:

openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
                 [--os-cloud <cloud-config-name>]
                 [--os-region-name <auth-region-name>]
                 [--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>]
                 [--os-key <key-file>] [--verify | --insecure]
                 [--os-default-domain <auth-domain>]
                 [--os-interface <interface>]
                 [--os-service-provider <service_provider>]
                 [--os-remote-project-name <remote_project_name> | --os-remote-project-id <remote_project_id>]
                 [--os-remote-project-domain-name <remote_project_domain_name> | --os-remote-project-domain-id <remote_project_domain_id>]
                 [--timing] [--os-beta-command] [--os-profile hmac-key]
                 [--os-compute-api-version <compute-api-version>]
                 [--os-network-api-version <network-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-database-api-version <database-api-version>]
                 [--os-auth-type <auth-type>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-protocol <auth-protocol>]
                 [--os-project-name <auth-project-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-code <auth-code>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-access-token <auth-access-token>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-user-id <auth-user-id>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-username <auth-username>]
                 [--os-auth-url <auth-auth-url>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-client-id <auth-client-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-access-key <auth-access-key>]
                 [--os-password <auth-password>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-endpoint <auth-endpoint>] [--os-roles <auth-roles>]
                 [--os-url <auth-url>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-token <auth-token>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-passcode <auth-passcode>]
                 [--os-system-scope <auth-system-scope>]
                 [--os-project-id <auth-project-id>] [--os-user <auth-user>]

Table 1.1. Optional Arguments

ValueSummary

--inspector-url INSPECTOR_URL

Inspector url, defaults to localhost (env: INSPECTOR_URL).

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

Ca certificate bundle file (env: os_cacert)

--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)

--inspector-api-version INSPECTOR_API_VERSION

Inspector api version, only 1 is supported now (env: INSPECTOR_VERSION).

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

With v3oidcauthcode: openid connect redirect url (env: OS_REDIRECT_URI)

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

Cloud name in clouds.yaml (env: os_cloud)

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

Container-infra api version, default=1 (env: OS_CONTAINER_INFRA_API_VERSION)

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

Queues api version, default=2 (env: OS_ALARMING_API_VERSION)

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

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

-h, --help

Show help message and exit.

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

With v3adfspassword: project name to scope to with v3password: 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 v3tokenlessauth: 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-identity-api-version <identity-api-version>

Identity api version, default=3 (env: OS_IDENTITY_API_VERSION)

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

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

--verify

Verify server certificate (default)

--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.

--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-auth-type <auth-type>

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

--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-project-domain-name <auth-project-domain-name>

With v3adfspassword: domain name containing project With v3password: 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 v3tokenlessauth: 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-endpoint <auth-endpoint>

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

--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-aodh-endpoint <auth-aodh-endpoint>

With aodh-noauth: aodh endpoint (env: OS_AODH_ENDPOINT)

--os-roles <auth-roles>

With aodh-noauth: roles with gnocchi-noauth: roles (Env: OS_ROLES)

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

With v3applicationcredential: application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

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

Dns api version, default=2 (env: os_dns_api_version)

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

Barbican api version, default=1 (env: OS_KEY_MANAGER_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-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-secret <auth-access-secret>

With v3oauth1: oauth access secret (env: OS_ACCESS_SECRET)

--os-beta-command

Enable beta commands which are subject to change

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

Orchestration api version, default=1 (env: OS_ORCHESTRATION_API_VERSION)

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

With v3adfspassword: service provider’s endpoint (env: OS_SERVICE_PROVIDER_ENDPOINT)

--timing

Print api call timing info

--os-tripleoclient-api-version <tripleoclient-api-version>

Tripleo client api version, default=1 (env: OS_TRIPLEOCLIENT_API_VERSION)

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

Osc plugin api version, default=2.0 (env: OS_LOADBALANCER_API_VERSION)

--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-auth-url <auth-auth-url>

With v2token: authentication url with v3adfspassword: Authentication URL With v2password: Authentication URL With v3password: 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 v3tokenlessauth: 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-user <auth-user>

With gnocchi-basic: user (env: os_user)

--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-project-domain-id <auth-project-domain-id>

With v3adfspassword: domain id containing project with v3password: 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 v3tokenlessauth: 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)

--insecure

Disable server certificate verification

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

Network api version, default=2.0 (env: OS_NETWORK_API_VERSION)

--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-cert <certificate-file>

Client certificate bundle file (env: os_cert)

--os-code <auth-code>

With v3oidcauthcode: oauth 2.0 authorization code (Env: OS_CODE)

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

With v3oauth1: oauth consumer secret (env: OS_CONSUMER_SECRET)

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

Compute api version, default=2.1 (env: OS_COMPUTE_API_VERSION)

--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-access-token <auth-access-token>

With v3oidcaccesstoken: oauth 2.0 access token (env: OS_ACCESS_TOKEN)

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

Authentication region name (env: os_region_name)

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

Queues api version, default=2 (env: OS_QUEUES_API_VERSION)

--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-application-credential-secret <auth-application-credential-secret>

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

--os-passcode <auth-passcode>

With v3totp: user’s totp passcode (env: os_passcode)

--os-profile hmac-key

Hmac key for encrypting profiling context data

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

With v3adfspassword: domain id to scope to with v3password: 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 v3tokenlessauth: 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-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-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)

-v, --verbose

Increase verbosity of output. can be repeated.

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

Workflow api version, default=2 (env: OS_WORKFLOW_API_VERSION)

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

With v3applicationcredential: application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing api url, (env: OS_DATA_PROCESSING_API_URL)

--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-image-api-version <image-api-version>

Image api version, default=2 (env: OS_IMAGE_API_VERSION)

--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-remote-project-id <remote_project_id>

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

--os-key <key-file>

Client certificate key file (env: os_key)

--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-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-default-domain <auth-domain>

Default domain id, default=default. (env: OS_DEFAULT_DOMAIN)

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

Volume api version, default=2 (env: OS_VOLUME_API_VERSION)

--log-file LOG_FILE

Specify a file to log output. disabled by default.

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

With v3oauth1: oauth access key (env: os_access_key)

--debug

Show tracebacks on errors.

--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-domain-name <auth-domain-name>

With v3adfspassword: domain name to scope to with v3password: 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 v3tokenlessauth: 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-project-id <auth-project-id>

With v3adfspassword: project id to scope to with v3password: Project ID to scope to With noauth: Project ID 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 v3tokenlessauth: Project ID to scope to 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 (Env: OS_PROJECT_ID)

-q, --quiet

Suppress output except warnings and errors.

--version

Show program’s version number and exit

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

Metrics api version, default=1 (env: OS_METRICS_API_VERSION)

--os-interface <interface>

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

--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-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-object-api-version <object-api-version>

Object api version, default=1 (env: OS_OBJECT_API_VERSION)

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

Database api version, default=1 (env: OS_DATABASE_API_VERSION)

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

With v3oauth1: oauth consumer id/key (env: OS_CONSUMER_KEY)

--os-url <auth-url>

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

--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-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)

Chapter 2. acl

This chapter describes the commands under the acl command.

2.1. acl delete

Delete ACLs for a secret or container as identified by its href.

Usage:

openstack acl delete [-h] URI

Table 2.1. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 2.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

2.2. acl get

Retrieve ACLs for a secret or container by providing its href.

Usage:

openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--noindent] [--quote {all,minimal,none,nonnumeric}]
                         [--sort-column SORT_COLUMN]
                         URI

Table 2.3. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 2.4. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 2.5. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 2.6. Output Formatters

ValueSummary

output formatter options-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

Table 2.7. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

2.3. acl submit

Submit ACL on a secret or container as identified by its href.

Usage:

openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN] [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI

Table 2.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 2.10. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 2.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 2.12. Output Formatters

ValueSummary

output formatter options-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

Table 2.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.14. Optional Arguments

ValueSummary

--project-access

Flag to enable project access behavior.

-h, --help

Show this help message and exit

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

Keystone userid(s) for acl.

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

Type of barbican operation acl is set for

--no-project-access

Flag to disable project access behavior.

2.4. acl user add

Add ACL users to a secret or container as identified by its href.

Usage:

openstack acl user add [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--user [USERS]]
                              [--project-access | --no-project-access]
                              [--operation-type {read}]
                              URI

Table 2.15. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 2.16. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 2.17. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 2.18. Output Formatters

ValueSummary

output formatter options-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

Table 2.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.20. Optional Arguments

ValueSummary

--project-access

Flag to enable project access behavior.

-h, --help

Show this help message and exit

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

Keystone userid(s) for acl.

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

Type of barbican operation acl is set for

--no-project-access

Flag to disable project access behavior.

2.5. acl user remove

Remove ACL users from a secret or container as identified by its href.

Usage:

openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN] [--user [USERS]]
                                 [--project-access | --no-project-access]
                                 [--operation-type {read}]
                                 URI

Table 2.21. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 2.22. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 2.23. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 2.24. Output Formatters

ValueSummary

output formatter options-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

Table 2.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.26. Optional Arguments

ValueSummary

--project-access

Flag to enable project access behavior.

-h, --help

Show this help message and exit

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

Keystone userid(s) for acl.

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

Type of barbican operation acl is set for

--no-project-access

Flag to disable project access behavior.

Chapter 3. action

This chapter describes the commands under the action command.

3.1. action definition create

Create new action.

Usage:

openstack action definition create [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--public]
                                          definition

Table 3.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.2. Positional Arguments

ValueSummary

definition

Action definition file

Table 3.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 3.4. Output Formatters

ValueSummary

output formatter options-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

Table 3.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public

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

3.2. action definition definition show

Show action definition.

Usage:

openstack action definition definition show [-h] name

Table 3.7. Positional Arguments

ValueSummary

name

Action name

Table 3.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

3.3. action definition delete

Delete action.

Usage:

openstack action definition delete [-h] action [action ...]

Table 3.9. Positional Arguments

ValueSummary

action

Name or id of action(s).

Table 3.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

3.4. action definition list

List all actions.

Usage:

openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--filter FILTERS]

Table 3.11. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.12. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 3.13. Output Formatters

ValueSummary

output formatter options-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

Table 3.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.15. Optional Arguments

ValueSummary

--filter FILTERS

Filters. can be repeated.

-h, --help

Show this help message and exit

3.5. action definition show

Show specific action.

Usage:

openstack action definition show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        action

Table 3.16. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.17. Positional Arguments

ValueSummary

action

Action (name or id)

Table 3.18. Output Formatters

ValueSummary

output formatter options-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

Table 3.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 3.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

3.6. action definition update

Update action.

Usage:

openstack action definition update [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--id ID] [--public]
                                          definition

Table 3.22. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.23. Positional Arguments

ValueSummary

definition

Action definition file

Table 3.24. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 3.25. Output Formatters

ValueSummary

output formatter options-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

Table 3.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--id ID

Action id.

--public

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

3.7. action execution delete

Delete action execution.

Usage:

openstack action execution delete [-h]
                                         action_execution
                                         [action_execution ...]

Table 3.28. Positional Arguments

ValueSummary

action_execution

Id of action execution identifier(s).

Table 3.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

3.8. action execution input show

Show Action execution input data.

Usage:

openstack action execution input show [-h] id

Table 3.30. Positional Arguments

ValueSummary

id

Action execution id.

Table 3.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

3.9. action execution list

List all Action executions.

Usage:

openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--limit [LIMIT]]
                                       [task_execution_id]

Table 3.32. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.33. Positional Arguments

ValueSummary

task_execution_id

Task execution id.

Table 3.34. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 3.35. Output Formatters

ValueSummary

output formatter options-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

Table 3.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.37. Optional Arguments

ValueSummary

-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.

3.10. action execution output show

Show Action execution output data.

Usage:

openstack action execution output show [-h] id

Table 3.38. Positional Arguments

ValueSummary

id

Action execution id.

Table 3.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

3.11. action execution run

Create new Action execution or just run specific action.

Usage:

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX] [-s]
                                      [--run-sync] [-t TARGET]
                                      name [input]

Table 3.40. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.41. Positional Arguments

ValueSummary

input

Action input.

name

Action name to execute.

Table 3.42. Output Formatters

ValueSummary

output formatter options-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

Table 3.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.44. Optional Arguments

ValueSummary

-s, --save-result

Save the result into db.

-t TARGET, --target TARGET

Action will be executed on <target> executor.

-h, --help

Show this help message and exit

--run-sync

Run the action synchronously.

Table 3.45. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

3.12. action execution show

Show specific Action execution.

Usage:

openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       action_execution

Table 3.46. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.47. Positional Arguments

ValueSummary

action_execution

Action execution id.

Table 3.48. Output Formatters

ValueSummary

output formatter options-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

Table 3.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 3.51. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

3.13. action execution update

Update specific Action execution.

Usage:

openstack action execution update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--state {IDLE,RUNNING,SUCCESS,ERROR,CANCELLED}]
                                         [--output OUTPUT]
                                         id

Table 3.52. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 3.53. Positional Arguments

ValueSummary

id

Action execution id.

Table 3.54. Output Formatters

ValueSummary

output formatter options-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

Table 3.55. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output OUTPUT

Action execution output

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

Action execution state

Table 3.57. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Chapter 4. address

This chapter describes the commands under the address command.

4.1. address scope create

Create a new Address Scope

Usage:

openstack address scope create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--ip-version {4,6}]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

Table 4.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 4.2. Positional Arguments

ValueSummary

<name>

New address scope name

Table 4.3. Output Formatters

ValueSummary

output formatter options-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

Table 4.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.5. Optional Arguments

ValueSummary

--share

Share the address scope between projects

--ip-version {4,6}

Ip version (default is 4)

--project-domain <project-domain>

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

--no-share

Do not share the address scope between projects (default)

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

Table 4.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

4.2. address scope delete

Delete address scope(s)

Usage:

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]

Table 4.7. Positional Arguments

ValueSummary

<address-scope>

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

Table 4.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

4.3. address scope list

List address scopes

Usage:

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--name <name>]
                                    [--ip-version <ip-version>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]

Table 4.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 4.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 4.11. Output Formatters

ValueSummary

output formatter options-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

Table 4.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.13. Optional Arguments

ValueSummary

--share

List address scopes shared between projects

--ip-version <ip-version>

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

--name <name>

List only address scopes of given name in output

--project <project>

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

--no-share

List address scopes not shared between projects

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

4.4. address scope set

Set address scope properties

Usage:

openstack address scope set [-h] [--name <name>] [--share | --no-share]
                                   <address-scope>

Table 4.14. Positional Arguments

ValueSummary

<address-scope>

Address scope to modify (name or id)

Table 4.15. Optional Arguments

ValueSummary

--share

Share the address scope between projects

--name <name>

Set address scope name

-h, --help

Show this help message and exit

--no-share

Do not share the address scope between projects

4.5. address scope show

Display address scope details

Usage:

openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <address-scope>

Table 4.16. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 4.17. Positional Arguments

ValueSummary

<address-scope>

Address scope to display (name or id)

Table 4.18. Output Formatters

ValueSummary

output formatter options-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

Table 4.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 4.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Chapter 5. aggregate

This chapter describes the commands under the aggregate command.

5.1. aggregate add host

Add host to aggregate

Usage:

openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <aggregate> <host>

Table 5.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 5.2. Positional Arguments

ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to add to <aggregate>

Table 5.3. Output Formatters

ValueSummary

output formatter options-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

Table 5.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 5.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

5.2. aggregate create

Create a new aggregate

Usage:

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [--zone <availability-zone>]
                                  [--property <key=value>]
                                  <name>

Table 5.7. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 5.8. Positional Arguments

ValueSummary

<name>

New aggregate name

Table 5.9. Output Formatters

ValueSummary

output formatter options-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

Table 5.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.11. Optional Arguments

ValueSummary

-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)

Table 5.12. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

5.3. aggregate delete

Delete existing aggregate(s)

Usage:

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]

Table 5.13. Positional Arguments

ValueSummary

<aggregate>

Aggregate(s) to delete (name or id)

Table 5.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

5.4. aggregate list

List all aggregates

Usage:

openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN] [--long]

Table 5.15. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 5.16. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 5.17. Output Formatters

ValueSummary

output formatter options-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

Table 5.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

5.5. aggregate remove host

Remove host from aggregate

Usage:

openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <aggregate> <host>

Table 5.20. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 5.21. Positional Arguments

ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to remove from <aggregate>

Table 5.22. Output Formatters

ValueSummary

output formatter options-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

Table 5.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 5.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

5.6. aggregate set

Set aggregate properties

Usage:

openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>] [--no-property]
                               <aggregate>

Table 5.26. Positional Arguments

ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 5.27. Optional Arguments

ValueSummary

--name <name>

Set aggregate name

-h, --help

Show this help message and exit

--zone <availability-zone>

Set availability zone name

--no-property

Remove all properties from <aggregate> (specify both --property and --no-property to overwrite the current properties)

--property <key=value>

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

5.7. aggregate show

Display aggregate details

Usage:

openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <aggregate>

Table 5.28. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 5.29. Positional Arguments

ValueSummary

<aggregate>

Aggregate to display (name or id)

Table 5.30. Output Formatters

ValueSummary

output formatter options-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

Table 5.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.32. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 5.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

5.8. aggregate unset

Unset aggregate properties

Usage:

openstack aggregate unset [-h] [--property <key>] <aggregate>

Table 5.34. Positional Arguments

ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 5.35. Optional Arguments

ValueSummary

--property <key>

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

-h, --help

Show this help message and exit

Chapter 6. alarm

This chapter describes the commands under the alarm command.

6.1. alarm create

Create an alarm

Usage:

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] --name <NAME> -t <TYPE>
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]

Table 6.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.2. Output Formatters

ValueSummary

output formatter options-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

Table 6.3. common gnocchi alarm rules

ValueSummary

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--granularity <GRANULARITY>

The time range in seconds over which to query.

Table 6.4. event alarm

ValueSummary

--event-type <EVENT_TYPE>

Event type to evaluate against

Table 6.5. gnocchi resource threshold alarm

ValueSummary

--resource-id <RESOURCE_ID>

The id of a resource.

--resource-type <RESOURCE_TYPE>

The type of resource.

Table 6.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.7. composite alarm

ValueSummary

--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]}]}.

Table 6.8. Optional Arguments

ValueSummary

--ok-action <Webhook URL>

Url to invoke when state transitions to ok. may be used multiple times

--user-id <USER_ID>

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

--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.

--repeat-actions {True

False}

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

--state <STATE>

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

--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>]]

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

Url to invoke when state transitions to alarm. may be used multiple times

-h, --help

Show this help message and exit

--description <DESCRIPTION>

Free text description of the alarm

--enabled {True

False}

True if alarm evaluation is enabled

Table 6.9. common alarm rules

ValueSummary

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--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]

--metric <METRIC>

Metric to evaluate against.

--threshold <THRESHOLD>

Threshold to evaluate against.

Table 6.10. gnocchi aggregation by metrics alarm

ValueSummary

--metrics <METRICS>

The list of metric ids.

Table 6.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

6.2. alarm delete

Delete an alarm

Usage:

openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]

Table 6.12. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 6.13. Optional Arguments

ValueSummary

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

6.4. alarm-history show

Show history for an alarm

Usage:

openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT_KEY:SORT_DIR>]
                                    alarm_id

Table 6.19. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.20. Positional Arguments

ValueSummary

alarm_id

Id of an alarm

Table 6.21. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 6.22. Output Formatters

ValueSummary

output formatter options-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

Table 6.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.24. Optional Arguments

ValueSummary

--sort <SORT_KEY:SORT_DIR>

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

--limit <LIMIT>

Number of resources to return (default is server default)

-h, --help

Show this help message and exit

--marker <MARKER>

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

6.5. alarm list

List alarms

Usage:

openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN]
                            [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                            [--limit <LIMIT>] [--marker <MARKER>]
                            [--sort <SORT_KEY:SORT_DIR>]

Table 6.25. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.26. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 6.27. Output Formatters

ValueSummary

output formatter options-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

Table 6.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.29. Optional Arguments

ValueSummary

--sort <SORT_KEY:SORT_DIR>

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

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

Filter parameters to apply on returned alarms.

--query QUERY

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

--marker <MARKER>

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

--limit <LIMIT>

Number of resources to return (default is server default)

-h, --help

Show this help message and exit

6.6. alarm show

Show an alarm

Usage:

openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--name <NAME>]
                            [<ALARM ID or NAME>]

Table 6.30. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.31. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 6.32. Output Formatters

ValueSummary

output formatter options-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

Table 6.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.34. Optional Arguments

ValueSummary

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

Table 6.35. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

6.7. alarm state get

Get state of an alarm

Usage:

openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] [--name <NAME>]
                                 [<ALARM ID or NAME>]

Table 6.36. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.37. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 6.38. Output Formatters

ValueSummary

output formatter options-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

Table 6.39. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.40. Optional Arguments

ValueSummary

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

Table 6.41. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

6.8. alarm state set

Set state of an alarm

Usage:

openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] [--name <NAME>] --state
                                 <STATE>
                                 [<ALARM ID or NAME>]

Table 6.42. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.43. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 6.44. Output Formatters

ValueSummary

output formatter options-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

Table 6.45. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.46. Optional Arguments

ValueSummary

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

--state <STATE>

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

Table 6.47. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

6.9. alarm update

Update an alarm

Usage:

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--name <NAME>] [-t <TYPE>]
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]

Table 6.48. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 6.49. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 6.50. Output Formatters

ValueSummary

output formatter options-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

Table 6.51. common gnocchi alarm rules

ValueSummary

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--granularity <GRANULARITY>

The time range in seconds over which to query.

Table 6.52. event alarm

ValueSummary

--event-type <EVENT_TYPE>

Event type to evaluate against

Table 6.53. gnocchi resource threshold alarm

ValueSummary

--resource-id <RESOURCE_ID>

The id of a resource.

--resource-type <RESOURCE_TYPE>

The type of resource.

Table 6.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.55. composite alarm

ValueSummary

--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]}]}.

Table 6.56. Optional Arguments

ValueSummary

--ok-action <Webhook URL>

Url to invoke when state transitions to ok. may be used multiple times

--user-id <USER_ID>

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

--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.

--repeat-actions {True

False}

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

--state <STATE>

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

--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>]]

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

Url to invoke when state transitions to alarm. may be used multiple times

-h, --help

Show this help message and exit

--description <DESCRIPTION>

Free text description of the alarm

--enabled {True

False}

True if alarm evaluation is enabled

Table 6.57. common alarm rules

ValueSummary

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--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]

--metric <METRIC>

Metric to evaluate against.

--threshold <THRESHOLD>

Threshold to evaluate against.

Table 6.58. gnocchi aggregation by metrics alarm

ValueSummary

--metrics <METRICS>

The list of metric ids.

Table 6.59. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Chapter 7. alarming

This chapter describes the commands under the alarming command.

7.1. alarming capabilities list

List capabilities of alarming service

Usage:

openstack alarming capabilities list [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]

Table 7.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 7.2. Output Formatters

ValueSummary

output formatter options-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

Table 7.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 7.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Chapter 8. availability

This chapter describes the commands under the availability command.

8.1. availability zone list

List availability zones and their status

Usage:

openstack availability zone list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--compute] [--network] [--volume]
                                        [--long]

Table 8.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 8.2. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 8.3. Output Formatters

ValueSummary

output formatter options-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

Table 8.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 8.5. Optional Arguments

ValueSummary

--compute

List compute availability zones

--volume

List volume availability zones

-h, --help

Show this help message and exit

--network

List network availability zones

--long

List additional fields in output

Chapter 9. baremetal

This chapter describes the commands under the baremetal command.

9.1. baremetal chassis create

Create a new chassis.

Usage:

openstack baremetal chassis create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--description <description>]
                                          [--extra <key=value>]
                                          [--uuid <uuid>]

Table 9.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.2. Output Formatters

ValueSummary

output formatter options-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

Table 9.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.4. Optional Arguments

ValueSummary

--uuid <uuid>

Unique uuid of the chassis

-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.

Table 9.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.2. baremetal chassis delete

Delete a chassis.

Usage:

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

Table 9.6. Positional Arguments

ValueSummary

<chassis>

Uuids of chassis to delete

Table 9.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.3. baremetal chassis list

List the chassis.

Usage:

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--fields <field> [<field> ...]]
                                        [--limit <limit>] [--long]
                                        [--marker <chassis>]
                                        [--sort <key>[:<direction>]]

Table 9.8. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.9. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.10. Output Formatters

ValueSummary

output formatter options-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

Table 9.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.12. Optional Arguments

ValueSummary

--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.

--long

Show detailed information about the chassis

--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.

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

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

--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.

-h, --help

Show this help message and exit

9.4. baremetal chassis set

Set chassis properties.

Usage:

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

Table 9.13. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 9.14. Optional Arguments

ValueSummary

-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)

9.5. baremetal chassis show

Show chassis details.

Usage:

openstack baremetal chassis show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--fields <field> [<field> ...]]
                                        <chassis>

Table 9.15. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.16. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 9.17. Output Formatters

ValueSummary

output formatter options-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

Table 9.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.19. Optional Arguments

ValueSummary

-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.

Table 9.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.6. baremetal chassis unset

Unset chassis properties.

Usage:

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>

Table 9.21. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 9.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

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

--description

Clear the chassis description

9.7. baremetal create

Create resources from files

Usage:

openstack baremetal create [-h] <file> [<file> ...]

Table 9.23. Positional Arguments

ValueSummary

<file>

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

Table 9.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.8. baremetal driver list

List the enabled drivers.

Usage:

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--type <type>] [--long]

Table 9.25. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.26. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.27. Output Formatters

ValueSummary

output formatter options-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

Table 9.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.29. Optional Arguments

ValueSummary

--type <type>

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

-h, --help

Show this help message and exit

--long

Show detailed information about the drivers.

9.9. baremetal driver passthru call

Call a vendor passthru method for a driver.

Usage:

openstack baremetal driver passthru call [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--arg <key=value>]
                                                [--http-method <http-method>]
                                                <driver> <method>

Table 9.30. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.31. Positional Arguments

ValueSummary

<method>

Vendor passthru method to be called.

<driver>

Name of the driver.

Table 9.32. Output Formatters

ValueSummary

output formatter options-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

Table 9.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--http-method <http-method>

The http method to use in the passthru request. one of DELETE, GET, PATCH, POST, PUT. Defaults to POST.

--arg <key=value>

Argument to pass to the passthru method (repeat option to specify multiple arguments).

Table 9.35. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.10. baremetal driver passthru list

List available vendor passthru methods for a driver.

Usage:

openstack baremetal driver passthru list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

Table 9.36. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.37. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.38. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.39. Output Formatters

ValueSummary

output formatter options-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

Table 9.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.11. baremetal driver property list

List the driver properties.

Usage:

openstack baremetal driver property list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                <driver>

Table 9.42. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.43. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.44. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.45. Output Formatters

ValueSummary

output formatter options-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

Table 9.46. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.12. baremetal driver raid property list

List a driver’s RAID logical disk properties.

Usage:

openstack baremetal driver raid property list [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--noindent]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--sort-column SORT_COLUMN]
                                                     <driver>

Table 9.48. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.49. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.50. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.51. Output Formatters

ValueSummary

output formatter options-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

Table 9.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.13. baremetal driver show

Show information about a driver.

Usage:

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <driver>

Table 9.54. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.55. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.56. Output Formatters

ValueSummary

output formatter options-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

Table 9.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.59. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.14. baremetal introspection abort

Abort running introspection for node.

Usage:

openstack baremetal introspection abort [-h] node

Table 9.60. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.15. baremetal introspection data save

Save or display raw introspection data.

Usage:

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node

Table 9.62. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded introspection data filename (default: stdout)

9.16. baremetal introspection interface list

List interface data including attached switch port information.

Usage:

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--quote {all,minimal,none,nonnumeric}]
                                                        [--sort-column SORT_COLUMN]
                                                        [--vlan VLAN]
                                                        [--long | --fields <field> [<field> ...]]
                                                        node_ident

Table 9.64. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.65. Positional Arguments

ValueSummary

node_ident

Baremetal node uuid or name

Table 9.66. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.67. Output Formatters

ValueSummary

output formatter options-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

Table 9.68. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--vlan VLAN

List only interfaces configured for this vlan id, can be repeated

--long

Show detailed information about interfaces.

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

Display one or more fields. can not be used when -- long is specified

9.17. baremetal introspection interface show

Show interface data including attached switch port information.

Usage:

openstack baremetal introspection interface show [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--fields <field> [<field> ...]]
                                                        node_ident interface

Table 9.70. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.71. Positional Arguments

ValueSummary

interface

Interface name

node_ident

Baremetal node uuid or name

Table 9.72. Output Formatters

ValueSummary

output formatter options-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

Table 9.73. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Display one or more fields.

Table 9.75. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.18. baremetal introspection list

List introspection statuses

Usage:

openstack baremetal introspection list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--marker MARKER]
                                              [--limit LIMIT]

Table 9.76. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.77. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.78. Output Formatters

ValueSummary

output formatter options-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

Table 9.79. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT

The amount of items to return

--marker MARKER

Uuid of the last item on the previous page

9.19. baremetal introspection reprocess

Reprocess stored introspection data

Usage:

openstack baremetal introspection reprocess [-h] node

Table 9.81. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.20. baremetal introspection rule delete

Delete an introspection rule.

Usage:

openstack baremetal introspection rule delete [-h] uuid

Table 9.83. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 9.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.21. baremetal introspection rule import

Import one or several introspection rules from a json file.

Usage:

openstack baremetal introspection rule import [-h]
                                                     [-f {csv,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--fit-width]
                                                     [--print-empty]
                                                     [--noindent]
                                                     [--quote {all,minimal,none,nonnumeric}]
                                                     [--sort-column SORT_COLUMN]
                                                     file

Table 9.85. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.86. Positional Arguments

ValueSummary

file

Json file to import, may contain one or several rules

Table 9.87. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.88. Output Formatters

ValueSummary

output formatter options-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

Table 9.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.22. baremetal introspection rule list

List all introspection rules.

Usage:

openstack baremetal introspection rule list [-h]
                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--sort-column SORT_COLUMN]

Table 9.91. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.92. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.93. Output Formatters

ValueSummary

output formatter options-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

Table 9.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.23. baremetal introspection rule purge

Drop all introspection rules.

Usage:

openstack baremetal introspection rule purge [-h]

Table 9.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.24. baremetal introspection rule show

Show an introspection rule.

Usage:

openstack baremetal introspection rule show [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   uuid

Table 9.97. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.98. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 9.99. Output Formatters

ValueSummary

output formatter options-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

Table 9.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.101. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.102. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.25. baremetal introspection start

Start the introspection.

Usage:

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--sort-column SORT_COLUMN]
                                               [--wait]
                                               node [node ...]

Table 9.103. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.104. Positional Arguments

ValueSummary

node

Baremetal node uuid(s) or name(s)

Table 9.105. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.106. Output Formatters

ValueSummary

output formatter options-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

Table 9.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for introspection to finish; the result will be displayed in the end

9.26. baremetal introspection status

Get introspection status.

Usage:

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                node

Table 9.109. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.110. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.111. Output Formatters

ValueSummary

output formatter options-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

Table 9.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.114. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.27. baremetal node abort

Set provision state of baremetal node to abort

Usage:

openstack baremetal node abort [-h] <node>

Table 9.115. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.28. baremetal node add trait

Add traits to a node.

Usage:

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

Table 9.117. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to add

Table 9.118. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.29. baremetal node adopt

Set provision state of baremetal node to adopt

Usage:

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

Table 9.119. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.120. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

9.30. baremetal node boot device set

Set the boot device for a node

Usage:

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

Table 9.121. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<device>

One of bios, cdrom, disk, pxe, safe, wanboot

Table 9.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

9.31. baremetal node boot device show

Show the boot device information for a node

Usage:

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--supported]
                                                 <node>

Table 9.123. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.124. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.125. Output Formatters

ValueSummary

output formatter options-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

Table 9.126. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.127. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

Table 9.128. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.32. baremetal node clean

Set provision state of baremetal node to clean

Usage:

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

Table 9.129. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.130. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

--clean-steps <clean-steps>

The clean steps in json format. may be the path to a file containing the clean steps; OR -, with the clean steps being read from standard input; OR a string. The value should be a list of clean-step dictionaries; each dictionary should have keys interface and step, and optional key args.

9.33. baremetal node console disable

Disable console access for a node

Usage:

openstack baremetal node console disable [-h] <node>

Table 9.131. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.34. baremetal node console enable

Enable console access for a node

Usage:

openstack baremetal node console enable [-h] <node>

Table 9.133. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.35. baremetal node console show

Show console information for a node

Usage:

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <node>

Table 9.135. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.136. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.137. Output Formatters

ValueSummary

output formatter options-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

Table 9.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.140. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.36. baremetal node create

Register a new node with the baremetal service

Usage:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--boot-interface <boot_interface>]
                                       [--console-interface <console_interface>]
                                       [--deploy-interface <deploy_interface>]
                                       [--inspect-interface <inspect_interface>]
                                       [--management-interface <management_interface>]
                                       [--network-interface <network_interface>]
                                       [--power-interface <power_interface>]
                                       [--raid-interface <raid_interface>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]

Table 9.141. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.142. Output Formatters

ValueSummary

output formatter options-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

Table 9.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.144. Optional Arguments

ValueSummary

--inspect-interface <inspect_interface>

Inspect interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--boot-interface <boot_interface>

Boot interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--management-interface <management_interface>

Management interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--driver <driver>

Driver used to control the node [required].

--deploy-interface <deploy_interface>

Deploy interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--uuid <uuid>

Unique uuid for the node.

--console-interface <console_interface>

Console interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--chassis-uuid <chassis>

Uuid of the chassis that this node belongs to.

--network-interface <network_interface>

Network interface used for switching node to cleaning/provisioning networks.

--property <key=value>

Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.

--vendor-interface <vendor_interface>

Vendor interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--resource-class <resource_class>

Resource class for mapping nodes to nova flavors

--raid-interface <raid_interface>

Raid interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--storage-interface <storage_interface>

Storage interface used by the node’s driver.

--power-interface <power_interface>

Power interface used by the node’s driver. this is only applicable when the specified --driver is a hardware type.

--name <name>

Unique name for the node.

--driver-info <key=value>

Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.

--extra <key=value>

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

-h, --help

Show this help message and exit

Table 9.145. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.37. baremetal node delete

Unregister baremetal node(s)

Usage:

openstack baremetal node delete [-h] <node> [<node> ...]

Table 9.146. Positional Arguments

ValueSummary

<node>

Node(s) to delete (name or uuid)

Table 9.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.38. baremetal node deploy

Set provision state of baremetal node to deploy

Usage:

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

Table 9.148. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.149. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

--config-drive <config-drive>

A gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files. In case it’s a directory, a config drive will be generated from it.

9.39. baremetal node inject nmi

Inject NMI to baremetal node

Usage:

openstack baremetal node inject nmi [-h] <node>

Table 9.150. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.151. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.40. baremetal node inspect

Set provision state of baremetal node to inspect

Usage:

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

Table 9.152. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.153. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

9.41. baremetal node list

List baremetal nodes

Usage:

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--chassis <chassis UUID>]
                                     [--long | --fields <field> [<field> ...]]

Table 9.154. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.155. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.156. Output Formatters

ValueSummary

output formatter options-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

Table 9.157. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.158. Optional Arguments

ValueSummary

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

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

--chassis <chassis UUID>

Limit list to nodes of this chassis

--resource-class <resource class>

Limit list to nodes with resource class <resource class>

--marker <node>

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

--long

Show detailed information about the nodes.

--provision-state <provision state>

List nodes in specified provision state.

--limit <limit>

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

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

One or more node fields. only these fields will be fetched from the server. Can not be used when --long is specified.

--maintenance

Limit list to nodes in maintenance mode

--unassociated

List only nodes not associated with an instance.

-h, --help

Show this help message and exit

--associated

List only nodes associated with an instance.

--no-maintenance

Limit list to nodes not in maintenance mode

--driver <driver>

Limit list to nodes with driver <driver>

9.42. baremetal node maintenance set

Set baremetal node to maintenance mode

Usage:

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

Table 9.159. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.160. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

9.43. baremetal node maintenance unset

Unset baremetal node from maintenance mode

Usage:

openstack baremetal node maintenance unset [-h] <node>

Table 9.161. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.162. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.44. baremetal node manage

Set provision state of baremetal node to manage

Usage:

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

Table 9.163. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.164. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

9.45. baremetal node passthru call

Call a vendor passthu method for a node

Usage:

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

Table 9.165. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

Table 9.166. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--http-method <http-method>

The http method to use in the passthru request. one of DELETE, GET, PATCH, POST, PUT. Defaults to POST.

--arg <key=value>

Argument to pass to the passthru method (repeat option to specify multiple arguments)

9.46. baremetal node passthru list

List vendor passthru methods for a node

Usage:

openstack baremetal node passthru list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              <node>

Table 9.167. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.168. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.169. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.170. Output Formatters

ValueSummary

output formatter options-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

Table 9.171. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.172. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.47. baremetal node power off

Power off a node

Usage:

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

Table 9.173. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.174. Optional Arguments

ValueSummary

--soft

Request graceful power-off.

-h, --help

Show this help message and exit

--power-timeout <power-timeout>

Timeout (in seconds, positive integer) to wait for the target power state before erroring out.

9.48. baremetal node power on

Power on a node

Usage:

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

Table 9.175. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.176. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--power-timeout <power-timeout>

Timeout (in seconds, positive integer) to wait for the target power state before erroring out.

9.49. baremetal node provide

Set provision state of baremetal node to provide

Usage:

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

Table 9.177. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.178. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, available. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

9.50. baremetal node reboot

Reboot baremetal node

Usage:

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

Table 9.179. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.180. Optional Arguments

ValueSummary

--soft

Request graceful reboot.

-h, --help

Show this help message and exit

--power-timeout <power-timeout>

Timeout (in seconds, positive integer) to wait for the target power state before erroring out.

9.51. baremetal node rebuild

Set provision state of baremetal node to rebuild

Usage:

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

Table 9.181. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.182. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

--config-drive <config-drive>

A gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files. In case it’s a directory, a config drive will be generated from it.

9.52. baremetal node remove trait

Remove trait(s) from a node.

Usage:

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

Table 9.183. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to remove

Table 9.184. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Remove all traits

9.53. baremetal node set

Set baremetal properties

Usage:

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--boot-interface <boot_interface>]
                                    [--console-interface <console_interface>]
                                    [--deploy-interface <deploy_interface>]
                                    [--inspect-interface <inspect_interface>]
                                    [--management-interface <management_interface>]
                                    [--network-interface <network_interface>]
                                    [--power-interface <power_interface>]
                                    [--raid-interface <raid_interface>]
                                    [--storage-interface <storage_interface>]
                                    [--vendor-interface <vendor_interface>]
                                    [--resource-class <resource_class>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    <node>

Table 9.185. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.186. Optional Arguments

ValueSummary

--instance-uuid <uuid>

Set instance uuid of node to <uuid>

--inspect-interface <inspect_interface>

Set the inspect interface for the node

--boot-interface <boot_interface>

Set the boot interface for the node

--management-interface <management_interface>

Set the management interface for the node

--driver <driver>

Set the driver for the node

--extra <key=value>

Extra to set on this baremetal node (repeat option to set multiple extras)

--deploy-interface <deploy_interface>

Set the deploy interface for the node

--name <name>

Set the name of the node

--console-interface <console_interface>

Set the console interface for the node

--power-interface <power_interface>

Set the power interface for the node

--network-interface <network_interface>

Set the network interface for the node

--property <key=value>

Property to set on this baremetal node (repeat option to set multiple properties)

--vendor-interface <vendor_interface>

Set the vendor interface for the node

--resource-class <resource_class>

Set the resource class for the node

--chassis-uuid <chassis UUID>

Set the chassis for the node

--raid-interface <raid_interface>

Set the raid interface for the node

--storage-interface <storage_interface>

Set the storage interface for the node

--instance-info <key=value>

Instance information to set on this baremetal node (repeat option to set multiple instance infos)

--driver-info <key=value>

Driver information to set on this baremetal node (repeat option to set multiple driver infos)

-h, --help

Show this help message and exit

--target-raid-config <target_raid_config>

Set the target raid configuration (json) for the node. This can be one of: 1. a file containing JSON data of the RAID configuration; 2. "-" to read the contents from standard input; or 3. a valid JSON string.

9.54. baremetal node show

Show baremetal node details

Usage:

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>

Table 9.187. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.188. Positional Arguments

ValueSummary

<node>

Name or uuid of the node (or instance uuid if --instance is specified)

Table 9.189. Output Formatters

ValueSummary

output formatter options-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

Table 9.190. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.191. Optional Arguments

ValueSummary

--instance

<node> is an instance uuid.

-h, --help

Show this help message and exit

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

One or more node fields. only these fields will be fetched from the server.

Table 9.192. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.55. baremetal node trait list

List a node’s traits.

Usage:

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <node>

Table 9.193. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.194. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.195. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.196. Output Formatters

ValueSummary

output formatter options-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

Table 9.197. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.198. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.56. baremetal node undeploy

Set provision state of baremetal node to deleted

Usage:

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

Table 9.199. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.200. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, available. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

9.57. baremetal node unset

Unset baremetal properties

Usage:

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--boot-interface] [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--storage-interface]
                                      [--vendor-interface]
                                      <node>

Table 9.201. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.202. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal node (repeat option to unset multiple properties)

--storage-interface

Unset storage interface on this baremetal node

--instance-uuid

Unset instance uuid on this baremetal node

--deploy-interface

Unset deploy interface on this baremetal node

--vendor-interface

Unset vendor interface on this baremetal node

--network-interface

Unset network interface on this baremetal node

--instance-info <key>

Instance information to unset on this baremetal node (repeat option to unset multiple instance informations)

--driver-info <key>

Driver information to unset on this baremetal node (repeat option to unset multiple driver informations)

--extra <key>

Extra to unset on this baremetal node (repeat option to unset multiple extras)

--resource-class

Unset the resource class of the node

--management-interface

Unset management interface on this baremetal node

--boot-interface

Unset boot interface on this baremetal node

--raid-interface

Unset raid interface on this baremetal node

--console-interface

Unset console interface on this baremetal node

--target-raid-config

Unset the target raid configuration of the node

--name

Unset the name of the node

-h, --help

Show this help message and exit

--inspect-interface

Unset inspect interface on this baremetal node

--chassis-uuid

Unset chassis uuid on this baremetal node

--power-interface

Unset power interface on this baremetal node

9.58. baremetal node validate

Validate a node’s driver interfaces

Usage:

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>

Table 9.203. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.204. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.205. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.206. Output Formatters

ValueSummary

output formatter options-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

Table 9.207. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.208. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.59. baremetal node vif attach

Attach VIF to a given node

Usage:

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

Table 9.209. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

Name or uuid of the vif to attach to a node.

Table 9.210. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--vif-info <key=value>

Record arbitrary key/value metadata. can be specified multiple times. The mandatory id parameter cannot be specified as a key.

9.60. baremetal node vif detach

Detach VIF from a given node

Usage:

openstack baremetal node vif detach [-h] <node> <vif-id>

Table 9.211. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

Name or uuid of the vif to detach from a node.

Table 9.212. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.61. baremetal node vif list

Show attached VIFs for a node

Usage:

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>

Table 9.213. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.214. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.215. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.216. Output Formatters

ValueSummary

output formatter options-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

Table 9.217. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.218. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.62. baremetal port create

Create a new port

Usage:

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX] --node
                                       <uuid> [--uuid <uuid>]
                                       [--extra <key=value>]
                                       [--local-link-connection <key=value>]
                                       [-l <key=value>]
                                       [--pxe-enabled <boolean>]
                                       [--port-group <uuid>]
                                       [--physical-network <physical network>]
                                       <address>

Table 9.219. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.220. Positional Arguments

ValueSummary

<address>

Mac address for this port.

Table 9.221. Output Formatters

ValueSummary

output formatter options-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

Table 9.222. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.223. Optional Arguments

ValueSummary

--extra <key=value>

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

--physical-network <physical network>

Name of the physical network to which this port is connected.

--uuid <uuid>

Uuid of the port.

--port-group <uuid>

Uuid of the port group that this port belongs to.

--local-link-connection <key=value>

Key/value metadata describing local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

--pxe-enabled <boolean>

Indicates whether this port should be used when pxe booting this Node.

-l <key=value>

Deprecated. please use --local-link-connection instead. Key/value metadata describing Local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this port belongs to.

Table 9.224. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.63. baremetal port delete

Delete port(s).

Usage:

openstack baremetal port delete [-h] <port> [<port> ...]

Table 9.225. Positional Arguments

ValueSummary

<port>

Uuid(s) of the port(s) to delete.

Table 9.226. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.64. baremetal port group create

Create a new baremetal port group.

Usage:

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

Table 9.227. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.228. Output Formatters

ValueSummary

output formatter options-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

Table 9.229. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.230. Optional Arguments

ValueSummary

--support-standalone-ports

Ports that are members of this port group can be used as stand-alone ports. (default)

--extra <key=value>

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

--address <mac-address>

Mac address for this port group.

--unsupport-standalone-ports

Ports that are members of this port group cannot be used as stand-alone ports.

--property <key=value>

Key/value property related to this port group’s configuration. Can be specified multiple times.

--mode MODE

Mode of the port group. for possible values, refer to https://www.kernel.org/doc/Documentation/networking/bo nding.txt.

--name NAME

Name of the port group.

-h, --help

Show this help message and exit

--uuid UUID

Uuid of the port group.

--node <uuid>

Uuid of the node that this port group belongs to.

Table 9.231. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.65. baremetal port group delete

Unregister baremetal port group(s).

Usage:

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

Table 9.232. Positional Arguments

ValueSummary

<port group>

Port group(s) to delete (name or uuid).

Table 9.233. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.66. baremetal port group list

List baremetal port groups.

Usage:

openstack baremetal port group list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--marker <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

Table 9.234. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.235. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.236. Output Formatters

ValueSummary

output formatter options-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

Table 9.237. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.238. Optional Arguments

ValueSummary

--node <node>

Only list port groups of this node (name or uuid).

--address <mac-address>

Only show information for the port group with this mac address.

--long

Show detailed information about the port groups.

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

One or more port group fields. only these fields will be fetched from the server. Can not be used when -- long is specified.

--limit <limit>

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

--marker <port group>

Port group uuid (for example, of the last port group in the list from a previous request). Returns the list of port groups after this UUID.

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

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

-h, --help

Show this help message and exit

9.67. baremetal port group set

Set baremetal port group properties.

Usage:

openstack baremetal port group set [-h] [--node <uuid>]
                                          [--address <mac-address>]
                                          [--name <name>]
                                          [--extra <key=value>] [--mode MODE]
                                          [--property <key=value>]
                                          [--support-standalone-ports | --unsupport-standalone-ports]
                                          <port group>

Table 9.239. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 9.240. Optional Arguments

ValueSummary

--support-standalone-ports

Ports that are members of this port group can be used as stand-alone ports.

--extra <key=value>

Extra to set on this baremetal port group (repeat option to set multiple extras).

--address <mac-address>

Mac address for this port group.

--unsupport-standalone-ports

Ports that are members of this port group cannot be used as stand-alone ports.

--property <key=value>

Key/value property related to this port group’s configuration (repeat option to set multiple properties).

--mode MODE

Mode of the port group. for possible values, refer to https://www.kernel.org/doc/Documentation/networking/bo nding.txt.

--name <name>

Name of the port group.

-h, --help

Show this help message and exit

--node <uuid>

Update uuid of the node that this port group belongs to.

9.68. baremetal port group show

Show baremetal port group details.

Usage:

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

Table 9.241. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.242. Positional Arguments

ValueSummary

<id>

Uuid or name of the port group (or mac address if --address is specified).

Table 9.243. Output Formatters

ValueSummary

output formatter options-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

Table 9.244. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.245. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--address

<id> is the mac address (instead of uuid or name) of the port group.

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

One or more port group fields. only these fields will be fetched from the server.

Table 9.246. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.69. baremetal port group unset

Unset baremetal port group properties.

Usage:

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

Table 9.247. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 9.248. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal port group (repeat option to unset multiple properties).

--name

Unset the name of the port group.

-h, --help

Show this help message and exit

--address

Unset the address of the port group.

--extra <key>

Extra to unset on this baremetal port group (repeat option to unset multiple extras).

9.70. baremetal port list

List baremetal ports.

Usage:

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

Table 9.249. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.250. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.251. Output Formatters

ValueSummary

output formatter options-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

Table 9.252. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.253. Optional Arguments

ValueSummary

--node <node>

Only list ports of this node (name or uuid).

--address <mac-address>

Only show information for the port with this mac address.

--marker <port>

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

--long

Show detailed information about ports.

--port-group <port group>

Only list ports of this port group (name or uuid).

--limit <limit>

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

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

One or more port fields. only these fields will be fetched from the server. Can not be used when --long is specified.

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

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

-h, --help

Show this help message and exit

9.71. baremetal port set

Set baremetal port properties.

Usage:

openstack baremetal port set [-h] [--node <uuid>] [--address <address>]
                                    [--extra <key=value>]
                                    [--port-group <uuid>]
                                    [--local-link-connection <key=value>]
                                    [--pxe-enabled | --pxe-disabled]
                                    [--physical-network <physical network>]
                                    <port>

Table 9.254. Positional Arguments

ValueSummary

<port>

Uuid of the port

Table 9.255. Optional Arguments

ValueSummary

--pxe-enabled

Indicates that this port should be used when pxe booting this node (default)

--extra <key=value>

Extra to set on this baremetal port (repeat option to set multiple extras)

--pxe-disabled

Indicates that this port should not be used when pxe booting this node

--port-group <uuid>

Set uuid of the port group that this port belongs to.

--local-link-connection <key=value>

Key/value metadata describing local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

--physical-network <physical network>

Set the name of the physical network to which this port is connected.

-h, --help

Show this help message and exit

--node <uuid>

Set uuid of the node that this port belongs to

--address <address>

Set mac address for this port

9.72. baremetal port show

Show baremetal port details.

Usage:

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>

Table 9.256. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.257. Positional Arguments

ValueSummary

<id>

Uuid of the port (or mac address if --address is specified).

Table 9.258. Output Formatters

ValueSummary

output formatter options-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

Table 9.259. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.260. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--address

<id> is the mac address (instead of the uuid) of the port.

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

One or more port fields. only these fields will be fetched from the server.

Table 9.261. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.73. baremetal port unset

Unset baremetal port properties.

Usage:

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network]
                                      <port>

Table 9.262. Positional Arguments

ValueSummary

<port>

Uuid of the port.

Table 9.263. Optional Arguments

ValueSummary

--port-group

Remove port from the port group

-h, --help

Show this help message and exit

--extra <key>

Extra to unset on this baremetal port (repeat option to unset multiple extras)

--physical-network

Unset the physical network on this baremetal port.

9.74. baremetal volume connector create

Create a new baremetal volume connector.

Usage:

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

Table 9.264. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.265. Output Formatters

ValueSummary

output formatter options-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

Table 9.266. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.267. Optional Arguments

ValueSummary

--node <uuid>

Uuid of the node that this volume connector belongs to.

--uuid <uuid>

Uuid of the volume connector.

--type <type>

Type of the volume connector. can be iqn, ip, mac, wwnn, wwpn, port, portgroup.

--extra <key=value>

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

-h, --help

Show this help message and exit

--connector-id <connector id>

Id of the volume connector in the specified type. for example, the iSCSI initiator IQN for the node if the type is iqn.

Table 9.268. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.75. baremetal volume connector delete

Unregister baremetal volume connector(s).

Usage:

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

Table 9.269. Positional Arguments

ValueSummary

<volume connector>

Uuid(s) of the volume connector(s) to delete.

Table 9.270. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.76. baremetal volume connector list

List baremetal volume connectors.

Usage:

openstack baremetal volume connector list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--node <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

Table 9.271. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.272. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.273. Output Formatters

ValueSummary

output formatter options-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

Table 9.274. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.275. Optional Arguments

ValueSummary

--node <node>

Only list volume connectors of this node (name or UUID).

--long

Show detailed information about volume connectors.

--limit <limit>

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

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

One or more volume connector fields. only these fields will be fetched from the server. Can not be used when --long is specified.

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

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

-h, --help

Show this help message and exit

--marker <volume connector>

Volume connector uuid (for example, of the last volume connector in the list from a previous request). Returns the list of volume connectors after this UUID.

9.77. baremetal volume connector set

Set baremetal volume connector properties.

Usage:

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

Table 9.276. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

Table 9.277. Optional Arguments

ValueSummary

--extra <key=value>

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

--type <type>

Type of the volume connector. can be iqn, ip, mac, wwnn, wwpn, port, portgroup.

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this volume connector belongs to.

--connector-id <connector id>

Id of the volume connector in the specified type.

9.78. baremetal volume connector show

Show baremetal volume connector details.

Usage:

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

Table 9.278. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.279. Positional Arguments

ValueSummary

<id>

Uuid of the volume connector.

Table 9.280. Output Formatters

ValueSummary

output formatter options-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

Table 9.281. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.282. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

One or more volume connector fields. only these fields will be fetched from the server.

Table 9.283. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.79. baremetal volume connector unset

Unset baremetal volume connector properties.

Usage:

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

Table 9.284. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

Table 9.285. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

9.80. baremetal volume target create

Create a new baremetal volume target.

Usage:

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

Table 9.286. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.287. Output Formatters

ValueSummary

output formatter options-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

Table 9.288. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.289. Optional Arguments

ValueSummary

--extra <key=value>

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

--uuid <uuid>

Uuid of the volume target.

--property <key=value>

Key/value property related to the type of this volume target. Can be specified multiple times.

--boot-index <boot index>

Boot index of the volume target.

--type <volume type>

Type of the volume target, e.g. iscsi, fibre_channel.

-h, --help

Show this help message and exit

--volume-id <volume id>

Id of the volume associated with this target.

--node <uuid>

Uuid of the node that this volume target belongs to.

Table 9.290. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.81. baremetal volume target delete

Unregister baremetal volume target(s).

Usage:

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

Table 9.291. Positional Arguments

ValueSummary

<volume target>

Uuid(s) of the volume target(s) to delete.

Table 9.292. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.82. baremetal volume target list

List baremetal volume targets.

Usage:

openstack baremetal volume target list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--node <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

Table 9.293. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.294. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.295. Output Formatters

ValueSummary

output formatter options-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

Table 9.296. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.297. Optional Arguments

ValueSummary

--node <node>

Only list volume targets of this node (name or uuid).

--marker <volume target>

Volume target uuid (for example, of the last volume target in the list from a previous request). Returns the list of volume targets after this UUID.

--long

Show detailed information about volume targets.

--limit <limit>

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

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

One or more volume target fields. only these fields will be fetched from the server. Can not be used when --long is specified.

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

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

-h, --help

Show this help message and exit

9.83. baremetal volume target set

Set baremetal volume target properties.

Usage:

openstack baremetal volume target set [-h] [--node <uuid>]
                                             [--type <volume type>]
                                             [--property <key=value>]
                                             [--boot-index <boot index>]
                                             [--volume-id <volume id>]
                                             [--extra <key=value>]
                                             <volume target>

Table 9.298. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 9.299. Optional Arguments

ValueSummary

--extra <key=value>

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

--property <key=value>

Key/value property related to the type of this volume target. Can be specified multiple times.

--boot-index <boot index>

Boot index of the volume target.

--type <volume type>

Type of the volume target, e.g. iscsi, fibre_channel.

-h, --help

Show this help message and exit

--volume-id <volume id>

Id of the volume associated with this target.

--node <uuid>

Uuid of the node that this volume target belongs to.

9.84. baremetal volume target show

Show baremetal volume target details.

Usage:

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--fields <field> [<field> ...]]
                                              <id>

Table 9.300. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 9.301. Positional Arguments

ValueSummary

<id>

Uuid of the volume target.

Table 9.302. Output Formatters

ValueSummary

output formatter options-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

Table 9.303. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.304. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

One or more volume target fields. only these fields will be fetched from the server.

Table 9.305. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.85. baremetal volume target unset

Unset baremetal volume target properties.

Usage:

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

Table 9.306. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 9.307. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal volume target (repeat option to unset multiple properties).

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

Chapter 10. bgp

This chapter describes the commands under the bgp command.

10.1. bgp dragent add speaker

Add a BGP speaker to a dynamic routing agent

Usage:

openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>

Table 10.1. Positional Arguments

ValueSummary

<agent-id>

Id of the dynamic routing agent

<bgp-speaker>

Id or name of the bgp speaker

Table 10.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.2. bgp dragent remove speaker

Removes a BGP speaker from a dynamic routing agent

Usage:

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>

Table 10.3. Positional Arguments

ValueSummary

<agent-id>

Id of the dynamic routing agent

<bgp-speaker>

Id or name of the bgp speaker

Table 10.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.3. bgp peer create

Create a BGP peer

Usage:

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --peer-ip <peer-ip-address>
                                 --remote-as <peer-remote-as>
                                 [--auth-type <peer-auth-type>]
                                 [--password <auth-password>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 <name>

Table 10.5. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.6. Positional Arguments

ValueSummary

<name>

Name of the bgp peer to create

Table 10.7. Output Formatters

ValueSummary

output formatter options-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

Table 10.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.9. Optional Arguments

ValueSummary

--remote-as <peer-remote-as>

Peer as number. (integer in [1, 65535] is allowed)

--auth-type <peer-auth-type>

Authentication algorithm. supported algorithms: none (default), md5

--peer-ip <peer-ip-address>

Peer ip address

--project-domain <project-domain>

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

--password <auth-password>

Authentication password

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

Table 10.10. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

10.4. bgp peer delete

Delete a BGP peer

Usage:

openstack bgp peer delete [-h] <bgp-peer>

Table 10.11. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to delete (name or id)

Table 10.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.5. bgp peer list

List BGP peers

Usage:

openstack bgp peer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN]

Table 10.13. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.14. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 10.15. Output Formatters

ValueSummary

output formatter options-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

Table 10.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.6. bgp peer set

Update a BGP peer

Usage:

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

Table 10.18. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to update (name or id)

Table 10.19. Optional Arguments

ValueSummary

--password <auth-password>

Updated authentication password

-h, --help

Show this help message and exit

--name NAME

Updated name of the bgp peer

10.7. bgp peer show

Show information for a BGP peer

Usage:

openstack bgp peer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <bgp-peer>

Table 10.20. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.21. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to display (name or id)

Table 10.22. Output Formatters

ValueSummary

output formatter options-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

Table 10.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 10.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

10.8. bgp speaker add network

Add a network to a BGP speaker

Usage:

openstack bgp speaker add network [-h] <bgp-speaker> <network>

Table 10.26. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<network>

Network to add (name or id)

Table 10.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.9. bgp speaker add peer

Add a peer to a BGP speaker

Usage:

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

Table 10.28. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to add (name or id)

<bgp-speaker>

Bgp speaker (name or id)

Table 10.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.10. bgp speaker create

Create a BGP speaker

Usage:

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] --local-as <local-as>
                                    [--ip-version {4,6}]
                                    [--advertise-floating-ip-host-routes]
                                    [--no-advertise-floating-ip-host-routes]
                                    [--advertise-tenant-networks]
                                    [--no-advertise-tenant-networks]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <name>

Table 10.30. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.31. Positional Arguments

ValueSummary

<name>

Name of the bgp speaker to create

Table 10.32. Output Formatters

ValueSummary

output formatter options-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

Table 10.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.34. Optional Arguments

ValueSummary

--no-advertise-floating-ip-host-routes

Disable the advertisement of floating ip host routes by the BGP speaker.

--project-domain <project-domain>

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

--no-advertise-tenant-networks

Disable the advertisement of tenant network routes by the BGP speaker.

--ip-version {4,6}

Ip version for the bgp speaker (default is 4)

--advertise-floating-ip-host-routes

Enable the advertisement of floating ip host routes by the BGP speaker. (default)

--local-as <local-as>

Local as number. (integer in [1, 65535] is allowed.)

--advertise-tenant-networks

Enable the advertisement of tenant network routes by the BGP speaker. (default)

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

Table 10.35. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

10.11. bgp speaker delete

Delete a BGP speaker

Usage:

openstack bgp speaker delete [-h] <bgp-speaker>

Table 10.36. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to delete (name or id)

Table 10.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.12. bgp speaker list advertised routes

List routes advertised

Usage:

openstack bgp speaker list advertised routes [-h]
                                                    [-f {csv,json,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--noindent]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--sort-column SORT_COLUMN]
                                                    <bgp-speaker>

Table 10.38. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.39. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

Table 10.40. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 10.41. Output Formatters

ValueSummary

output formatter options-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

Table 10.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.43. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.13. bgp speaker list

List BGP speakers

Usage:

openstack bgp speaker list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--agent <agent-id>]

Table 10.44. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.45. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 10.46. Output Formatters

ValueSummary

output formatter options-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

Table 10.47. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--agent <agent-id>

List bgp speakers hosted by an agent (id only)

10.14. bgp speaker remove network

Remove a network from a BGP speaker

Usage:

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

Table 10.49. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<network>

Network to remove (name or id)

Table 10.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.15. bgp speaker remove peer

Remove a peer from a BGP speaker

Usage:

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

Table 10.51. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to remove (name or id)

<bgp-speaker>

Bgp speaker (name or id)

Table 10.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.16. bgp speaker set

Set BGP speaker properties

Usage:

openstack bgp speaker set [-h] [--name NAME]
                                 [--advertise-floating-ip-host-routes]
                                 [--no-advertise-floating-ip-host-routes]
                                 [--advertise-tenant-networks]
                                 [--no-advertise-tenant-networks]
                                 <bgp-speaker>

Table 10.53. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to update (name or id)

Table 10.54. Optional Arguments

ValueSummary

--no-advertise-floating-ip-host-routes

Disable the advertisement of floating ip host routes by the BGP speaker.

--no-advertise-tenant-networks

Disable the advertisement of tenant network routes by the BGP speaker.

--advertise-floating-ip-host-routes

Enable the advertisement of floating ip host routes by the BGP speaker. (default)

--name NAME

Name of the bgp speaker to update

--advertise-tenant-networks

Enable the advertisement of tenant network routes by the BGP speaker. (default)

-h, --help

Show this help message and exit

10.17. bgp speaker show dragents

List dynamic routing agents hosting a BGP speaker

Usage:

openstack bgp speaker show dragents [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <bgp-speaker>

Table 10.55. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.56. Positional Arguments

ValueSummary

<bgp-speaker>

Id or name of the bgp speaker

Table 10.57. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 10.58. Output Formatters

ValueSummary

output formatter options-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

Table 10.59. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

10.18. bgp speaker show

Show a BGP speaker

Usage:

openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <bgp-speaker>

Table 10.61. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 10.62. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to display (name or id)

Table 10.63. Output Formatters

ValueSummary

output formatter options-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

Table 10.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.65. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 10.66. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Chapter 11. bgpvpn

This chapter describes the commands under the bgpvpn command.

11.1. bgpvpn create

Create BGP VPN resource

Usage:

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--project <project>]
                               [--project-domain <project-domain>]
                               [--name <name>] [--route-target <route-target>]
                               [--import-target <import-target>]
                               [--export-target <export-target>]
                               [--route-distinguisher <route-distinguisher>]
                               [--vni VNI] [--type {l2,l3}]

Table 11.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 11.2. Output Formatters

ValueSummary

output formatter options-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

Table 11.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.4. Optional Arguments

Value