Command Line Interface Reference

Red Hat OpenStack Platform 15

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation Team

Abstract

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

Preface

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

Chapter 1. The OpenStack Client

The openstack client is a common OpenStack command-line interface (CLI).

1.1. openstack

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-identity-api-version <identity-api-version>]
               [--os-image-api-version <image-api-version>]
               [--os-network-api-version <network-api-version>]
               [--os-object-api-version <object-api-version>]
               [--os-volume-api-version <volume-api-version>]
               [--os-queues-api-version <queues-api-version>]
               [--os-database-api-version <database-api-version>]
               [--os-data-processing-api-version <data-processing-api-version>]
               [--os-data-processing-url OS_DATA_PROCESSING_URL]
               [--os-loadbalancer-api-version <loadbalancer-api-version>]
               [--os-workflow-api-version <workflow-api-version>]
               [--os-container-infra-api-version <container-infra-api-version>]
               [--os-baremetal-api-version <baremetal-api-version>]
               [--inspector-api-version INSPECTOR_API_VERSION]
               [--inspector-url INSPECTOR_URL]
               [--os-orchestration-api-version <orchestration-api-version>]
               [--os-dns-api-version <dns-api-version>]
               [--os-key-manager-api-version <key-manager-api-version>]
               [--os-alarming-api-version <alarming-api-version>]
               [--os-auth-type <auth-type>] [--os-auth-url <auth-auth-url>]
               [--os-system-scope <auth-system-scope>]
               [--os-domain-id <auth-domain-id>]
               [--os-domain-name <auth-domain-name>]
               [--os-project-id <auth-project-id>]
               [--os-project-name <auth-project-name>]
               [--os-project-domain-id <auth-project-domain-id>]
               [--os-project-domain-name <auth-project-domain-name>]
               [--os-trust-id <auth-trust-id>]
               [--os-default-domain-id <auth-default-domain-id>]
               [--os-default-domain-name <auth-default-domain-name>]
               [--os-token <auth-token>]
               [--os-identity-provider <auth-identity-provider>]
               [--os-protocol <auth-protocol>]
               [--os-client-id <auth-client-id>]
               [--os-client-secret <auth-client-secret>]
               [--os-openid-scope <auth-openid-scope>]
               [--os-access-token-endpoint <auth-access-token-endpoint>]
               [--os-discovery-endpoint <auth-discovery-endpoint>]
               [--os-access-token-type <auth-access-token-type>]
               [--os-redirect-uri <auth-redirect-uri>]
               [--os-code <auth-code>]
               [--os-identity-provider-url <auth-identity-provider-url>]
               [--os-username <auth-username>]
               [--os-password <auth-password>] [--os-user-id <auth-user-id>]
               [--os-user-domain-id <auth-user-domain-id>]
               [--os-user-domain-name <auth-user-domain-name>]
               [--os-passcode <auth-passcode>]
               [--os-endpoint <auth-endpoint>] [--os-roles <auth-roles>]
               [--os-aodh-endpoint <auth-aodh-endpoint>]
               [--os-application-credential-secret <auth-application-credential-secret>]
               [--os-application-credential-id <auth-application-credential-id>]
               [--os-application-credential-name <auth-application-credential-name>]
               [--os-access-token <auth-access-token>] [--os-url <auth-url>]
               [--os-consumer-key <auth-consumer-key>]
               [--os-consumer-secret <auth-consumer-secret>]
               [--os-access-key <auth-access-key>]
               [--os-access-secret <auth-access-secret>]
               [--os-service-provider-endpoint <auth-service-provider-endpoint>]
               [--os-service-provider-entity-id <auth-service-provider-entity-id>]

Command-line interface to the OpenStack APIs

Table 1.1. Optional Arguments

ValueSummary

--version

Show program’s version number and exit

-v, --verbose

Increase verbosity of output. can be repeated.

-q, --quiet

Suppress output except warnings and errors.

--log-file LOG_FILE

Specify a file to log output. disabled by default.

-h, --help

Show help message and exit.

--debug

Show tracebacks on errors.

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

Cloud name in clouds.yaml (Env: OS_CLOUD)

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

Authentication region name (Env: OS_REGION_NAME)

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

CA certificate bundle file (Env: OS_CACERT)

--os-cert <certificate-file>

Client certificate bundle file (Env: OS_CERT)

--os-key <key-file>

Client certificate key file (env: os_key)

--verify

Verify server certificate (default)

--insecure

Disable server certificate verification

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

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

--os-interface <interface>

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

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

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

--timing

Print api call timing info

--os-beta-command

Enable beta commands which are subject to change

--os-profile hmac-key

HMAC key for encrypting profiling context data

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing API URL, (Env: OS_DATA_PROCESSING_API_URL)

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

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

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

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

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

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

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

--inspector-url INSPECTOR_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

With token: Project ID to scope to With v3token: Project ID to scope to With v3oidcauthcode: Project ID to scope to With v3oidcclientcredentials: 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 v3oidcpassword: Project ID to scope to With v3applicationcredential: Project ID to scope to With v3password: Project ID to scope to With v3oidcaccesstoken: Project ID to scope to With noauth: Project ID With v3tokenlessauth: Project ID to scope to With password: Project ID to scope to With v3adfspassword: Project ID to scope to (Env: OS_PROJECT_ID)

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

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

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

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

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

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

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

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

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

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. 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. (Env: OS_DEFAULT_DOMAIN_ID)

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

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. 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. (Env: OS_DEFAULT_DOMAIN_NAME)

--os-token <auth-token>

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

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

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

--os-protocol <auth-protocol>

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

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

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

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

--os-code <auth-code>

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

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

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

--os-username <auth-username>

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

--os-password <auth-password>

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

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

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

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

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

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

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

--os-passcode <auth-passcode>

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

--os-endpoint <auth-endpoint>

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

--os-roles <auth-roles>

With aodh-noauth: Roles (Env: OS_ROLES)

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

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

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

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

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

With v3applicationcredential: Application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

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

With v3applicationcredential: Application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

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

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

--os-url <auth-url>

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

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

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

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

With v3oauth1: OAuth Consumer Secret (Env: OS_CONSUMER_SECRET)

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

With v3oauth1: OAuth Access Key (Env: OS_ACCESS_KEY)

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

With v3oauth1: OAuth Access Secret (Env: OS_ACCESS_SECRET)

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

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

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

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

Chapter 2. access

This chapter describes the commands under the access command.

2.1. access token create

Usage:

openstack access token create [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--noindent]
                                   [--prefix PREFIX] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   --consumer-key <consumer-key>
                                   --consumer-secret <consumer-secret>
                                   --request-key <request-key>
                                   --request-secret <request-secret>
                                   --verifier <verifier>

Create an access token

Table 2.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--consumer-key <consumer-key>

Consumer key (required)

--consumer-secret <consumer-secret>

Consumer secret (required)

--request-key <request-key>

Request token to exchange for access token (required)

--request-secret <request-secret>

Secret associated with <request-key> (required)

--verifier <verifier>

Verifier associated with <request-key> (required)

Table 2.2. Output Formatters

ValueSummary

-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 2.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.4. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 2.5. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Chapter 3. acl

This chapter describes the commands under the acl command.

3.1. acl delete

Usage:

openstack acl delete [-h] URI

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

Table 3.1. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 3.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-barbicanclient plugin.

3.2. acl get

Usage:

openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                       [--quote {all,minimal,none,nonnumeric}] [--noindent]
                       [--max-width <integer>] [--fit-width] [--print-empty]
                       [--sort-column SORT_COLUMN]
                       URI

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

Table 3.3. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 3.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 3.5. Output Formatters

ValueSummary

-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.6. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 3.7. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.8. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-barbicanclient plugin.

3.3. acl submit

Usage:

openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                          [--quote {all,minimal,none,nonnumeric}]
                          [--noindent] [--max-width <integer>] [--fit-width]
                          [--print-empty] [--sort-column SORT_COLUMN]
                          [--user [USERS]]
                          [--project-access | --no-project-access]
                          [--operation-type {read}]
                          URI

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

Table 3.9. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 3.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

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

Type of Barbican operation ACL is set for

Table 3.11. Output Formatters

ValueSummary

-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.12. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 3.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.14. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-barbicanclient plugin.

3.4. acl user add

Usage:

openstack acl user add [-h] [-f {csv,json,table,value,yaml}]

                            [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>]
                            [--fit-width] [--print-empty]
                            [--sort-column SORT_COLUMN] [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI

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

Table 3.15. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 3.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

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

Type of Barbican operation ACL is set for

Table 3.17. Output Formatters

ValueSummary

-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.18. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 3.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.20. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-barbicanclient plugin.

3.5. acl user remove

Usage:

openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]

                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--user [USERS]]
                               [--project-access | --no-project-access]
                               [--operation-type {read}]
                               URI

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

Table 3.21. Positional Arguments

ValueSummary

URI

The uri reference for the secret or container.

Table 3.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Keystone userid(s) for ACL.

--project-access

Flag to enable project access behavior.

--no-project-access

Flag to disable project access behavior.

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

Type of Barbican operation ACL is set for

Table 3.23. Output Formatters

ValueSummary

-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.24. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 3.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 3.26. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-barbicanclient plugin.

Chapter 4. action

This chapter describes the commands under the action command.

4.1. action definition create

Usage:

openstack action definition create [-h]

                                        [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--marker [MARKER]]
                                        [--limit [LIMIT]]
                                        [--sort_keys [SORT_KEYS]]
                                        [--sort_dirs [SORT_DIRS]]
                                        [--filter FILTERS] [--public]
                                        definition

Create new action.

Table 4.1. Positional Arguments

ValueSummary

definition

Action definition file

Table 4.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list

--sort_keys=id,description

 

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. Default: asc. Example: mistral execution-list

--sort_keys=id,description --sort_dirs=asc,desc

 

--filter FILTERS

Filters. can be repeated.

--public

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

Table 4.3. Output Formatters

ValueSummary

-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.4. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 4.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.2. action definition definition show

Usage:

openstack action definition definition show [-h] name

Show action definition.

Table 4.7. Positional Arguments

ValueSummary

name

Action name

Table 4.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

4.3. action definition delete

Usage:

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

Delete action.

Table 4.9. Positional Arguments

ValueSummary

action

Name or id of action(s).

Table 4.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

4.4. action definition list

Usage:

openstack action definition list [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--marker [MARKER]] [--limit [LIMIT]]
                                      [--sort_keys [SORT_KEYS]]
                                      [--sort_dirs [SORT_DIRS]]
                                      [--filter FILTERS]

List all actions.

Table 4.11. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list

--sort_keys=id,description

 

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. Default: asc. Example: mistral execution-list

--sort_keys=id,description --sort_dirs=asc,desc

 

--filter FILTERS

Filters. can be repeated.

Table 4.12. Output Formatters

ValueSummary

-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.13. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 4.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.15. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.5. action definition show

Usage:

openstack action definition show [-h]

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

Show specific action.

Table 4.16. Positional Arguments

ValueSummary

action

Action (name or id)

Table 4.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 4.18. Output Formatters

ValueSummary

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

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 4.21. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.6. action definition update

Usage:

openstack action definition update [-h]

                                        [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--marker [MARKER]]
                                        [--limit [LIMIT]]
                                        [--sort_keys [SORT_KEYS]]
                                        [--sort_dirs [SORT_DIRS]]
                                        [--filter FILTERS] [--id ID]
                                        [--public]
                                        definition

Update action.

Table 4.22. Positional Arguments

ValueSummary

definition

Action definition file

Table 4.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list

--sort_keys=id,description

 

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. Default: asc. Example: mistral execution-list

--sort_keys=id,description --sort_dirs=asc,desc

 

--filter FILTERS

Filters. can be repeated.

--id ID

Action id.

--public

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

Table 4.24. Output Formatters

ValueSummary

-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.25. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 4.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.27. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.7. action execution delete

Usage:

openstack action execution delete [-h]

                                       action_execution
                                       [action_execution ...]

Delete action execution.

Table 4.28. Positional Arguments

ValueSummary

action_execution

Id of action execution identifier(s).

Table 4.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

4.8. action execution input show

Usage:

openstack action execution input show [-h] id

Show Action execution input data.

Table 4.30. Positional Arguments

ValueSummary

id

Action execution id.

Table 4.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

4.9. action execution list

Usage:

openstack action execution list [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker [MARKER]] [--limit [LIMIT]]
                                     [--sort_keys [SORT_KEYS]]
                                     [--sort_dirs [SORT_DIRS]]
                                     [--filter FILTERS] [--oldest]
                                     [task_execution_id]

List all Action executions.

Table 4.32. Positional Arguments

ValueSummary

task_execution_id

Task execution id.

Table 4.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list

--sort_keys=id,description

 

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. Default: asc. Example: mistral execution-list

--sort_keys=id,description --sort_dirs=asc,desc

 

--filter FILTERS

Filters. can be repeated.

--oldest

Display the executions starting from the oldest entries instead of the newest

Table 4.34. Output Formatters

ValueSummary

-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.35. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 4.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.37. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.10. action execution output show

Usage:

openstack action execution output show [-h] id

Show Action execution output data.

Table 4.38. Positional Arguments

ValueSummary

id

Action execution id.

Table 4.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-mistralclient plugin.

4.11. action execution run

Usage:

openstack action execution run [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--noindent]
                                    [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [-s] [--run-sync]
                                    [-t TARGET]
                                    name [input]

Create new Action execution or just run specific action.

Table 4.40. Positional Arguments

ValueSummary

name

Action name to execute.

input

Action input.

Table 4.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-s, --save-result

Save the result into db.

--run-sync

Run the action synchronously.

-t TARGET, --target TARGET

Action will be executed on <target> executor.

Table 4.42. Output Formatters

ValueSummary

-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.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.44. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 4.45. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.12. action execution show

Usage:

openstack action execution show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty]
                                     action_execution

Show specific Action execution.

Table 4.46. Positional Arguments

ValueSummary

action_execution

Action execution id.

Table 4.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 4.48. Output Formatters

ValueSummary

-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.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.50. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 4.51. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

4.13. action execution update

Usage:

openstack action execution update [-h]

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

Update specific Action execution.

Table 4.52. Positional Arguments

ValueSummary

id

Action execution id.

Table 4.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Action execution state

--output OUTPUT

Action execution output

Table 4.54. Output Formatters

ValueSummary

-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.55. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.56. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 4.57. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-mistralclient plugin.

Chapter 5. address

This chapter describes the commands under the address command.

5.1. address scope create

Usage:

openstack address scope create [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--noindent]
                                    [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--ip-version {4,6}]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--share | --no-share]
                                    <name>

Create a new Address Scope

Table 5.1. Positional Arguments

ValueSummary

<name>

New address scope name

Table 5.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--ip-version {4,6}

Ip version (default is 4)

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

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

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects (default)

Table 5.3. Output Formatters

ValueSummary

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

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 5.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

5.2. address scope delete

Usage:

openstack address scope delete [-h]

                                    <address-scope> [<address-scope> ...]

Delete address scope(s)

Table 5.7. Positional Arguments

ValueSummary

<address-scope>

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

Table 5.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

5.3. address scope list

Usage:

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]

                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--name <name>]
                                  [--ip-version <ip-version>]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--share | --no-share]

List address scopes

Table 5.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List only address scopes of given name in output

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

List address scopes shared between projects

--no-share

List address scopes not shared between projects

Table 5.10. Output Formatters

ValueSummary

-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.11. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 5.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.13. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

5.4. address scope set

Usage:

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

                                 <address-scope>

Set address scope properties

Table 5.14. Positional Arguments

ValueSummary

<address-scope>

Address scope to modify (name or id)

Table 5.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set address scope name

--share

Share the address scope between projects

--no-share

Do not share the address scope between projects

5.5. address scope show

Usage:

openstack address scope show [-h] [-f {json,shell,table,value,yaml}]

                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <address-scope>

Display address scope details

Table 5.16. Positional Arguments

ValueSummary

<address-scope>

Address scope to display (name or id)

Table 5.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 5.18. Output Formatters

ValueSummary

-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.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.20. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 5.21. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Chapter 6. aggregate

This chapter describes the commands under the aggregate command.

6.1. aggregate add host

Usage:

openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]

                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <aggregate> <host>

Add host to aggregate

Table 6.1. Positional Arguments

ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to add to <aggregate>

Table 6.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 6.3. Output Formatters

ValueSummary

-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.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.5. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 6.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

6.2. aggregate create

Usage:

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]

                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--zone <availability-zone>]
                                [--property <key=value>]
                                <name>

Create a new aggregate

Table 6.7. Positional Arguments

ValueSummary

<name>

New aggregate name

Table 6.8. 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 6.9. Output Formatters

ValueSummary

-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.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.11. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 6.12. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

6.3. aggregate delete

Usage:

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

Delete existing aggregate(s)

Table 6.13. Positional Arguments

ValueSummary

<aggregate>

Aggregate(s) to delete (name or id)

Table 6.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

6.4. aggregate list

Usage:

openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]

                              [-c COLUMN]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--noindent] [--max-width <integer>]
                              [--fit-width] [--print-empty]
                              [--sort-column SORT_COLUMN] [--long]

List all aggregates

Table 6.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 6.16. Output Formatters

ValueSummary

-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.17. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 6.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.19. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

6.5. aggregate remove host

Usage:

openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty]
                                     <aggregate> <host>

Remove host from aggregate

Table 6.20. Positional Arguments

ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to remove from <aggregate>

Table 6.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 6.22. Output Formatters

ValueSummary

-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.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.24. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 6.25. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

6.6. aggregate set

Usage:

openstack aggregate set [-h] [--name <name>]

                             [--zone <availability-zone>]
                             [--property <key=value>] [--no-property]
                             <aggregate>

Set aggregate properties

Table 6.26. Positional Arguments

ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 6.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set aggregate name

--zone <availability-zone>

Set availability zone name

--property <key=value>

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

--no-property

Remove all properties from <aggregate> (specify both

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

properties)

6.7. aggregate show

Usage:

openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]

                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <aggregate>

Display aggregate details

Table 6.28. Positional Arguments

ValueSummary

<aggregate>

Aggregate to display (name or id)

Table 6.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 6.30. Output Formatters

ValueSummary

-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.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.32. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 6.33. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

6.8. aggregate unset

Usage:

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

Unset aggregate properties

Table 6.34. Positional Arguments

ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 6.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

Chapter 7. alarm

This chapter describes the commands under the alarm command.

7.1. alarm create

Usage:

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]

                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] --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>]
                            [--event-type <EVENT_TYPE>]
                            [--granularity <GRANULARITY>]
                            [--aggregation-method <AGGR_METHOD>]
                            [--metric <METRIC>]
                            [--resource-type <RESOURCE_TYPE>]
                            [--resource-id <RESOURCE_ID>]
                            [--composite-rule <COMPOSITE_RULE>]

Create an alarm

Table 7.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

Free text description of the alarm

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True

False}

True if alarm evaluation is enabled

--alarm-action <Webhook URL>

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

--ok-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True

False}

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

Table 7.2. Output Formatters

ValueSummary

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

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 7.5. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Table 7.6. common alarm rules

ValueSummary

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--threshold <THRESHOLD>

Threshold to evaluate against.

Table 7.7. event alarm

ValueSummary

--event-type <EVENT_TYPE>

Event type to evaluate against

Table 7.8. common gnocchi alarm rules

ValueSummary

--granularity <GRANULARITY>

The time range in seconds over which to query.

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

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

The metric id or name depending of the alarm type

Table 7.9. gnocchi resource threshold alarm

ValueSummary

--resource-type <RESOURCE_TYPE>

The type of resource.

--resource-id <RESOURCE_ID>

The id of a resource.

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

This command is provided by the aodhclient plugin.

7.2. alarm delete

Usage:

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

Delete an alarm

Table 7.11. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

This command is provided by the aodhclient plugin.

7.3. alarm list

Usage:

openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                          [--quote {all,minimal,none,nonnumeric}]
                          [--noindent] [--max-width <integer>] [--fit-width]
                          [--print-empty] [--sort-column SORT_COLUMN]
                          [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                          [--limit <LIMIT>] [--marker <MARKER>]
                          [--sort <SORT_KEY:SORT_DIR>]

List alarms

Table 7.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--query QUERY

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

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

Filter parameters to apply on returned alarms.

--limit <LIMIT>

Number of resources to return (default is server default)

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

Table 7.14. Output Formatters

ValueSummary

-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 7.15. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 7.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.17. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

7.4. alarm show

Usage:

openstack alarm show [-h] [-f {json,shell,table,value,yaml}]

                          [-c COLUMN] [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--name <NAME>]
                          [<ALARM ID or NAME>]

Show an alarm

Table 7.18. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

Table 7.20. Output Formatters

ValueSummary

-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.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.22. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 7.23. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

7.5. alarm state get

Usage:

openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]

                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--name <NAME>]
                               [<ALARM ID or NAME>]

Get state of an alarm

Table 7.24. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

Table 7.26. Output Formatters

ValueSummary

-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.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.28. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 7.29. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

7.6. alarm state set

Usage:

openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]

                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--name <NAME>] --state
                               <STATE>
                               [<ALARM ID or NAME>]

Set state of an alarm

Table 7.30. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

--state <STATE>

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

Table 7.32. Output Formatters

ValueSummary

-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.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.34. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 7.35. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

7.7. alarm update

Usage:

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]

                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--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>]
                            [--event-type <EVENT_TYPE>]
                            [--granularity <GRANULARITY>]
                            [--aggregation-method <AGGR_METHOD>]
                            [--metric <METRIC>]
                            [--resource-type <RESOURCE_TYPE>]
                            [--resource-id <RESOURCE_ID>]
                            [--composite-rule <COMPOSITE_RULE>]
                            [<ALARM ID or NAME>]

Update an alarm

Table 7.36. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

Free text description of the alarm

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True

False}

True if alarm evaluation is enabled

--alarm-action <Webhook URL>

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

--ok-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True

False}

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

Table 7.38. Output Formatters

ValueSummary

-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.39. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.40. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 7.41. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Table 7.42. common alarm rules

ValueSummary

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--threshold <THRESHOLD>

Threshold to evaluate against.

Table 7.43. event alarm

ValueSummary

--event-type <EVENT_TYPE>

Event type to evaluate against

Table 7.44. common gnocchi alarm rules

ValueSummary

--granularity <GRANULARITY>

The time range in seconds over which to query.

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

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

The metric id or name depending of the alarm type

Table 7.45. gnocchi resource threshold alarm

ValueSummary

--resource-type <RESOURCE_TYPE>

The type of resource.

--resource-id <RESOURCE_ID>

The id of a resource.

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

This command is provided by the aodhclient plugin.

7.9. alarm history show

Usage:

openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}]

                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <LIMIT>] [--marker <MARKER>]
                                  [--sort <SORT_KEY:SORT_DIR>]
                                  <alarm-id>

Show history for an alarm

Table 7.52. Positional Arguments

ValueSummary

<alarm-id>

Id of an alarm

Table 7.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <LIMIT>

Number of resources to return (default is server default)

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

Table 7.54. Output Formatters

ValueSummary

-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 7.55. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 7.56. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.57. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

Chapter 8. alarming

This chapter describes the commands under the alarming command.

8.1. alarming capabilities list

Usage:

openstack alarming capabilities list [-h]

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

List capabilities of alarming service

Table 8.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 8.2. Output Formatters

ValueSummary

-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 8.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 8.4. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 8.5. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the aodhclient plugin.

Chapter 9. application

This chapter describes the commands under the application command.

9.1. application credential create

Usage:

openstack application credential create [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--secret <secret>]
                                             [--role <role>]
                                             [--expiration <expiration>]
                                             [--description <description>]
                                             [--unrestricted] [--restricted]
                                             <name>

Create new application credential

Table 9.1. Positional Arguments

ValueSummary

<name>

Name of the application credential

Table 9.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--secret <secret>

Secret to use for authentication (if not provided, one will be generated)

--role <role>

Roles to authorize (name or id) (repeat option to set multiple values)

--expiration <expiration>

Sets an expiration date for the application credential, format of YYYY-mm-ddTHH:MM:SS (if not provided, the application credential will not expire)

--description <description>

Application credential description

--unrestricted

Enable application credential to create and delete other application credentials and trusts (this is potentially dangerous behavior and is disabled by default)

--restricted

Prohibit application credential from creating and deleting other application credentials and trusts (this is the default behavior)

Table 9.3. Output Formatters

ValueSummary

-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.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.5. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 9.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

9.2. application credential delete

Usage:

openstack application credential delete [-h]

                                             <application-credential>
                                             [<application-credential> ...]

Delete application credentials(s)

Table 9.7. Positional Arguments

ValueSummary

<application-credential>

Application credentials(s) to delete (name or ID)

Table 9.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.3. application credential list

Usage:

openstack application credential list [-h]

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

List application credentials

Table 9.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

User whose application credentials to list (name or ID)

--user-domain <user-domain>

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

Table 9.10. Output Formatters

ValueSummary

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

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 9.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.13. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

9.4. application credential show

Usage:

openstack application credential show [-h]

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

Display application credential details

Table 9.14. Positional Arguments

ValueSummary

<application-credential>

Application credential to display (name or ID)

Table 9.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.16. Output Formatters

ValueSummary

-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.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.18. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 9.19. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Chapter 10. availability

This chapter describes the commands under the availability command.

10.1. availability zone list

Usage:

openstack availability zone list [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--compute] [--network] [--volume]
                                      [--long]

List availability zones and their status

Table 10.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--compute

List compute availability zones

--network

List network availability zones

--volume

List volume availability zones

--long

List additional fields in output

Table 10.2. Output Formatters

ValueSummary

-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.3. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 10.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 10.5. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Chapter 11. baremetal

This chapter describes the commands under the baremetal command.

11.1. baremetal allocation create

Usage:

openstack baremetal allocation create [-h]

                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           --resource-class RESOURCE_CLASS
                                           [--trait TRAITS]
                                           [--candidate-node CANDIDATE_NODES]
                                           [--name NAME] [--uuid UUID]
                                           [--extra <key=value>]
                                           [--wait [<time-out>]]

Create a new baremetal allocation.

Table 11.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-class RESOURCE_CLASS

Resource class to request.

--trait TRAITS

A trait to request. can be specified multiple times.

--candidate-node CANDIDATE_NODES

A candidate node for this allocation. Can be specified multiple times. If at least one is specified, only the provided candidate nodes are considered for the allocation.

--name NAME

Unique name of the allocation.

--uuid UUID

Uuid of the allocation.

--extra <key=value>

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

--wait [<time-out>]

Wait for the new allocation to become active. an error is returned if allocation fails and --wait is used. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

Table 11.2. Output Formatters

ValueSummary

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

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.5. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.2. baremetal allocation delete

Usage:

openstack baremetal allocation delete [-h]

                                           <allocation> [<allocation> ...]

Unregister baremetal allocation(s).

Table 11.6. Positional Arguments

ValueSummary

<allocation>

Allocations(s) to delete (name or uuid).

Table 11.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.3. baremetal allocation list

Usage:

openstack baremetal allocation list [-h]

                                         [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--noindent]
                                         [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--sort-column SORT_COLUMN]
                                         [--limit <limit>]
                                         [--marker <allocation>]
                                         [--sort <key>[:<direction>]]
                                         [--node <node>]
                                         [--resource-class <resource_class>]
                                         [--state <state>]
                                         [--long | --fields <field> [<field> ...]]

List baremetal allocations.

Table 11.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

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

--marker <allocation>

Allocation UUID (for example, of the last allocation in the list from a previous request). Returns the list of allocations after this UUID.

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

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

--node <node>

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

--resource-class <resource_class>

Only list allocations with this resource class.

--state <state>

Only list allocations in this state.

--long

Show detailed information about the allocations.

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

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

Table 11.9. Output Formatters

ValueSummary

-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 11.10. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.12. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.4. baremetal allocation show

Usage:

openstack baremetal allocation show [-h]

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

Show baremetal allocation details.

Table 11.13. Positional Arguments

ValueSummary

<id>

Uuid or name of the allocation

Table 11.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 11.15. Output Formatters

ValueSummary

-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.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.17. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.18. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.5. baremetal chassis create

Usage:

openstack baremetal chassis create [-h]

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

Create a new chassis.

Table 11.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the chassis

--extra <key=value>

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

--uuid <uuid>

Unique uuid of the chassis

Table 11.20. Output Formatters

ValueSummary

-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.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.22. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.23. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.6. baremetal chassis delete

Usage:

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

Delete a chassis.

Table 11.24. Positional Arguments

ValueSummary

<chassis>

Uuids of chassis to delete

Table 11.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.7. baremetal chassis list

Usage:

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--noindent] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--sort-column SORT_COLUMN]
                                      [--fields <field> [<field> ...]]
                                      [--limit <limit>] [--long]
                                      [--marker <chassis>]
                                      [--sort <key>[:<direction>]]

List the chassis.

Table 11.26. 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. Cannot be used when '--long' is specified.

--limit <limit>

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

--long

Show detailed information about the chassis

--marker <chassis>

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

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

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

Table 11.27. Output Formatters

ValueSummary

-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 11.28. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.29. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.30. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.8. baremetal chassis set

Usage:

openstack baremetal chassis set [-h] [--description <description>]

                                     [--extra <key=value>]
                                     <chassis>

Set chassis properties.

Table 11.31. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 11.32. 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)

This command is provided by the python-ironicclient plugin.

11.9. baremetal chassis show

Usage:

openstack baremetal chassis show [-h]

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

Show chassis details.

Table 11.33. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 11.34. 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 11.35. Output Formatters

ValueSummary

-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.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.37. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.38. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.10. baremetal chassis unset

Usage:

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

                                       <chassis>

Unset chassis properties.

Table 11.39. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 11.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description

Clear the chassis description

--extra <key>

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

This command is provided by the python-ironicclient plugin.

11.11. baremetal conductor list

Usage:

openstack baremetal conductor list [-h]

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

List baremetal conductors

Table 11.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

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

--marker <conductor>

Hostname of the conductor (for example, of the last conductor in the list from a previous request). Returns the list of conductors after this conductor.

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

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

--long

Show detailed information about the conductors.

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

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

Table 11.42. Output Formatters

ValueSummary

-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 11.43. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.45. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.12. baremetal conductor show

Usage:

openstack baremetal conductor show [-h]

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

Show baremetal conductor details

Table 11.46. Positional Arguments

ValueSummary

<conductor>

Hostname of the conductor

Table 11.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 11.48. Output Formatters

ValueSummary

-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.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.50. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.51. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.13. baremetal create

Usage:

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

Create resources from files

Table 11.52. Positional Arguments

ValueSummary

<file>

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

Table 11.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.14. baremetal deploy template create

Usage:

openstack baremetal deploy template create [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty]
                                                [--uuid <uuid>]
                                                [--extra <key=value>]
                                                --steps <steps>
                                                <name>

Create a new deploy template

Table 11.54. Positional Arguments

ValueSummary

<name>

Unique name for this deploy template. must be a valid trait name

Table 11.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--uuid <uuid>

Uuid of the deploy template.

--extra <key=value>

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

--steps <steps>

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

Table 11.56. Output Formatters

ValueSummary

-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.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.58. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.59. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.15. baremetal deploy template delete

Usage:

openstack baremetal deploy template delete [-h]

                                                <template> [<template> ...]

Delete deploy template(s).

Table 11.60. Positional Arguments

ValueSummary

<template>

Name(s) or uuid(s) of the deploy template(s) to delete.

Table 11.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.16. baremetal deploy template list

Usage:

openstack baremetal deploy template list [-h]

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

List baremetal deploy templates.

Table 11.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

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

--marker <template>

Deploytemplate uuid (for example, of the last deploy template in the list from a previous request). Returns the list of deploy templates after this UUID.

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

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

--long

Show detailed information about deploy templates.

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

One or more deploy template fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified.

Table 11.63. Output Formatters

ValueSummary

-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 11.64. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.65. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.66. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.17. baremetal deploy template set

Usage:

openstack baremetal deploy template set [-h] [--name <name>]

                                             [--steps <steps>]
                                             [--extra <key=value>]
                                             <template>

Set baremetal deploy template properties.

Table 11.67. Positional Arguments

ValueSummary

<template>

Name or uuid of the deploy template

Table 11.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set unique name of the deploy template. must be a valid trait name.

--steps <steps>

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

--extra <key=value>

Extra to set on this baremetal deploy template (repeat option to set multiple extras).

This command is provided by the python-ironicclient plugin.

11.18. baremetal deploy template show

Usage:

openstack baremetal deploy template show [-h]

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

Show baremetal deploy template details.

Table 11.69. Positional Arguments

ValueSummary

<template>

Name or uuid of the deploy template.

Table 11.70. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 11.71. Output Formatters

ValueSummary

-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.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.73. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.74. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.19. baremetal deploy template unset

Usage:

openstack baremetal deploy template unset [-h] [--extra <key>]

                                               <template>

Unset baremetal deploy template properties.

Table 11.75. Positional Arguments

ValueSummary

<template>

Name or uuid of the deploy template

Table 11.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

Extra to unset on this baremetal deploy template (repeat option to unset multiple extras).

This command is provided by the python-ironicclient plugin.

11.20. baremetal driver list

Usage:

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--type <type>] [--long]

List the enabled drivers.

Table 11.77. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

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

--long

Show detailed information about the drivers.

Table 11.78. Output Formatters

ValueSummary

-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 11.79. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.80. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.81. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.21. baremetal driver passthru call

Usage:

openstack baremetal driver passthru call [-h]

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

Call a vendor passthru method for a driver.

Table 11.82. Positional Arguments

ValueSummary

<driver>

Name of the driver.

<method>

Vendor passthru method to be called.

Table 11.83. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--arg <key=value>

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

--http-method <http-method>

The HTTP method to use in the passthru request. One of DELETE, GET, PATCH, POST, PUT. Defaults to 'POST'.

Table 11.84. Output Formatters

ValueSummary

-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.85. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.86. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.87. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.22. baremetal driver passthru list

Usage:

openstack baremetal driver passthru list [-h]

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

List available vendor passthru methods for a driver.

Table 11.88. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 11.89. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.90. Output Formatters

ValueSummary

-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 11.91. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.92. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.93. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.23. baremetal driver property list

Usage:

openstack baremetal driver property list [-h]

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

List the driver properties.

Table 11.94. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 11.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.96. Output Formatters

ValueSummary

-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 11.97. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.98. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.99. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.24. baremetal driver raid property list

Usage:

openstack baremetal driver raid property list [-h]

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

List a driver’s RAID logical disk properties.

Table 11.100. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 11.101. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.102. Output Formatters

ValueSummary

-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 11.103. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.104. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.105. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.25. baremetal driver show

Usage:

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty]
                                     <driver>

Show information about a driver.

Table 11.106. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 11.107. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.108. Output Formatters

ValueSummary

-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.109. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.110. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.111. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.26. baremetal introspection abort

Usage:

openstack baremetal introspection abort [-h] node

Abort running introspection for node.

Table 11.112. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 11.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

11.27. baremetal introspection data save

Usage:

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

                                                 node

Save or display raw introspection data.

Table 11.114. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 11.115. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded introspection data filename (default: stdout)

This command is provided by the python-ironic-inspector-client plugin.

11.28. baremetal introspection interface list

Usage:

openstack baremetal introspection interface list [-h]

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

List interface data including attached switch port information.

Table 11.116. Positional Arguments

ValueSummary

node_ident

Baremetal node uuid or name

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

Table 11.118. Output Formatters

ValueSummary

-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 11.119. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.120. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.121. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.29. baremetal introspection interface show

Usage:

openstack baremetal introspection interface show [-h]

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

Show interface data including attached switch port information.

Table 11.122. Positional Arguments

ValueSummary

node_ident

Baremetal node uuid or name

interface

Interface name

Table 11.123. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Display one or more fields.

Table 11.124. Output Formatters

ValueSummary

-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.125. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.126. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.127. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.30. baremetal introspection list

Usage:

openstack baremetal introspection list [-h]

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

List introspection statuses

Table 11.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker MARKER

Uuid of the last item on the previous page

--limit LIMIT

The amount of items to return

Table 11.129. Output Formatters

ValueSummary

-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 11.130. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.131. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.132. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.31. baremetal introspection reprocess

Usage:

openstack baremetal introspection reprocess [-h] node

Reprocess stored introspection data

Table 11.133. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 11.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

11.32. baremetal introspection rule delete

Usage:

openstack baremetal introspection rule delete [-h] uuid

Delete an introspection rule.

Table 11.135. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 11.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

11.33. baremetal introspection rule import

Usage:

openstack baremetal introspection rule import [-h]

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

Import one or several introspection rules from a JSON/YAML file.

Table 11.137. Positional Arguments

ValueSummary

file

Json or yaml file to import, may contain one or several rules

Table 11.138. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.139. Output Formatters

ValueSummary

-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 11.140. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.141. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.142. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.34. baremetal introspection rule list

Usage:

openstack baremetal introspection rule list [-h]

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

List all introspection rules.

Table 11.143. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.144. Output Formatters

ValueSummary

-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 11.145. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.146. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.147. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.35. baremetal introspection rule purge

Usage:

openstack baremetal introspection rule purge [-h]

Drop all introspection rules.

Table 11.148. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

11.36. baremetal introspection rule show

Usage:

openstack baremetal introspection rule show [-h]

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

Show an introspection rule.

Table 11.149. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 11.150. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.151. Output Formatters

ValueSummary

-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.152. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.153. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.154. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.37. baremetal introspection start

Usage:

openstack baremetal introspection start [-h]

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

Start the introspection.

Table 11.155. Positional Arguments

ValueSummary

node

Baremetal node uuid(s) or name(s)

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

--check-errors

Check if errors occurred during the introspection; if any error occurs only the errors are displayed; can only be used with --wait

Table 11.157. Output Formatters

ValueSummary

-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 11.158. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.159. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.160. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.38. baremetal introspection status

Usage:

openstack baremetal introspection status [-h]

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

Get introspection status.

Table 11.161. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 11.162. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.163. Output Formatters

ValueSummary

-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.164. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.165. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.166. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironic-inspector-client plugin.

11.39. baremetal node abort

Usage:

openstack baremetal node abort [-h] <node>

Set provision state of baremetal node to 'abort'

Table 11.167. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 11.168. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.40. baremetal node add trait

Usage:

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

Add traits to a node.

Table 11.169. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to add

Table 11.170. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

11.41. baremetal node adopt

Usage:

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

Set provision state of baremetal node to 'adopt'

Table 11.171. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

11.42. baremetal node bios setting list

Usage:

openstack baremetal node bios setting list [-h]

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

List a node’s BIOS settings.

Table 11.173. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.174. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.175. Output Formatters

ValueSummary

-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 11.176. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 11.177. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.178. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

11.43. baremetal node bios setting show

Usage:

openstack baremetal node bios setting show [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty]
                                                <node> <setting name>

Show a specific BIOS setting for a node.

Table 11.179. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<setting name>

Setting name to show

Table 11.180. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.181. Output Formatters

ValueSummary

-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.182. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.183. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 11.184. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

Chapter 12. ca

This chapter describes the commands under the ca command.

12.1. ca get

Usage:

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]

                      [--noindent] [--prefix PREFIX] [--max-width <integer>]
                      [--fit-width] [--print-empty]
                      URI

Retrieve a CA by providing its URI.

Table 12.1. Positional Arguments

ValueSummary

URI

The uri reference for the ca.

Table 12.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.3. Output Formatters

ValueSummary

-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 12.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 12.5. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 12.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-barbicanclient plugin.

Chapter 13. baremetal

This chapter describes the commands under the baremetal command.

13.1. baremetal node boot device set

Usage:

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

                                              <node> <device>

Set the boot device for a node

Table 13.1. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<device>

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

Table 13.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

This command is provided by the python-ironicclient plugin.

13.2. baremetal node boot device show

Usage:

openstack baremetal node boot device show [-h]

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

Show the boot device information for a node

Table 13.3. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

Table 13.5. Output Formatters

ValueSummary

-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 13.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.7. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.8. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.3. baremetal node clean

Usage:

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

                                    <clean-steps>
                                    <node>

Set provision state of baremetal node to 'clean'

Table 13.9. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.10. 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'.

This command is provided by the python-ironicclient plugin.

13.4. baremetal node console disable

Usage:

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

Disable console access for a node

Table 13.11. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.5. baremetal node console enable

Usage:

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

Enable console access for a node

Table 13.13. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.6. baremetal node console show

Usage:

openstack baremetal node console show [-h]

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

Show console information for a node

Table 13.15. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.17. Output Formatters

ValueSummary

-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 13.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.19. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.20. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.7. baremetal node create

Usage:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty]
                                     [--chassis-uuid <chassis>] --driver
                                     <driver> [--driver-info <key=value>]
                                     [--property <key=value>]
                                     [--extra <key=value>] [--uuid <uuid>]
                                     [--name <name>]
                                     [--bios-interface <bios_interface>]
                                     [--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>]
                                     [--rescue-interface <rescue_interface>]
                                     [--storage-interface <storage_interface>]
                                     [--vendor-interface <vendor_interface>]
                                     [--resource-class <resource_class>]
                                     [--conductor-group <conductor_group>]
                                     [--automated-clean] [--owner <owner>]
                                     [--description <description>]

Register a new node with the baremetal service

Table 13.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--chassis-uuid <chassis>

UUID of the chassis that this node belongs to.

--driver <driver>

Driver used to control the node [required].

--driver-info <key=value>

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

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

--extra <key=value>

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

--uuid <uuid>

Unique uuid for the node.

--name <name>

Unique name for the node.

--bios-interface <bios_interface>

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

--console-interface <console_interface>

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

--deploy-interface <deploy_interface>

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

--inspect-interface <inspect_interface>

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

--network-interface <network_interface>

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

--power-interface <power_interface>

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

--raid-interface <raid_interface>

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

--rescue-interface <rescue_interface>

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

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

--conductor-group <conductor_group>

Conductor group the node will belong to

--automated-clean

Enable automated cleaning for the node

--owner <owner>

Owner of the node.

--description <description>

Description for the node.

Table 13.22. Output Formatters

ValueSummary

-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 13.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.24. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.25. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.8. baremetal node delete

Usage:

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

Unregister baremetal node(s)

Table 13.26. Positional Arguments

ValueSummary

<node>

Node(s) to delete (name or uuid)

Table 13.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.9. baremetal node deploy

Usage:

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

                                     [--config-drive <config-drive>]
                                     <node>

Set provision state of baremetal node to 'deploy'

Table 13.28. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.29. 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 OR a JSON object to build config drive from. In case it’s a directory, a config drive will be generated from it. In case it’s a JSON object with optional keys meta_data, user_data and network_data, a config drive will be generated on the server side (see the bare metal API reference for more details).

This command is provided by the python-ironicclient plugin.

13.10. baremetal node inject nmi

Usage:

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

Inject NMI to baremetal node

Table 13.30. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.11. baremetal node inspect

Usage:

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

Set provision state of baremetal node to 'inspect'

Table 13.32. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.12. baremetal node list

Usage:

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]

                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--limit <limit>] [--marker <node>]
                                   [--sort <key>[:<direction>]]
                                   [--maintenance | --no-maintenance]
                                   [--fault <fault>]
                                   [--associated | --unassociated]
                                   [--provision-state <provision state>]
                                   [--driver <driver>]
                                   [--resource-class <resource class>]
                                   [--conductor-group <conductor_group>]
                                   [--conductor <conductor>]
                                   [--chassis <chassis UUID>]
                                   [--owner <owner>]
                                   [--description-contains <description_contains>]
                                   [--long | --fields <field> [<field> ...]]

List baremetal nodes

Table 13.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

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

--maintenance

Limit list to nodes in maintenance mode

--no-maintenance

Limit list to nodes not in maintenance mode

--fault <fault>

List nodes in specified fault.

--associated

List only nodes associated with an instance.

--unassociated

List only nodes not associated with an instance.

--provision-state <provision state>

List nodes in specified provision state.

--driver <driver>

Limit list to nodes with driver <driver>

--resource-class <resource class>

Limit list to nodes with resource class <resource class>

--conductor-group <conductor_group>

Limit list to nodes with conductor group <conductor group>

--conductor <conductor>

Limit list to nodes with conductor <conductor>

--chassis <chassis UUID>

Limit list to nodes of this chassis

--owner <owner>

Limit list to nodes with owner <owner>

--description-contains <description_contains>

Limit list to nodes with description contains

<description_contains>

 

--long

Show detailed information about the nodes.

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

Table 13.35. Output Formatters

ValueSummary

-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 13.36. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.38. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.13. baremetal node maintenance set

Usage:

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

                                              <node>

Set baremetal node to maintenance mode

Table 13.39. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

This command is provided by the python-ironicclient plugin.

13.14. baremetal node maintenance unset

Usage:

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

Unset baremetal node from maintenance mode

Table 13.41. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.15. baremetal node manage

Usage:

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

Set provision state of baremetal node to 'manage'

Table 13.43. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.16. baremetal node passthru call

Usage:

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

                                            [--http-method <http-method>]
                                            <node> <method>

Call a vendor passthu method for a node

Table 13.45. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

Table 13.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--arg <key=value>

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

--http-method <http-method>

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

This command is provided by the python-ironicclient plugin.

13.17. baremetal node passthru list

Usage:

openstack baremetal node passthru list [-h]

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

List vendor passthru methods for a node

Table 13.47. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.49. Output Formatters

ValueSummary

-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 13.50. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.51. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.52. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.18. baremetal node power off

Usage:

openstack baremetal node power off [-h]

                                        [--power-timeout <power-timeout>]
                                        [--soft]
                                        <node>

Power off a node

Table 13.53. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

--soft

Request graceful power-off.

This command is provided by the python-ironicclient plugin.

13.19. baremetal node power on

Usage:

openstack baremetal node power on [-h]

                                       [--power-timeout <power-timeout>]
                                       <node>

Power on a node

Table 13.55. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.20. baremetal node provide

Usage:

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

Set provision state of baremetal node to 'provide'

Table 13.57. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.21. baremetal node reboot

Usage:

openstack baremetal node reboot [-h] [--soft]

                                     [--power-timeout <power-timeout>]
                                     <node>

Reboot baremetal node

Table 13.59. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--soft

Request graceful reboot.

--power-timeout <power-timeout>

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

This command is provided by the python-ironicclient plugin.

13.22. baremetal node rebuild

Usage:

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

                                      [--config-drive <config-drive>]
                                      <node>

Set provision state of baremetal node to 'rebuild'

Table 13.61. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.62. 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 OR a JSON object to build config drive from. In case it’s a directory, a config drive will be generated from it. In case it’s a JSON object with optional keys meta_data, user_data and network_data, a config drive will be generated on the server side (see the bare metal API reference for more details).

This command is provided by the python-ironicclient plugin.

13.23. baremetal node remove trait

Usage:

openstack baremetal node remove trait [-h] [--all]

                                           <node> [<trait> [<trait> ...]]

Remove trait(s) from a node.

Table 13.63. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to remove

Table 13.64. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Remove all traits

This command is provided by the python-ironicclient plugin.

13.24. baremetal node rescue

Usage:

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

                                     --rescue-password <rescue-password>
                                     <node>

Set provision state of baremetal node to 'rescue'

Table 13.65. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

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

--rescue-password <rescue-password>

The password that will be used to login to the rescue ramdisk. The value should be a non-empty string.

This command is provided by the python-ironicclient plugin.

13.25. baremetal node set

Usage:

openstack baremetal node set [-h] [--instance-uuid <uuid>]

                                  [--name <name>]
                                  [--chassis-uuid <chassis UUID>]
                                  [--driver <driver>]
                                  [--bios-interface <bios_interface> | --reset-bios-interface]
                                  [--boot-interface <boot_interface> | --reset-boot-interface]
                                  [--console-interface <console_interface> | --reset-console-interface]
                                  [--deploy-interface <deploy_interface> | --reset-deploy-interface]
                                  [--inspect-interface <inspect_interface> | --reset-inspect-interface]
                                  [--management-interface <management_interface> | --reset-management-interface]
                                  [--network-interface <network_interface> | --reset-network-interface]
                                  [--power-interface <power_interface> | --reset-power-interface]
                                  [--raid-interface <raid_interface> | --reset-raid-interface]
                                  [--rescue-interface <rescue_interface> | --reset-rescue-interface]
                                  [--storage-interface <storage_interface> | --reset-storage-interface]
                                  [--vendor-interface <vendor_interface> | --reset-vendor-interface]
                                  [--reset-interfaces]
                                  [--resource-class <resource_class>]
                                  [--conductor-group <conductor_group>]
                                  [--automated-clean] [--protected]
                                  [--protected-reason <protected_reason>]
                                  [--target-raid-config <target_raid_config>]
                                  [--property <key=value>]
                                  [--extra <key=value>]
                                  [--driver-info <key=value>]
                                  [--instance-info <key=value>]
                                  [--owner <owner>]
                                  [--description <description>]
                                  <node>

Set baremetal properties

Table 13.67. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--instance-uuid <uuid>

Set instance UUID of node to <uuid>

--name <name>

Set the name of the node

--chassis-uuid <chassis UUID>

Set the chassis for the node

--driver <driver>

Set the driver for the node

--bios-interface <bios_interface>

Set the BIOS interface for the node

--reset-bios-interface

Reset the BIOS interface to its hardware type default

--boot-interface <boot_interface>

Set the boot interface for the node

--reset-boot-interface

Reset the boot interface to its hardware type default

--console-interface <console_interface>

Set the console interface for the node

--reset-console-interface

Reset the console interface to its hardware type default

--deploy-interface <deploy_interface>

Set the deploy interface for the node

--reset-deploy-interface

Reset the deploy interface to its hardware type default

--inspect-interface <inspect_interface>

Set the inspect interface for the node

--reset-inspect-interface

Reset the inspect interface to its hardware type default

--management-interface <management_interface>

Set the management interface for the node

--reset-management-interface

Reset the management interface to its hardware type default

--network-interface <network_interface>

Set the network interface for the node

--reset-network-interface

Reset the network interface to its hardware type default

--power-interface <power_interface>

Set the power interface for the node

--reset-power-interface

Reset the power interface to its hardware type default

--raid-interface <raid_interface>

Set the RAID interface for the node

--reset-raid-interface

Reset the RAID interface to its hardware type default

--rescue-interface <rescue_interface>

Set the rescue interface for the node

--reset-rescue-interface

Reset the rescue interface to its hardware type default

--storage-interface <storage_interface>

Set the storage interface for the node

--reset-storage-interface

Reset the storage interface to its hardware type default

--vendor-interface <vendor_interface>

Set the vendor interface for the node

--reset-vendor-interface

Reset the vendor interface to its hardware type default

--reset-interfaces

Reset all interfaces not specified explicitly to their default implementations. Only valid with --driver.

--resource-class <resource_class>

Set the resource class for the node

--conductor-group <conductor_group>

Set the conductor group for the node

--automated-clean

Enable automated cleaning for the node

--protected

Mark the node as protected

--protected-reason <protected_reason>

Set the reason of marking the node as protected

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

--property <key=value>

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

--extra <key=value>

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

--driver-info <key=value>

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

--instance-info <key=value>

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

--owner <owner>

Set the owner for the node

--description <description>

Set the description for the node

This command is provided by the python-ironicclient plugin.

13.26. baremetal node show

Usage:

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--noindent]
                                   [--prefix PREFIX] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--instance]
                                   [--fields <field> [<field> ...]]
                                   <node>

Show baremetal node details

Table 13.69. Positional Arguments

ValueSummary

<node>

Name or uuid of the node (or instance uuid if

--instance is specified)

 

Table 13.70. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--instance

<node> is an instance uuid.

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

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

Table 13.71. Output Formatters

ValueSummary

-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 13.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.73. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.74. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.27. baremetal node trait list

Usage:

openstack baremetal node trait list [-h]

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

List a node’s traits.

Table 13.75. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.77. Output Formatters

ValueSummary

-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 13.78. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.79. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.80. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.28. baremetal node undeploy

Usage:

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

Set provision state of baremetal node to 'deleted'

Table 13.81. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.29. baremetal node unrescue

Usage:

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

Set provision state of baremetal node to 'unrescue'

Table 13.83. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

This command is provided by the python-ironicclient plugin.

13.30. baremetal node unset

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]
                                    [--bios-interface] [--boot-interface]
                                    [--console-interface]
                                    [--deploy-interface]
                                    [--inspect-interface]
                                    [--management-interface]
                                    [--network-interface]
                                    [--power-interface] [--raid-interface]
                                    [--rescue-interface]
                                    [--storage-interface]
                                    [--vendor-interface] [--conductor-group]
                                    [--automated-clean] [--protected]
                                    [--protected-reason] [--owner]
                                    [--description]
                                    <node>

Unset baremetal properties

Table 13.85. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 13.86. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--instance-uuid

Unset instance uuid on this baremetal node

--name

Unset the name of the node

--resource-class

Unset the resource class of the node

--target-raid-config

Unset the target raid configuration of the node

--property <key>

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

--extra <key>

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

--driver-info <key>

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

--instance-info <key>

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

--chassis-uuid

Unset chassis uuid on this baremetal node

--bios-interface

Unset bios interface on this baremetal node

--boot-interface

Unset boot interface on this baremetal node

--console-interface

Unset console interface on this baremetal node

--deploy-interface

Unset deploy interface on this baremetal node

--inspect-interface

Unset inspect interface on this baremetal node

--management-interface

Unset management interface on this baremetal node

--network-interface

Unset network interface on this baremetal node

--power-interface

Unset power interface on this baremetal node

--raid-interface

Unset raid interface on this baremetal node

--rescue-interface

Unset rescue interface on this baremetal node

--storage-interface

Unset storage interface on this baremetal node

--vendor-interface

Unset vendor interface on this baremetal node

--conductor-group

Unset conductor group for this baremetal node (the default group will be used)

--automated-clean

Unset automated clean option on this baremetal node (the value from configuration will be used)

--protected

Unset the protected flag on the node

--protected-reason

Unset the protected reason (gets unset automatically when protected is unset)

--owner

Unset the owner field of the node

--description

Unset the description field of the node

This command is provided by the python-ironicclient plugin.

13.31. baremetal node validate

Usage:

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]

                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <node>

Validate a node’s driver interfaces

Table 13.87. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.89. Output Formatters

ValueSummary

-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 13.90. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.91. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.92. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.32. baremetal node vif attach

Usage:

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

                                         <node> <vif-id>

Attach VIF to a given node

Table 13.93. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

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

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

This command is provided by the python-ironicclient plugin.

13.33. baremetal node vif detach

Usage:

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

Detach VIF from a given node

Table 13.95. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

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

Table 13.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.34. baremetal node vif list

Usage:

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]

                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <node>

Show attached VIFs for a node

Table 13.97. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 13.98. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.99. Output Formatters

ValueSummary

-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 13.100. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.101. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.102. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.35. baremetal port create

Usage:

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX]
                                     [--max-width <integer>] [--fit-width]
                                     [--print-empty] --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>]
                                     [--is-smartnic]
                                     <address>

Create a new port

Table 13.103. Positional Arguments

ValueSummary

<address>

Mac address for this port.

Table 13.104. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this port belongs to.

--uuid <uuid>

Uuid of the port.

--extra <key=value>

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

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

Key/value metadata describing Local link connection information. Valid keys are 'switch_info', 'switch_id', 'port_id' and 'hostname'. The keys 'switch_id' and 'port_id' are required. In case of a Smart NIC port, the required keys are 'port_id' and 'hostname'. Argument can be specified multiple times.

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

--pxe-enabled <boolean>

Indicates whether this Port should be used when PXE booting this Node.

--port-group <uuid>

Uuid of the port group that this port belongs to.

--physical-network <physical network>

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

--is-smartnic

Indicates whether this port is a smart nic port

Table 13.105. Output Formatters

ValueSummary

-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 13.106. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.107. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.108. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.36. baremetal port delete

Usage:

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

Delete port(s).

Table 13.109. Positional Arguments

ValueSummary

<port>

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

Table 13.110. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.37. baremetal port group create

Usage:

openstack baremetal port group create [-h]

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

Create a new baremetal port group.

Table 13.111. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this port group belongs to.

--address <mac-address>

MAC address for this port group.

--name NAME

Name of the port group.

--uuid UUID

Uuid of the port group.

--extra <key=value>

Record arbitrary key/value metadata. 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.

--property <key=value>

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

--support-standalone-ports

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

--unsupport-standalone-ports

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

Table 13.112. Output Formatters

ValueSummary

-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 13.113. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.114. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.115. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.38. baremetal port group delete

Usage:

openstack baremetal port group delete [-h]

                                           <port group> [<port group> ...]

Unregister baremetal port group(s).

Table 13.116. Positional Arguments

ValueSummary

<port group>

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

Table 13.117. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.39. baremetal port group list

Usage:

openstack baremetal port group list [-h]

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

List baremetal port groups.

Table 13.118. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--address <mac-address>

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

--node <node>

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

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

Table 13.119. Output Formatters

ValueSummary

-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 13.120. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.122. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.40. baremetal port group set

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>

Set baremetal port group properties.

Table 13.123. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 13.124. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

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

--address <mac-address>

MAC address for this port group.

--name <name>

Name of the port group.

--extra <key=value>

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

--mode MODE

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

--property <key=value>

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

--support-standalone-ports

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

--unsupport-standalone-ports

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

This command is provided by the python-ironicclient plugin.

13.41. baremetal port group show

Usage:

openstack baremetal port group show [-h]

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

Show baremetal port group details.

Table 13.125. Positional Arguments

ValueSummary

<id>

Uuid or name of the port group (or mac address if

--address is specified).

 

Table 13.126. 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 13.127. Output Formatters

ValueSummary

-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 13.128. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.129. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.130. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.42. baremetal port group unset

Usage:

openstack baremetal port group unset [-h] [--name] [--address]

                                          [--extra <key>] [--property <key>]
                                          <port group>

Unset baremetal port group properties.

Table 13.131. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 13.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name

Unset the name of the port group.

--address

Unset the address of the port group.

--extra <key>

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

--property <key>

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

This command is provided by the python-ironicclient plugin.

13.43. baremetal port list

Usage:

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]

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

List baremetal ports.

Table 13.133. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--address <mac-address>

Only show information for the port with this MAC address.

--node <node>

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

--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 Baremetal API Service.

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

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

--long

Show detailed information about ports.

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

Table 13.134. Output Formatters

ValueSummary

-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 13.135. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.136. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.137. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.44. baremetal port set

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>]
                                  [--is-smartnic]
                                  <port>

Set baremetal port properties.

Table 13.138. Positional Arguments

ValueSummary

<port>

Uuid of the port

Table 13.139. Optional Arguments

ValueSummary

-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

--extra <key=value>

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

--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', 'port_id' and 'hostname'. The keys 'switch_id' and 'port_id' are required. In case of a Smart NIC port, the required keys are 'port_id' and 'hostname'. Argument can be specified multiple times.

--pxe-enabled

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

--pxe-disabled

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

--physical-network <physical network>

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

--is-smartnic

Set port to be smart nic port

This command is provided by the python-ironicclient plugin.

13.45. baremetal port show

Usage:

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--noindent]
                                   [--prefix PREFIX] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--address]
                                   [--fields <field> [<field> ...]]
                                   <id>

Show baremetal port details.

Table 13.140. Positional Arguments

ValueSummary

<id>

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

Table 13.141. 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 13.142. Output Formatters

ValueSummary

-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 13.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.144. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.145. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.46. baremetal port unset

Usage:

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

                                    [--physical-network] [--is-smartnic]
                                    <port>

Unset baremetal port properties.

Table 13.146. Positional Arguments

ValueSummary

<port>

Uuid of the port.

Table 13.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

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

--port-group

Remove port from the port group

--physical-network

Unset the physical network on this baremetal port.

--is-smartnic

Set port as not smart nic port

This command is provided by the python-ironicclient plugin.

13.47. baremetal volume connector create

Usage:

openstack baremetal volume connector create [-h]

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

Create a new baremetal volume connector.

Table 13.148. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this volume connector belongs to.

--type <type>

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

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

--uuid <uuid>

Uuid of the volume connector.

--extra <key=value>

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

Table 13.149. Output Formatters

ValueSummary

-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 13.150. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.151. shell formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 13.152. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.

13.48. baremetal volume connector delete

Usage:

openstack baremetal volume connector delete [-h]

                                                 <volume connector>
                                                 [<volume connector> ...]

Unregister baremetal volume connector(s).

Table 13.153. Positional Arguments

ValueSummary

<volume connector>

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

Table 13.154. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

13.49. baremetal volume connector list

Usage:

openstack baremetal volume connector list [-h]

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

List baremetal volume connectors.

Table 13.155. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <node>

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

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

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

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

--long

Show detailed information about volume connectors.

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

Table 13.156. Output Formatters

ValueSummary

-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 13.157. CSV Formatter

ValueSummary

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

when to include quotes, defaults to nonnumeric

Table 13.158. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.159. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

This command is provided by the python-ironicclient plugin.