Command Line Interface Reference

Red Hat OpenStack Platform 15

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation Team

OpenStack Documentation Team

Abstract

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

Preface

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

Chapter 1. The OpenStack Client

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

Command-line interface to the OpenStack APIs

Usage:

openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
                 [--os-cloud <cloud-config-name>]
                 [--os-region-name <auth-region-name>]
                 [--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>]
                 [--os-key <key-file>] [--verify | --insecure]
                 [--os-default-domain <auth-domain>]
                 [--os-interface <interface>]
                 [--os-service-provider <service_provider>]
                 [--os-remote-project-name <remote_project_name> | --os-remote-project-id <remote_project_id>]
                 [--os-remote-project-domain-name <remote_project_domain_name> | --os-remote-project-domain-id <remote_project_domain_id>]
                 [--timing] [--os-beta-command] [--os-profile hmac-key]
                 [--os-compute-api-version <compute-api-version>]
                 [--os-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-tripleoclient-api-version <tripleoclient-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-metrics-api-version <metrics-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-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-username <auth-username>]
                 [--os-password <auth-password>]
                 [--os-endpoint <auth-endpoint>] [--os-token <auth-token>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--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-user <auth-user>]
                 [--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-roles <auth-roles>]
                 [--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-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-url <auth-url>] [--os-access-token <auth-access-token>]

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

Tripleo client api version, default=1 (env: OS_TRIPLEOCLIENT_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-metrics-api-version <metrics-api-version>

Metrics api version, default=1 (env: OS_METRICS_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: v3oidcpassword, admin_token, password, v3totp, noauth, none, v3oidcclientcredentials, gnocchi-basic, v3oauth1, v3tokenlessauth, v3token, gnocchi-noauth, v3applicationcredential, aodh-noauth, v2password, v3password, v2token, v3oidcauthcode, v3adfspassword, v3samlpassword, token_endpoint, v1password, token, v3oidcaccesstoken. Default: selected based on --os- username/--os-token (Env: OS_AUTH_TYPE)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-protocol <auth-protocol>

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

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

With v3oidcpassword: oauth 2.0 client id with v3oidcclientcredentials: OAuth 2.0 Client ID With v3oidcauthcode: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)

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

With v3oidcpassword: oauth 2.0 client secret with v3oidcclientcredentials: OAuth 2.0 Client Secret With v3oidcauthcode: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)

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

With v3oidcpassword: 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 v3oidcauthcode: 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 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. 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 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. (Env: OS_ACCESS_TOKEN_ENDPOINT)

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

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

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

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" 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 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" (Env: OS_ACCESS_TOKEN_TYPE)

--os-username <auth-username>

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

--os-password <auth-password>

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

--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 With gnocchi-basic: Gnocchi endpoint With gnocchi-noauth: Gnocchi endpoint (Env: OS_ENDPOINT)

--os-token <auth-token>

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

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

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

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

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

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

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

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

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

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

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

--os-passcode <auth-passcode>

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

--os-user <auth-user>

With gnocchi-basic: user (env: os_user)

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

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

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

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

--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 v3adfspassword: an identity provider url, where the SAML authentication request will be sent. With v3samlpassword: An Identity Provider URL, where the SAML2 authentication request will be sent. (Env: OS_IDENTITY_PROVIDER_URL)

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

--os-url <auth-url>

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

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

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

Chapter 2. access

This chapter describes the commands under the access command.

2.1. access token create

Create an access token

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 2.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 2.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

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

Usage:

openstack acl delete [-h] URI

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

3.2. acl get

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

Usage:

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

3.3. acl submit

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

Usage:

openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

3.4. acl user add

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

Usage:

openstack acl user add [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [--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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

3.5. acl user remove

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

Usage:

openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

Chapter 4. action

This chapter describes the commands under the action command.

4.1. action definition create

Create new action.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

4.2. action definition definition show

Show action definition.

Usage:

openstack action definition definition show [-h] name

Table 4.7. Positional Arguments

ValueSummary

name

Action name

Table 4.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

4.3. action definition delete

Delete action.

Usage:

openstack action definition delete [-h] action [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

4.4. action definition list

List all actions.

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

4.5. action definition show

Show specific action.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 4.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

4.6. action definition update

Update action.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

4.7. action execution delete

Delete action execution.

Usage:

openstack action execution delete [-h]
                                         action_execution
                                         [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

4.8. action execution input show

Show Action execution input data.

Usage:

openstack action execution input show [-h] id

Table 4.30. Positional Arguments

ValueSummary

id

Action execution id.

Table 4.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

4.9. action execution list

List all Action executions.

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

4.10. action execution output show

Show Action execution output data.

Usage:

openstack action execution output show [-h] id

Table 4.38. Positional Arguments

ValueSummary

id

Action execution id.

Table 4.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

4.11. action execution run

Create new Action execution or just run specific action.

Usage:

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 4.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.44. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

4.12. action execution show

Show specific Action execution.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 4.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.50. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

4.13. action execution update

Update specific Action execution.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 4.55. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 4.56. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

Chapter 5. address

This chapter describes the commands under the address command.

5.1. address scope create

Create a new Address Scope

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 5.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Delete address scope(s)

Usage:

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

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

List address scopes

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

Set address scope properties

Usage:

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

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

Display address scope details

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 5.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 5.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Add host to aggregate

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 6.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Create a new aggregate

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 6.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Delete existing aggregate(s)

Usage:

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

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

List all aggregates

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

Remove host from aggregate

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 6.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Set aggregate properties

Usage:

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

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

Display aggregate details

Usage:

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 6.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 6.32. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Unset aggregate properties

Usage:

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

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

Create an alarm

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 7.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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]}]}.

7.2. alarm delete

Delete an alarm

Usage:

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

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

7.4. alarm-history show

Show history for an alarm

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>

Table 7.18. Positional Arguments

ValueSummary

<alarm-id>

Id of an alarm

Table 7.19. 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.20. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 7.21. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 7.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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.

7.5. alarm list

List alarms

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

Table 7.24. 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.25. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 7.26. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 7.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

7.6. alarm show

Show an alarm

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

Table 7.29. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

Table 7.31. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 7.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.33. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

7.7. alarm state get

Get state of an alarm

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

Table 7.35. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <NAME>

Name of the alarm

Table 7.37. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 7.38. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.39. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

7.8. alarm state set

Set state of an alarm

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

Table 7.41. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.42. 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.43. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 7.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.45. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

7.9. alarm update

Update an alarm

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

Table 7.47. Positional Arguments

ValueSummary

<ALARM ID or NAME>

Id or name of an alarm.

Table 7.48. 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.49. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 7.50. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 7.51. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Table 7.53. 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.54. event alarm

ValueSummary

--event-type <EVENT_TYPE>

Event type to evaluate against

Table 7.55. 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.56. gnocchi resource threshold alarm

ValueSummary

--resource-type <RESOURCE_TYPE>

The type of resource.

--resource-id <RESOURCE_ID>

The id of a resource.

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

Chapter 8. alarming

This chapter describes the commands under the alarming command.

8.1. alarming capabilities list

List capabilities of alarming service

Usage:

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

Table 8.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 8.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 8.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 8.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

Chapter 9. application

This chapter describes the commands under the application command.

9.1. application credential create

Create new application credential

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 9.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

Delete application credentials(s)

Usage:

openstack application credential delete [-h]
                                               <application-credential>
                                               [<application-credential> ...]

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

List application credentials

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

Display application credential details

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 9.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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

List availability zones and their status

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

Create a new baremetal allocation.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.2. baremetal allocation delete

Unregister baremetal allocation(s).

Usage:

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

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

11.3. baremetal allocation list

List baremetal allocations.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.4. baremetal allocation show

Show baremetal allocation details.

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.17. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.5. baremetal chassis create

Create a new chassis.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.22. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.6. baremetal chassis delete

Delete a chassis.

Usage:

openstack baremetal chassis delete [-h] <chassis> [<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

11.7. baremetal chassis list

List the chassis.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.8. baremetal chassis set

Set chassis properties.

Usage:

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

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)

11.9. baremetal chassis show

Show chassis details.

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.37. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.10. baremetal chassis unset

Unset chassis properties.

Usage:

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

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)

11.11. baremetal conductor list

List baremetal conductors

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.12. baremetal conductor show

Show baremetal conductor details

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.50. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.13. baremetal create

Create resources from files

Usage:

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

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

11.14. baremetal deploy template create

Create a new deploy template

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.58. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.15. baremetal deploy template delete

Delete deploy template(s).

Usage:

openstack baremetal deploy template delete [-h]
                                                  <template> [<template> ...]

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

11.16. baremetal deploy template list

List baremetal deploy templates.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.17. baremetal deploy template set

Set baremetal deploy template properties.

Usage:

openstack baremetal deploy template set [-h] [--name <name>]
                                               [--steps <steps>]
                                               [--extra <key=value>]
                                               <template>

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

11.18. baremetal deploy template show

Show baremetal deploy template details.

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.73. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.19. baremetal deploy template unset

Unset baremetal deploy template properties.

Usage:

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

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

11.20. baremetal driver list

List the enabled drivers.

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.21. baremetal driver passthru call

Call a vendor passthru method for a driver.

Usage:

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.85. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.86. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.22. baremetal driver passthru list

List available vendor passthru methods for a driver.

Usage:

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.23. baremetal driver property list

List the driver properties.

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>

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.24. baremetal driver raid property list

List a driver’s RAID logical disk properties.

Usage:

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.25. baremetal driver show

Show information about a driver.

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.109. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.110. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.26. baremetal introspection abort

Abort running introspection for node.

Usage:

openstack baremetal introspection abort [-h] 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

11.27. baremetal introspection data save

Save or display raw introspection data.

Usage:

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

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)

11.28. baremetal introspection interface list

List interface data including attached switch port information.

Usage:

openstack baremetal introspection interface list [-h]
                                                        [-f {csv,json,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.29. baremetal introspection interface show

Show interface data including attached switch port information.

Usage:

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.125. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.126. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.30. baremetal introspection list

List introspection statuses

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]

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.31. baremetal introspection reprocess

Reprocess stored introspection data

Usage:

openstack baremetal introspection reprocess [-h] node

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

11.32. baremetal introspection rule delete

Delete an introspection rule.

Usage:

openstack baremetal introspection rule delete [-h] uuid

Table 11.135. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 11.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.33. baremetal introspection rule import

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

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.34. baremetal introspection rule list

List all introspection rules.

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]

Table 11.143. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.144. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.35. baremetal introspection rule purge

Drop all introspection rules.

Usage:

openstack baremetal introspection rule purge [-h]

Table 11.148. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.36. baremetal introspection rule show

Show an introspection rule.

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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.152. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.153. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.37. baremetal introspection start

Start the introspection.

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

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.38. baremetal introspection status

Get 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

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.164. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.165. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.39. baremetal node abort

Set provision state of baremetal node to abort

Usage:

openstack baremetal node abort [-h] <node>

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

11.40. baremetal node add trait

Add traits to a node.

Usage:

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

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

11.41. baremetal node adopt

Set provision state of baremetal node to adopt

Usage:

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

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.

11.42. baremetal node bios setting list

List a node’s BIOS settings.

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>

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

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

11.43. baremetal node bios setting show

Show a specific BIOS setting for a node.

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>

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.182. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.183. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--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.

11.44. baremetal node boot device set

Set the boot device for a node

Usage:

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

Table 11.185. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<device>

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

Table 11.186. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

11.45. baremetal node boot device show

Show the boot device information for a node

Usage:

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

Table 11.187. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.188. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

Table 11.189. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.190. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.191. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.46. baremetal node clean

Set provision state of baremetal node to clean

Usage:

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

Table 11.193. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.47. baremetal node console disable

Disable console access for a node

Usage:

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

Table 11.195. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.196. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.48. baremetal node console enable

Enable console access for a node

Usage:

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

Table 11.197. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.198. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.49. baremetal node console show

Show console information for a node

Usage:

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

Table 11.199. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.200. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.201. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.202. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.203. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.50. baremetal node create

Register a new node with the baremetal service

Usage:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--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>]

Table 11.205. 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 11.206. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.207. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.208. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.51. baremetal node delete

Unregister baremetal node(s)

Usage:

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

Table 11.210. Positional Arguments

ValueSummary

<node>

Node(s) to delete (name or uuid)

Table 11.211. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.52. baremetal node deploy

Set provision state of baremetal node to deploy

Usage:

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

Table 11.212. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.53. baremetal node inject nmi

Inject NMI to baremetal node

Usage:

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

Table 11.214. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 11.215. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.54. baremetal node inspect

Set provision state of baremetal node to inspect

Usage:

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

Table 11.216. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.55. baremetal node list

List baremetal nodes

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

Table 11.218. 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 11.219. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.220. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.221. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.56. baremetal node maintenance set

Set baremetal node to maintenance mode

Usage:

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

Table 11.223. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 11.224. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

11.57. baremetal node maintenance unset

Unset baremetal node from maintenance mode

Usage:

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

Table 11.225. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 11.226. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.58. baremetal node manage

Set provision state of baremetal node to manage

Usage:

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

Table 11.227. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.59. baremetal node passthru call

Call a vendor passthu method for a node

Usage:

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

Table 11.229. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

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

11.60. baremetal node passthru list

List vendor passthru methods for a node

Usage:

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

Table 11.231. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.232. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.233. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.234. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.235. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.61. baremetal node power off

Power off a node

Usage:

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

Table 11.237. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.62. baremetal node power on

Power on a node

Usage:

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

Table 11.239. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.63. baremetal node provide

Set provision state of baremetal node to provide

Usage:

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

Table 11.241. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.64. baremetal node reboot

Reboot baremetal node

Usage:

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

Table 11.243. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.65. baremetal node rebuild

Set provision state of baremetal node to rebuild

Usage:

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

Table 11.245. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.66. baremetal node remove trait

Remove trait(s) from a node.

Usage:

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

Table 11.247. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to remove

Table 11.248. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Remove all traits

11.67. baremetal node rescue

Set provision state of baremetal node to rescue

Usage:

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

Table 11.249. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.68. baremetal node set

Set baremetal properties

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>

Table 11.251. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.69. baremetal node show

Show baremetal node details

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>

Table 11.253. Positional Arguments

ValueSummary

<node>

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

Table 11.254. 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 11.255. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.256. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.257. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.70. baremetal node trait list

List a node’s traits.

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>

Table 11.259. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.260. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.261. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.262. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.263. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.71. baremetal node undeploy

Set provision state of baremetal node to deleted

Usage:

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

Table 11.265. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.72. baremetal node unrescue

Set provision state of baremetal node to unrescue

Usage:

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

Table 11.267. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.73. baremetal node unset

Unset baremetal properties

Usage:

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--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>

Table 11.269. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

11.74. baremetal node validate

Validate a node’s driver interfaces

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>

Table 11.271. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.272. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.273. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.274. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.275. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.75. baremetal node vif attach

Attach VIF to a given node

Usage:

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

Table 11.277. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

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

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

11.76. baremetal node vif detach

Detach VIF from a given node

Usage:

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

Table 11.279. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

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

Table 11.280. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.77. baremetal node vif list

Show attached VIFs for a node

Usage:

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

Table 11.281. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 11.282. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 11.283. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.284. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.285. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.78. baremetal port create

Create a new port

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>

Table 11.287. Positional Arguments

ValueSummary

<address>

Mac address for this port.

Table 11.288. 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 11.289. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.290. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.291. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.79. baremetal port delete

Delete port(s).

Usage:

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

Table 11.293. Positional Arguments

ValueSummary

<port>

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

Table 11.294. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.80. baremetal port group create

Create a new baremetal port group.

Usage:

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--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]

Table 11.295. 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 11.296. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.297. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.298. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.81. baremetal port group delete

Unregister baremetal port group(s).

Usage:

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

Table 11.300. Positional Arguments

ValueSummary

<port group>

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

Table 11.301. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.82. baremetal port group list

List baremetal port groups.

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

Table 11.302. 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 11.303. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.304. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.305. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.83. baremetal port group set

Set baremetal port group properties.

Usage:

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

Table 11.307. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

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

11.84. baremetal port group show

Show baremetal port group details.

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>

Table 11.309. Positional Arguments

ValueSummary

<id>

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

Table 11.310. 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 11.311. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.312. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.313. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.85. baremetal port group unset

Unset baremetal port group properties.

Usage:

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

Table 11.315. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

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

11.86. baremetal port list

List baremetal ports.

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

Table 11.317. 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 11.318. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.319. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.320. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.87. baremetal port set

Set baremetal port properties.

Usage:

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

Table 11.322. Positional Arguments

ValueSummary

<port>

Uuid of the port

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

11.88. baremetal port show

Show baremetal port details.

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>

Table 11.324. Positional Arguments

ValueSummary

<id>

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

Table 11.325. 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 11.326. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.327. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.328. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.89. baremetal port unset

Unset baremetal port properties.

Usage:

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

Table 11.330. Positional Arguments

ValueSummary

<port>

Uuid of the port.

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

11.90. baremetal volume connector create

Create a new baremetal volume connector.

Usage:

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

Table 11.332. 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 11.333. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.334. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.335. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.91. baremetal volume connector delete

Unregister baremetal volume connector(s).

Usage:

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

Table 11.337. Positional Arguments

ValueSummary

<volume connector>

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

Table 11.338. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.92. baremetal volume connector list

List baremetal volume connectors.

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

Table 11.339. 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 11.340. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.341. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.342. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.93. baremetal volume connector set

Set baremetal volume connector properties.

Usage:

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

Table 11.344. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

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

--extra <key=value>

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

11.94. baremetal volume connector show

Show baremetal volume connector details.

Usage:

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

Table 11.346. Positional Arguments

ValueSummary

<id>

Uuid of the volume connector.

Table 11.347. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 11.348. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.349. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.350. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.95. baremetal volume connector unset

Unset baremetal volume connector properties.

Usage:

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

Table 11.352. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

Table 11.353. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

11.96. baremetal volume target create

Create a new baremetal volume target.

Usage:

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

Table 11.354. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this volume target belongs to.

--type <volume type>

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

--property <key=value>

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

--boot-index <boot index>

Boot index of the volume target.

--volume-id <volume id>

Id of the volume associated with this target.

--uuid <uuid>

Uuid of the volume target.

--extra <key=value>

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

Table 11.355. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.356. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.357. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.97. baremetal volume target delete

Unregister baremetal volume target(s).

Usage:

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

Table 11.359. Positional Arguments

ValueSummary

<volume target>

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

Table 11.360. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

11.98. baremetal volume target list

List baremetal volume targets.

Usage:

openstack baremetal volume target 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 target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

Table 11.361. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <node>

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

--limit <limit>

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

--marker <volume target>

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

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

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

--long

Show detailed information about volume targets.

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

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

Table 11.362. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 11.363. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 11.364. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

11.99. baremetal volume target set

Set baremetal volume target properties.

Usage:

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

Table 11.366. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 11.367. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this volume target belongs to.

--type <volume type>

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

--property <key=value>

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

--boot-index <boot index>

Boot index of the volume target.

--volume-id <volume id>

Id of the volume associated with this target.

--extra <key=value>

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

11.100. baremetal volume target show

Show baremetal volume target details.

Usage:

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

Table 11.368. Positional Arguments

ValueSummary

<id>

Uuid of the volume target.

Table 11.369. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

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

Table 11.370. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 11.371. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 11.372. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

11.101. baremetal volume target unset

Unset baremetal volume target properties.

Usage:

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

Table 11.374. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 11.375. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

--property <key>

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

Chapter 12. bgp

This chapter describes the commands under the bgp command.

12.1. bgp dragent add speaker

Add a BGP speaker to a dynamic routing agent

Usage:

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

Table 12.1. Positional Arguments

ValueSummary

<agent-id>

Id of the dynamic routing agent

<bgp-speaker>

Id or name of the bgp speaker

Table 12.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.2. bgp dragent remove speaker

Removes a BGP speaker from a dynamic routing agent

Usage:

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

Table 12.3. Positional Arguments

ValueSummary

<agent-id>

Id of the dynamic routing agent

<bgp-speaker>

Id or name of the bgp speaker

Table 12.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.3. bgp peer create

Create a BGP peer

Usage:

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

Table 12.5. Positional Arguments

ValueSummary

<name>

Name of the bgp peer to create

Table 12.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Peer ip address

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

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

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

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

--password <auth-password>

Authentication password

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

Table 12.7. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 12.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 12.9. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

12.4. bgp peer delete

Delete a BGP peer

Usage:

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

Table 12.11. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to delete (name or id)

Table 12.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.5. bgp peer list

List BGP peers

Usage:

openstack bgp peer 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]

Table 12.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.14. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 12.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 12.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

12.6. bgp peer set

Update a BGP peer

Usage:

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

Table 12.18. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to update (name or id)

Table 12.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Updated name of the bgp peer

--password <auth-password>

Updated authentication password

12.7. bgp peer show

Show information for a BGP peer

Usage:

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

Table 12.20. Positional Arguments

ValueSummary

<bgp-peer>

Bgp peer to display (name or id)

Table 12.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 12.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 12.24. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

12.8. bgp speaker add network

Add a network to a BGP speaker

Usage:

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

Table 12.26. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<network>

Network to add (name or id)

Table 12.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.9. bgp speaker add peer

Add a peer to a BGP speaker

Usage:

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

Table 12.28. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<bgp-peer>

Bgp peer to add (name or id)

Table 12.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.10. bgp speaker create

Create a BGP speaker

Usage:

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

Table 12.30. Positional Arguments

ValueSummary

<name>

Name of the bgp speaker to create

Table 12.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--local-as <local-as>

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

--ip-version {4,6}

Ip version for the bgp speaker (default is 4)

--advertise-floating-ip-host-routes

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

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

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

--advertise-tenant-networks

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

--no-advertise-tenant-networks

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

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

Table 12.32. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 12.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 12.34. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

12.11. bgp speaker delete

Delete a BGP speaker

Usage:

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

Table 12.36. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to delete (name or id)

Table 12.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.12. bgp speaker list advertised routes

List routes advertised

Usage:

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

Table 12.38. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

Table 12.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.40. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 12.41. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 12.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

12.13. bgp speaker list

List BGP speakers

Usage:

openstack bgp speaker 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]
                                  [--agent <agent-id>]

Table 12.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--agent <agent-id>

List bgp speakers hosted by an agent (id only)

Table 12.45. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 12.46. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 12.47. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

12.14. bgp speaker remove network

Remove a network from a BGP speaker

Usage:

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

Table 12.49. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<network>

Network to remove (name or id)

Table 12.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.15. bgp speaker remove peer

Remove a peer from a BGP speaker

Usage:

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

Table 12.51. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker (name or id)

<bgp-peer>

Bgp peer to remove (name or id)

Table 12.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

12.16. bgp speaker set

Set BGP speaker properties

Usage:

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

Table 12.53. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to update (name or id)

Table 12.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Name of the bgp speaker to update

--advertise-floating-ip-host-routes

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

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

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

--advertise-tenant-networks

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

--no-advertise-tenant-networks

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

12.17. bgp speaker show dragents

List dynamic routing agents hosting a BGP speaker

Usage:

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

Table 12.55. Positional Arguments

ValueSummary

<bgp-speaker>

Id or name of the bgp speaker

Table 12.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.57. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 12.58. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 12.59. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

12.18. bgp speaker show

Show a BGP speaker

Usage:

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

Table 12.61. Positional Arguments

ValueSummary

<bgp-speaker>

Bgp speaker to display (name or id)

Table 12.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 12.63. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 12.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 12.65. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 13. bgpvpn

This chapter describes the commands under the bgpvpn command.

13.1. bgpvpn create

Create BGP VPN resource

Usage:

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

Table 13.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--name <name>

Name of the bgp vpn

--route-target <route-target>

Add route target to import/export list (repeat option for multiple Route Targets)

--import-target <import-target>

Add route target to import list (repeat option for multiple Route Targets)

--export-target <export-target>

Add route target to export list (repeat option for multiple Route Targets)

--route-distinguisher <route-distinguisher>

Add route distinguisher to the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

--type {l2,l3}

Bgp vpn type selection between ip vpn (l3) and Ethernet VPN (l2) (default: l3)

Table 13.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.4. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.2. bgpvpn delete

Delete BGP VPN resource(s)

Usage:

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

Table 13.6. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn(s) to delete (name or id)

Table 13.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.3. bgpvpn list

List BGP VPN resources

Usage:

openstack bgpvpn 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] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]

Table 13.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

Table 13.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 13.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.4. bgpvpn network association create

Create a BGP VPN network association

Usage:

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>

Table 13.13. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the network association (name or id)

<network>

Network to associate the bgp vpn (name or id)

Table 13.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 13.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.17. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.5. bgpvpn network association delete

Delete a BGP VPN network association(s) for a given BGP VPN

Usage:

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

Table 13.19. Positional Arguments

ValueSummary

<network association ID>

Network association id(s) to remove

<bgpvpn>

Bgp vpn the network association belongs to (name or ID)

Table 13.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.6. bgpvpn network association list

List BGP VPN network associations for a given BGP VPN

Usage:

openstack bgpvpn network association 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]
                                                 [--property <key=value>]
                                                 <bgpvpn>

Table 13.21. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

Table 13.23. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 13.24. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.7. bgpvpn network association show

Show information of a given BGP VPN network association

Usage:

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

Table 13.27. Positional Arguments

ValueSummary

<network association ID>

Network association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.29. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.30. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.31. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.8. bgpvpn port association create

Create a BGP VPN port association

Usage:

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--project <project>]
                                                [--project-domain <project-domain>]
                                                [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                                [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                                [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                                <bgpvpn> <port>

Table 13.33. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the port association (name or id)

<port>

Port to associate the bgp vpn (name or id)

Table 13.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN (default)

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

Table 13.35. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.37. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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.

13.9. bgpvpn port association delete

Delete a BGP VPN port association(s) for a given BGP VPN

Usage:

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

Table 13.39. Positional Arguments

ValueSummary

<port association ID>

Port association id(s) to remove

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.10. bgpvpn port association list

List BGP VPN port associations for a given BGP VPN

Usage:

openstack bgpvpn port association 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]
                                              [--property <key=value>]
                                              <bgpvpn>

Table 13.41. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

Table 13.43. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 13.44. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.45. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.11. bgpvpn port association set

Set BGP VPN port association properties

Usage:

openstack bgpvpn port association set [-h]
                                             [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                             [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                             [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                             [--no-prefix-route]
                                             [--no-bgpvpn-route]
                                             <port association ID> <bgpvpn>

Table 13.47. Positional Arguments

ValueSummary

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--no-advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

Add prefix route in cidr notation. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple prefix routes)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

Add bgp vpn route for route leaking. optionally, can control the value of the BGP LOCAL_PREF of the routes that will be advertised (repeat option for multiple BGP VPN routes)

--no-prefix-route

Empty prefix route list

--no-bgpvpn-route

Empty bgp vpn route list

13.12. bgpvpn port association show

Show information of a given BGP VPN port association

Usage:

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

Table 13.49. Positional Arguments

ValueSummary

<port association ID>

Port association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.51. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.53. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.13. bgpvpn port association unset

Unset BGP VPN port association properties

Usage:

openstack bgpvpn port association unset [-h]
                                               [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                               [--prefix-route <cidr>]
                                               [--bgpvpn-route <BGP VPN ID or name>]
                                               [--all-prefix-routes]
                                               [--all-bgpvpn-routes]
                                               <port association ID> <bgpvpn>

Table 13.55. Positional Arguments

ValueSummary

<port association ID>

Port association id to update

<bgpvpn>

Bgp vpn the port association belongs to (name or id)

Table 13.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise-fixed-ips

Fixed ips of the port will not be advertised to the BGP VPN

--no-advertise-fixed-ips

Fixed ips of the port will be advertised to the bgp VPN

--prefix-route <cidr>

Remove prefix route in cidr notation (repeat option for multiple prefix routes)

--bgpvpn-route <BGP VPN ID or name>

Remove bgp vpn route (repeat option for multiple bgp VPN routes)

--all-prefix-routes

Empty prefix route list

--all-bgpvpn-routes

Empty bgp vpn route list

13.14. bgpvpn router association create

Create a BGP VPN router association

Usage:

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  [--advertise_extra_routes | --no-advertise_extra_routes]
                                                  <bgpvpn> <router>

Table 13.57. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to apply the router association (name or id)

<router>

Router to associate the bgp vpn (name or id)

Table 13.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

--advertise_extra_routes

Routes will be advertised to the bgp vpn (default)

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

Table 13.59. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.60. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.61. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.15. bgpvpn router association delete

Delete a BGP VPN router association(s) for a given BGP VPN

Usage:

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

Table 13.63. Positional Arguments

ValueSummary

<router association ID>

Router association id(s) to remove

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.64. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

13.16. bgpvpn router association list

List BGP VPN router associations for a given BGP VPN

Usage:

openstack bgpvpn router association 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]
                                                [--property <key=value>]
                                                <bgpvpn>

Table 13.65. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn listed associations belong to (name or id)

Table 13.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--property <key=value>

Filter property to apply on returned bgp vpns (repeat to filter on multiple properties)

Table 13.67. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 13.68. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

13.17. bgpvpn router association set

Set BGP VPN router association properties

Usage:

openstack bgpvpn router association set [-h]
                                               [--advertise_extra_routes | --no-advertise_extra_routes]
                                               <router association ID>
                                               <bgpvpn>

Table 13.71. Positional Arguments

ValueSummary

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes will be advertised to the bgp vpn

--no-advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

13.18. bgpvpn router association show

Show information of a given BGP VPN router association

Usage:

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

Table 13.73. Positional Arguments

ValueSummary

<router association ID>

Router association id to look up

<bgpvpn>

Bgp vpn the association belongs to (name or id)

Table 13.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.75. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.77. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.19. bgpvpn router association unset

Unset BGP VPN router association properties

Usage:

openstack bgpvpn router association unset [-h]
                                                 [--advertise_extra_routes | --no-advertise_extra_routes]
                                                 <router association ID>
                                                 <bgpvpn>

Table 13.79. Positional Arguments

ValueSummary

<router association ID>

Router association id to update

<bgpvpn>

Bgp vpn the router association belongs to (name or id)

Table 13.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--advertise_extra_routes

Routes from the router will not be advertised to the BGP VPN

--no-advertise_extra_routes

Routes will be advertised to the bgp vpn

13.20. bgpvpn set

Set BGP VPN properties

Usage:

openstack bgpvpn set [-h] [--name <name>]
                            [--route-target <route-target>]
                            [--no-route-target]
                            [--import-target <import-target>]
                            [--no-import-target]
                            [--export-target <export-target>]
                            [--no-export-target]
                            [--route-distinguisher <route-distinguisher>]
                            [--no-route-distinguisher] [--vni VNI]
                            [--local-pref LOCAL_PREF]
                            <bgpvpn>

Table 13.81. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to update (name or id)

Table 13.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the bgp vpn

--route-target <route-target>

Add route target to import/export list (repeat option for multiple Route Targets)

--no-route-target

Empty route target list

--import-target <import-target>

Add route target to import list (repeat option for multiple Route Targets)

--no-import-target

Empty import route target list

--export-target <export-target>

Add route target to export list (repeat option for multiple Route Targets)

--no-export-target

Empty export route target list

--route-distinguisher <route-distinguisher>

Add route distinguisher to the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--no-route-distinguisher

Empty route distinguisher list

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

13.21. bgpvpn show

Show information of a given BGP VPN

Usage:

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

Table 13.83. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to display (name or id)

Table 13.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.85. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 13.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.87. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

13.22. bgpvpn unset

Unset BGP VPN properties

Usage:

openstack bgpvpn unset [-h] [--route-target <route-target>]
                              [--all-route-target]
                              [--import-target <import-target>]
                              [--all-import-target]
                              [--export-target <export-target>]
                              [--all-export-target]
                              [--route-distinguisher <route-distinguisher>]
                              [--all-route-distinguisher] [--vni VNI]
                              [--local-pref LOCAL_PREF]
                              <bgpvpn>

Table 13.89. Positional Arguments

ValueSummary

<bgpvpn>

Bgp vpn to update (name or id)

Table 13.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--route-target <route-target>

Remove route target from import/export list (repeat option for multiple Route Targets)

--all-route-target

Empty route target list

--import-target <import-target>

Remove route target from import list (repeat option for multiple Route Targets)

--all-import-target

Empty import route target list

--export-target <export-target>

Remove route target from export list (repeat option for multiple Route Targets)

--all-export-target

Empty export route target list

--route-distinguisher <route-distinguisher>

Remove route distinguisher from the list of route Distinguishers from which a Route Distinguishers will be picked from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--all-route-distinguisher

Empty route distinguisher list

--vni VNI

Vxlan network identifier to be used for this bgpvpn when a VXLAN encapsulation is used

--local-pref LOCAL_PREF

Default bgp local_pref to use in route advertisementstowards this BGPVPN.

Chapter 14. ca

This chapter describes the commands under the ca command.

14.1. ca get

Retrieve a CA by providing its URI.

Usage:

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

Table 14.1. Positional Arguments

ValueSummary

URI

The uri reference for the ca.

Table 14.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 14.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 14.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

14.2. ca list

List CAs.

Usage:

openstack ca 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]
                         [--offset OFFSET] [--name NAME]

Table 14.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

Specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

Specify the page offset (default: 0)

--name NAME, -n NAME

Specify the ca name (default: none)

Table 14.8. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 14.9. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 14.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.11. 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 15. catalog

This chapter describes the commands under the catalog command.

15.1. catalog list

List services in the service catalog

Usage:

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

Table 15.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 15.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 15.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 15.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

15.2. catalog show

Display service catalog details

Usage:

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

Table 15.6. Positional Arguments

ValueSummary

<service>

Service to display (type or name)

Table 15.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 15.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 15.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 15.10. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 15.11. 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 16. coe

This chapter describes the commands under the coe command.

16.1. coe ca rotate

Rotate the CA certificate for cluster to revoke access.

Usage:

openstack coe ca rotate [-h] <cluster>

Table 16.1. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 16.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.2. coe ca show

Show details about the CA certificate for a cluster.

Usage:

openstack coe ca show [-h] <cluster>

Table 16.3. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 16.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.3. coe ca sign

Generate the CA certificate for a cluster.

Usage:

openstack coe ca sign [-h] <cluster> <csr>

Table 16.5. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

<csr>

File path of csr file to send to magnum to get signed.

Table 16.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.4. coe cluster config

Get Configuration for a Cluster

Usage:

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

Table 16.7. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

Table 16.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dir <dir>

Directory to save the certificate and config files.

--force

Overwrite files if existing.

--output-certs

Output certificates in separate files.

--use-certificate

Use certificate in config files.

--use-keystone

Use keystone token in config files.

16.5. coe cluster create

Create a cluster

Usage:

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    <name>

Table 16.9. Positional Arguments

ValueSummary

<name>

Name of the cluster to create.

Table 16.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--cluster-template <cluster-template>

Id or name of the cluster template.

--discovery-url <discovery-url>

Specifies custom delivery url for node discovery.

--docker-volume-size <docker-volume-size>

The size in gb for the docker volume to use.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=valuepairs to associate with a cluster template. May be used multiple times.

--keypair <keypair>

Uuid or name of the keypair to use.

--master-count <master-count>

The number of master nodes for the cluster.

--node-count <node-count>

The cluster node count.

--timeout <timeout>

The timeout for cluster creation time. the default is 60 minutes.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

16.6. coe cluster delete

Delete a cluster

Usage:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

Table 16.11. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster(s) to delete.

Table 16.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.7. coe cluster list

List clusters

Usage:

openstack coe cluster 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>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

Table 16.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of clusters to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

Table 16.14. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 16.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 16.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

16.8. coe cluster show

Show a Cluster

Usage:

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

Table 16.18. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster to show.

Table 16.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.20. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 16.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.22. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

16.9. coe cluster template create

Create a Cluster Template.

Usage:

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             <name>

Table 16.24. Positional Arguments

ValueSummary

<name>

Name of the cluster template to create.

Table 16.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--coe <coe>

Specify the container orchestration engine to use.

--image <image>

The name or uuid of the base image to customize for the Cluster.

--external-network <external-network>

The external neutron network name or uuid to connect to this Cluster Template.

--keypair <keypair>

The name or uuid of the ssh keypair to load into the Cluster nodes.

--fixed-network <fixed-network>

The private neutron network name to connect to this Cluster model.

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--network-driver <network-driver>

The network driver name for instantiating container networks.

--volume-driver <volume-driver>

The volume driver name for instantiating container volume.

--dns-nameserver <dns-nameserver>

The dns nameserver to use for this cluster template.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--docker-volume-size <docker-volume-size>

Specify the number of size in gb for the docker volume to use.

--docker-storage-driver <docker-storage-driver>

Select a docker storage driver. supported: devicemapper, overlay. Default: devicemapper

--http-proxy <http-proxy>

The http_proxy address to use for nodes in cluster.

--https-proxy <https-proxy>

The https_proxy address to use for nodes in cluster.

--no-proxy <no-proxy>

The no_proxy address to use for nodes in cluster.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=value pairs to associate with a cluster template. May be used multiple times.

--tls-disabled

Disable tls in the cluster.

--public

Make cluster template public.

--registry-enabled

Enable docker registry in the cluster

--server-type <server-type>

Specify the server type to be used for example vm. for this release default server type will be vm.

--master-lb-enabled

Indicates whether created clusters should have a load balancer for master nodes or not.

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

--floating-ip-disabled

Disables floating ip creation on the new cluster

Table 16.26. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 16.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.28. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

16.10. coe cluster template delete

Delete a Cluster Template.

Usage:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

Table 16.30. Positional Arguments

ValueSummary

<cluster-templates>

Id or name of the (cluster template)s to delete.

Table 16.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.11. coe cluster template list

List Cluster Templates.

Usage:

openstack coe cluster 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>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

Table 16.32. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of cluster templates to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--fields <fields>

Comma-separated list of fields to display. available fields: uuid, name, coe, image_id, public, link, apiserver_port, server_type, tls_disabled, registry_enabled

Table 16.33. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 16.34. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 16.35. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

16.12. coe cluster template show

Show a Cluster Template.

Usage:

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

Table 16.37. Positional Arguments

ValueSummary

<cluster-template>

Id or name of the cluster template to show.

Table 16.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.39. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 16.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.41. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

16.13. coe cluster template update

Update a Cluster Template.

Usage:

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

Table 16.43. Positional Arguments

ValueSummary

<cluster-template>

The name or uuid of cluster template to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

Table 16.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.45. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 16.46. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.47. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

16.14. coe cluster update

Update a Cluster

Usage:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

Table 16.49. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

Table 16.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--rollback

Rollback cluster on update failure.

16.15. coe quotas create

Create a quota.

Usage:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 16.51. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

16.16. coe quotas delete

Delete specified resource quota.

Usage:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

Table 16.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

16.17. coe quotas list

Print a list of available quotas.

Usage:

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

Table 16.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <marker>

The last quota uuid of the previous page; displays list of quotas after "marker".

--limit <limit>

Maximum number of quotas to return.

--sort-key <sort-key>

Column to sort results by.

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--all-tenants

Flag to indicate list all tenant quotas.

16.18. coe quotas show

Show details about the given project resource quota.

Usage:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

Table 16.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

16.19. coe quotas update

Update information about the given project resource quota.

Usage:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 16.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

16.20. coe service list

Print a list of Magnum services.

Usage:

openstack coe service 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]

Table 16.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.57. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 16.58. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 16.59. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

16.21. coe stats list

Show stats for the given project_id

Usage:

openstack coe stats list [-h] <project>

Table 16.61. Positional Arguments

ValueSummary

<project>

Project id

Table 16.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 17. command

This chapter describes the commands under the command command.

17.1. command list

List recognized commands by group

Usage:

openstack command 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]
                              [--group <group-keyword>]

Table 17.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group <group-keyword>

Show commands filtered by a command group, for example: identity, volume, compute, image, network and other keywords

Table 17.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 17.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 17.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 17.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 18. complete.adoc

This chapter describes the commands under the complete.adoc command.

18.1. complete

print bash completion command

Usage:

openstack complete [-h] [--name <command_name>] [--shell <shell>]

Table 18.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <command_name>

Command name to support with command completion

--shell <shell>

Shell being used. use none for data only (default: bash)

Chapter 19. compute

This chapter describes the commands under the compute command.

19.1. compute agent create

Create compute agent

Usage:

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

Table 19.1. Positional Arguments

ValueSummary

<os>

Type of os

<architecture>

Type of architecture

<version>

Version

<url>

Url

<md5hash>

Md5 hash

<hypervisor>

Type of hypervisor

Table 19.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 19.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 19.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 19.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

19.2. compute agent delete

Delete compute agent(s)

Usage:

openstack compute agent delete [-h] <id> [<id> ...]

Table 19.7. Positional Arguments

ValueSummary

<id>

Id of agent(s) to delete

Table 19.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

19.3. compute agent list

List compute agents

Usage:

openstack compute agent 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]
                                    [--hypervisor <hypervisor>]

Table 19.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--hypervisor <hypervisor>

Type of hypervisor

Table 19.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 19.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 19.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

19.4. compute agent set

Set compute agent properties

Usage:

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

Table 19.14. Positional Arguments

ValueSummary

<id>

Id of the agent

Table 19.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--agent-version <version>

Version of the agent

--url <url>

Url of the agent

--md5hash <md5hash>

Md5 hash of the agent

19.5. compute service delete

Delete compute service(s)

Usage:

openstack compute service delete [-h] <service> [<service> ...]

Table 19.16. Positional Arguments

ValueSummary

<service>

Compute service(s) to delete (id only). if using ``--os-compute- api-version`` 2.53 or greater, the ID is a UUID which can be retrieved by listing compute services using the same 2.53+ microversion.

Table 19.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

19.6. compute service list

List compute services. Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a UUID value which can be used to uniquely identify the service in a multi-cell deployment.

Usage:

openstack compute service 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]
                                      [--host <host>] [--service <service>]
                                      [--long]

Table 19.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--service <service>

List only specified service (name only)

--long

List additional fields in output

Table 19.19. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 19.20. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 19.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

19.7. compute service set

Set compute service properties

Usage:

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

Table 19.23. Positional Arguments

ValueSummary

<host>

Name of host

<service>

Name of service (binary name)

Table 19.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable service

--disable

Disable service

--disable-reason <reason>

Reason for disabling the service (in quotes). should be used with --disable option.

--up

Force up service

--down

Force down service

Chapter 20. configuration

This chapter describes the commands under the configuration command.

20.1. configuration show

Display configuration details

Usage:

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

Table 20.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--mask

Attempt to mask passwords (default)

--unmask

Show password in clear text

Table 20.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 20.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 20.4. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 20.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 21. consistency

This chapter describes the commands under the consistency command.

21.1. consistency group add volume

Add volume(s) to consistency group

Usage:

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

Table 21.1. Positional Arguments

ValueSummary

<consistency-group>

Consistency group to contain <volume> (name or id)

<volume>

Volume(s) to add to <consistency-group> (name or id) (repeat option to add multiple volumes)

Table 21.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

21.2. consistency group create

Create new consistency group.

Usage:

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>)
                                          [--description <description>]
                                          [--availability-zone <availability-zone>]
                                          [<name>]

Table 21.3. Positional Arguments

ValueSummary

<name>

Name of new consistency group (default to none)

Table 21.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume-type <volume-type>

Volume type of this consistency group (name or id)

--consistency-group-source <consistency-group>

Existing consistency group (name or id)

--consistency-group-snapshot <consistency-group-snapshot>

Existing consistency group snapshot (name or id)

--description <description>

Description of this consistency group

--availability-zone <availability-zone>

Availability zone for this consistency group (not available if creating consistency group from source)

Table 21.5. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 21.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.7. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

21.3. consistency group delete

Delete consistency group(s).

Usage:

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

Table 21.9. Positional Arguments

ValueSummary

<consistency-group>

Consistency group(s) to delete (name or id)

Table 21.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Allow delete in state other than error or available

21.4. consistency group list

List consistency groups.

Usage:

openstack consistency 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]
                                        [--all-projects] [--long]

Table 21.11. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show details for all projects. admin only. (defaults to False)

--long

List additional fields in output

Table 21.12. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 21.13. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 21.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

21.5. consistency group remove volume

Remove volume(s) from consistency group

Usage:

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

Table 21.16. Positional Arguments

ValueSummary

<consistency-group>

Consistency group containing <volume> (name or id)

<volume>

Volume(s) to remove from <consistency-group> (name or ID) (repeat option to remove multiple volumes)

Table 21.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

21.6. consistency group set

Set consistency group properties

Usage:

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

Table 21.18. Positional Arguments

ValueSummary

<consistency-group>

Consistency group to modify (name or id)

Table 21.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New consistency group name

--description <description>

New consistency group description

21.7. consistency group show

Display consistency group details.

Usage:

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

Table 21.20. Positional Arguments

ValueSummary

<consistency-group>

Consistency group to display (name or id)

Table 21.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 21.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 21.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.24. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

21.8. consistency group snapshot create

Create new consistency group snapshot.

Usage:

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]

Table 21.26. Positional Arguments

ValueSummary

<snapshot-name>

Name of new consistency group snapshot (default to None)

Table 21.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--consistency-group <consistency-group>

Consistency group to snapshot (name or id) (default to be the same as <snapshot-name>)

--description <description>

Description of this consistency group snapshot

Table 21.28. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 21.29. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.30. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

21.9. consistency group snapshot delete

Delete consistency group snapshot(s).

Usage:

openstack consistency group snapshot delete [-h]
                                                   <consistency-group-snapshot>
                                                   [<consistency-group-snapshot> ...]

Table 21.32. Positional Arguments

ValueSummary

<consistency-group-snapshot>

Consistency group snapshot(s) to delete (name or id)

Table 21.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

21.10. consistency group snapshot list

List consistency group snapshots.

Usage:

openstack consistency group snapshot 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]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]

Table 21.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show detail for all projects (admin only) (defaults to False)

--long

List additional fields in output

--status <status>

Filters results by a status ("available", "error", "creating", "deleting" or "error_deleting")

--consistency-group <consistency-group>

Filters results by a consistency group (name or id)

Table 21.35. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 21.36. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 21.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

21.11. consistency group snapshot show

Display consistency group snapshot details

Usage:

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

Table 21.39. Positional Arguments

ValueSummary

<consistency-group-snapshot>

Consistency group snapshot to display (name or id)

Table 21.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 21.41. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 21.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.43. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 21.44. 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 22. console

This chapter describes the commands under the console command.

22.1. console log show

Show server’s console output

Usage:

openstack console log show [-h] [--lines <num-lines>] <server>

Table 22.1. Positional Arguments

ValueSummary

<server>

Server to show console log (name or id)

Table 22.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--lines <num-lines>

Number of lines to display from the end of the log (default=all)

22.2. console url show

Show server’s remote console URL

Usage:

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>

Table 22.3. Positional Arguments

ValueSummary

<server>

Server to show url (name or id)

Table 22.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--novnc

Show novnc console url (default)

--xvpvnc

Show xvpvnc console url

--spice

Show spice console url

--rdp

Show rdp console url

--serial

Show serial console url

--mks

Show webmks console url

Table 22.5. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 22.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 22.7. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 23. consumer

This chapter describes the commands under the consumer command.

23.1. consumer create

Create new consumer

Usage:

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

Table 23.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

Table 23.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 23.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 23.4. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

23.2. consumer delete

Delete consumer(s)

Usage:

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

Table 23.6. Positional Arguments

ValueSummary

<consumer>

Consumer(s) to delete

Table 23.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

23.3. consumer list

List consumers

Usage:

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

Table 23.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 23.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 23.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 23.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

23.4. consumer set

Set consumer properties

Usage:

openstack consumer set [-h] [--description <description>] <consumer>

Table 23.13. Positional Arguments

ValueSummary

<consumer>

Consumer to modify

Table 23.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

23.5. consumer show

Display consumer details

Usage:

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

Table 23.15. Positional Arguments

ValueSummary

<consumer>

Consumer to display

Table 23.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 23.17. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 23.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 23.19. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 24. container

This chapter describes the commands under the container command.

24.1. container create

Create new container

Usage:

openstack container 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]
                                  <container-name> [<container-name> ...]

Table 24.1. Positional Arguments

ValueSummary

<container-name>

New container name(s)

Table 24.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 24.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 24.4. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 24.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

24.2. container delete

Delete container

Usage:

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

Table 24.7. Positional Arguments

ValueSummary

<container>

Container(s) to delete

Table 24.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--recursive, -r

Recursively delete objects and container

24.3. container list

List containers

Usage:

openstack container 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]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

Table 24.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--prefix <prefix>

Filter list using <prefix>

--marker <marker>

Anchor for paging

--end-marker <end-marker>

End anchor for paging

--limit <num-containers>

Limit the number of containers returned

--long

List additional fields in output

--all

List all containers (default is 10000)

Table 24.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 24.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 24.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

24.4. container save

Save container contents locally

Usage:

openstack container save [-h] <container>

Table 24.14. Positional Arguments

ValueSummary

<container>

Container to save

Table 24.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

24.5. container set

Set container properties

Usage:

openstack container set [-h] --property <key=value> <container>

Table 24.16. Positional Arguments

ValueSummary

<container>

Container to modify

Table 24.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Set a property on this container (repeat option to set multiple properties)

24.6. container show

Display container details

Usage:

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

Table 24.18. Positional Arguments

ValueSummary

<container>

Container to display

Table 24.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 24.20. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 24.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 24.22. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

24.7. container unset

Unset container properties

Usage:

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

Table 24.24. Positional Arguments

ValueSummary

<container>

Container to modify

Table 24.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

Chapter 25. credential

This chapter describes the commands under the credential command.

25.1. credential create

Create new credential

Usage:

openstack credential create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--type <type>]
                                   [--project <project>]
                                   <user> <data>

Table 25.1. Positional Arguments

ValueSummary

<user>

User that owns the credential (name or id)

<data>

New credential data

Table 25.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New credential type: cert, ec2, totp and so on

--project <project>

Project which limits the scope of the credential (name or ID)

Table 25.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 25.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 25.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

25.2. credential delete

Delete credential(s)

Usage:

openstack credential delete [-h] <credential-id> [<credential-id> ...]

Table 25.7. Positional Arguments

ValueSummary

<credential-id>

Id of credential(s) to delete

Table 25.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

25.3. credential list

List credentials

Usage:

openstack 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>] [--type <type>]

Table 25.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

Filter credentials by <user> (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.

--type <type>

Filter credentials by type: cert, ec2, totp and so on

Table 25.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 25.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 25.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

25.4. credential set

Set credential properties

Usage:

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

Table 25.14. Positional Arguments

ValueSummary

<credential-id>

Id of credential to change

Table 25.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

User that owns the credential (name or id)

--type <type>

New credential type: cert, ec2, totp and so on

--data <data>

New credential data

--project <project>

Project which limits the scope of the credential (name or ID)

25.5. credential show

Display credential details

Usage:

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

Table 25.16. Positional Arguments

ValueSummary

<credential-id>

Id of credential to display

Table 25.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 25.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 25.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 25.20. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 25.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 26. cron

This chapter describes the commands under the cron command.

26.1. cron trigger create

Create new trigger.

Usage:

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

Table 26.1. Positional Arguments

ValueSummary

name

Cron trigger name

workflow_identifier

Workflow name or id

workflow_input

Workflow input

Table 26.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--params PARAMS

Workflow params

--pattern <* * * * *>

Cron trigger pattern

--first-time <YYYY-MM-DD HH:MM>

Date and time of the first execution. time is treated as local time unless --utc is also specified

--count <integer>

Number of wanted executions

--utc

All times specified should be treated as utc

Table 26.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 26.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

26.2. cron trigger delete

Delete trigger.

Usage:

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

Table 26.7. Positional Arguments

ValueSummary

cron_trigger

Name of cron trigger(s).

Table 26.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

26.3. cron trigger list

List all cron triggers.

Usage:

openstack cron trigger 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]

Table 26.9. 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 26.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 26.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 26.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

26.4. cron trigger show

Show specific cron trigger.

Usage:

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

Table 26.14. Positional Arguments

ValueSummary

cron_trigger

Cron trigger name

Table 26.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 26.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 26.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.18. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 26.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 27. datastore

This chapter describes the commands under the datastore command.

27.1. datastore list

List available datastores

Usage:

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

Table 27.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 27.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 27.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 27.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

27.2. datastore show

Shows details of a datastore

Usage:

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

Table 27.6. Positional Arguments

ValueSummary

<datastore>

Id of the datastore

Table 27.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 27.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 27.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 27.10. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

27.3. datastore version list

Lists available versions for a datastore

Usage:

openstack datastore version 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]
                                        <datastore>

Table 27.12. Positional Arguments

ValueSummary

<datastore>

Id or name of the datastore

Table 27.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 27.14. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 27.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 27.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

27.4. datastore version show

Shows details of a datastore version.

Usage:

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

Table 27.18. Positional Arguments

ValueSummary

<datastore_version>

Id or name of the datastore version.

Table 27.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--datastore <datastore>

Id or name of the datastore. optional if the id ofthe datastore_version is provided.

Table 27.20. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 27.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 27.22. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 28. dns

This chapter describes the commands under the dns command.

28.1. dns quota list

List quotas

Usage:

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]

Table 28.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

--project-id PROJECT_ID

Project id default: current project

Table 28.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 28.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 28.4. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

28.2. dns quota reset

Reset quotas

Usage:

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

Table 28.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

--project-id PROJECT_ID

Project id

28.3. dns quota set

Set quotas

Usage:

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]
                               [--zones <zones>]

Table 28.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

--project-id PROJECT_ID

Project id

--api-export-size <api-export-size>

New value for the api-export-size quota

--recordset-records <recordset-records>

New value for the recordset-records quota

--zone-records <zone-records>

New value for the zone-records quota

--zone-recordsets <zone-recordsets>

New value for the zone-recordsets quota

--zones <zones>

New value for the zones quota

Table 28.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 28.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 28.10. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

28.4. dns service list

List service statuses

Usage:

openstack dns service 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]
                                  [--hostname HOSTNAME]
                                  [--service_name SERVICE_NAME]
                                  [--status STATUS] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

Table 28.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--hostname HOSTNAME

Hostname

--service_name SERVICE_NAME

Service name

--status STATUS

Status

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 28.13. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 28.14. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 28.15. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

28.5. dns service show

Show service status details

Usage:

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id

Table 28.17. Positional Arguments

ValueSummary

id

Service status id

Table 28.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 28.19. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 28.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 28.21. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 28.22. 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 29. domain

This chapter describes the commands under the domain command.

29.1. domain create

Create new domain

Usage:

openstack domain create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--description <description>]
                               [--enable | --disable] [--or-show]
                               <domain-name>

Table 29.1. Positional Arguments

ValueSummary

<domain-name>

New domain name

Table 29.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

New domain description

--enable

Enable domain (default)

--disable

Disable domain

--or-show

Return existing domain

Table 29.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 29.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 29.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

29.2. domain delete

Delete domain(s)

Usage:

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

Table 29.7. Positional Arguments

ValueSummary

<domain>

Domain(s) to delete (name or id)

Table 29.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

29.3. domain list

List domains

Usage:

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

Table 29.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 29.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 29.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 29.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

29.4. domain set

Set domain properties

Usage:

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

Table 29.14. Positional Arguments

ValueSummary

<domain>

Domain to modify (name or id)

Table 29.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New domain name

--description <description>

New domain description

--enable

Enable domain

--disable

Disable domain

29.5. domain show

Display domain details

Usage:

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

Table 29.16. Positional Arguments

ValueSummary

<domain>

Domain to display (name or id)

Table 29.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 29.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 29.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 29.20. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 29.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 30. ec2

This chapter describes the commands under the ec2 command.

30.1. ec2 credentials create

Create EC2 credentials

Usage:

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--project <project>]
                                        [--user <user>]
                                        [--user-domain <user-domain>]
                                        [--project-domain <project-domain>]

Table 30.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Create credentials in project (name or id; default: current authenticated project)

--user <user>

Create credentials for user (name or id; default: current authenticated user)

--user-domain <user-domain>

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

--project-domain <project-domain>

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

Table 30.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 30.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 30.4. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

30.2. ec2 credentials delete

Delete EC2 credentials

Usage:

openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key> [<access-key> ...]

Table 30.6. Positional Arguments

ValueSummary

<access-key>

Credentials access key(s)

Table 30.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

Delete credentials for user (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.

30.3. ec2 credentials list

List EC2 credentials

Usage:

openstack ec2 credentials 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>]

Table 30.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

Filter list by user (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 30.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 30.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 30.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

30.4. ec2 credentials show

Display EC2 credentials details

Usage:

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

Table 30.13. Positional Arguments

ValueSummary

<access-key>

Credentials access key

Table 30.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--user <user>

Show credentials for user (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 30.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 30.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 30.17. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 31. endpoint

This chapter describes the commands under the endpoint command.

31.1. endpoint add project

Associate a project to an endpoint

Usage:

openstack endpoint add project [-h] [--project-domain <project-domain>]
                                      <endpoint> <project>

Table 31.1. Positional Arguments

ValueSummary

<endpoint>

Endpoint to associate with specified project (name or ID)

<project>

Project to associate with specified endpoint name or ID)

Table 31.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

31.2. endpoint create

Create new endpoint

Usage:

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--region <region-id>]
                                 [--enable | --disable]
                                 <service> <interface> <url>

Table 31.3. Positional Arguments

ValueSummary

<service>

Service to be associated with new endpoint (name or ID)

<interface>

New endpoint interface type (admin, public or internal)

<url>

New endpoint url

Table 31.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--region <region-id>

New endpoint region id

--enable

Enable endpoint (default)

--disable

Disable endpoint

Table 31.5. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 31.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.7. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

31.3. endpoint delete

Delete endpoint(s)

Usage:

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

Table 31.9. Positional Arguments

ValueSummary

<endpoint-id>

Endpoint(s) to delete (id only)

Table 31.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

31.4. endpoint group add project

Add a project to an endpoint group

Usage:

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>

Table 31.11. Positional Arguments

ValueSummary

<endpoint-group>

Endpoint group (name or id)

<project>

Project to associate (name or id)

Table 31.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

31.5. endpoint group create

Create new endpoint group

Usage:

openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description DESCRIPTION]
                                       <name> <filename>

Table 31.13. Positional Arguments

ValueSummary

<name>

Name of the endpoint group

<filename>

Filename that contains a new set of filters

Table 31.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description of the endpoint group

Table 31.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 31.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.17. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

31.6. endpoint group delete

Delete endpoint group(s)

Usage:

openstack endpoint group delete [-h]
                                       <endpoint-group> [<endpoint-group> ...]

Table 31.19. Positional Arguments

ValueSummary

<endpoint-group>

Endpoint group(s) to delete (name or id)

Table 31.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

31.7. endpoint group list

List endpoint groups

Usage:

openstack endpoint 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]
                                     [--endpointgroup <endpoint-group> | --project <project>]
                                     [--domain <domain>]

Table 31.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--endpointgroup <endpoint-group>

Endpoint group (name or id)

--project <project>

Project (name or id)

--domain <domain>

Domain owning <project> (name or id)

Table 31.22. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 31.23. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 31.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

31.8. endpoint group remove project

Remove project from endpoint group

Usage:

openstack endpoint group remove project [-h]
                                               [--project-domain <project-domain>]
                                               <endpoint-group> <project>

Table 31.26. Positional Arguments

ValueSummary

<endpoint-group>

Endpoint group (name or id)

<project>

Project to remove (name or id)

Table 31.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

31.9. endpoint group set

Set endpoint group properties

Usage:

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>

Table 31.28. Positional Arguments

ValueSummary

<endpoint-group>

Endpoint group to modify (name or id)

Table 31.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New enpoint group name

--filters <filename>

Filename that contains a new set of filters

--description <description>

New endpoint group description

31.10. endpoint group show

Display endpoint group details

Usage:

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

Table 31.30. Positional Arguments

ValueSummary

<endpointgroup>

Endpoint group (name or id)

Table 31.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 31.32. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 31.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.34. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

31.11. endpoint list

List endpoints

Usage:

openstack endpoint 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]
                               [--service <service>] [--interface <interface>]
                               [--region <region-id>]
                               [--endpoint <endpoint-group> | --project <project>]
                               [--project-domain <project-domain>]

Table 31.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--service <service>

Filter by service (type, name or id)

--interface <interface>

Filter by interface type (admin, public or internal)

--region <region-id>

Filter by region id

--endpoint <endpoint-group>

Endpoint to list filters

--project <project>

Project to list filters (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.

Table 31.37. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 31.38. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 31.39. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

31.12. endpoint remove project

Dissociate a project from an endpoint

Usage:

openstack endpoint remove project [-h]
                                         [--project-domain <project-domain>]
                                         <endpoint> <project>

Table 31.41. Positional Arguments

ValueSummary

<endpoint>

Endpoint to dissociate from specified project (name or ID)

<project>

Project to dissociate from specified endpoint name or ID)

Table 31.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

31.13. endpoint set

Set endpoint properties

Usage:

openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>

Table 31.43. Positional Arguments

ValueSummary

<endpoint-id>

Endpoint to modify (id only)

Table 31.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--region <region-id>

New endpoint region id

--interface <interface>

New endpoint interface type (admin, public or internal)

--url <url>

New endpoint url

--service <service>

New endpoint service (name or id)

--enable

Enable endpoint

--disable

Disable endpoint

31.14. endpoint show

Display endpoint details

Usage:

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

Table 31.45. Positional Arguments

ValueSummary

<endpoint>

Endpoint to display (endpoint id, service id, service name, service type)

Table 31.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 31.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 31.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 31.49. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 31.50. 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 32. event

This chapter describes the commands under the event command.

32.1. event trigger create

Create new trigger.

Usage:

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

Table 32.1. Positional Arguments

ValueSummary

name

Event trigger name

workflow_id

Workflow id

exchange

Event trigger exchange

topic

Event trigger topic

event

Event trigger event name

workflow_input

Workflow input

Table 32.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--params PARAMS

Workflow params

Table 32.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 32.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 32.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

32.2. event trigger delete

Delete trigger.

Usage:

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

Table 32.7. Positional Arguments

ValueSummary

event_trigger_id

Id of event trigger(s).

Table 32.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

32.3. event trigger list

List all event triggers.

Usage:

openstack event trigger 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]

Table 32.9. 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 32.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 32.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 32.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

32.4. event trigger show

Show specific event trigger.

Usage:

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

Table 32.14. Positional Arguments

ValueSummary

event_trigger

Event trigger id

Table 32.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 32.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 32.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 32.18. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 32.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 33. extension

This chapter describes the commands under the extension command.

33.1. extension list

List API extensions

Usage:

openstack extension 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]
                                [--identity] [--network] [--volume] [--long]

Table 33.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--compute

List extensions for the compute api

--identity

List extensions for the identity api

--network

List extensions for the network api

--volume

List extensions for the block storage api

--long

List additional fields in output

Table 33.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 33.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 33.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

33.2. extension show

Show API extension

Usage:

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

Table 33.6. Positional Arguments

ValueSummary

<extension>

Extension to display. currently, only network extensions are supported. (Name or Alias)

Table 33.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 33.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 33.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 33.10. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 33.11. 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 34. federation

This chapter describes the commands under the federation command.

34.1. federation domain list

List accessible domains

Usage:

openstack federation domain 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]

Table 34.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 34.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 34.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 34.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

34.2. federation project list

List accessible projects

Usage:

openstack federation project 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]

Table 34.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 34.7. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 34.8. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 34.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

34.3. federation protocol create

Create new federation protocol

Usage:

openstack federation protocol create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --identity-provider
                                            <identity-provider> --mapping
                                            <mapping>
                                            <name>

Table 34.11. Positional Arguments

ValueSummary

<name>

New federation protocol name (must be unique per identity provider)

Table 34.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider that will support the new federation protocol (name or ID) (required)

--mapping <mapping>

Mapping that is to be used (name or id) (required)

Table 34.13. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 34.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 34.15. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

34.4. federation protocol delete

Delete federation protocol(s)

Usage:

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

Table 34.17. Positional Arguments

ValueSummary

<federation-protocol>

Federation protocol(s) to delete (name or id)

Table 34.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider that supports <federation-protocol> (name or ID) (required)

34.5. federation protocol list

List federation protocols

Usage:

openstack federation protocol 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]
                                          --identity-provider
                                          <identity-provider>

Table 34.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider to list (name or id) (required)

Table 34.20. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 34.21. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 34.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

34.6. federation protocol set

Set federation protocol properties

Usage:

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

Table 34.24. Positional Arguments

ValueSummary

<name>

Federation protocol to modify (name or id)

Table 34.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider that supports <federation-protocol> (name or ID) (required)

--mapping <mapping>

Mapping that is to be used (name or id)

34.7. federation protocol show

Display federation protocol details

Usage:

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

Table 34.26. Positional Arguments

ValueSummary

<federation-protocol>

Federation protocol to display (name or id)

Table 34.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--identity-provider <identity-provider>

Identity provider that supports <federation-protocol> (name or ID) (required)

Table 34.28. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 34.29. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 34.30. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

Table 34.31. 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 35. flavor

This chapter describes the commands under the flavor command.

35.1. flavor create

Create new flavor

Usage:

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--id <id>] [--ram <size-mb>]
                               [--disk <size-gb>] [--ephemeral <size-gb>]
                               [--swap <size-mb>] [--vcpus <vcpus>]
                               [--rxtx-factor <factor>] [--public | --private]
                               [--property <key=value>] [--project <project>]
                               [--description <description>]
                               [--project-domain <project-domain>]
                               <flavor-name>

Table 35.1. Positional Arguments

ValueSummary

<flavor-name>

New flavor name

Table 35.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--id <id>

Unique flavor id; auto creates a uuid (default: auto)

--ram <size-mb>

Memory size in mb (default 256m)

--disk <size-gb>

Disk size in gb (default 0g)

--ephemeral <size-gb>

Ephemeral disk size in gb (default 0g)

--swap <size-mb>

Additional swap space size in mb (default 0m)

--vcpus <vcpus>

Number of vcpus (default 1)

--rxtx-factor <factor>

Rx/tx factor (default 1.0)

--public

Flavor is available to other projects (default)

--private

Flavor is not available to other projects

--property <key=value>

Property to add for this flavor (repeat option to set multiple properties)

--project <project>

Allow <project> to access private flavor (name or id) (Must be used with --private option)

--description <description>

Description for the flavor.(supported by api versions 2.55 - 2.latest

--project-domain <project-domain>

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

Table 35.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 35.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 35.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

35.2. flavor delete

Delete flavor(s)

Usage:

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

Table 35.7. Positional Arguments

ValueSummary

<flavor>

Flavor(s) to delete (name or id)

Table 35.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

35.3. flavor list

List flavors

Usage:

openstack flavor 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]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]

Table 35.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public

List only public flavors (default)

--private

List only private flavors

--all

List all flavors, whether public or private

--long

List additional fields in output

--marker <flavor-id>

The last flavor id of the previous page

--limit <num-flavors>

Maximum number of flavors to display

Table 35.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 35.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 35.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

35.4. flavor set

Set flavor properties

Usage:

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--description <description>]
                            [--project-domain <project-domain>]
                            <flavor>

Table 35.14. Positional Arguments

ValueSummary

<flavor>

Flavor to modify (name or id)

Table 35.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--no-property

Remove all properties from this flavor (specify both --no-property and --property to remove the current properties before setting new properties.)

--property <key=value>

Property to add or modify for this flavor (repeat option to set multiple properties)

--project <project>

Set flavor access to project (name or id) (admin only)

--description <description>

Set description for the flavor.(supported by api versions 2.55 - 2.latest

--project-domain <project-domain>

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

35.5. flavor show

Display flavor details

Usage:

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

Table 35.16. Positional Arguments

ValueSummary

<flavor>

Flavor to display (name or id)

Table 35.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 35.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 35.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 35.20. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

35.6. flavor unset

Unset flavor properties

Usage:

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

Table 35.22. Positional Arguments

ValueSummary

<flavor>

Flavor to modify (name or id)

Table 35.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from flavor (repeat option to unset multiple properties)

--project <project>

Remove flavor access from project (name or id) (admin only)

--project-domain <project-domain>

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

Chapter 36. floating

This chapter describes the commands under the floating command.

36.1. floating ip create

Create floating IP

Usage:

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--dns-domain <dns-domain>]
                                    [--dns-name <dns-name>]
                                    [--project-domain <project-domain>]
                                    [--tag <tag> | --no-tag]
                                    <network>

Table 36.1. Positional Arguments

ValueSummary

<network>

Network to allocate floating ip from (name or id)

Table 36.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--subnet <subnet>

Subnet on which you want to create the floating ip (name or ID)

--port <port>

Port to be associated with the floating ip (name or ID)

--floating-ip-address <ip-address>

Floating ip address

--fixed-ip-address <ip-address>

Fixed ip address mapped to the floating ip

--qos-policy <qos-policy>

Attach qos policy to the floating ip (name or id)

--description <description>

Set floating ip description

--project <project>

Owner’s project (name or id)

--dns-domain <dns-domain>

Set dns domain for this floating ip

--dns-name <dns-name>

Set dns name for this floating ip

--project-domain <project-domain>

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

--tag <tag>

Tag to be added to the floating ip (repeat option to set multiple tags)

--no-tag

No tags associated with the floating ip

Table 36.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 36.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 36.5. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

36.2. floating ip delete

Delete floating IP(s)

Usage:

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

Table 36.7. Positional Arguments

ValueSummary

<floating-ip>

Floating ip(s) to delete (ip address or id)

Table 36.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

36.3. floating ip list

List floating IP(s)

Usage:

openstack floating ip 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]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>]
                                  [--floating-ip-address <ip-address>]
                                  [--long] [--status <status>]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

Table 36.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--network <network>

List floating ip(s) according to given network (name or ID)

--port <port>

List floating ip(s) according to given port (name or ID)

--fixed-ip-address <ip-address>

List floating ip(s) according to given fixed ip address

--floating-ip-address <ip-address>

List floating ip(s) according to given floating ip address

--long

List additional fields in output

--status <status>

List floating ip(s) according to given status (ACTIVE, DOWN)

--project <project>

List floating ip(s) according to given 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.

--router <router>

List floating ip(s) according to given router (name or ID)

--tags <tag>[,<tag>,…​]

List floating ip which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List floating ip which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude floating ip which have all given tag(s) (Comma-separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude floating ip which have any given tag(s) (Comma-separated list of tags)

Table 36.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 36.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 36.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

36.4. floating ip pool list

List pools of floating IP addresses

Usage:

openstack floating ip pool 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]

Table 36.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 36.15. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 36.16. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 36.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

36.5. floating ip set

Set floating IP Properties

Usage:

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 [--tag <tag>] [--no-tag]
                                 <floating-ip>

Table 36.19. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to modify (ip address or id)

Table 36.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--port <port>

Associate the floating ip with port (name or id)

--fixed-ip-address <ip-address>

Fixed ip of the port (required only if port has multiple IPs)

--qos-policy <qos-policy>

Attach qos policy to the floating ip (name or id)

--no-qos-policy

Remove the qos policy attached to the floating ip

--tag <tag>

Tag to be added to the floating ip (repeat option to set multiple tags)

--no-tag

Clear tags associated with the floating ip. specify both --tag and --no-tag to overwrite current tags

36.6. floating ip show

Display floating IP details

Usage:

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

Table 36.21. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to display (ip address or id)

Table 36.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 36.23. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 36.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 36.25. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

36.7. floating ip unset

Unset floating IP Properties

Usage:

openstack floating ip unset [-h] [--port] [--qos-policy]
                                   [--tag <tag> | --all-tag]
                                   <floating-ip>

Table 36.27. Positional Arguments

ValueSummary

<floating-ip>

Floating ip to disassociate (ip address or id)

Table 36.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--port

Disassociate any port associated with the floating ip

--qos-policy

Remove the qos policy attached to the floating ip

--tag <tag>

Tag to be removed from the floating ip (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the floating ip

Chapter 37. group

This chapter describes the commands under the group command.

37.1. group add user

Add user to group

Usage:

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

Table 37.1. Positional Arguments

ValueSummary

<group>

Group to contain <user> (name or id)

<user>

User(s) to add to <group> (name or id) (repeat option to add multiple users)

Table 37.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.2. group contains user

Check user membership in group

Usage:

openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>

Table 37.3. Positional Arguments

ValueSummary

<group>

Group to check (name or id)

<user>

User to check (name or id)

Table 37.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.3. group create

Create new group

Usage:

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

Table 37.5. Positional Arguments

ValueSummary

<group-name>

New group name

Table 37.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain to contain new group (name or id)

--description <description>

New group description

--or-show

Return existing group

Table 37.7. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 37.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.9. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

37.4. group delete

Delete group(s)

Usage:

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]

Table 37.11. Positional Arguments

ValueSummary

<group>

Group(s) to delete (name or id)

Table 37.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing group(s) (name or id)

37.5. group list

List groups

Usage:

openstack 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]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]

Table 37.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Filter group list by <domain> (name or id)

--user <user>

Filter group list by <user> (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.

--long

List additional fields in output

Table 37.14. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 37.15. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 37.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

37.6. group remove user

Remove user from group

Usage:

openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user> [<user> ...]

Table 37.18. Positional Arguments

ValueSummary

<group>

Group containing <user> (name or id)

<user>

User(s) to remove from <group> (name or id) (repeat option to remove multiple users)

Table 37.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group-domain <group-domain>

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

--user-domain <user-domain>

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

37.7. group set

Set group properties

Usage:

openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>

Table 37.20. Positional Arguments

ValueSummary

<group>

Group to modify (name or id)

Table 37.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing <group> (name or id)

--name <name>

New group name

--description <description>

New group description

37.8. group show

Display group details

Usage:

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

Table 37.22. Positional Arguments

ValueSummary

<group>

Group to display (name or id)

Table 37.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain containing <group> (name or id)

Table 37.24. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 37.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.26. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

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

Chapter 38. help.adoc

This chapter describes the commands under the help.adoc command.

38.1. help

print detailed help for another command

Usage:

openstack help [-h] [cmd [cmd ...]]

Table 38.1. Positional Arguments

ValueSummary

cmd

Name of the command

Table 38.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 39. host

This chapter describes the commands under the host command.

39.1. host list

List hosts

Usage:

openstack host 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]
                           [--zone <zone>]

Table 39.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--zone <zone>

Only return hosts in the availability zone

Table 39.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Table 39.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 39.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.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.

39.2. host set

Set host properties

Usage:

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

Table 39.6. Positional Arguments

ValueSummary

<host>

Host to modify (name only)

Table 39.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable the host

--disable

Disable the host

--enable-maintenance

Enable maintenance mode for the host

--disable-maintenance

Disable maintenance mode for the host

39.3. host show

Display host details

Usage:

openstack host 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]
                           <host>

Table 39.8. Positional Arguments

ValueSummary

<host>

Name of host

Table 39.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 39.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 39.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.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.

Chapter 40. hypervisor

This chapter describes the commands under the hypervisor command.

40.1. hypervisor list

List hypervisors

Usage:

openstack hypervisor 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]
                                 [--matching <hostname>] [--long]

Table 40.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--matching <hostname>

Filter hypervisors using <hostname> substring

--long

List additional fields in output

Table 40.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 40.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 40.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.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.

40.2. hypervisor show

Display hypervisor details

Usage:

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

Table 40.6. Positional Arguments

ValueSummary

<hypervisor>

Hypervisor to display (name or id)

Table 40.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 40.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.10. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 40.11. 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.

40.3. hypervisor stats show

Display hypervisor stats details

Usage:

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

Table 40.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.13. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 40.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.15. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 40.16. 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 41. identity

This chapter describes the commands under the identity command.

41.1. identity provider create

Create new identity provider

Usage:

openstack identity provider create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--domain <domain>]
                                          [--enable | --disable]
                                          <name>

Table 41.1. Positional Arguments

ValueSummary

<name>

New identity provider name (must be unique)

Table 41.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--remote-id <remote-id>

Remote ids to associate with the identity provider (repeat option to provide multiple values)

--remote-id-file <file-name>

Name of a file that contains many remote ids to associate with the identity provider, one per line

--description <description>

New identity provider description

--domain <domain>

Domain to associate with the identity provider. if not specified, a domain will be created automatically. (Name or ID)

--enable

Enable identity provider (default)

--disable

Disable the identity provider

Table 41.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 41.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 41.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.

41.2. identity provider delete

Delete identity provider(s)

Usage:

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

Table 41.7. Positional Arguments

ValueSummary

<identity-provider>

Identity provider(s) to delete

Table 41.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

41.3. identity provider list

List identity providers

Usage:

openstack identity provider 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]

Table 41.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 41.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 41.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 41.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.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.

41.4. identity provider set

Set identity provider properties

Usage:

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>

Table 41.14. Positional Arguments

ValueSummary

<identity-provider>

Identity provider to modify

Table 41.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set identity provider description

--remote-id <remote-id>

Remote ids to associate with the identity provider (repeat option to provide multiple values)

--remote-id-file <file-name>

Name of a file that contains many remote ids to associate with the identity provider, one per line

--enable

Enable the identity provider

--disable

Disable the identity provider

41.5. identity provider show

Display identity provider details

Usage:

openstack identity provider show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <identity-provider>

Table 41.16. Positional Arguments

ValueSummary

<identity-provider>

Identity provider to display

Table 41.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 41.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 41.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 41.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 42. image

This chapter describes the commands under the image command.

42.1. image add project

Associate project with image

Usage:

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--project-domain <project-domain>]
                                   <image> <project>

Table 42.1. Positional Arguments

ValueSummary

<image>

Image to share (name or id)

<project>

Project to associate with image (id)

Table 42.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

Table 42.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 42.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 42.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 42.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.

42.2. image create

Create/upload an image

Usage:

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--sign-key-path <sign-key-path>]
                              [--sign-cert-id <sign-cert-id>]
                              [--protected | --unprotected]
                              [--public | --private | --community | --shared]
                              [--property <key=value>] [--tag <tag>]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>

Table 42.7. Positional Arguments

ValueSummary

<image-name>

New image name

Table 42.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--id <id>

Image id to reserve

--container-format <container-format>

Image container format. the supported options are: ami, ari, aki, bare, docker, ova, ovf. The default format is: bare

--disk-format <disk-format>

Image disk format. the supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop. The default format is: raw

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <ram-mb>

Minimum ram size needed to boot image, in megabytes

--file <file>

Upload image from local file

--volume <volume>

Create image from a volume

--force

Force image creation if volume is in use (only meaningful with --volume)

--sign-key-path <sign-key-path>

Sign the image using the specified private key. only use in combination with --sign-cert-id

--sign-cert-id <sign-cert-id>

The specified certificate uuid is a reference to the certificate in the key manager that corresponds to the public key and is used for signature validation. Only use in combination with --sign-key-path

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--community

Image is accessible to the community

--shared

Image can be shared

--property <key=value>

Set a property on this image (repeat option to set multiple properties)

--tag <tag>

Set a tag on this image (repeat option to set multiple tags)

--project <project>

Set an alternate project on this image (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.

Table 42.9. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 42.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 42.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 42.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.

42.3. image delete

Delete image(s)

Usage:

openstack image delete [-h] <image> [<image> ...]

Table 42.13. Positional Arguments

ValueSummary

<image>

Image(s) to delete (name or id)

Table 42.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

42.4. image list

List available images

Usage:

openstack image 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]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>]
                            [--member-status <member-status>] [--tag <tag>]
                            [--long] [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

Table 42.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public

List only public images

--private

List only private images

--community

List only community images

--shared

List only shared images

--property <key=value>

Filter output based on property (repeat option to filter on multiple properties)

--name <name>

Filter images based on name.

--status <status>

Filter images based on status.

--member-status <member-status>

Filter images based on member status. the supported options are: accepted, pending, rejected, all.

--tag <tag>

Filter images based on tag.

--long

List additional fields in output

--sort <key>[:<direction>]

Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma

--limit <num-images>

Maximum number of images to display.

--marker <image>

The last image of the previous page. display list of images after marker. Display all images if not specified. (name or ID)

Table 42.16. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 42.17. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 42.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 42.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.

42.5. image member list

List projects associated with image

Usage:

openstack image member 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]
                                   [--project-domain <project-domain>]
                                   <image>

Table 42.20. Positional Arguments

ValueSummary

<image>

Image (name or id)

Table 42.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

Table 42.22. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 42.23. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 42.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 42.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.

42.6. image remove project

Disassociate project with image

Usage:

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

Table 42.26. Positional Arguments

ValueSummary

<image>

Image to unshare (name or id)

<project>

Project to disassociate with image (name or id)

Table 42.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

42.7. image save

Save an image locally

Usage:

openstack image save [-h] [--file <filename>] <image>

Table 42.28. Positional Arguments

ValueSummary

<image>

Image to save (name or id)

Table 42.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded image save filename (default: stdout)

42.8. image set

Set image properties

Usage:

openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
                           [--min-ram <ram-mb>]
                           [--container-format <container-format>]
                           [--disk-format <disk-format>]
                           [--protected | --unprotected]
                           [--public | --private | --community | --shared]
                           [--property <key=value>] [--tag <tag>]
                           [--architecture <architecture>]
                           [--instance-id <instance-id>]
                           [--kernel-id <kernel-id>] [--os-distro <os-distro>]
                           [--os-version <os-version>]
                           [--ramdisk-id <ramdisk-id>]
                           [--deactivate | --activate] [--project <project>]
                           [--project-domain <project-domain>]
                           [--accept | --reject | --pending]
                           <image>

Table 42.30. Positional Arguments

ValueSummary

<image>

Image to modify (name or id)

Table 42.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New image name

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <ram-mb>

Minimum ram size needed to boot image, in megabytes

--container-format <container-format>

Image container format. the supported options are: ami, ari, aki, bare, docker, ova, ovf

--disk-format <disk-format>

Image disk format. the supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--community

Image is accessible to the community

--shared

Image can be shared

--property <key=value>

Set a property on this image (repeat option to set multiple properties)

--tag <tag>

Set a tag on this image (repeat option to set multiple tags)

--architecture <architecture>

Operating system architecture

--instance-id <instance-id>

Id of server instance used to create this image

--kernel-id <kernel-id>

Id of kernel image used to boot this disk image

--os-distro <os-distro>

Operating system distribution name

--os-version <os-version>

Operating system distribution version

--ramdisk-id <ramdisk-id>

Id of ramdisk image used to boot this disk image

--deactivate

Deactivate the image

--activate

Activate the image

--project <project>

Set an alternate project on this image (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.

--accept

Accept the image membership

--reject

Reject the image membership

--pending

Reset the image membership to pending

42.9. image show

Display image details

Usage:

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--human-readable]
                            <image>

Table 42.32. Positional Arguments

ValueSummary

<image>

Image to display (name or id)

Table 42.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--human-readable

Print image size in a human-friendly format.

Table 42.34. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 42.35. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 42.36. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 42.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.

42.10. image unset

Unset image tags and properties

Usage:

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

Table 42.38. Positional Arguments

ValueSummary

<image>

Image to modify (name or id)

Table 42.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Unset a tag on this image (repeat option to unset multiple tags)

--property <property-key>

Unset a property on this image (repeat option to unset multiple properties)

Chapter 43. implied

This chapter describes the commands under the implied command.

43.1. implied role create

Creates an association between prior and implied roles

Usage:

openstack implied role create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --implied-role <role>
                                     <role>

Table 43.1. Positional Arguments

ValueSummary

<role>

Role (name or id) that implies another role

Table 43.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--implied-role <role>

<role> (name or id) implied by another role

Table 43.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 43.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 43.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.

43.2. implied role delete

Deletes an association between prior and implied roles

Usage:

openstack implied role delete [-h] --implied-role <role> <role>

Table 43.7. Positional Arguments

ValueSummary

<role>

Role (name or id) that implies another role

Table 43.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--implied-role <role>

<role> (name or id) implied by another role

43.3. implied role list

List implied roles

Usage:

openstack implied role 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]

Table 43.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 43.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 43.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.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.

Chapter 44. ip

This chapter describes the commands under the ip command.

44.1. ip availability list

List IP availability for network

Usage:

openstack ip availability 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]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

Table 44.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--ip-version <ip-version>

List ip availability of given ip version networks (default is 4)

--project <project>

List ip availability of given 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.

Table 44.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 44.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 44.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.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.

44.2. ip availability show

Show network IP availability details

Usage:

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network>

Table 44.6. Positional Arguments

ValueSummary

<network>

Show ip availability for a specific network (name or ID)

Table 44.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 44.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 44.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.10. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 44.11. 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 45. keypair

This chapter describes the commands under the keypair command.

45.1. keypair create

Create new public or private key for server ssh access

Usage:

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--public-key <file> | --private-key <file>]
                                <name>

Table 45.1. Positional Arguments

ValueSummary

<name>

New public or private key name

Table 45.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public-key <file>

Filename for public key to add. if not used, creates a private key.

--private-key <file>

Filename for private key to save. if not used, print private key in console.

Table 45.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 45.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 45.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 45.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.

45.2. keypair delete

Delete public or private key(s)

Usage:

openstack keypair delete [-h] <key> [<key> ...]

Table 45.7. Positional Arguments

ValueSummary

<key>

Name of key(s) to delete (name only)

Table 45.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

45.3. keypair list

List key fingerprints

Usage:

openstack keypair 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]

Table 45.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 45.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 45.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 45.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 45.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.

45.4. keypair show

Display key details

Usage:

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--public-key]
                              <key>

Table 45.14. Positional Arguments

ValueSummary

<key>

Public or private key to display (name only)

Table 45.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public-key

Show only bare public key paired with the generated key

Table 45.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 45.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 45.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 45.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 46. l2gw

This chapter describes the commands under the l2gw command.

46.1. l2gw connection create

Create l2gateway-connection

Usage:

openstack l2gw connection create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--default-segmentation-id SEG_ID]
                                        <GATEWAY-NAME/UUID>
                                        <NETWORK-NAME/UUID>

Table 46.1. Positional Arguments

ValueSummary

<GATEWAY-NAME/UUID>

Descriptive name for logical gateway.

<NETWORK-NAME/UUID>

Network name or uuid.

Table 46.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--default-segmentation-id SEG_ID

Default segmentation-id that will be applied to the interfaces for which segmentation id was not specified in l2-gateway-create command.

Table 46.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 46.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 46.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.

46.2. l2gw connection delete

Delete a given l2gateway-connection

Usage:

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

Table 46.7. Positional Arguments

ValueSummary

<L2_GATEWAY_CONNECTIONS>

Id(s) of l2_gateway_connections(s) to delete.

Table 46.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

46.3. l2gw connection list

List l2gateway-connections

Usage:

openstack l2gw connection 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]
                                      [--project <project>]
                                      [--project-domain <project-domain>]

Table 46.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

Table 46.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 46.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 46.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.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.

46.4. l2gw connection show

Show information of a given l2gateway-connection

Usage:

openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <L2_GATEWAY_CONNECTION>

Table 46.14. Positional Arguments

ValueSummary

<L2_GATEWAY_CONNECTION>

Id of l2_gateway_connection to look up.

Table 46.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 46.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 46.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 46.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.

46.5. l2gw create

Create l2gateway resource

Usage:

openstack l2gw create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--project <project>]
                             [--project-domain <project-domain>]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <GATEWAY-NAME>

Table 46.20. Positional Arguments

ValueSummary

<GATEWAY-NAME>

Descriptive name for logical gateway.

Table 46.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

--device name=name,interface_names=INTERFACE-DETAILS

Device name and interface-names of l2gateway. INTERFACE-DETAILS is of form "<interface_name1>;[<inte rface_name2>][

Table 46.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 46.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 46.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.

46.6. l2gw delete

Delete a given l2gateway

Usage:

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

Table 46.26. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id(s) or name(s) of l2_gateway to delete.

Table 46.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

46.7. l2gw list

List l2gateway that belongs to a given tenant

Usage:

openstack l2gw 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]
                           [--project <project>]
                           [--project-domain <project-domain>]

Table 46.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

Table 46.29. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 46.30. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 46.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.32. 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.

46.8. l2gw show

Show information of a given l2gateway

Usage:

openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <L2_GATEWAY>

Table 46.33. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to look up.

Table 46.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 46.35. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 46.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.37. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 46.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.

46.9. l2gw update

Update a given l2gateway

Usage:

openstack l2gw update [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name name]
                             [--device name=name,interface_names=INTERFACE-DETAILS]
                             <L2_GATEWAY>

Table 46.39. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to update.

Table 46.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name name

Descriptive name for logical gateway.

--device name=name,interface_names=INTERFACE-DETAILS

Device name and interface-names of l2gateway. INTERFACE-DETAILS is of form "<interface_name1>;[<inte rface_name2>][

Table 46.41. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 46.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.43. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 46.44. 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 47. limit

This chapter describes the commands under the limit command.

47.1. limit create

Create a limit

Usage:

openstack limit create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--description <description>]
                              [--region <region>] --project <project>
                              --service <service> --resource-limit
                              <resource-limit>
                              <resource-name>

Table 47.1. Positional Arguments

ValueSummary

<resource-name>

The name of the resource to limit

Table 47.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the limit

--region <region>

Region for the limit to affect.

--project <project>

Project to associate the resource limit to

--service <service>

Service responsible for the resource to limit

--resource-limit <resource-limit>

The resource limit for the project to assume

Table 47.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 47.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 47.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 47.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.

47.2. limit delete

Delete a limit

Usage:

openstack limit delete [-h] <limit-id> [<limit-id> ...]

Table 47.7. Positional Arguments

ValueSummary

<limit-id>

Limit to delete (id)

Table 47.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

47.3. limit list

List limits

Usage:

openstack limit 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]
                            [--service <service>]
                            [--resource-name <resource-name>]
                            [--region <region>] [--project <project>]

Table 47.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--service <service>

Service responsible for the resource to limit

--resource-name <resource-name>

The name of the resource to limit

--region <region>

Region for the registered limit to affect.

--project <project>

List resource limits associated with project

Table 47.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 47.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 47.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 47.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.

47.4. limit set

Update information about a limit

Usage:

openstack limit set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--description <description>]
                           [--resource-limit <resource-limit>]
                           <limit-id>

Table 47.14. Positional Arguments

ValueSummary

<limit-id>

Limit to update (id)

Table 47.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the limit

--resource-limit <resource-limit>

The resource limit for the project to assume

Table 47.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 47.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 47.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 47.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.

47.5. limit show

Display limit details

Usage:

openstack limit show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <limit-id>

Table 47.20. Positional Arguments

ValueSummary

<limit-id>

Limit to display (id)

Table 47.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 47.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 47.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 47.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 47.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.

Chapter 48. limits

This chapter describes the commands under the limits command.

48.1. limits show

Show compute and block storage limits

Usage:

openstack limits 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] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]

Table 48.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--absolute

Show absolute limits

--rate

Show rate limits

--reserved

Include reservations count [only valid with --absolute]

--project <project>

Show limits for a specific project (name or id) [only valid with --absolute]

--domain <domain>

Domain the project belongs to (name or id) [only valid with --absolute]

Table 48.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 48.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 48.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 48.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 49. loadbalancer

This chapter describes the commands under the loadbalancer command.

49.1. loadbalancer amphora configure

Update the amphora agent configuration

Usage:

openstack loadbalancer amphora configure [-h] <amphora-id>

Table 49.1. Positional Arguments

ValueSummary

<amphora-id>

Uuid of the amphora to configure.

Table 49.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.2. loadbalancer amphora failover

Force failover an amphora

Usage:

openstack loadbalancer amphora failover [-h] <amphora-id>

Table 49.3. Positional Arguments

ValueSummary

<amphora-id>

Uuid of the amphora.

Table 49.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.3. loadbalancer amphora list

List amphorae

Usage:

openstack loadbalancer amphora 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]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {BACKUP,MASTER,STANDALONE}]
                                           [--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}]

Table 49.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

--compute-id <compute-id>

Filter by compute id.

--role {BACKUP,MASTER,STANDALONE}

Filter by role.

--status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}, --provisioning-status {ALLOCATED,BOOTING,DELETED,ERROR,PENDING_CREATE,PENDING_DELETE,READY}

Filter by amphora provisioning status.

Table 49.6. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.7. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.9. 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.

49.4. loadbalancer amphora show

Show the details of a single amphora

Usage:

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <amphora-id>

Table 49.10. Positional Arguments

ValueSummary

<amphora-id>

Uuid of the amphora.

Table 49.11. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.12. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.14. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.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.

49.5. loadbalancer create

Create a load balancer

Usage:

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <name>]
                                     [--description <description>]
                                     [--vip-address <vip_address>]
                                     [--vip-port-id <vip_port_id>]
                                     [--vip-subnet-id <vip_subnet_id>]
                                     [--vip-network-id <vip_network_id>]
                                     [--vip-qos-policy-id <vip_qos_policy_id>]
                                     [--project <project>]
                                     [--provider <provider>]
                                     [--enable | --disable]
                                     [--flavor <flavor>]

Table 49.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New load balancer name.

--description <description>

Set load balancer description.

--vip-address <vip_address>

Set the vip ip address.

--vip-qos-policy-id <vip_qos_policy_id>

Set qos policy id for vip port. unset with none.

--project <project>

Project for the load balancer (name or id).

--provider <provider>

Provider name for the load balancer.

--enable

Enable load balancer (default).

--disable

Disable load balancer.

--flavor <flavor>

The name or id of the flavor for the load balancer.

Table 49.17. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.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.

Table 49.21. VIP Network

ValueSummary

At least one of the following arguments is required.--vip-port-id <vip_port_id>

Set port for the load balancer (name or id).

--vip-subnet-id <vip_subnet_id>

Set subnet for the load balancer (name or id).

--vip-network-id <vip_network_id>

Set network for the load balancer (name or id).

49.6. loadbalancer delete

Delete a load balancer

Usage:

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

Table 49.22. Positional Arguments

ValueSummary

<load_balancer>

Load balancers to delete (name or id)

Table 49.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--cascade

Cascade the delete to all child elements of the load balancer.

49.7. loadbalancer failover

Trigger load balancer failover

Usage:

openstack loadbalancer failover [-h] <load_balancer>

Table 49.24. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 49.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.8. loadbalancer flavor create

Create a octavia flavor

Usage:

openstack loadbalancer flavor create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --name <name> --flavorprofile
                                            <flavor_profile>
                                            [--description <description>]
                                            [--enable | --disable]

Table 49.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New flavor name.

--flavorprofile <flavor_profile>

Flavor profile to add the flavor to (name or id).

--description <description>

Set flavor description.

--enable

Enable flavor.

--disable

Disable flavor.

Table 49.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.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.

49.9. loadbalancer flavor delete

Delete a flavor

Usage:

openstack loadbalancer flavor delete [-h] <flavor>

Table 49.31. Positional Arguments

ValueSummary

<flavor>

Flavor to delete (name or id)

Table 49.32. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.10. loadbalancer flavor list

List flavor

Usage:

openstack loadbalancer flavor 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>]
                                          [--flavorprofile <flavor_profile>]
                                          [--enable | --disable]

Table 49.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List flavors according to their name.

--flavorprofile <flavor_profile>

List flavors according to their flavor profile.

--enable

List enabled flavors.

--disable

List disabled flavors.

Table 49.34. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.35. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.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.

49.11. loadbalancer flavor set

Update a flavor

Usage:

openstack loadbalancer flavor set [-h] [--name <name>]
                                         [--enable | --disable]
                                         <flavor>

Table 49.38. Positional Arguments

ValueSummary

<flavor>

Name or uuid of the flavor to update.

Table 49.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the name of the flavor.

--enable

Enable flavor.

--disable

Disable flavor.

49.12. loadbalancer flavor show

Show the details for a single flavor

Usage:

openstack loadbalancer flavor show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flavor>

Table 49.40. Positional Arguments

ValueSummary

<flavor>

Name or uuid of the flavor.

Table 49.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.42. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.44. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.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.

49.13. loadbalancer flavorprofile create

Create a octavia flavor profile

Usage:

openstack loadbalancer flavorprofile create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] --name
                                                   <name> --provider <provider
                                                   name> --flavor-data
                                                   <flavor_data>

Table 49.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New octavia flavor profile name.

--provider <provider name>

Provider name for the flavor profile.

--flavor-data <flavor_data>

The json string containing the flavor metadata.

Table 49.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.49. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.50. 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.

49.14. loadbalancer flavorprofile delete

Delete a flavor profile

Usage:

openstack loadbalancer flavorprofile delete [-h] <flavor_profile>

Table 49.51. Positional Arguments

ValueSummary

<flavor_profile>

Flavor profiles to delete (name or id)

Table 49.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.15. loadbalancer flavorprofile list

List flavor profile

Usage:

openstack loadbalancer flavorprofile 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>]
                                                 [--provider <provider_name>]

Table 49.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List flavor profiles by flavor profile name.

--provider <provider_name>

List flavor profiles according to their provider.

Table 49.54. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.55. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.56. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.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.

49.16. loadbalancer flavorprofile set

Update a flavor profile

Usage:

openstack loadbalancer flavorprofile set [-h] [--name <name>]
                                                [--provider <provider_name>]
                                                [--flavor-data <flavor_data>]
                                                <flavor_profile>

Table 49.58. Positional Arguments

ValueSummary

<flavor_profile>

Name or uuid of the flavor profile to update.

Table 49.59. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the name of the flavor profile.

--provider <provider_name>

Set the provider of the flavor profile.

--flavor-data <flavor_data>

Set the flavor data of the flavor profile.

49.17. loadbalancer flavorprofile show

Show the details for a single flavor profile

Usage:

openstack loadbalancer flavorprofile show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <flavor_profile>

Table 49.60. Positional Arguments

ValueSummary

<flavor_profile>

Name or uuid of the flavor profile to show.

Table 49.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.62. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.64. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.65. 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.

49.18. loadbalancer healthmonitor create

Create a health monitor

Usage:

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--domain-name <domain_name>]
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   [--http-version <http_version>]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>

Table 49.66. Positional Arguments

ValueSummary

<pool>

Set the pool for the health monitor (name or id).

Table 49.67. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the health monitor name.

--delay <delay>

Set the time in seconds, between sending probes to members.

--domain-name <domain_name>

Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check.

--expected-codes <codes>

Set the list of http status codes expected in response from the member to declare it healthy.

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

Set the http method that the health monitor uses for requests.

--http-version <http_version>

Set the http version.

--timeout <timeout>

Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.

--max-retries <max_retries>

The number of successful checks before changing the operating status of the member to ONLINE.

--url-path <url_path>

Set the http url path of the request sent by the monitor to test the health of a backend member.

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO,UDP-CONNECT}

Set the health monitor type.

--max-retries-down <max_retries_down>

Set the number of allowed check failures before changing the operating status of the member to ERROR.

--enable

Enable health monitor (default).

--disable

Disable health monitor.

Table 49.68. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.70. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.71. 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.

49.19. loadbalancer healthmonitor delete

Delete a health monitor

Usage:

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

Table 49.72. Positional Arguments

ValueSummary

<health_monitor>

Health monitor to delete (name or id).

Table 49.73. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.20. loadbalancer healthmonitor list

List health monitors

Usage:

openstack loadbalancer healthmonitor 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]

Table 49.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.75. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.76. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.78. 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.

49.21. loadbalancer healthmonitor set

Update a health monitor

Usage:

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--domain-name <domain_name>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--http-version <http_version>]
                                                [--timeout <timeout>]
                                                [--max-retries <max_retries>]
                                                [--max-retries-down <max_retries_down>]
                                                [--url-path <url_path>]
                                                [--enable | --disable]
                                                <health_monitor>

Table 49.79. Positional Arguments

ValueSummary

<health_monitor>

Health monitor to update (name or id).

Table 49.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set health monitor name.

--delay <delay>

Set the time in seconds, between sending probes to members.

--domain-name <domain_name>

Set the domain name, which be injected into the http Host Header to the backend server for HTTP health check.

--expected-codes <codes>

Set the list of http status codes expected in response from the member to declare it healthy.

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

Set the http method that the health monitor uses for requests.

--http-version <http_version>

Set the http version.

--timeout <timeout>

Set the maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value.

--max-retries <max_retries>

Set the number of successful checks before changing the operating status of the member to ONLINE.

--max-retries-down <max_retries_down>

Set the number of allowed check failures before changing the operating status of the member to ERROR.

--url-path <url_path>

Set the http url path of the request sent by the monitor to test the health of a backend member.

--enable

Enable health monitor.

--disable

Disable health monitor.

49.22. loadbalancer healthmonitor show

Show the details of a single health monitor

Usage:

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 <health_monitor>

Table 49.81. Positional Arguments

ValueSummary

<health_monitor>

Name or uuid of the health monitor.

Table 49.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.83. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.84. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.85. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.86. 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.

49.23. loadbalancer l7policy create

Create a l7policy

Usage:

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                              [--redirect-http-code <redirect_http_code>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>

Table 49.87. Positional Arguments

ValueSummary

<listener>

Listener to add l7policy to (name or id).

Table 49.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the l7policy name.

--description <description>

Set l7policy description.

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

Set the action of the policy.

--redirect-pool <pool>

Set the pool to redirect requests to (name or id).

--redirect-url <url>

Set the url to redirect requests to.

--redirect-prefix <url>

Set the url prefix to redirect requests to.

--redirect-http-code <redirect_http_code>

Set the http response code for redirect_url orREDIRECT_PREFIX action.

--position <position>

Sequence number of this l7 policy.

--enable

Enable l7policy (default).

--disable

Disable l7policy.

Table 49.89. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.90. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.91. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.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.

49.24. loadbalancer l7policy delete

Delete a l7policy

Usage:

openstack loadbalancer l7policy delete [-h] <policy>

Table 49.93. Positional Arguments

ValueSummary

<policy>

L7policy to delete (name or id).

Table 49.94. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.25. loadbalancer l7policy list

List l7policies

Usage:

openstack loadbalancer l7policy 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]

Table 49.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.96. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.97. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.98. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.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.

49.26. loadbalancer l7policy set

Update a l7policy

Usage:

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url> | --redirect-prefix <url>]
                                           [--redirect-http-code <redirect_http_code>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>

Table 49.100. Positional Arguments

ValueSummary

<policy>

L7policy to update (name or id).

Table 49.101. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set l7policy name.

--description <description>

Set l7policy description.

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

Set the action of the policy.

--redirect-pool <pool>

Set the pool to redirect requests to (name or id).

--redirect-url <url>

Set the url to redirect requests to.

--redirect-prefix <url>

Set the url prefix to redirect requests to.

--redirect-http-code <redirect_http_code>

Set the http response code for redirect_url orREDIRECT_PREFIX action.

--position <position>

Set sequence number of this l7 policy.

--enable

Enable l7policy.

--disable

Disable l7policy.

49.27. loadbalancer l7policy show

Show the details of a single l7policy

Usage:

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <policy>

Table 49.102. Positional Arguments

ValueSummary

<policy>

Name or uuid of the l7policy.

Table 49.103. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.104. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.105. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.106. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.107. 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.

49.28. loadbalancer l7rule create

Create a l7rule

Usage:

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}
                                            [--enable | --disable]
                                            <l7policy>

Table 49.108. Positional Arguments

ValueSummary

<l7policy>

L7policy to add l7rule to (name or id).

Table 49.109. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

Set the compare type for the l7rule.

--invert

Invert l7rule.

--value <value>

Set the rule value to match on.

--key <key>

Set the key for the l7rule’s value to match on.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

Set the type for the l7rule.

--enable

Enable l7rule (default).

--disable

Disable l7rule.

Table 49.110. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.111. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.112. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.113. 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.

49.29. loadbalancer l7rule delete

Delete a l7rule

Usage:

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

Table 49.114. Positional Arguments

ValueSummary

<l7policy>

L7policy to delete rule from (name or id).

<rule_id>

L7rule to delete.

Table 49.115. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.30. loadbalancer l7rule list

List l7rules for l7policy

Usage:

openstack loadbalancer l7rule 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]
                                          <l7policy>

Table 49.116. Positional Arguments

ValueSummary

<l7policy>

L7policy to list rules for (name or id).

Table 49.117. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.118. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.119. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.120. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.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.

49.31. loadbalancer l7rule set

Update a l7rule

Usage:

openstack loadbalancer l7rule set [-h]
                                         [--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}]
                                         [--invert] [--value <value>]
                                         [--key <key>]
                                         [--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>

Table 49.122. Positional Arguments

ValueSummary

<l7policy>

L7policy to update l7rule on (name or id).

<l7rule_id>

L7rule to update.

Table 49.123. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

Set the compare type for the l7rule.

--invert

Invert l7rule.

--value <value>

Set the rule value to match on.

--key <key>

Set the key for the l7rule’s value to match on.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

Set the type for the l7rule.

--enable

Enable l7rule.

--disable

Disable l7rule.

49.32. loadbalancer l7rule show

Show the details of a single l7rule

Usage:

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <l7policy> <l7rule_id>

Table 49.124. Positional Arguments

ValueSummary

<l7policy>

L7policy to show rule from (name or id).

<l7rule_id>

L7rule to show.

Table 49.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.126. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.127. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.128. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.129. 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.

49.33. loadbalancer list

List load balancers

Usage:

openstack loadbalancer 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>]
                                   [--enable | --disable]
                                   [--project <project-id>]
                                   [--vip-network-id <vip_network_id>]
                                   [--vip-subnet-id <vip_subnet_id>]
                                   [--vip-qos-policy-id <vip_qos_policy_id>]
                                   [--vip-port-id <vip_port_id>]
                                   [--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}]
                                   [--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}]
                                   [--provider <provider>] [--flavor <flavor>]

Table 49.130. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List load balancers according to their name.

--enable

List enabled load balancers.

--disable

List disabled load balancers.

--project <project-id>

List load balancers according to their project (name or ID).

--vip-network-id <vip_network_id>

List load balancers according to their vip network (name or ID).

--vip-subnet-id <vip_subnet_id>

List load balancers according to their vip subnet (name or ID).

--vip-qos-policy-id <vip_qos_policy_id>

List load balancers according to their vip qos policy (name or ID).

--vip-port-id <vip_port_id>

List load balancers according to their vip port (name or ID).

--provisioning-status {ACTIVE,DELETED,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE}

List load balancers according to their provisioning status.

--operating-status {ONLINE,DRAINING,OFFLINE,DEGRADED,ERROR,NO_MONITOR}

List load balancers according to their operating status.

--provider <provider>

List load balancers according to their provider.

--flavor <flavor>

List load balancers according to their flavor.

Table 49.131. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.132. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.133. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.134. 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.

49.34. loadbalancer listener create

Create a listener

Usage:

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}
                                              [--connection-limit <limit>]
                                              [--default-pool <pool>]
                                              [--default-tls-container-ref <container_ref>]
                                              [--sni-container-refs [<container_ref> [<container_ref> ...]]]
                                              [--insert-headers <header=value,...>]
                                              --protocol-port <port>
                                              [--timeout-client-data <timeout>]
                                              [--timeout-member-connect <timeout>]
                                              [--timeout-member-data <timeout>]
                                              [--timeout-tcp-inspect <timeout>]
                                              [--enable | --disable]
                                              [--client-ca-tls-container-ref <container_ref>]
                                              [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                              [--client-crl-container-ref <client_crl_container_ref>]
                                              <loadbalancer>

Table 49.135. Positional Arguments

ValueSummary

<loadbalancer>

Load balancer for the listener (name or id).

Table 49.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the listener name.

--description <description>

Set the description of this listener.

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,UDP}

The protocol for the listener.

--connection-limit <limit>

Set the maximum number of connections permitted for this listener.

--default-pool <pool>

Set the name or id of the pool used by the listener if no L7 policies match.

--default-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS listeners.

--sni-container-refs [<container_ref> [<container_ref> …​]]

A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value,…​>

A dictionary of optional headers to insert into the request before it is sent to the backend member.

--protocol-port <port>

Set the protocol port number for the listener.

--timeout-client-data <timeout>

Frontend client inactivity timeout in milliseconds. Default: 50000.

--timeout-member-connect <timeout>

Backend member connection timeout in milliseconds. Default: 5000.

--timeout-member-data <timeout>

Backend member inactivity timeout in milliseconds. Default: 50000.

--timeout-tcp-inspect <timeout>

Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0.

--enable

Enable listener (default).

--disable

Disable listener.

--client-ca-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners.

--client-authentication {NONE,OPTIONAL,MANDATORY}

The tls client authentication verify options for TERMINATED_TLS listeners.

--client-crl-container-ref <client_crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners.

Table 49.137. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.139. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.140. 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.

49.35. loadbalancer listener delete

Delete a listener

Usage:

openstack loadbalancer listener delete [-h] <listener>

Table 49.141. Positional Arguments

ValueSummary

<listener>

Listener to delete (name or id)

Table 49.142. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.36. loadbalancer listener list

List listeners

Usage:

openstack loadbalancer listener 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>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]

Table 49.143. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List listeners by listener name.

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

--enable

List enabled listeners.

--disable

List disabled listeners.

--project <project>

List listeners by project id.

Table 49.144. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.145. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.146. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.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.

49.37. loadbalancer listener set

Update a listener

Usage:

openstack loadbalancer listener set [-h] [--name <name>]
                                           [--description <description>]
                                           [--connection-limit <limit>]
                                           [--default-pool <pool>]
                                           [--default-tls-container-ref <container-ref>]
                                           [--sni-container-refs [<container-ref> [<container-ref> ...]]]
                                           [--insert-headers <header=value>]
                                           [--timeout-client-data <timeout>]
                                           [--timeout-member-connect <timeout>]
                                           [--timeout-member-data <timeout>]
                                           [--timeout-tcp-inspect <timeout>]
                                           [--enable | --disable]
                                           [--client-ca-tls-container-ref <container_ref>]
                                           [--client-authentication {NONE,OPTIONAL,MANDATORY}]
                                           [--client-crl-container-ref <client_crl_container_ref>]
                                           <listener>

Table 49.148. Positional Arguments

ValueSummary

<listener>

Listener to modify (name or id).

Table 49.149. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the listener name.

--description <description>

Set the description of this listener.

--connection-limit <limit>

The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections.

--default-pool <pool>

The id of the pool used by the listener if no l7 policies match.

--default-tls-container-ref <container-ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLSlisteners.

--sni-container-refs [<container-ref> [<container-ref> …​]]

A list of uris to the key manager service secrets containers containing the certificates and keys for TERMINATED_TLS the listener using Server Name Indication.

--insert-headers <header=value>

A dictionary of optional headers to insert into the request before it is sent to the backend member.

--timeout-client-data <timeout>

Frontend client inactivity timeout in milliseconds. Default: 50000.

--timeout-member-connect <timeout>

Backend member connection timeout in milliseconds. Default: 5000.

--timeout-member-data <timeout>

Backend member inactivity timeout in milliseconds. Default: 50000.

--timeout-tcp-inspect <timeout>

Time, in milliseconds, to wait for additional tcp packets for content inspection. Default: 0.

--enable

Enable listener.

--disable

Disable listener.

--client-ca-tls-container-ref <container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners.

--client-authentication {NONE,OPTIONAL,MANDATORY}

The tls client authentication verify options for TERMINATED_TLS listeners.

--client-crl-container-ref <client_crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners.

49.38. loadbalancer listener show

Show the details of a single listener

Usage:

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <listener>

Table 49.150. Positional Arguments

ValueSummary

<listener>

Name or uuid of the listener

Table 49.151. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.152. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.153. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.154. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.155. 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.

49.39. loadbalancer listener stats show

Shows the current statistics for a listener.

Usage:

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  <listener>

Table 49.156. Positional Arguments

ValueSummary

<listener>

Name or uuid of the listener

Table 49.157. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.158. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.159. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.160. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.161. 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.

49.40. loadbalancer member create

Creating a member in a pool

Usage:

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--name <name>]
                                            [--disable-backup | --enable-backup]
                                            [--weight <weight>] --address
                                            <ip_address>
                                            [--subnet-id <subnet_id>]
                                            --protocol-port <protocol_port>
                                            [--monitor-port <monitor_port>]
                                            [--monitor-address <monitor_address>]
                                            [--enable | --disable]
                                            <pool>

Table 49.162. Positional Arguments

ValueSummary

<pool>

Id or name of the pool to create the member for.

Table 49.163. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the member.

--disable-backup

Disable member backup (default)

--enable-backup

Enable member backup

--weight <weight>

The weight of a member determines the portion of requests or connections it services compared to the other members of the pool.

--address <ip_address>

The ip address of the backend member server

--subnet-id <subnet_id>

The subnet id the member service is accessible from.

--protocol-port <protocol_port>

The protocol port number the backend member server is listening on.

--monitor-port <monitor_port>

An alternate protocol port used for health monitoring a backend member.

--monitor-address <monitor_address>

An alternate ip address used for health monitoring a backend member.

--enable

Enable member (default)

--disable

Disable member

Table 49.164. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.165. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.166. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.167. 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.

49.41. loadbalancer member delete

Delete a member from a pool

Usage:

openstack loadbalancer member delete [-h] <pool> <member>

Table 49.168. Positional Arguments

ValueSummary

<pool>

Pool name or id to delete the member from.

<member>

Name or id of the member to be deleted.

Table 49.169. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.42. loadbalancer member list

List members in a pool

Usage:

openstack loadbalancer member 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]
                                          <pool>

Table 49.170. Positional Arguments

ValueSummary

<pool>

Pool name or id to list the members of.

Table 49.171. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.172. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.173. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.174. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.175. 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.

49.43. loadbalancer member set

Update a member

Usage:

openstack loadbalancer member set [-h] [--name <name>]
                                         [--disable-backup | --enable-backup]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>

Table 49.176. Positional Arguments

ValueSummary

<pool>

Pool that the member to update belongs to (name or ID).

<member>

Name or id of the member to update

Table 49.177. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the name of the member

--disable-backup

Disable member backup (default)

--enable-backup

Enable member backup

--weight <weight>

Set the weight of member in the pool

--monitor-port <monitor_port>

An alternate protocol port used for health monitoring a backend member

--monitor-address <monitor_address>

An alternate ip address used for health monitoring a backend member.

--enable

Set the admin_state_up to true

--disable

Set the admin_state_up to false

49.44. loadbalancer member show

Shows details of a single Member

Usage:

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <pool> <member>

Table 49.178. Positional Arguments

ValueSummary

<pool>

Pool name or id to show the members of.

<member>

Name or id of the member to show.

Table 49.179. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.180. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.181. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.182. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.183. 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.

49.45. loadbalancer pool create

Create a pool

Usage:

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
                                          [--enable | --disable]
                                          [--tls-container-ref <container-ref>]
                                          [--ca-tls-container-ref <ca_tls_container_ref>]
                                          [--crl-container-ref <crl_container_ref>]
                                          [--enable-tls | --disable-tls]

Table 49.184. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set pool name.

--description <description>

Set pool description.

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY,UDP}

Set the pool protocol.

--listener <listener>

Listener to add the pool to (name or id).

--loadbalancer <load_balancer>

Load balncer to add the pool to (name or id)

--session-persistence <session persistence>

Set the session persistence for the listener (key=value).

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

Load balancing algorithm to use.

--enable

Enable pool (default).

--disable

Disable pool.

--tls-container-ref <container-ref>

The reference to the key manager service secrets container containing the certificate and key for ``tls_enabled``pools to re-encrpt the traffic to backend member servers.

--ca-tls-container-ref <ca_tls_container_ref>

The reference to the key manager service secrets container containing the CA certificate for ``tls_enabled`` pools to check the backend member servers certificates

--crl-container-ref <crl_container_ref>

The reference to the key manager service secrets container containting the CA revocation list file for ``tls_enabled`` pools to validate the backend member servers certificates.

--enable-tls

Enable backend member re-encryption.

--disable-tls

Disable backend member re-encryption.

Table 49.185. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.186. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.187. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.188. 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.

49.46. loadbalancer pool delete

Delete a pool

Usage:

openstack loadbalancer pool delete [-h] <pool>

Table 49.189. Positional Arguments

ValueSummary

<pool>

Pool to delete (name or id).

Table 49.190. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.47. loadbalancer pool list

List pools

Usage:

openstack loadbalancer pool 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]
                                        [--loadbalancer <loadbalancer>]

Table 49.191. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--loadbalancer <loadbalancer>

Filter by load balancer (name or id).

Table 49.192. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.193. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.194. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.195. 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.

49.48. loadbalancer pool set

Update a pool

Usage:

openstack loadbalancer pool set [-h] [--name <name>]
                                       [--description <description>]
                                       [--session-persistence <session_persistence>]
                                       [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}]
                                       [--enable | --disable]
                                       [--tls-container-ref <container-ref>]
                                       [--ca-tls-container-ref <ca_tls_container_ref>]
                                       [--crl-container-ref <crl_container_ref>]
                                       [--enable-tls | --disable-tls]
                                       <pool>

Table 49.196. Positional Arguments

ValueSummary

<pool>

Pool to update (name or id).

Table 49.197. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set the name of the pool.

--description <description>

Set the description of the pool.

--session-persistence <session_persistence>

Set the session persistence for the listener (key=value).

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

Set the load balancing algorithm to use.

--enable

Enable pool.

--disable

Disable pool.

--tls-container-ref <container-ref>

The uri to the key manager service secrets container containing the certificate and key for TERMINATED_TLS pools to re-encrpt the traffic from TERMINATED_TLS listener to backend servers.

--ca-tls-container-ref <ca_tls_container_ref>

The uri to the key manager service secrets container containing the CA certificate for TERMINATED_TLS listeners to check the backend servers certificates in ssl traffic.

--crl-container-ref <crl_container_ref>

The uri to the key manager service secrets container containting the CA revocation list file for TERMINATED_TLS listeners to valid the backend servers certificates in ssl traffic.

--enable-tls

Enable backend associated members re-encryption.

--disable-tls

Disable backend associated members re-encryption.

49.49. loadbalancer pool show

Show the details of a single pool

Usage:

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <pool>

Table 49.198. Positional Arguments

ValueSummary

<pool>

Name or uuid of the pool.

Table 49.199. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.200. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.201. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.202. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.203. 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.

49.50. loadbalancer provider capability list

List specified provider driver’s flavor capabilicies.

Usage:

openstack loadbalancer provider capability 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]
                                                       <provider_name>

Table 49.204. Positional Arguments

ValueSummary

<provider_name>

Name of the provider driver.

Table 49.205. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.206. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.207. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.208. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.209. 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.

49.51. loadbalancer provider list

List all providers

Usage:

openstack loadbalancer provider 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]

Table 49.210. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.211. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.212. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.213. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.214. 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.

49.52. loadbalancer quota defaults show

Show quota defaults

Usage:

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]

Table 49.215. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.216. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.217. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.218. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.219. 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.

49.53. loadbalancer quota list

List quotas

Usage:

openstack loadbalancer quota 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]
                                         [--project <project-id>]

Table 49.220. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project-id>

Name or uuid of the project.

Table 49.221. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 49.222. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 49.223. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.224. 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.

49.54. loadbalancer quota reset

Resets quotas to default quotas

Usage:

openstack loadbalancer quota reset [-h] <project>

Table 49.225. Positional Arguments

ValueSummary

<project>

Project to reset quotas (name or id)

Table 49.226. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

49.55. loadbalancer quota set

Update a quota

Usage:

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>

Table 49.227. Positional Arguments

ValueSummary

<project>

Name or uuid of the project.

Table 49.228. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.229. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.230. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.231. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.232. 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 49.233. Quota limits

ValueSummary

At least one of the following arguments is required.--healthmonitor <health_monitor>

New value for the health monitor quota. value -1 means unlimited.

--listener <listener>

New value for the listener quota. value -1 means unlimited.

--loadbalancer <load_balancer>

New value for the load balancer quota limit. value -1 means unlimited.

--member <member>

New value for the member quota limit. value -1 means unlimited.

--pool <pool>

New value for the pool quota limit. value -1 means unlimited.

49.56. loadbalancer quota show

Show the quota details for a project

Usage:

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <project>

Table 49.234. Positional Arguments

ValueSummary

<project>

Name or uuid of the project.

Table 49.235. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.236. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.237. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.238. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.239. 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.

49.57. loadbalancer set

Update a load balancer

Usage:

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

Table 49.240. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer to update.

Table 49.241. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set load balancer name.

--description <description>

Set load balancer description.

--vip-qos-policy-id <vip_qos_policy_id>

Set qos policy id for vip port. unset with none.

--enable

Enable load balancer.

--disable

Disable load balancer.

49.58. loadbalancer show

Show the details for a single load balancer

Usage:

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <load_balancer>

Table 49.242. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 49.243. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.244. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.245. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.246. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.247. 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.

49.59. loadbalancer stats show

Shows the current statistics for a load balancer

Usage:

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <load_balancer>

Table 49.248. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 49.249. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 49.250. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 49.251. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 49.252. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 49.253. 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.

49.60. loadbalancer status show

Display load balancer status tree in json format

Usage:

openstack loadbalancer status show [-h] <load_balancer>

Table 49.254. Positional Arguments

ValueSummary

<load_balancer>

Name or uuid of the load balancer.

Table 49.255. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 50. mapping

This chapter describes the commands under the mapping command.

50.1. mapping create

Create new mapping

Usage:

openstack mapping create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --rules <filename>
                                <name>

Table 50.1. Positional Arguments

ValueSummary

<name>

New mapping name (must be unique)

Table 50.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--rules <filename>

Filename that contains a set of mapping rules (required)

Table 50.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 50.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 50.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 50.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.

50.2. mapping delete

Delete mapping(s)

Usage:

openstack mapping delete [-h] <mapping> [<mapping> ...]

Table 50.7. Positional Arguments

ValueSummary

<mapping>

Mapping(s) to delete

Table 50.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

50.3. mapping list

List mappings

Usage:

openstack mapping 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]

Table 50.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 50.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 50.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 50.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 50.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.

50.4. mapping set

Set mapping properties

Usage:

openstack mapping set [-h] [--rules <filename>] <name>

Table 50.14. Positional Arguments

ValueSummary

<name>

Mapping to modify

Table 50.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--rules <filename>

Filename that contains a new set of mapping rules

50.5. mapping show

Display mapping details

Usage:

openstack mapping show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <mapping>

Table 50.16. Positional Arguments

ValueSummary

<mapping>

Mapping to display

Table 50.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 50.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 50.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 50.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 50.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 51. messaging

This chapter describes the commands under the messaging command.

51.1. messaging claim create

Create claim and return a list of claimed messages

Usage:

openstack messaging claim 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]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

Table 51.1. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to be claim

Table 51.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--ttl <ttl>

Time to live in seconds for claim

--grace <grace>

The message grace period in seconds

--limit <limit>

Claims a set of messages, up to limit

Table 51.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.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.

51.2. messaging claim query

Display claim details

Usage:

openstack messaging claim query [-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]
                                       <queue_name> <claim_id>

Table 51.7. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Id of the claim

Table 51.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.10. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.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.

51.3. messaging claim release

Delete a claim

Usage:

openstack messaging claim release [-h] <queue_name> <claim_id>

Table 51.13. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id to delete

Table 51.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.4. messaging claim renew

Renew a claim

Usage:

openstack messaging claim renew [-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]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

Table 51.15. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id

Table 51.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--ttl <ttl>

Time to live in seconds for claim

--grace <grace>

The message grace period in seconds

Table 51.17. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.18. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.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.

51.5. messaging flavor create

Create a pool flavor

Usage:

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--capabilities <capabilities>]
                                         <flavor_name> <pool_group>

Table 51.21. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

<pool_group>

Pool group for flavor

Table 51.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--capabilities <capabilities>

Describes flavor-specific capabilities, this option is only available in client api version < 2 .

Table 51.23. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.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.

51.6. messaging flavor delete

Delete a pool flavor

Usage:

openstack messaging flavor delete [-h] <flavor_name>

Table 51.27. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 51.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.7. messaging flavor list

List available pool flavors

Usage:

openstack messaging flavor 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 <flavor_name>]
                                       [--limit <limit>] [--detailed]

Table 51.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <flavor_name>

Flavor’s paging marker

--limit <limit>

Page size limit

--detailed

If show detailed capabilities of flavor

Table 51.30. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.31. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.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.

51.8. messaging flavor show

Display pool flavor details

Usage:

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <flavor_name>

Table 51.34. Positional Arguments

ValueSummary

<flavor_name>

Flavor to display (name)

Table 51.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.36. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.38. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.39. 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.

51.9. messaging flavor update

Update a flavor’s attributes

Usage:

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--pool_group <pool_group>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>

Table 51.40. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 51.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool_group <pool_group>

Pool group the flavor sits on

--capabilities <capabilities>

Describes flavor-specific capabilities.

Table 51.42. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.44. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.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.

51.10. messaging health

Display detailed health status of Zaqar server

Usage:

openstack messaging health [-h]

Table 51.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.11. messaging homedoc

Display detailed resource doc of Zaqar server

Usage:

openstack messaging homedoc [-h]

Table 51.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.12. messaging message list

List all messages for a given queue

Usage:

openstack messaging message 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]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

Table 51.48. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.49. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--message-ids <message_ids>

List of messages' ids to retrieve

--limit <limit>

Maximum number of messages to get

--echo

Whether to get this client’s own messages

--include-claimed

Whether to include claimed messages

--include-delayed

Whether to include delayed messages

--client-id <client_id>

A uuid for each client instance.

Table 51.50. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.51. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.53. 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.

51.13. messaging message post

Post messages for a given queue

Usage:

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

Table 51.54. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

<messages>

Messages to be posted.

Table 51.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--client-id <client_id>

A uuid for each client instance.

51.14. messaging ping

Check if Zaqar server is alive or not

Usage:

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]

Table 51.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.57. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.58. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.59. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.60. 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.

51.15. messaging pool create

Create a pool

Usage:

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

Table 51.61. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

<pool_uri>

Storage engine uri

<pool_weight>

Weight of the pool

Table 51.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool_group <pool_group>

Group of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

Table 51.63. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.65. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.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.

51.16. messaging pool delete

Delete a pool

Usage:

openstack messaging pool delete [-h] <pool_name>

Table 51.67. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

Table 51.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.17. messaging pool list

List available Pools

Usage:

openstack messaging pool 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 <pool_name>] [--limit <limit>]
                                     [--detailed]

Table 51.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <pool_name>

Pool’s paging marker

--limit <limit>

Page size limit

--detailed

Detailed output

Table 51.70. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.71. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.73. 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.

51.18. messaging pool show

Display pool details

Usage:

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <pool_name>

Table 51.74. Positional Arguments

ValueSummary

<pool_name>

Pool to display (name)

Table 51.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.76. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.78. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.79. 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.

51.19. messaging pool update

Update a pool attribute

Usage:

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

Table 51.80. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

Table 51.81. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool_uri <pool_uri>

Storage engine uri

--pool_weight <pool_weight>

Weight of the pool

--pool_group <pool_group>

Group of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

Table 51.82. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.83. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.84. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.85. 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.

51.20. messaging queue create

Create a queue

Usage:

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <queue_name>

Table 51.86. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.87. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.88. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.90. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.91. 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.

51.21. messaging queue delete

Delete a queue

Usage:

openstack messaging queue delete [-h] <queue_name>

Table 51.92. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.93. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.22. messaging queue get metadata

Get queue metadata

Usage:

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <queue_name>

Table 51.94. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.96. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.97. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.98. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.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.

51.23. messaging queue list

List available queues

Usage:

openstack messaging queue 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 <queue_id>] [--limit <limit>]
                                      [--detailed]

Table 51.100. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <queue_id>

Queue’s paging marker

--limit <limit>

Page size limit

--detailed

If show detailed information of queue

Table 51.101. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.102. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.103. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.104. 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.

51.24. messaging queue purge

Purge a queue

Usage:

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

Table 51.105. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.106. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource_types <resource_types>

Resource types want to be purged.

51.25. messaging queue set metadata

Set queue metadata

Usage:

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

Table 51.107. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

<queue_metadata>

Queue metadata, all the metadata of the queue will be replaced by queue_metadata

Table 51.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.26. messaging queue signed url

Create a pre-signed url

Usage:

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

Table 51.109. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.110. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--paths <paths>

Allowed paths in a comma-separated list. options: messages, subscriptions, claims

--ttl-seconds <ttl_seconds>

Length of time (in seconds) until the signature expires

--methods <methods>

Http methods to allow as a comma-separated list. Options: GET, HEAD, OPTIONS, POST, PUT, DELETE

Table 51.111. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.113. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.114. 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.

51.27. messaging queue stats

Get queue stats

Usage:

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <queue_name>

Table 51.115. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.117. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.118. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.119. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.120. 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.

51.28. messaging subscription create

Create a subscription for queue

Usage:

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

Table 51.121. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscriber>

Subscriber which will be notified

<ttl>

Time to live of the subscription in seconds

Table 51.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

Table 51.123. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.124. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.125. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.126. 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.

51.29. messaging subscription delete

Delete a subscription

Usage:

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

Table 51.127. Positional Arguments

ValueSummary

<queue_name>

Name of the queue for the subscription

<subscription_id>

Id of the subscription

Table 51.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.30. messaging subscription list

List available subscriptions

Usage:

openstack messaging subscription 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 <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

Table 51.129. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

Table 51.130. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <subscription_id>

Subscription’s paging marker, the id of the last subscription of the previous page

--limit <limit>

Page size limit, default value is 20

Table 51.131. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 51.132. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 51.133. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.134. 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.

51.31. messaging subscription show

Display subscription details

Usage:

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <queue_name> <subscription_id>

Table 51.135. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Table 51.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 51.137. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.139. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.140. 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.

51.32. messaging subscription update

Update a subscription

Usage:

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

Table 51.141. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Table 51.142. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--subscriber <subscriber>

Subscriber which will be notified

--ttl <ttl>

Time to live of the subscription in seconds

--options <options>

Metadata of the subscription in json format

Table 51.143. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 51.144. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.145. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 51.146. 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 52. metric

This chapter describes the commands under the metric command.

52.1. metric aggregates

Get measurements of aggregated metrics.

Usage:

openstack metric aggregates [-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]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

Table 52.1. Positional Arguments

ValueSummary

operations

Operations to apply to time series

search

A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.

Table 52.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-type RESOURCE_TYPE

Resource type to query

--start START

Beginning of the period

--stop STOP

End of the period

--granularity GRANULARITY

Granularity to retrieve

--needed-overlap NEEDED_OVERLAP

Percentage of overlap across datapoints

--groupby GROUPBY

Attribute to use to group resources

--fill FILL

Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or null.

Table 52.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.2. metric archive-policy create

Create an archive policy.

Usage:

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

Table 52.7. Positional Arguments

ValueSummary

name

Name of the archive policy

Table 52.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-d <DEFINITION>, --definition <DEFINITION>

Two attributes (separated by ,) of an archive policy definition with its name and value separated with a :

-b BACK_WINDOW, --back-window BACK_WINDOW

Back window of the archive policy

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

Aggregation method of the archive policy

Table 52.9. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.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.

52.3. metric archive-policy delete

Delete an archive policy.

Usage:

openstack metric archive-policy delete [-h] name

Table 52.13. Positional Arguments

ValueSummary

name

Name of the archive policy

Table 52.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

52.4. metric archive-policy list

List archive policies.

Usage:

openstack metric archive-policy 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]

Table 52.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.16. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.17. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.5. metric archive-policy-rule create

Create an archive policy rule.

Usage:

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

Table 52.20. Positional Arguments

ValueSummary

name

Rule name

Table 52.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

Archive policy name

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

Wildcard of metric name to match

Table 52.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.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.

52.6. metric archive-policy-rule delete

Delete an archive policy rule.

Usage:

openstack metric archive-policy-rule delete [-h] name

Table 52.26. Positional Arguments

ValueSummary

name

Name of the archive policy rule

Table 52.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

52.7. metric archive-policy-rule list

List archive policy rules.

Usage:

openstack metric archive-policy-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]

Table 52.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.29. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.30. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.32. 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.

52.8. metric archive-policy-rule show

Show an archive policy rule.

Usage:

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 name

Table 52.33. Positional Arguments

ValueSummary

name

Name of the archive policy rule

Table 52.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.35. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.37. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.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.

52.9. metric archive-policy show

Show an archive policy.

Usage:

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            name

Table 52.39. Positional Arguments

ValueSummary

name

Name of the archive policy

Table 52.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.41. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.43. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.44. 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.

52.10. metric archive-policy update

Update an archive policy.

Usage:

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty] -d
                                              <DEFINITION>
                                              name

Table 52.45. Positional Arguments

ValueSummary

name

Name of the archive policy

Table 52.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-d <DEFINITION>, --definition <DEFINITION>

Two attributes (separated by ,) of an archive policy definition with its name and value separated with a :

Table 52.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.49. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.50. 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.

52.11. metric benchmark measures add

Do benchmark testing of adding measurements.

Usage:

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

Table 52.51. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--workers WORKERS, -w WORKERS

Number of workers to use

--count COUNT, -n COUNT

Number of total measures to send

--batch BATCH, -b BATCH

Number of measures to send in each batch

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

First timestamp to use

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

Last timestamp to use

--wait

Wait for all measures to be processed

Table 52.53. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.55. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.56. 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.

52.12. metric benchmark measures show

Do benchmark testing of measurements show.

Usage:

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric

Table 52.57. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--utc

Return timestamps as utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--aggregation AGGREGATION

Aggregation to retrieve

--start START

Beginning of the period

--stop STOP

End of the period

--granularity GRANULARITY

Granularity to retrieve

--refresh

Force aggregation of all known measures

--resample RESAMPLE

Granularity to resample time-series to (in seconds)

--workers WORKERS, -w WORKERS

Number of workers to use

--count COUNT, -n COUNT

Number of total measures to send

Table 52.59. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--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 52.60. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.61. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.62. 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.

52.13. metric benchmark metric create

Do benchmark testing of metric creation.

Usage:

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

Table 52.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

Name of the archive policy

--workers WORKERS, -w WORKERS

Number of workers to use

--count COUNT, -n COUNT

Number of metrics to create

--keep, -k

Keep created metrics

Table 52.64. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.65. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.66. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.67. 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.

52.14. metric benchmark metric show

Do benchmark testing of metric show.

Usage:

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

Table 52.68. Positional Arguments

ValueSummary

metric

Id or name of the metrics

Table 52.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--workers WORKERS, -w WORKERS

Number of workers to use

--count COUNT, -n COUNT

Number of metrics to get

Table 52.70. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.72. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.73. 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.

52.15. metric capabilities list

List capabilities.

Usage:

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

Table 52.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.75. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.77. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.78. 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.

52.16. metric create

Create a metric.

Usage:

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

Table 52.79. Positional Arguments

ValueSummary

METRIC_NAME

Name of the metric

Table 52.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

Name of the archive policy

--unit UNIT, -u UNIT

Unit of the metric

Table 52.81. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.83. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.84. 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.

52.17. metric delete

Delete a metric.

Usage:

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

Table 52.85. Positional Arguments

ValueSummary

metric

Ids or names of the metric

Table 52.86. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

52.18. metric list

List metrics.

Usage:

openstack metric 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 <MARKER>] [--sort <SORT>]

Table 52.87. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <LIMIT>

Number of metrics to return (default is server default)

--marker <MARKER>

Last item of the previous listing. return the next results after this value

--sort <SORT>

Sort of metric attribute (example: user_id:desc- nullslast

Table 52.88. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.89. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.90. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.91. 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.

52.19. metric measures add

Add measurements to a metric.

Usage:

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

Table 52.92. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.93. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

-m MEASURE, --measure MEASURE

Timestamp and value of a measure separated with a @

52.20. metric measures aggregation

Get measurements of aggregated metrics.

Usage:

openstack metric measures aggregation [-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]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]

Table 52.94. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--utc

Return timestamps as utc

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

Metrics ids or metric name

--aggregation AGGREGATION

Granularity aggregation function to retrieve

--reaggregation REAGGREGATION

Groupby aggregation function to retrieve

--start START

Beginning of the period

--stop STOP

End of the period

--granularity GRANULARITY

Granularity to retrieve

--needed-overlap NEEDED_OVERLAP

Percent of datapoints in each metrics required

--query QUERY

A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.

--resource-type RESOURCE_TYPE

Resource type to query

--groupby GROUPBY

Attribute to use to group resources

--refresh

Force aggregation of all known measures

--resample RESAMPLE

Granularity to resample time-series to (in seconds)

--fill FILL

Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or null.

Table 52.95. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.96. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.97. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.98. 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.

52.21. metric measures batch-metrics

Usage:

openstack metric measures batch-metrics [-h] file

Table 52.99. Positional Arguments

ValueSummary

file

File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Table 52.100. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

52.22. metric measures batch-resources-metrics

Usage:

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

Table 52.101. Positional Arguments

ValueSummary

file

File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Table 52.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--create-metrics

Create unknown metrics

52.23. metric measures show

Get measurements of a metric.

Usage:

openstack metric measures 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] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

Table 52.103. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.104. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--utc

Return timestamps as utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--aggregation AGGREGATION

Aggregation to retrieve

--start START

Beginning of the period

--stop STOP

End of the period

--granularity GRANULARITY

Granularity to retrieve

--refresh

Force aggregation of all known measures

--resample RESAMPLE

Granularity to resample time-series to (in seconds)

Table 52.105. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.106. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.24. metric metric create

Deprecated: Create a metric.

Usage:

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

Table 52.109. Positional Arguments

ValueSummary

METRIC_NAME

Name of the metric

Table 52.110. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

Name of the archive policy

--unit UNIT, -u UNIT

Unit of the metric

Table 52.111. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.113. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.114. 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.

52.25. metric metric delete

Deprecated: Delete a metric.

Usage:

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

Table 52.115. Positional Arguments

ValueSummary

metric

Ids or names of the metric

Table 52.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

52.26. metric metric list

Deprecated: List metrics.

Usage:

openstack metric metric 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 <MARKER>]
                                    [--sort <SORT>]

Table 52.117. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <LIMIT>

Number of metrics to return (default is server default)

--marker <MARKER>

Last item of the previous listing. return the next results after this value

--sort <SORT>

Sort of metric attribute (example: user_id:desc- nullslast

Table 52.118. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.119. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.120. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.27. metric metric show

Deprecated: Show a metric.

Usage:

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--resource-id RESOURCE_ID]
                                    metric

Table 52.122. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.123. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

Table 52.124. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.125. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.126. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.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.

52.28. metric resource batch delete

Delete a batch of resources based on attribute values.

Usage:

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--type RESOURCE_TYPE]
                                              query

Table 52.128. Positional Arguments

ValueSummary

query

A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.

Table 52.129. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

Table 52.130. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.131. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.132. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.133. 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.

52.29. metric resource create

Create a resource.

Usage:

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC]
                                        resource_id

Table 52.134. Positional Arguments

ValueSummary

resource_id

Id of the resource

Table 52.135. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

-a ATTRIBUTE, --attribute ATTRIBUTE

Name and value of an attribute separated with a :

-m ADD_METRIC, --add-metric ADD_METRIC

Name:id of a metric to add

-n CREATE_METRIC, --create-metric CREATE_METRIC

Name:archive_policy_name of a metric to create

Table 52.136. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.137. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.138. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.139. 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.

52.30. metric resource delete

Delete a resource.

Usage:

openstack metric resource delete [-h] resource_id

Table 52.140. Positional Arguments

ValueSummary

resource_id

Id of the resource

Table 52.141. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

52.31. metric resource history

Show the history of a resource.

Usage:

openstack metric resource history [-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]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

Table 52.142. Positional Arguments

ValueSummary

resource_id

Id of a resource

Table 52.143. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--details

Show all attributes of generic resources

--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

--sort <SORT>

Sort of resource attribute (example: user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

Table 52.144. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.145. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.146. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.32. metric resource list

List resources.

Usage:

openstack metric resource 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] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

Table 52.148. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--details

Show all attributes of generic resources

--history

Show history of the resources

--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

--sort <SORT>

Sort of resource attribute (example: user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

Table 52.149. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.150. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.151. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.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.

52.34. metric resource show

Show a resource.

Usage:

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--type RESOURCE_TYPE]
                                      resource_id

Table 52.159. Positional Arguments

ValueSummary

resource_id

Id of a resource

Table 52.160. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

Table 52.161. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.162. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.163. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.164. 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.

52.35. metric resource-type create

Create a resource type.

Usage:

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             name

Table 52.165. Positional Arguments

ValueSummary

name

Name of the resource type

Table 52.166. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-a ATTRIBUTE, --attribute ATTRIBUTE

Attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ For example: display_name:string:true:max_length=255

Table 52.167. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.168. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.169. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.170. 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.

52.36. metric resource-type delete

Delete a resource type.

Usage:

openstack metric resource-type delete [-h] name

Table 52.171. Positional Arguments

ValueSummary

name

Name of the resource type

Table 52.172. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

52.37. metric resource-type list

List resource types.

Usage:

openstack metric resource-type 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]

Table 52.173. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.174. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 52.175. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 52.176. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.177. 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.

52.38. metric resource-type show

Show a resource type.

Usage:

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           name

Table 52.178. Positional Arguments

ValueSummary

name

Name of the resource type

Table 52.179. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.180. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.181. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.182. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.183. 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.

52.39. metric resource-type update

Create a resource type.

Usage:

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

Table 52.184. Positional Arguments

ValueSummary

name

Name of the resource type

Table 52.185. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-a ATTRIBUTE, --attribute ATTRIBUTE

Attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ For example: display_name:string:true:max_length=255

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

Attribute name

Table 52.186. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.187. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.188. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.189. 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.

52.40. metric resource update

Update a resource.

Usage:

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--type RESOURCE_TYPE]
                                        [-a ATTRIBUTE] [-m ADD_METRIC]
                                        [-n CREATE_METRIC] [-d DELETE_METRIC]
                                        resource_id

Table 52.190. Positional Arguments

ValueSummary

resource_id

Id of the resource

Table 52.191. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

-a ATTRIBUTE, --attribute ATTRIBUTE

Name and value of an attribute separated with a :

-m ADD_METRIC, --add-metric ADD_METRIC

Name:id of a metric to add

-n CREATE_METRIC, --create-metric CREATE_METRIC

Name:archive_policy_name of a metric to create

-d DELETE_METRIC, --delete-metric DELETE_METRIC

Name of a metric to delete

Table 52.192. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.193. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.194. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.195. 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.

52.41. metric server version

Show the version of Gnocchi server.

Usage:

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

Table 52.196. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.197. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.198. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.199. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.200. 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.

52.42. metric show

Show a metric.

Usage:

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--resource-id RESOURCE_ID]
                             metric

Table 52.201. Positional Arguments

ValueSummary

metric

Id or name of the metric

Table 52.202. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

Id of the resource

Table 52.203. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.204. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.205. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.206. 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.

52.43. metric status

Show the status of measurements processing.

Usage:

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]

Table 52.207. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 52.208. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 52.209. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 52.210. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 52.211. 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 53. module

This chapter describes the commands under the module command.

53.1. module list

List module versions

Usage:

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all]

Table 53.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Show all modules that have version information

Table 53.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 53.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 53.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 53.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 54. network

This chapter describes the commands under the network command.

54.1. network agent add network

Add network to an agent

Usage:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

Table 54.1. Positional Arguments

ValueSummary

<agent-id>

Agent to which a network is added (id only)

<network>

Network to be added to an agent (name or id)

Table 54.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dhcp

Add network to a dhcp agent

54.2. network agent add router

Add router to an agent

Usage:

openstack network agent add router [-h] [--l3] <agent-id> <router>

Table 54.3. Positional Arguments

ValueSummary

<agent-id>

Agent to which a router is added (id only)

<router>

Router to be added to an agent (name or id)

Table 54.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--l3

Add router to an l3 agent

54.3. network agent delete

Delete network agent(s)

Usage:

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

Table 54.5. Positional Arguments

ValueSummary

<network-agent>

Network agent(s) to delete (id only)

Table 54.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.4. network agent list

List network agents

Usage:

openstack network agent 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]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

Table 54.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--agent-type <agent-type>

List only agents with the specified agent type. the supported agent types are: bgp, dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic.

--host <host>

List only agents running on the specified host

--network <network>

List agents hosting a network (name or id)

--router <router>

List agents hosting this router (name or id)

--long

List additional fields in output

Table 54.8. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.9. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.11. 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.

54.5. network agent remove network

Remove network from an agent.

Usage:

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

Table 54.12. Positional Arguments

ValueSummary

<agent-id>

Agent to which a network is removed (id only)

<network>

Network to be removed from an agent (name or id)

Table 54.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dhcp

Remove network from dhcp agent

54.6. network agent remove router

Remove router from an agent

Usage:

openstack network agent remove router [-h] [--l3] <agent-id> <router>

Table 54.14. Positional Arguments

ValueSummary

<agent-id>

Agent from which router will be removed (id only)

<router>

Router to be removed from an agent (name or id)

Table 54.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--l3

Remove router from an l3 agent

54.7. network agent set

Set network agent properties

Usage:

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

Table 54.16. Positional Arguments

ValueSummary

<network-agent>

Network agent to modify (id only)

Table 54.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set network agent description

--enable

Enable network agent

--disable

Disable network agent

54.8. network agent show

Display network agent details

Usage:

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <network-agent>

Table 54.18. Positional Arguments

ValueSummary

<network-agent>

Network agent to display (id only)

Table 54.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.20. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.22. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.9. network auto allocated topology create

Create the auto allocated topology for project

Usage:

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

Table 54.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Return the auto allocated topology for a given project. Default is current project

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--check-resources

Validate the requirements for auto allocated topology. Does not return a topology.

--or-show

If topology exists returns the topology’s information (Default)

Table 54.25. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.27. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.28. 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.

54.10. network auto allocated topology delete

Delete auto allocated topology for project

Usage:

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

Table 54.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Delete auto allocated topology for a given project. Default is the current project

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

54.11. network create

Create new network

Usage:

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--dns-domain <dns-domain>]
                                [--tag <tag> | --no-tag]
                                <name>

Table 54.30. Positional Arguments

ValueSummary

<name>

New network name

Table 54.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--share

Share the network between projects

--no-share

Do not share the network between projects

--enable

Enable network (default)

--disable

Disable network

--project <project>

Owner’s project (name or id)

--description <description>

Set network description

--mtu <mtu>

Set network mtu

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--availability-zone-hint <availability-zone>

Availability zone in which to create this network (Network Availability Zone extension required, repeat option to set multiple availability zones)

--enable-port-security

Enable port security by default for ports created on this network (default)

--disable-port-security

Disable port security by default for ports created on this network

--external

Set this network as an external network (external-net extension required)

--internal

Set this network as an internal network (default)

--default

Specify if this network should be used as the default external network

--no-default

Do not use the network as the default external network (default)

--qos-policy <qos-policy>

Qos policy to attach to this network (name or id)

--transparent-vlan

Make the network vlan transparent

--no-transparent-vlan

Do not make the network vlan transparent

--provider-network-type <provider-network-type>

The physical mechanism by which the virtual network is implemented. For example: flat, geneve, gre, local, vlan, vxlan.

--provider-physical-network <provider-physical-network>

Name of the physical network over which the virtual network is implemented

--provider-segment <provider-segment>

Vlan id for vlan networks or tunnel id for GENEVE/GRE/VXLAN networks

--dns-domain <dns-domain>

Set dns domain for this network (requires dns integration extension)

--tag <tag>

Tag to be added to the network (repeat option to set multiple tags)

--no-tag

No tags associated with the network

Table 54.32. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.34. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.12. network delete

Delete network(s)

Usage:

openstack network delete [-h] <network> [<network> ...]

Table 54.36. Positional Arguments

ValueSummary

<network>

Network(s) to delete (name or id)

Table 54.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.13. network flavor add profile

Add a service profile to a network flavor

Usage:

openstack network flavor add profile [-h] <flavor> <service-profile>

Table 54.38. Positional Arguments

ValueSummary

<flavor>

Network flavor (name or id)

<service-profile>

Service profile (id only)

Table 54.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.14. network flavor create

Create new network flavor

Usage:

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --service-type
                                       <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

Table 54.40. Positional Arguments

ValueSummary

<name>

Name for the flavor

Table 54.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--service-type <service-type>

Service type to which the flavor applies to: e.g. vpn (See openstack network service provider list for loaded examples.)

--description DESCRIPTION

Description for the flavor

--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.

--enable

Enable the flavor (default)

--disable

Disable the flavor

Table 54.42. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.44. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.15. network flavor delete

Delete network flavors

Usage:

openstack network flavor delete [-h] <flavor> [<flavor> ...]

Table 54.46. Positional Arguments

ValueSummary

<flavor>

Flavor(s) to delete (name or id)

Table 54.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.16. network flavor list

List network flavors

Usage:

openstack network flavor 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]

Table 54.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.49. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.50. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.51. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.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.

54.17. network flavor profile create

Create new network flavor profile

Usage:

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

Table 54.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

--description <description>

Description for the flavor profile

--enable

Enable the flavor profile

--disable

Disable the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if --metainfo is missing and vice versa

--metainfo METAINFO

Metainfo for the flavor profile. this becomes required if --driver is missing and vice versa

Table 54.54. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.55. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.56. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.18. network flavor profile delete

Delete network flavor profile

Usage:

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

Table 54.58. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile(s) to delete (id only)

Table 54.59. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.19. network flavor profile list

List network flavor profile(s)

Usage:

openstack network flavor profile 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]

Table 54.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.61. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.62. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.64. 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.

54.20. network flavor profile set

Set network flavor profile properties

Usage:

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

Table 54.65. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile to update (id only)

Table 54.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--description <description>

Description for the flavor profile

--enable

Enable the flavor profile

--disable

Disable the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if --metainfo is missing and vice versa

--metainfo METAINFO

Metainfo for the flavor profile. this becomes required if --driver is missing and vice versa

54.21. network flavor profile show

Display network flavor profile details

Usage:

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <flavor-profile>

Table 54.67. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile to display (id only)

Table 54.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.69. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.70. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.71. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.72. 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.

54.22. network flavor remove profile

Remove service profile from network flavor

Usage:

openstack network flavor remove profile [-h] <flavor> <service-profile>

Table 54.73. Positional Arguments

ValueSummary

<flavor>

Network flavor (name or id)

<service-profile>

Service profile (id only)

Table 54.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.23. network flavor set

Set network flavor properties

Usage:

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

Table 54.75. Positional Arguments

ValueSummary

<flavor>

Flavor to update (name or id)

Table 54.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Set network flavor description

--disable

Disable network flavor

--enable

Enable network flavor

--name <name>

Set flavor name

54.24. network flavor show

Display network flavor details

Usage:

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <flavor>

Table 54.77. Positional Arguments

ValueSummary

<flavor>

Flavor to display (name or id)

Table 54.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.79. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.80. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.81. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.82. 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.

54.25. network list

List networks

Usage:

openstack network 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]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]

Table 54.83. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--external

List external networks

--internal

List internal networks

--long

List additional fields in output

--name <name>

List networks according to their name

--enable

List enabled networks

--disable

List disabled networks

--project <project>

List networks 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 networks shared between projects

--no-share

List networks not shared between projects

--status <status>

List networks according to their status (active, BUILD, DOWN, ERROR)

--provider-network-type <provider-network-type>

List networks according to their physical mechanisms. The supported options are: flat, geneve, gre, local, vlan, vxlan.

--provider-physical-network <provider-physical-network>

List networks according to name of the physical network

--provider-segment <provider-segment>

List networks according to vlan id for vlan networks or Tunnel ID for GENEVE/GRE/VXLAN networks

--agent <agent-id>

List networks hosted by agent (id only)

--tags <tag>[,<tag>,…​]

List networks which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List networks which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude networks which have all given tag(s) (comma- separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude networks which have any given tag(s) (comma- separated list of tags)

Table 54.84. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.85. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.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.

54.26. network log create

Create a new network log

Usage:

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event <event>] --resource-type
                                    <resource-type> [--resource <resource>]
                                    [--target <target>]
                                    <name>

Table 54.88. Positional Arguments

ValueSummary

<name>

Name for the network log

Table 54.89. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the network log

--enable

Enable this log (default is disabled)

--disable

Disable this log

--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.

--event <event>

An event to store with log

--resource-type <resource-type>

Network log type(s). you can see supported type(s) with following command: $ openstack network loggable resources list

--resource <resource>

Name or id of resource (security group or firewall group) that used for logging. You can control for logging target combination with --target option.

--target <target>

Port (name or id) for logging. you can control for logging target combination with --resource option.

Table 54.90. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.91. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.92. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.27. network log delete

Delete network log(s)

Usage:

openstack network log delete [-h] <network-log> [<network-log> ...]

Table 54.94. Positional Arguments

ValueSummary

<network-log>

Network log(s) to delete (name or id)

Table 54.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.28. network log list

List network logs

Usage:

openstack network log 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]

Table 54.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 54.97. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.98. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.99. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.100. 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.

54.29. network log set

Set network log properties

Usage:

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

Table 54.101. Positional Arguments

ValueSummary

<network-log>

Network log to set (name or id)

Table 54.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the network log

--enable

Enable this log (default is disabled)

--disable

Disable this log

--name <name>

Name of the network log

54.30. network log show

Display network log details

Usage:

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <network-log>

Table 54.103. Positional Arguments

ValueSummary

<network-log>

Network log to show (name or id)

Table 54.104. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.105. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.106. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.107. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.31. network loggable resources list

List supported loggable resources

Usage:

openstack network loggable resources 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]

Table 54.109. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 54.110. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.111. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.113. 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.

54.32. network meter create

Create network meter

Usage:

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

Table 54.114. Positional Arguments

ValueSummary

<name>

Name of meter

Table 54.115. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Create description for meter

--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 meter between projects

--no-share

Do not share meter between projects

Table 54.116. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.117. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.118. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.119. 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.

54.33. network meter delete

Delete network meter

Usage:

openstack network meter delete [-h] <meter> [<meter> ...]

Table 54.120. Positional Arguments

ValueSummary

<meter>

Meter to delete (name or id)

Table 54.121. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.34. network meter list

List network meters

Usage:

openstack network meter 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]

Table 54.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.123. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.124. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.125. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.126. 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.

54.35. network meter rule create

Create a new meter rule

Usage:

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

Table 54.127. Positional Arguments

ValueSummary

<meter>

Label to associate with this metering rule (name or ID)

Table 54.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

--exclude

Exclude remote ip prefix from traffic count

--include

Include remote ip prefix from traffic count (default)

--ingress

Apply rule to incoming network traffic (default)

--egress

Apply rule to outgoing network traffic

--remote-ip-prefix <remote-ip-prefix>

The remote ip prefix to associate with this rule

Table 54.129. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.130. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.131. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.36. network meter rule delete

Delete meter rule(s)

Usage:

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

Table 54.133. Positional Arguments

ValueSummary

<meter-rule-id>

Meter rule to delete (id only)

Table 54.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.37. network meter rule list

List meter rules

Usage:

openstack network meter 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]

Table 54.135. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.136. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.137. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.139. 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.

54.38. network meter rule show

Display meter rules details

Usage:

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <meter-rule-id>

Table 54.140. Positional Arguments

ValueSummary

<meter-rule-id>

Meter rule (id only)

Table 54.141. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.142. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.144. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.39. network meter show

Show network meter

Usage:

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <meter>

Table 54.146. Positional Arguments

ValueSummary

<meter>

Meter to display (name or id)

Table 54.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.148. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.149. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.150. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.151. 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.

54.40. network onboard subnets

Onboard network subnets into a subnet pool

Usage:

openstack network onboard subnets [-h] <network> <subnetpool>

Table 54.152. Positional Arguments

ValueSummary

<network>

Onboard all subnets associated with this network

<subnetpool>

Target subnet pool for onboarding subnets

Table 54.153. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.41. network qos policy create

Create a QoS policy

Usage:

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

Table 54.154. Positional Arguments

ValueSummary

<name>

Name of qos policy to create

Table 54.155. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the qos policy

--share

Make the qos policy accessible by other projects

--no-share

Make the qos policy not accessible by other projects (default)

--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.

--default

Set this as a default network qos policy

--no-default

Set this as a non-default network qos policy

Table 54.156. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.157. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.158. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.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.

54.42. network qos policy delete

Delete Qos Policy(s)

Usage:

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

Table 54.160. Positional Arguments

ValueSummary

<qos-policy>

Qos policy(s) to delete (name or id)

Table 54.161. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.43. network qos policy list

List QoS policies

Usage:

openstack network qos policy 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]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

Table 54.162. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

List qos policies 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 qos policies shared between projects

--no-share

List qos policies not shared between projects

Table 54.163. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.164. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.165. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.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.

54.44. network qos policy set

Set QoS policy properties

Usage:

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

Table 54.167. Positional Arguments

ValueSummary

<qos-policy>

Qos policy to modify (name or id)

Table 54.168. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set qos policy name

--description <description>

Description of the qos policy

--share

Make the qos policy accessible by other projects

--no-share

Make the qos policy not accessible by other projects

--default

Set this as a default network qos policy

--no-default

Set this as a non-default network qos policy

54.45. network qos policy show

Display QoS policy details

Usage:

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <qos-policy>

Table 54.169. Positional Arguments

ValueSummary

<qos-policy>

Qos policy to display (name or id)

Table 54.170. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.171. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.172. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.173. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.174. 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.

54.46. network qos rule create

Create new Network QoS rule

Usage:

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--type <type>]
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

Table 54.175. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Table 54.176. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

Qos rule type (minimum-bandwidth, dscp-marking, bandwidth-limit)

--max-kbps <max-kbps>

Maximum bandwidth in kbps

--max-burst-kbits <max-burst-kbits>

Maximum burst in kilobits, 0 or not specified means automatic, which is 80% of the bandwidth limit, which works for typical TCP traffic. For details check the QoS user workflow.

--dscp-mark <dscp-mark>

Dscp mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--egress

Egress traffic direction from the project point of view

Table 54.177. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.178. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.179. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.180. 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.

54.47. network qos rule delete

Delete Network QoS rule

Usage:

openstack network qos rule delete [-h] <qos-policy> <rule-id>

Table 54.181. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 54.182. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.48. network qos rule list

List Network QoS rules

Usage:

openstack network qos 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]
                                       <qos-policy>

Table 54.183. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Table 54.184. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.185. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.186. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.187. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.188. 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.

54.49. network qos rule set

Set Network QoS rule properties

Usage:

openstack network qos rule set [-h] [--max-kbps <max-kbps>]
                                      [--max-burst-kbits <max-burst-kbits>]
                                      [--dscp-mark <dscp-mark>]
                                      [--min-kbps <min-kbps>]
                                      [--ingress | --egress]
                                      <qos-policy> <rule-id>

Table 54.189. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 54.190. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--max-kbps <max-kbps>

Maximum bandwidth in kbps

--max-burst-kbits <max-burst-kbits>

Maximum burst in kilobits, 0 or not specified means automatic, which is 80% of the bandwidth limit, which works for typical TCP traffic. For details check the QoS user workflow.

--dscp-mark <dscp-mark>

Dscp mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--egress

Egress traffic direction from the project point of view

54.50. network qos rule show

Display Network QoS rule details

Usage:

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <qos-policy> <rule-id>

Table 54.191. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 54.192. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.193. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.194. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.195. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.196. 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.

54.51. network qos rule type list

List QoS rule types

Usage:

openstack network qos rule type 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]

Table 54.197. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.198. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.199. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.200. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.201. 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.

54.52. network qos rule type show

Show details about supported QoS rule type

Usage:

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <qos-rule-type-name>

Table 54.202. Positional Arguments

ValueSummary

<qos-rule-type-name>

Name of qos rule type

Table 54.203. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.204. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.205. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.206. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.207. 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.

54.53. network rbac create

Create network RBAC policy

Usage:

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty] --type
                                     <type> --action <action>
                                     (--target-project <target-project> | --target-all-projects)
                                     [--target-project-domain <target-project-domain>]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <rbac-object>

Table 54.208. Positional Arguments

ValueSummary

<rbac-object>

The object to which this rbac policy affects (name or ID)

Table 54.209. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

Type of the object that rbac policy affects ("qos_policy" or "network")

--action <action>

Action for the rbac policy ("access_as_external" or "access_as_shared")

--target-project <target-project>

The project to which the rbac policy will be enforced (name or ID)

--target-all-projects

Allow creating rbac policy for all projects.

--target-project-domain <target-project-domain>

Domain the target project belongs to (name or id). This can be used in case collisions between project names exist.

--project <project>

The owner 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.

Table 54.210. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.211. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.212. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.213. 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.

54.54. network rbac delete

Delete network RBAC policy(s)

Usage:

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

Table 54.214. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy(s) to delete (id only)

Table 54.215. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.55. network rbac list

List network RBAC policies

Usage:

openstack network rbac 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>]
                                   [--action <action>] [--long]

Table 54.216. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

List network rbac policies according to given object type ("qos_policy" or "network")

--action <action>

List network rbac policies according to given action ("access_as_external" or "access_as_shared")

--long

List additional fields in output

Table 54.217. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.218. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.219. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.220. 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.

54.56. network rbac set

Set network RBAC policy properties

Usage:

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

Table 54.221. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy to be modified (id only)

Table 54.222. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--target-project <target-project>

The project to which the rbac policy will be enforced (name or ID)

--target-project-domain <target-project-domain>

Domain the target project belongs to (name or id). This can be used in case collisions between project names exist.

54.57. network rbac show

Display network RBAC policy details

Usage:

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <rbac-policy>

Table 54.223. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy (id only)

Table 54.224. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.225. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.226. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.227. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.228. 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.

54.58. network segment create

Create new network segment

Usage:

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

Table 54.229. Positional Arguments

ValueSummary

<name>

New network segment name

Table 54.230. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Network segment description

--physical-network <physical-network>

Physical network name of this network segment

--segment <segment>

Segment identifier for this network segment which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types

--network <network>

Network this network segment belongs to (name or id)

--network-type <network-type>

Network type of this network segment (flat, geneve, gre, local, vlan or vxlan)

Table 54.231. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.232. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.233. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.234. 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.

54.59. network segment delete

Delete network segment(s)

Usage:

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

Table 54.235. Positional Arguments

ValueSummary

<network-segment>

Network segment(s) to delete (name or id)

Table 54.236. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.60. network segment list

List network segments

Usage:

openstack network segment 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]
                                      [--network <network>]

Table 54.237. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--network <network>

List network segments that belong to this network (name or ID)

Table 54.238. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.239. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.240. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.241. 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.

54.61. network segment range create

Create new network segment range

Usage:

openstack network segment range create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--private | --shared]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              --network-type <network-type>
                                              [--physical-network <physical-network-name>]
                                              --minimum
                                              <minimum-segmentation-id>
                                              --maximum
                                              <maximum-segmentation-id>
                                              <name>

Table 54.242. Positional Arguments

ValueSummary

<name>

Name of new network segment range

Table 54.243. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--private

Network segment range is assigned specifically to the project

--shared

Network segment range is shared with other projects

--project <project>

Network segment range owner (name or id). optional when the segment range is shared

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--network-type <network-type>

Network type of this network segment range (geneve, gre, vlan or vxlan)

--physical-network <physical-network-name>

Physical network name of this network segment range

--minimum <minimum-segmentation-id>

Minimum segment identifier for this network segment range which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types

--maximum <maximum-segmentation-id>

Maximum segment identifier for this network segment range which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types

Table 54.244. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.245. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.246. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.247. 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.

54.62. network segment range delete

Delete network segment range(s)

Usage:

openstack network segment range delete [-h]
                                              <network-segment-range>
                                              [<network-segment-range> ...]

Table 54.248. Positional Arguments

ValueSummary

<network-segment-range>

Network segment range(s) to delete (name or id)

Table 54.249. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.63. network segment range list

List network segment ranges

Usage:

openstack network segment range 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] [--used | --unused]
                                            [--available | --unavailable]

Table 54.250. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--used

List network segment ranges that have segments in use

--unused

List network segment ranges that have segments not in use

--available

List network segment ranges that have available segments

--unavailable

List network segment ranges without available segments

Table 54.251. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.252. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.253. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.254. 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.

54.64. network segment range set

Set network segment range properties

Usage:

openstack network segment range set [-h] [--name <name>]
                                           [--minimum <minimum-segmentation-id>]
                                           [--maximum <maximum-segmentation-id>]
                                           <network-segment-range>

Table 54.255. Positional Arguments

ValueSummary

<network-segment-range>

Network segment range to modify (name or id)

Table 54.256. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set network segment name

--minimum <minimum-segmentation-id>

Set network segment range minimum segment identifier

--maximum <maximum-segmentation-id>

Set network segment range maximum segment identifier

54.65. network segment range show

Display network segment range details

Usage:

openstack network segment range show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            <network-segment-range>

Table 54.257. Positional Arguments

ValueSummary

<network-segment-range>

Network segment range to display (name or id)

Table 54.258. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.259. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.260. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.261. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.262. 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.

54.66. network segment set

Set network segment properties

Usage:

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

Table 54.263. Positional Arguments

ValueSummary

<network-segment>

Network segment to modify (name or id)

Table 54.264. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set network segment description

--name <name>

Set network segment name

54.67. network segment show

Display network segment details

Usage:

openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <network-segment>

Table 54.265. Positional Arguments

ValueSummary

<network-segment>

Network segment to display (name or id)

Table 54.266. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.267. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.268. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.269. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.270. 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.

54.68. network service provider list

List Service Providers

Usage:

openstack network service provider 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]

Table 54.271. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.272. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.273. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.274. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.275. 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.

54.69. network set

Set network properties

Usage:

openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share]
                             [--description <description] [--mtu <mtu]
                             [--enable-port-security | --disable-port-security]
                             [--external | --internal]
                             [--default | --no-default]
                             [--qos-policy <qos-policy> | --no-qos-policy]
                             [--tag <tag>] [--no-tag]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             [--dns-domain <dns-domain>]
                             <network>

Table 54.276. Positional Arguments

ValueSummary

<network>

Network to modify (name or id)

Table 54.277. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set network name

--enable

Enable network

--disable

Disable network

--share

Share the network between projects

--no-share

Do not share the network between projects

--description <description

Set network description

--mtu <mtu

Set network mtu

--enable-port-security

Enable port security by default for ports created on this network

--disable-port-security

Disable port security by default for ports created on this network

--external

Set this network as an external network (external-net extension required)

--internal

Set this network as an internal network

--default

Set the network as the default external network

--no-default

Do not use the network as the default external network

--qos-policy <qos-policy>

Qos policy to attach to this network (name or id)

--no-qos-policy

Remove the qos policy attached to this network

--tag <tag>

Tag to be added to the network (repeat option to set multiple tags)

--no-tag

Clear tags associated with the network. specify both --tag and --no-tag to overwrite current tags

--provider-network-type <provider-network-type>

The physical mechanism by which the virtual network is implemented. For example: flat, geneve, gre, local, vlan, vxlan.

--provider-physical-network <provider-physical-network>

Name of the physical network over which the virtual network is implemented

--provider-segment <provider-segment>

Vlan id for vlan networks or tunnel id for GENEVE/GRE/VXLAN networks

--dns-domain <dns-domain>

Set dns domain for this network (requires dns integration extension)

54.70. network show

Show network details

Usage:

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <network>

Table 54.278. Positional Arguments

ValueSummary

<network>

Network to display (name or id)

Table 54.279. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.280. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.281. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.282. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.283. 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.

54.71. network subport list

List all subports for a given network trunk

Usage:

openstack network subport 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] --trunk
                                      <trunk>

Table 54.284. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--trunk <trunk>

List subports belonging to this trunk (name or id)

Table 54.285. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.286. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.287. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.288. 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.

54.72. network trunk create

Create a network trunk for a given project

Usage:

openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      --parent-port <parent-port>
                                      [--subport <port=,segmentation-type=,segmentation-id=>]
                                      [--enable | --disable]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

Table 54.289. Positional Arguments

ValueSummary

<name>

Name of the trunk to create

Table 54.290. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

A description of the trunk

--parent-port <parent-port>

Parent port belonging to this trunk (name or id)

--subport <port=,segmentation-type=,segmentation-id⇒

Subport to add. subport is of form port=<name or ID>,segmentation-type=,segmentation-ID= (--subport) option can be repeated

--enable

Enable trunk (default)

--disable

Disable trunk

--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.

Table 54.291. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.292. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.293. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.294. 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.

54.73. network trunk delete

Delete a given network trunk

Usage:

openstack network trunk delete [-h] <trunk> [<trunk> ...]

Table 54.295. Positional Arguments

ValueSummary

<trunk>

Trunk(s) to delete (name or id)

Table 54.296. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

54.74. network trunk list

List all network trunks

Usage:

openstack network trunk 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]

Table 54.297. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 54.298. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 54.299. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 54.300. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.301. 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.

54.75. network trunk set

Set network trunk properties

Usage:

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

Table 54.302. Positional Arguments

ValueSummary

<trunk>

Trunk to modify (name or id)

Table 54.303. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set trunk name

--description <description>

A description of the trunk

--subport <port=,segmentation-type=,segmentation-id⇒

Subport to add. subport is of form port=<name or ID>,segmentation-type=,segmentation-ID=(--subport) option can be repeated

--enable

Enable trunk

--disable

Disable trunk

54.76. network trunk show

Show information of a given network trunk

Usage:

openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <trunk>

Table 54.304. Positional Arguments

ValueSummary

<trunk>

Trunk to display (name or id)

Table 54.305. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 54.306. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 54.307. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 54.308. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 54.309. 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.

54.77. network trunk unset

Unset subports from a given network trunk

Usage:

openstack network trunk unset [-h] --subport <subport> <trunk>

Table 54.310. Positional Arguments

ValueSummary

<trunk>

Unset subports from this trunk (name or id)

Table 54.311. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--subport <subport>

Subport to delete (name or id of the port) (--subport) option can be repeated

54.78. network unset

Unset network properties

Usage:

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

Table 54.312. Positional Arguments

ValueSummary

<network>

Network to modify (name or id)

Table 54.313. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Tag to be removed from the network (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the network

Chapter 55. object

This chapter describes the commands under the object command.

55.1. object create

Upload object to container

Usage:

openstack object 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] [--name <name>]
                               <container> <filename> [<filename> ...]

Table 55.1. Positional Arguments

ValueSummary

<container>

Container for new object

<filename>

Local filename(s) to upload

Table 55.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Upload a file and rename it. can only be used when uploading a single object

Table 55.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 55.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 55.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 55.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.

55.2. object delete

Delete object from container

Usage:

openstack object delete [-h] <container> <object> [<object> ...]

Table 55.7. Positional Arguments

ValueSummary

<container>

Delete object(s) from <container>

<object>

Object(s) to delete

Table 55.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

55.3. object list

List objects

Usage:

openstack object 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] [--prefix <prefix>]
                             [--delimiter <delimiter>] [--marker <marker>]
                             [--end-marker <end-marker>]
                             [--limit <num-objects>] [--long] [--all]
                             <container>

Table 55.9. Positional Arguments

ValueSummary

<container>

Container to list

Table 55.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--prefix <prefix>

Filter list using <prefix>

--delimiter <delimiter>

Roll up items with <delimiter>

--marker <marker>

Anchor for paging

--end-marker <end-marker>

End anchor for paging

--limit <num-objects>

Limit the number of objects returned

--long

List additional fields in output

--all

List all objects in container (default is 10000)

Table 55.11. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 55.12. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 55.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 55.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.

55.4. object save

Save object locally

Usage:

openstack object save [-h] [--file <filename>] <container> <object>

Table 55.15. Positional Arguments

ValueSummary

<container>

Download <object> from <container>

<object>

Object to save

Table 55.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Destination filename (defaults to object name); using - as the filename will print the file to stdout

55.5. object set

Set object properties

Usage:

openstack object set [-h] --property <key=value> <container> <object>

Table 55.17. Positional Arguments

ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Table 55.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Set a property on this object (repeat option to set multiple properties)

55.6. object show

Display object details

Usage:

openstack object show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <container> <object>

Table 55.19. Positional Arguments

ValueSummary

<container>

Display <object> from <container>

<object>

Object to display

Table 55.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 55.21. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 55.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 55.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 55.24. 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.

55.7. object store account set

Set account properties

Usage:

openstack object store account set [-h] --property <key=value>

Table 55.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Set a property on this account (repeat option to set multiple properties)

55.8. object store account show

Display account details

Usage:

openstack object store account show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]

Table 55.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 55.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 55.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 55.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 55.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.

55.9. object store account unset

Unset account properties

Usage:

openstack object store account unset [-h] --property <key>

Table 55.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from account (repeat option to remove multiple properties)

55.10. object unset

Unset object properties

Usage:

openstack object unset [-h] --property <key> <container> <object>

Table 55.32. Positional Arguments

ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Table 55.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from object (repeat option to remove multiple properties)

Chapter 56. orchestration

This chapter describes the commands under the orchestration command.

56.1. orchestration build info

Retrieve build information.

Usage:

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

Table 56.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 56.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 56.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 56.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.

56.2. orchestration resource type list

List resource types.

Usage:

openstack orchestration resource type 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]
                                                  [--filter <key=value>]
                                                  [--long]

Table 56.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--filter <key=value>

Filter parameters to apply on returned resource types. This can be specified multiple times. It can be any of name, version or support_status

--long

Show resource types with corresponding description of each resource type.

Table 56.7. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 56.8. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 56.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.10. 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.

56.3. orchestration resource type show

Show details and optionally generate a template for a resource type.

Usage:

openstack orchestration resource type show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--template-type <template-type>]
                                                  [--long]
                                                  <resource-type>

Table 56.11. Positional Arguments

ValueSummary

<resource-type>

Resource type to show details for

Table 56.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--template-type <template-type>

Optional template type to generate, hot or cfn

--long

Show resource type with corresponding description.

Table 56.13. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 56.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.15. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 56.16. 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.

56.4. orchestration service list

List the Heat engines.

Usage:

openstack orchestration service 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]

Table 56.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 56.18. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 56.19. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 56.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.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.

56.5. orchestration template function list

List the available functions.

Usage:

openstack orchestration template function 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]
                                                      [--with_conditions]
                                                      <template-version>

Table 56.22. Positional Arguments

ValueSummary

<template-version>

Template version to get the functions for

Table 56.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--with_conditions

Show condition functions for template.

Table 56.24. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 56.25. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 56.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.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.

56.6. orchestration template validate

Validate a template

Usage:

openstack orchestration template validate [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [-e <environment>]
                                                 [--show-nested]
                                                 [--parameter <key=value>]
                                                 [--ignore-errors <error1,error2,...>]
                                                 -t <template>

Table 56.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--show-nested

Resolve parameters from nested templates as well

--parameter <key=value>

Parameter values used to create the stack. this can be specified multiple times

--ignore-errors <error1,error2,…​>

List of heat errors to ignore

-t <template>, --template <template>

Path to the template

Table 56.29. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 56.30. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.31. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 56.32. 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.

56.7. orchestration template version list

List the available template versions.

Usage:

openstack orchestration template version 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]

Table 56.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 56.34. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 56.35. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 56.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 56.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.

Chapter 57. overcloud

This chapter describes the commands under the overcloud command.

57.1. overcloud admin authorize

Deploy the ssh keys needed by Mistral.

Usage:

openstack overcloud admin authorize [-h] [--stack STACK]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]

Table 57.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

57.2. overcloud config download

Download Overcloud Config

Usage:

openstack overcloud config download [-h] [--name NAME]
                                           [--config-dir CONFIG_DIR]
                                           [--config-type CONFIG_TYPE]
                                           [--no-preserve-config]

Table 57.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--config-dir CONFIG_DIR

The directory where the configuration files will be pushed

--config-type CONFIG_TYPE

Type of object config to be extract from the deployment, defaults to all keys available

--no-preserve-config

If specified, will delete and recreate the --config- dir if it already exists. Default is to use the existing dir location and overwrite files. Files in --config-dir not from the stack will be preserved by default.

57.3. overcloud container image build

Build overcloud container images with kolla-build.

Usage:

openstack overcloud container image build [-h]
                                                 [--config-file <yaml config file>]
                                                 --kolla-config-file <config
                                                 file> [--list-images]
                                                 [--list-dependencies]
                                                 [--exclude <container-name>]
                                                 [--use-buildah]

Table 57.3. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the images to build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append. If not specified, the default set of containers will be built.

--kolla-config-file <config file>

Path to a kolla config file to use. multiple config files can be specified, with values in later files taking precedence. By default, tripleo kolla conf file /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf is added.

--list-images

Show the images which would be built instead of building them.

--list-dependencies

Show the image build dependencies instead of building them.

--exclude <container-name>

Name of a container to match against the list of containers to be built to skip. Can be specified multiple times.

--use-buildah

Use buildah instead of docker to build the images with Kolla.

57.4. overcloud container image prepare

Generate files defining the images, tags and registry.

Usage:

openstack overcloud container image prepare [-h]
                                                   [--template-file <yaml template file>]
                                                   [--pull-source <location>]
                                                   [--push-destination <location>]
                                                   [--tag <tag>]
                                                   [--tag-from-label <image label>]
                                                   [--namespace <namespace>]
                                                   [--prefix <prefix>]
                                                   [--suffix <suffix>]
                                                   [--set <variable=value>]
                                                   [--exclude <regex>]
                                                   [--include <regex>]
                                                   [--output-images-file <file path>]
                                                   [--environment-file <file path>]
                                                   [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                   [--output-env-file <file path>]
                                                   [--roles-file ROLES_FILE]
                                                   [--modify-role MODIFY_ROLE]
                                                   [--modify-vars MODIFY_VARS]

Table 57.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--template-file <yaml template file>

Yaml template file which the images config file will be built from. Default: /usr/share/tripleo-common/container- images/overcloud_containers.yaml.j2

--pull-source <location>

Location of image registry to pull images from. (DEPRECATED. Include the registry in --namespace)

--push-destination <location>

Location of image registry to push images to. if specified, a push_destination will be set for every image entry.

--tag <tag>

Override the default tag substitution. if --tag-from- label is specified, start discovery with this tag. Default: 15.0

--tag-from-label <image label>

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

--namespace <namespace>

Override the default namespace substitution. Default: registry.redhat.io/rhosp15-rhel8

--prefix <prefix>

Override the default name prefix substitution. Default: openstack-

--suffix <suffix>

Override the default name suffix substitution. Default:

--set <variable=value>

Set the value of a variable in the template, even if it has no dedicated argument such as "--suffix".

--exclude <regex>

Pattern to match against resulting imagename entries to exclude from the final output. Can be specified multiple times.

--include <regex>

Pattern to match against resulting imagename entries to include in final output. Can be specified multiple times, entries not matching any --include will be excluded. --exclude is ignored if --include is used.

--output-images-file <file path>

File to write resulting image entries to, as well as stdout. Any existing file will be overwritten.

--environment-file <file path>, -e <file path>

Environment files specifying which services are containerized. Entries will be filtered to only contain images used by containerized services. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the update command. Entries will be filtered to only contain images used by containerized services. Can be specified more than once. Files in directories are loaded in ascending sort order.

--output-env-file <file path>

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--modify-role MODIFY_ROLE

Name of ansible role to run between every image upload pull and push.

--modify-vars MODIFY_VARS

Ansible variable file containing variables to use when invoking the role --modify-role.

57.5. overcloud container image tag discover

Discover the versioned tag for an image.

Usage:

openstack overcloud container image tag discover [-h] --image
                                                        <container image>
                                                        [--tag-from-label <image label>]

Table 57.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--image <container image>

Fully qualified name of the image to discover the tag for (Including registry and stable tag).

--tag-from-label <image label>

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

57.6. overcloud container image upload

Push overcloud container images to registries.

Usage:

openstack overcloud container image upload [-h] --config-file <yaml
                                                  config file>
                                                  [--cleanup <full, partial, none>]

Table 57.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the image build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--cleanup <full, partial, none>

Cleanup behavior for local images left after upload. The default full will attempt to delete all local images. partial will leave images required for deployment on this host. none will do no cleanup.

57.7. overcloud credentials

Create the overcloudrc files

Usage:

openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan

Table 57.7. Positional Arguments

ValueSummary

plan

The name of the plan you want to create rc files for.

Table 57.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--directory [DIRECTORY]

The directory to create the rc files. defaults to the current directory.

57.8. overcloud delete

Delete overcloud stack and plan

Usage:

openstack overcloud delete [-h] [-y] [stack]

Table 57.9. Positional Arguments

ValueSummary

stack

Name or id of heat stack to delete(default=env: OVERCLOUD_STACK_NAME)

Table 57.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes).

57.9. overcloud deploy

Deploy Overcloud

Usage:

openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK]
                                  [--timeout <TIMEOUT>]
                                  [--control-scale CONTROL_SCALE]
                                  [--compute-scale COMPUTE_SCALE]
                                  [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                  [--block-storage-scale BLOCK_STORAGE_SCALE]
                                  [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                  [--control-flavor CONTROL_FLAVOR]
                                  [--compute-flavor COMPUTE_FLAVOR]
                                  [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                  [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                  [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                  [--libvirt-type {kvm,qemu}]
                                  [--ntp-server NTP_SERVER]
                                  [--no-proxy NO_PROXY]
                                  [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                  [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                  [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                  [--environment-file <HEAT ENVIRONMENT FILE>]
                                  [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                  [--roles-file ROLES_FILE]
                                  [--networks-file NETWORKS_FILE]
                                  [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                  [--no-cleanup] [--update-plan-only]
                                  [--validation-errors-nonfatal]
                                  [--validation-warnings-fatal]
                                  [--disable-validations]
                                  [--inflight-validations] [--dry-run]
                                  [--run-validations] [--skip-postconfig]
                                  [--force-postconfig]
                                  [--skip-deploy-identifier] [--rhel-reg]
                                  [--reg-method {satellite,portal}]
                                  [--reg-org REG_ORG] [--reg-force]
                                  [--reg-sat-url REG_SAT_URL]
                                  [--reg-activation-key REG_ACTIVATION_KEY]
                                  [--answers-file ANSWERS_FILE]
                                  [--disable-password-generation]
                                  [--deployed-server] [--config-download]
                                  [--no-config-download]
                                  [--config-download-only]
                                  [--output-dir OUTPUT_DIR]
                                  [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                  [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                  [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

Table 57.11. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

Table 57.12. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.10. overcloud execute

Execute a Heat software config on the servers.

Usage:

openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in

Table 57.13. Positional Arguments

ValueSummary

file_in

None

Table 57.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-s SERVER_NAME, --server_name SERVER_NAME

Nova server_name or partial name to match.

-g GROUP, --group GROUP

Heat software config "group" type. defaults to "script".

57.11. overcloud external-update run

Run external minor update Ansible playbook This will run the external minor update Ansible playbook, executing tasks from the undercloud. The update playbooks are made available after completion of the overcloud update prepare command.

Usage:

openstack overcloud external-update run [-h]
                                               [--static-inventory STATIC_INVENTORY]
                                               [--ssh-user SSH_USER]
                                               [--tags TAGS]
                                               [--skip-tags SKIP_TAGS]
                                               [--stack STACK] [-e EXTRA_VARS]

Table 57.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

Set additional variables as key=value or yaml/json

57.12. overcloud external-upgrade run

Run external major upgrade Ansible playbook This will run the external major upgrade Ansible playbook, executing tasks from the undercloud. The upgrade playbooks are made available after completion of the overcloud upgrade prepare command.

Usage:

openstack overcloud external-upgrade run [-h]
                                                [--static-inventory STATIC_INVENTORY]
                                                [--ssh-user SSH_USER]
                                                [--tags TAGS]
                                                [--skip-tags SKIP_TAGS]
                                                [--stack STACK]
                                                [-e EXTRA_VARS]

Table 57.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

Set additional variables as key=value or yaml/json

57.13. overcloud failures

Get deployment failures

Usage:

openstack overcloud failures [-h] [--plan PLAN]

Table 57.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

Name of the stack/plan. (default: overcloud)

57.14. overcloud ffwd-upgrade converge

Converge the fast-forward upgrade on Overcloud Nodes This is the last step for completion of a fast forward upgrade. The main task is updating the plan and stack to unblock future stack updates. For the ffwd upgrade workflow we have set and used the config-download Software/Structured Deployment for the OS::TripleO and OS::Heat resources. This unsets those back to their default values.

Usage:

openstack overcloud ffwd-upgrade converge [--templates [TEMPLATES]]
                                                 [--stack STACK]
                                                 [--timeout <TIMEOUT>]
                                                 [--control-scale CONTROL_SCALE]
                                                 [--compute-scale COMPUTE_SCALE]
                                                 [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                 [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                 [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                 [--control-flavor CONTROL_FLAVOR]
                                                 [--compute-flavor COMPUTE_FLAVOR]
                                                 [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                 [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                 [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                 [--libvirt-type {kvm,qemu}]
                                                 [--ntp-server NTP_SERVER]
                                                 [--no-proxy NO_PROXY]
                                                 [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                 [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                 [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                                 [--environment-file <HEAT ENVIRONMENT FILE>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--networks-file NETWORKS_FILE]
                                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                 [--no-cleanup]
                                                 [--update-plan-only]
                                                 [--validation-errors-nonfatal]
                                                 [--validation-warnings-fatal]
                                                 [--disable-validations]
                                                 [--inflight-validations]
                                                 [--dry-run]
                                                 [--run-validations]
                                                 [--skip-postconfig]
                                                 [--force-postconfig]
                                                 [--skip-deploy-identifier]
                                                 [--rhel-reg]
                                                 [--reg-method {satellite,portal}]
                                                 [--reg-org REG_ORG]
                                                 [--reg-force]
                                                 [--reg-sat-url REG_SAT_URL]
                                                 [--reg-activation-key REG_ACTIVATION_KEY]
                                                 [--answers-file ANSWERS_FILE]
                                                 [--disable-password-generation]
                                                 [--deployed-server]
                                                 [--config-download]
                                                 [--no-config-download]
                                                 [--config-download-only]
                                                 [--output-dir OUTPUT_DIR]
                                                 [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                                 [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                                 [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                                 [--yes]

Table 57.18. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--yes

Use --yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

Table 57.19. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.15. overcloud ffwd-upgrade prepare

Run heat stack update for overcloud nodes to refresh heat stack outputs. The heat stack outputs are what we use later on to generate ansible playbooks which deliver the ffwd upgrade workflow. This is used as the first step for a fast forward upgrade of your overcloud.

Usage:

openstack overcloud ffwd-upgrade prepare [--templates [TEMPLATES]]
                                                [--stack STACK]
                                                [--timeout <TIMEOUT>]
                                                [--control-scale CONTROL_SCALE]
                                                [--compute-scale COMPUTE_SCALE]
                                                [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                                [--block-storage-scale BLOCK_STORAGE_SCALE]
                                                [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                                [--control-flavor CONTROL_FLAVOR]
                                                [--compute-flavor COMPUTE_FLAVOR]
                                                [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                                [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                                [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                                [--libvirt-type {kvm,qemu}]
                                                [--ntp-server NTP_SERVER]
                                                [--no-proxy NO_PROXY]
                                                [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                                [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                                [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                                [--environment-file <HEAT ENVIRONMENT FILE>]
                                                [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                [--roles-file ROLES_FILE]
                                                [--networks-file NETWORKS_FILE]
                                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                                [--no-cleanup]
                                                [--update-plan-only]
                                                [--validation-errors-nonfatal]
                                                [--validation-warnings-fatal]
                                                [--disable-validations]
                                                [--inflight-validations]
                                                [--dry-run]
                                                [--run-validations]
                                                [--skip-postconfig]
                                                [--force-postconfig]
                                                [--skip-deploy-identifier]
                                                [--rhel-reg]
                                                [--reg-method {satellite,portal}]
                                                [--reg-org REG_ORG]
                                                [--reg-force]
                                                [--reg-sat-url REG_SAT_URL]
                                                [--reg-activation-key REG_ACTIVATION_KEY]
                                                [--answers-file ANSWERS_FILE]
                                                [--disable-password-generation]
                                                [--deployed-server]
                                                [--config-download]
                                                [--no-config-download]
                                                [--config-download-only]
                                                [--output-dir OUTPUT_DIR]
                                                [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                                [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                                [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                                [--yes]

Table 57.20. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--yes

Use --yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

Table 57.21. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.16. overcloud ffwd-upgrade run

Run fast forward upgrade ansible playbooks on Overcloud nodes This will run the fast_forward_upgrade_playbook.yaml ansible playbook. This playbook was generated when you ran the ffwd-upgrade prepare command. Running 'ffwd- upgrade run ' is the second step in the ffwd upgrade workflow.

Usage:

openstack overcloud ffwd-upgrade run [-h] [--yes]
                                            [--static-inventory STATIC_INVENTORY]
                                            [--ssh-user SSH_USER]
                                            [--stack STACK]

Table 57.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--yes

Use --yes to skip the confirmation required before any ffwd-upgrade operation. Use this with caution!

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

57.17. overcloud generate fencing

Generate fencing parameters

Usage:

openstack overcloud generate fencing [-h] [-a FENCE_ACTION]
                                            [--delay DELAY] [--ipmi-lanplus]
                                            [--ipmi-no-lanplus]
                                            [--ipmi-cipher IPMI_CIPHER]
                                            [--ipmi-level IPMI_LEVEL]
                                            [--output OUTPUT]
                                            instackenv

Table 57.23. Positional Arguments

ValueSummary

instackenv

None

Table 57.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-a FENCE_ACTION, --action FENCE_ACTION

Deprecated: this option is ignored.

--delay DELAY

Wait delay seconds before fencing is started

--ipmi-lanplus

Deprecated: this is the default.

--ipmi-no-lanplus

Do not use lanplus. defaults to: false

--ipmi-cipher IPMI_CIPHER

Ciphersuite to use (same as ipmitool -c parameter.

--ipmi-level IPMI_LEVEL

Privilegel level on ipmi device. valid levels: callback, user, operator, administrator.

--output OUTPUT

Write parameters to a file

57.18. overcloud image build

Build images for the overcloud

Usage:

openstack overcloud image build [-h] [--config-file <yaml config file>]
                                       [--image-name <image name>] [--no-skip]
                                       [--output-directory OUTPUT_DIRECTORY]

Table 57.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the image build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--image-name <image name>

Name of image to build. may be specified multiple times. If unspecified, will build all images in given YAML files.

--no-skip

Skip build if cached image exists.

--output-directory OUTPUT_DIRECTORY

Output directory for images. defaults to $TRIPLEO_ROOT,or current directory if unset.

57.19. overcloud image upload

Create overcloud glance images from existing image files.

Usage:

openstack overcloud image upload [-h] [--image-path IMAGE_PATH]
                                        [--os-image-name OS_IMAGE_NAME]
                                        [--ironic-python-agent-name IPA_NAME]
                                        [--http-boot HTTP_BOOT]
                                        [--update-existing] [--whole-disk]
                                        [--architecture ARCHITECTURE]
                                        [--platform PLATFORM]
                                        [--image-type {os,ironic-python-agent}]
                                        [--progress]

Table 57.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--image-path IMAGE_PATH

Path to directory containing image files

--os-image-name OS_IMAGE_NAME

Openstack disk image filename

--ironic-python-agent-name IPA_NAME

Openstack ironic-python-agent (agent) image filename

--http-boot HTTP_BOOT

Root directory for the introspection image

--update-existing

Update images if already exist

--whole-disk

When set, the overcloud-full image to be uploaded will be considered as a whole disk one

--architecture ARCHITECTURE

Architecture type for these images, x86_64, i386 and ppc64le are common options. This option should match at least one arch value in instackenv.json

--platform PLATFORM

Platform type for these images. platform is a sub- category of architecture. For example you may have generic images for x86_64 but offer images specific to SandyBridge (SNB).

--image-type {os,ironic-python-agent}

If specified, allows to restrict the image type to upload (os for the overcloud image or ironic-python- agent for the ironic-python-agent one)

--progress

Show progress bar for upload files action

57.20. overcloud netenv validate

Validate the network environment file.

Usage:

openstack overcloud netenv validate [-h] [-f NETENV]

Table 57.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-f NETENV, --file NETENV

Path to the network environment file

57.21. overcloud node bios configure

Apply BIOS configuration on given nodes

Usage:

openstack overcloud node bios configure [-h] [--all-manageable]
                                               [--configuration <configuration>]
                                               [<node_uuid> [<node_uuid> ...]]

Table 57.28. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to configure bios

Table 57.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Configure bios for all nodes currently in manageable state

--configuration <configuration>

Bios configuration (yaml/json string or file name).

57.22. overcloud node bios reset

Reset BIOS configuration to factory default

Usage:

openstack overcloud node bios reset [-h] [--all-manageable]
                                           [<node_uuid> [<node_uuid> ...]]

Table 57.30. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to reset bios

Table 57.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Reset bios on all nodes currently in manageable state

57.23. overcloud node clean

Run node(s) through cleaning.

Usage:

openstack overcloud node clean [-h] [--all-manageable] [--provide]
                                      [<node_uuid> [<node_uuid> ...]]

Table 57.32. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to be cleaned

Table 57.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Clean all nodes currently in manageable state

--provide

Provide (make available) the nodes once cleaned

57.24. overcloud node configure

Configure Node boot options.

Usage:

openstack overcloud node configure [-h] [--all-manageable]
                                          [--deploy-kernel DEPLOY_KERNEL]
                                          [--deploy-ramdisk DEPLOY_RAMDISK]
                                          [--instance-boot-option {local,netboot}]
                                          [--root-device ROOT_DEVICE]
                                          [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE]
                                          [--overwrite-root-device-hints]
                                          [<node_uuid> [<node_uuid> ...]]

Table 57.34. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to be configured

Table 57.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Configure all nodes currently in manageable state

--deploy-kernel DEPLOY_KERNEL

Image with deploy kernel.

--deploy-ramdisk DEPLOY_RAMDISK

Image with deploy ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

--root-device ROOT_DEVICE

Define the root device for nodes. can be either a list of device names (without /dev) to choose from or one of two strategies: largest or smallest. For it to work this command should be run after the introspection.

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

Minimum size (in gib) of the detected root device. Used with --root-device.

--overwrite-root-device-hints

Whether to overwrite existing root device hints when --root-device is used.

57.25. overcloud node delete

Delete overcloud nodes.

Usage:

openstack overcloud node delete [-h] [--stack STACK]
                                       [--templates [TEMPLATES]]
                                       [-e <HEAT ENVIRONMENT FILE>]
                                       [--timeout <TIMEOUT>]
                                       <node> [<node> ...]

Table 57.36. Positional Arguments

ValueSummary

<node>

Node id(s) to delete

Table 57.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack to scale (default=env: OVERCLOUD_STACK_NAME)

--templates [TEMPLATES]

The directory containing the heat templates to deploy. This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.) This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

--timeout <TIMEOUT>

Timeout in minutes to wait for the nodes to be deleted. Keep in mind that due to keystone session duration that timeout has an upper bound of 4 hours

57.26. overcloud node discover

Discover overcloud nodes by polling their BMCs.

Usage:

openstack overcloud node discover [-h] (--ip <ips> | --range <range>)
                                         --credentials <key:value>
                                         [--port <ports>] [--introspect]
                                         [--run-validations] [--provide]
                                         [--no-deploy-image]
                                         [--instance-boot-option {local,netboot}]

Table 57.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--ip <ips>

Ip address(es) to probe

--range <range>

Ip range to probe

--credentials <key:value>

Key/value pairs of possible credentials

--port <ports>

Bmc port(s) to probe

--introspect

Introspect the imported nodes

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

57.27. overcloud node import

Import baremetal nodes from a JSON, YAML or CSV file. The node status will be set to manageable by default.

Usage:

openstack overcloud node import [-h] [--introspect] [--run-validations]
                                       [--validate-only] [--provide]
                                       [--no-deploy-image]
                                       [--instance-boot-option {local,netboot}]
                                       env_file

Table 57.39. Positional Arguments

ValueSummary

env_file

None

Table 57.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--introspect

Introspect the imported nodes

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

--validate-only

Validate the env_file and then exit without actually importing the nodes.

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

57.28. overcloud node introspect

Introspect specified nodes or all nodes in manageable state.

Usage:

openstack overcloud node introspect [-h] [--all-manageable] [--provide]
                                           [--run-validations]
                                           [<node_uuid> [<node_uuid> ...]]

Table 57.41. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to be introspected

Table 57.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Introspect all nodes currently in manageable state

--provide

Provide (make available) the nodes once introspected

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

57.29. overcloud node provide

Mark nodes as available based on UUIDs or current manageable state.

Usage:

openstack overcloud node provide [-h] [--all-manageable]
                                        [<node_uuid> [<node_uuid> ...]]

Table 57.43. Positional Arguments

ValueSummary

<node_uuid>

Baremetal node uuids for the node(s) to be provided

Table 57.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-manageable

Provide all nodes currently in manageable state

57.30. overcloud node provision

Provision a new node using Ironic.

Usage:

openstack overcloud node provision [-h] [-o OUTPUT] [--stack STACK]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          <baremetal_deployment.yaml>

Table 57.45. Positional Arguments

ValueSummary

<baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

Table 57.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-o OUTPUT, --output OUTPUT

The output environment file path

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to newly deployed nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Public key path for ssh access to newly deployed nodes

57.31. overcloud parameters set

Set a parameters for a plan

Usage:

openstack overcloud parameters set [-h] name file_in

Table 57.47. Positional Arguments

ValueSummary

name

The name of the plan, which is used for the swift container, Mistral environment and Heat stack names.

file_in

None

Table 57.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.32. overcloud plan create

Create a deployment plan

Usage:

openstack overcloud plan create [-h] [--templates TEMPLATES]
                                       [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                       [--disable-password-generation]
                                       [--source-url SOURCE_URL]
                                       name

Table 57.49. Positional Arguments

ValueSummary

name

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

Table 57.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--templates TEMPLATES

The directory containing the heat templates to deploy. If this or --source_url isn’t provided, the templates packaged on the Undercloud will be used.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--disable-password-generation

Disable password generation.

--source-url SOURCE_URL

The url of a git repository containing the heat templates to deploy. If this or --templates isn’t provided, the templates packaged on the Undercloud will be used.

57.33. overcloud plan delete

Delete an overcloud deployment plan. The plan will not be deleted if a stack exists with the same name.

Usage:

openstack overcloud plan delete [-h] <name> [<name> ...]

Table 57.51. Positional Arguments

ValueSummary

<name>

Name of the plan(s) to delete

Table 57.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.34. overcloud plan deploy

Deploy a deployment plan

Usage:

openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>]
                                       [--run-validations]
                                       name

Table 57.53. Positional Arguments

ValueSummary

name

The name of the plan to deploy.

Table 57.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

57.35. overcloud plan export

Export a deployment plan

Usage:

openstack overcloud plan export [-h] [--output-file <output file>]
                                       [--force-overwrite]
                                       <name>

Table 57.55. Positional Arguments

ValueSummary

<name>

Name of the plan to export.

Table 57.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output file>, -o <output file>

Name of the output file for export. it will default to "<name>.tar.gz".

--force-overwrite, -f

Overwrite output file if it exists.

57.36. overcloud plan list

List overcloud deployment plans.

Usage:

openstack overcloud plan 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]

Table 57.57. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 57.58. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 57.59. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 57.60. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.61. 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.

57.37. overcloud profiles list

List overcloud node profiles

Usage:

openstack overcloud profiles 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] [--all]
                                         [--control-scale CONTROL_SCALE]
                                         [--compute-scale COMPUTE_SCALE]
                                         [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                         [--block-storage-scale BLOCK_STORAGE_SCALE]
                                         [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                         [--control-flavor CONTROL_FLAVOR]
                                         [--compute-flavor COMPUTE_FLAVOR]
                                         [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                         [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                         [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

Table 57.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

List all nodes, even those not available to nova.

--control-scale CONTROL_SCALE

New number of control nodes.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes.

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes.

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes.

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

Table 57.63. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 57.64. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 57.65. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.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.

57.38. overcloud profiles match

Assign and validate profiles on nodes

Usage:

openstack overcloud profiles match [-h] [--dry-run]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]

Table 57.67. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dry-run

Only run validations, but do not apply any changes.

--control-scale CONTROL_SCALE

New number of control nodes.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes.

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes.

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes.

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

57.39. overcloud raid create

Create RAID on given nodes

Usage:

openstack overcloud raid create [-h] --node NODE configuration

Table 57.68. Positional Arguments

ValueSummary

configuration

Raid configuration (yaml/json string or file name).

Table 57.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--node NODE

Nodes to create raid on (expected to be in manageable state). Can be specified multiple times.

57.40. overcloud role list

List availables roles (DEPRECATED). Please use "openstack overcloud roles list" instead.

Usage:

openstack overcloud role list [-h] [--roles-path <roles directory>]

Table 57.70. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

57.41. overcloud role show

Show information about a given role (DEPRECATED). Please use "openstack overcloud roles show" intead.

Usage:

openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

Table 57.71. Positional Arguments

ValueSummary

<role>

Role to display more information about.

Table 57.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

57.42. overcloud roles generate

Generate roles_data.yaml file

Usage:

openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>] [--skip-validate]
                                          <role> [<role> ...]

Table 57.73. Positional Arguments

ValueSummary

<role>

List of roles to use to generate the roles_data.yaml file for the deployment. NOTE: Ordering is important if no role has the "primary" and "controller" tags. If no role is tagged then the first role listed will be considered the primary role. This usually is the controller role.

Table 57.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

-o <output file>, --output-file <output file>

File to capture all output to. for example, roles_data.yaml

--skip-validate

Skip role metadata type validation whengenerating the roles_data.yaml

57.43. overcloud roles list

List the current and available roles in a given plan

Usage:

openstack overcloud roles 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] [--detail] [--current]

Table 57.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--detail

Include details about each role

--current

Only show the information for the roles currently enabled for the plan.

Table 57.76. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 57.77. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 57.78. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.79. 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.

57.44. overcloud roles show

Show details for a specific role, given a plan

Usage:

openstack overcloud roles show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name NAME]
                                      <role>

Table 57.80. Positional Arguments

ValueSummary

<role>

Name of the role to look up.

Table 57.81. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

Table 57.82. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 57.83. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.84. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 57.85. 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.

57.45. overcloud status

Get deployment status

Usage:

openstack overcloud status [-h] [--plan PLAN]

Table 57.86. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

Name of the stack/plan. (default: overcloud)

57.46. overcloud support report collect

Run sosreport on selected servers.

Usage:

openstack overcloud support report collect [-h] [-c CONTAINER]
                                                  [-o DESTINATION]
                                                  [--skip-container-delete]
                                                  [-t TIMEOUT]
                                                  [-n CONCURRENCY]
                                                  [--collect-only | --download-only]
                                                  server_name

Table 57.87. Positional Arguments

ValueSummary

server_name

Nova server_name or partial name to match. for example "controller" will match all controllers for an environment.

Table 57.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-c CONTAINER, --container CONTAINER

Swift container to store logs to

-o DESTINATION, --output DESTINATION

Output directory for the report

--skip-container-delete

Do not delete the container after the files have been downloaded. Ignored if --collect-only or --download- only is provided.

-t TIMEOUT, --timeout TIMEOUT

Maximum time to wait for the log collection and container deletion workflows to finish.

-n CONCURRENCY, --concurrency CONCURRENCY

Number of parallel log collection and object deletion tasks to run.

--collect-only

Skip log downloads, only collect logs and put in the container

--download-only

Skip generation, only download from the provided container

57.47. overcloud update converge

Converge the update on Overcloud nodes. This restores the plan and stack so that normal deployment workflow is back in place.

Usage:

openstack overcloud update converge [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--rhel-reg]
                                           [--reg-method {satellite,portal}]
                                           [--reg-org REG_ORG] [--reg-force]
                                           [--reg-sat-url REG_SAT_URL]
                                           [--reg-activation-key REG_ACTIVATION_KEY]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

Table 57.89. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

Table 57.90. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.48. overcloud update prepare

Run heat stack update for overcloud nodes to refresh heat stack outputs. The heat stack outputs are what we use later on to generate ansible playbooks which deliver the minor update workflow. This is used as the first step for a minor update of your overcloud.

Usage:

openstack overcloud update prepare [--templates [TEMPLATES]]
                                          [--stack STACK]
                                          [--timeout <TIMEOUT>]
                                          [--control-scale CONTROL_SCALE]
                                          [--compute-scale COMPUTE_SCALE]
                                          [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                          [--block-storage-scale BLOCK_STORAGE_SCALE]
                                          [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                          [--control-flavor CONTROL_FLAVOR]
                                          [--compute-flavor COMPUTE_FLAVOR]
                                          [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                          [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                          [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                          [--libvirt-type {kvm,qemu}]
                                          [--ntp-server NTP_SERVER]
                                          [--no-proxy NO_PROXY]
                                          [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                          [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                          [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                          [--environment-file <HEAT ENVIRONMENT FILE>]
                                          [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                          [--roles-file ROLES_FILE]
                                          [--networks-file NETWORKS_FILE]
                                          [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                          [--no-cleanup] [--update-plan-only]
                                          [--validation-errors-nonfatal]
                                          [--validation-warnings-fatal]
                                          [--disable-validations]
                                          [--inflight-validations] [--dry-run]
                                          [--run-validations]
                                          [--skip-postconfig]
                                          [--force-postconfig]
                                          [--skip-deploy-identifier]
                                          [--rhel-reg]
                                          [--reg-method {satellite,portal}]
                                          [--reg-org REG_ORG] [--reg-force]
                                          [--reg-sat-url REG_SAT_URL]
                                          [--reg-activation-key REG_ACTIVATION_KEY]
                                          [--answers-file ANSWERS_FILE]
                                          [--disable-password-generation]
                                          [--deployed-server]
                                          [--config-download]
                                          [--no-config-download]
                                          [--config-download-only]
                                          [--output-dir OUTPUT_DIR]
                                          [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                          [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                          [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

Table 57.91. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

Table 57.92. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.49. overcloud update run

Run minor update ansible playbooks on Overcloud nodes

Usage:

openstack overcloud update run [-h]
                                      (--nodes NODES | --roles ROLES | --limit LIMIT)
                                      [--playbook PLAYBOOK]
                                      [--ssh-user SSH_USER]
                                      [--static-inventory STATIC_INVENTORY]
                                      [--stack STACK]

Table 57.93. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--nodes NODES

Deprecated: this option will be remove in the future release Use the limit option instead.A string that identifies a single node or comma-separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: --nodes "compute-0, compute-1, compute-5". NOTE: Using this parameter with nodes of controlplane roles (e.g. "--nodes controller-1") is NOT supported and WILL end badly unless you include ALL nodes of that role as a comma separated string. You should instead use the --roles parameter for controlplane roles and specify the role name.

--roles ROLES

Deprecated: this option will be remove in the future release Use the limit option instead.A string that identifies the role or comma-separated list ofroles to be upgraded in this upgrade run invocation. NOTE: nodes of specified role(s) are upgraded in parallel. This is REQUIRED for controlplane roles. For non controlplane roles (e.g., "Compute"), you may consider instead using the --nodes argument to limit the upgrade to a specific node or list (comma separated string) of nodes.

--limit LIMIT

A string that identifies a single node or comma- separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: --limit "compute-0, compute-1, compute-5".

--playbook PLAYBOOK

Ansible playbook to use for the minor update. defaults to the special value all which causes all the update playbooks to be executed. That is the update_steps_playbook.yaml and then thedeploy_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: make sure to run both those playbooks so that all services are updated and running with the target version configuration.

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

57.50. overcloud upgrade converge

Major upgrade converge - reset Heat resources in the stored plan This is the last step for completion of a overcloud major upgrade. The main task is updating the plan and stack to unblock future stack updates. For the major upgrade workflow we have set specific values for some stack Heat resources. This unsets those back to their default values.

Usage:

openstack overcloud upgrade converge [--templates [TEMPLATES]]
                                            [--stack STACK]
                                            [--timeout <TIMEOUT>]
                                            [--control-scale CONTROL_SCALE]
                                            [--compute-scale COMPUTE_SCALE]
                                            [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                            [--block-storage-scale BLOCK_STORAGE_SCALE]
                                            [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                            [--control-flavor CONTROL_FLAVOR]
                                            [--compute-flavor COMPUTE_FLAVOR]
                                            [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                            [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                            [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                            [--libvirt-type {kvm,qemu}]
                                            [--ntp-server NTP_SERVER]
                                            [--no-proxy NO_PROXY]
                                            [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                            [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                            [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                            [--environment-file <HEAT ENVIRONMENT FILE>]
                                            [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                            [--roles-file ROLES_FILE]
                                            [--networks-file NETWORKS_FILE]
                                            [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                            [--no-cleanup]
                                            [--update-plan-only]
                                            [--validation-errors-nonfatal]
                                            [--validation-warnings-fatal]
                                            [--disable-validations]
                                            [--inflight-validations]
                                            [--dry-run] [--run-validations]
                                            [--skip-postconfig]
                                            [--force-postconfig]
                                            [--skip-deploy-identifier]
                                            [--rhel-reg]
                                            [--reg-method {satellite,portal}]
                                            [--reg-org REG_ORG] [--reg-force]
                                            [--reg-sat-url REG_SAT_URL]
                                            [--reg-activation-key REG_ACTIVATION_KEY]
                                            [--answers-file ANSWERS_FILE]
                                            [--disable-password-generation]
                                            [--deployed-server]
                                            [--config-download]
                                            [--no-config-download]
                                            [--config-download-only]
                                            [--output-dir OUTPUT_DIR]
                                            [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                            [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                            [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

Table 57.94. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

Table 57.95. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.51. overcloud upgrade prepare

Run heat stack update for overcloud nodes to refresh heat stack outputs. The heat stack outputs are what we use later on to generate ansible playbooks which deliver the major upgrade workflow. This is used as the first step for a major upgrade of your overcloud.

Usage:

openstack overcloud upgrade prepare [--templates [TEMPLATES]]
                                           [--stack STACK]
                                           [--timeout <TIMEOUT>]
                                           [--control-scale CONTROL_SCALE]
                                           [--compute-scale COMPUTE_SCALE]
                                           [--ceph-storage-scale CEPH_STORAGE_SCALE]
                                           [--block-storage-scale BLOCK_STORAGE_SCALE]
                                           [--swift-storage-scale SWIFT_STORAGE_SCALE]
                                           [--control-flavor CONTROL_FLAVOR]
                                           [--compute-flavor COMPUTE_FLAVOR]
                                           [--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
                                           [--block-storage-flavor BLOCK_STORAGE_FLAVOR]
                                           [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
                                           [--libvirt-type {kvm,qemu}]
                                           [--ntp-server NTP_SERVER]
                                           [--no-proxy NO_PROXY]
                                           [--overcloud-ssh-user OVERCLOUD_SSH_USER]
                                           [--overcloud-ssh-key OVERCLOUD_SSH_KEY]
                                           [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK]
                                           [--environment-file <HEAT ENVIRONMENT FILE>]
                                           [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                           [--roles-file ROLES_FILE]
                                           [--networks-file NETWORKS_FILE]
                                           [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                           [--no-cleanup] [--update-plan-only]
                                           [--validation-errors-nonfatal]
                                           [--validation-warnings-fatal]
                                           [--disable-validations]
                                           [--inflight-validations]
                                           [--dry-run] [--run-validations]
                                           [--skip-postconfig]
                                           [--force-postconfig]
                                           [--skip-deploy-identifier]
                                           [--rhel-reg]
                                           [--reg-method {satellite,portal}]
                                           [--reg-org REG_ORG] [--reg-force]
                                           [--reg-sat-url REG_SAT_URL]
                                           [--reg-activation-key REG_ACTIVATION_KEY]
                                           [--answers-file ANSWERS_FILE]
                                           [--disable-password-generation]
                                           [--deployed-server]
                                           [--config-download]
                                           [--no-config-download]
                                           [--config-download-only]
                                           [--output-dir OUTPUT_DIR]
                                           [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG]
                                           [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT]
                                           [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]

Table 57.96. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. It will be removed after the "P" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. It will be removed after the "P" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. It will be removed after the "P" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. It will be removed after the "P" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. It will be removed after the "P" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. It will be removed after the "P" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. It will be removed after the "P" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. It will be removed after the "P" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. It will be removed after the "P" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. It will be removed after the "P" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

Table 57.97. Registration Parameters

ValueSummary

--rhel-reg

Register overcloud nodes to the customer portal or a satellite.

--reg-method {satellite,portal}

Rhel registration method to use for the overcloud nodes.

--reg-org REG_ORG

Organization key to use for registration.

--reg-force

Register the system even if it is already registered.

--reg-sat-url REG_SAT_URL

Satellite server to register overcloud nodes.

--reg-activation-key REG_ACTIVATION_KEY

Activation key to use for registration.

57.52. overcloud upgrade run

Run major upgrade ansible playbooks on Overcloud nodes This will run the major upgrade ansible playbooks on the overcloud. By default all playbooks are executed, that is the upgrade_steps_playbook.yaml then the deploy_steps_playbook.yaml and then the post_upgrade_steps_playbook.yaml. The upgrade playbooks are made available after completion of the overcloud upgrade prepare command. This overcloud upgrade run command is the second step in the major upgrade workflow.

Usage:

openstack overcloud upgrade run [-h]
                                       (--nodes NODES | --roles ROLES | --limit LIMIT)
                                       [--playbook PLAYBOOK]
                                       [--static-inventory STATIC_INVENTORY]
                                       [--ssh-user SSH_USER] [--tags TAGS]
                                       [--skip-tags SKIP_TAGS] [--stack STACK]

Table 57.98. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--nodes NODES

Deprecated: this option will be remove in the future release Use the limit option instead.A string that identifies a single node or comma-separated list of nodes to be upgraded in parallel in this upgrade run invocation. For example: --nodes "compute-0, compute-1, compute-5". NOTE: Using this parameter with nodes of controlplane roles (e.g. "--nodes controller-1") is NOT supported and WILL end badly unless you include ALL nodes of that role as a comma separated string. You should instead use the --roles parameter for controlplane roles and specify the role name.

--roles ROLES

Deprecated: this option will be remove in the future release Use the limit option instead.A string that identifies the role or comma-separated list ofroles to be upgraded in this upgrade run invocation. NOTE: nodes of specified role(s) are upgraded in parallel. This is REQUIRED for controlplane roles. For non controlplane roles (e.g., "Compute"), you may consider instead using the --nodes argument to limit the upgrade to a specific node or list (comma separated string) of nodes.

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes to be upgraded in parallel in this upgrade run invocation. For example: --limit "compute-0, compute-1, compute-5".

--playbook PLAYBOOK

Ansible playbook to use for the major upgrade. Defaults to the special value all which causes all the upgrade playbooks to run. That is the upgrade_steps_playbook.yaml then deploy_steps_playbook.yaml and then post_upgrade_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: you will have to run all of those playbooks so that all services are upgraded and running with the target version configuration.

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook. The currently supported values are validation and pre-upgrade. In particular validation is useful if you must re-run following a failed upgrade and some services cannot be started.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

Chapter 58. policy

This chapter describes the commands under the policy command.

58.1. policy create

Create new policy

Usage:

openstack policy create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--type <type>]
                               <filename>

Table 58.1. Positional Arguments

ValueSummary

<filename>

New serialized policy rules file

Table 58.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New mime type of the policy rules file (defaults to application/json)

Table 58.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 58.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 58.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 58.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.

58.2. policy delete

Delete policy(s)

Usage:

openstack policy delete [-h] <policy> [<policy> ...]

Table 58.7. Positional Arguments

ValueSummary

<policy>

Policy(s) to delete

Table 58.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

58.3. policy list

List policies

Usage:

openstack policy 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]

Table 58.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 58.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 58.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 58.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 58.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.

58.4. policy set

Set policy properties

Usage:

openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>

Table 58.14. Positional Arguments

ValueSummary

<policy>

Policy to modify

Table 58.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New mime type of the policy rules file

--rules <filename>

New serialized policy rules file

58.5. policy show

Display policy details

Usage:

openstack policy show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <policy>

Table 58.16. Positional Arguments

ValueSummary

<policy>

Policy to display

Table 58.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 58.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 58.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 58.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 58.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 59. port

This chapter describes the commands under the port command.

59.1. port create

Create a new port

Usage:

openstack port create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] --network <network>
                             [--description <description>]
                             [--device <device-id>]
                             [--mac-address <mac-address>]
                             [--device-owner <device-owner>]
                             [--vnic-type <vnic-type>] [--host <host-id>]
                             [--dns-domain dns-domain] [--dns-name <dns-name>]
                             [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
                             [--binding-profile <binding-profile>]
                             [--enable | --disable]
                             [--enable-uplink-status-propagation | --disable-uplink-status-propagation]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--security-group <security-group> | --no-security-group]
                             [--qos-policy <qos-policy>]
                             [--enable-port-security | --disable-port-security]
                             [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                             [--tag <tag> | --no-tag]
                             <name>

Table 59.1. Positional Arguments

ValueSummary

<name>

Name of this port

Table 59.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--network <network>

Network this port belongs to (name or id)

--description <description>

Description of this port

--device <device-id>

Port device id

--mac-address <mac-address>

Mac address of this port (admin only)

--device-owner <device-owner>

Device owner of this port. this is the entity that uses the port (for example, network:dhcp).

--vnic-type <vnic-type>

Vnic type for this port (direct

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

--host <host-id>

Allocate port on host <host-id> (id only)

--dns-domain dns-domain

Set dns domain to this port (requires dns_domain extension for ports)

--dns-name <dns-name>

Set dns name for this port (requires dns integration extension)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired ip and/or subnet for this port (name or id): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--no-fixed-ip

No ip or subnet for this port.

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. data may be passed as <key>=<value> or JSON. (repeat option to set multiple binding:profile data)

--enable

Enable port (default)

--disable

Disable port

--enable-uplink-status-propagation

Enable uplink status propagate

--disable-uplink-status-propagation

Disable uplink status propagate (default)

--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.

--security-group <security-group>

Security group to associate with this port (name or ID) (repeat option to set multiple security groups)

--no-security-group

Associate no security groups with this port

--qos-policy <qos-policy>

Attach qos policy to this port (name or id)

--enable-port-security

Enable port security for this port (default)

--disable-port-security

Disable port security for this port

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

Add allowed-address pair associated with this port: ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to set multiple allowed-address pairs)

--tag <tag>

Tag to be added to the port (repeat option to set multiple tags)

--no-tag

Table 59.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 59.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 59.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 59.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.

59.2. port delete

Delete port(s)

Usage:

openstack port delete [-h] <port> [<port> ...]

Table 59.7. Positional Arguments

ValueSummary

<port>

Port(s) to delete (name or id)

Table 59.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

59.3. port list

List ports

Usage:

openstack 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]
                           [--device-owner <device-owner>]
                           [--network <network>]
                           [--router <router> | --server <server> | --device-id <device-id>]
                           [--mac-address <mac-address>] [--long]
                           [--project <project>]
                           [--project-domain <project-domain>]
                           [--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>]
                           [--tags <tag>[,<tag>,...]]
                           [--any-tags <tag>[,<tag>,...]]
                           [--not-tags <tag>[,<tag>,...]]
                           [--not-any-tags <tag>[,<tag>,...]]

Table 59.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--device-owner <device-owner>

List only ports with the specified device owner. this is the entity that uses the port (for example, network:dhcp).

--network <network>

List only ports connected to this network (name or id)

--router <router>

List only ports attached to this router (name or id)

--server <server>

List only ports attached to this server (name or id)

--device-id <device-id>

List only ports with the specified device id

--mac-address <mac-address>

List only ports with this mac address

--long

List additional fields in output

--project <project>

List ports 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.

--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>

Desired ip and/or subnet for filtering ports (name or ID): subnet=<subnet>,ip-address=<ip-address>,ip- substring=<ip-substring> (repeat option to set multiple fixed IP addresses)

--tags <tag>[,<tag>,…​]

List ports which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List ports which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude ports which have all given tag(s) (comma- separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude ports which have any given tag(s) (comma- separated list of tags)

Table 59.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 59.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 59.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 59.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.

59.4. port set

Set port properties

Usage:

openstack port set [-h] [--description <description>]
                          [--device <device-id>] [--mac-address <mac-address>]
                          [--device-owner <device-owner>]
                          [--vnic-type <vnic-type>] [--host <host-id>]
                          [--dns-domain dns-domain] [--dns-name <dns-name>]
                          [--enable | --disable] [--name <name>]
                          [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                          [--no-fixed-ip]
                          [--binding-profile <binding-profile>]
                          [--no-binding-profile] [--qos-policy <qos-policy>]
                          [--security-group <security-group>]
                          [--no-security-group]
                          [--enable-port-security | --disable-port-security]
                          [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                          [--no-allowed-address]
                          [--data-plane-status <status>] [--tag <tag>]
                          [--no-tag]
                          <port>

Table 59.14. Positional Arguments

ValueSummary

<port>

Port to modify (name or id)

Table 59.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of this port

--device <device-id>

Port device id

--mac-address <mac-address>

Mac address of this port (admin only)

--device-owner <device-owner>

Device owner of this port. this is the entity that uses the port (for example, network:dhcp).

--vnic-type <vnic-type>

Vnic type for this port (direct

direct-physical

macvtap

normal

baremetal

virtio-forwarder, default: normal)

--host <host-id>

Allocate port on host <host-id> (id only)

--dns-domain dns-domain

Set dns domain to this port (requires dns_domain extension for ports)

--dns-name <dns-name>

Set dns name for this port (requires dns integration extension)

--enable

Enable port

--disable

Disable port

--name <name>

Set port name

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired ip and/or subnet for this port (name or id): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--no-fixed-ip

Clear existing information of fixed ip addresses.Specify both --fixed-ip and --no-fixed-ip to overwrite the current fixed IP addresses.

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. data may be passed as <key>=<value> or JSON. (repeat option to set multiple binding:profile data)

--no-binding-profile

Clear existing information of binding:profile. specify both --binding-profile and --no-binding-profile to overwrite the current binding:profile information.

--qos-policy <qos-policy>

Attach qos policy to this port (name or id)

--security-group <security-group>

Security group to associate with this port (name or ID) (repeat option to set multiple security groups)

--no-security-group

Clear existing security groups associated with this port

--enable-port-security

Enable port security for this port

--disable-port-security

Disable port security for this port

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

Add allowed-address pair associated with this port: ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to set multiple allowed-address pairs)

--no-allowed-address

Clear existing allowed-address pairs associated with this port. (Specify both --allowed-address and --no- allowed-address to overwrite the current allowed- address pairs)

--data-plane-status <status>

Set data plane status of this port (active

down). Unset it to None with the port unset command (requires data plane status extension)

--tag <tag>

Tag to be added to the port (repeat option to set multiple tags)

--no-tag

Clear tags associated with the port. specify both --tag and --no-tag to overwrite current tags

59.5. port show

Display port details

Usage:

openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <port>

Table 59.16. Positional Arguments

ValueSummary

<port>

Port to display (name or id)

Table 59.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 59.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 59.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 59.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 59.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.

59.6. port unset

Unset port properties

Usage:

openstack port unset [-h]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--binding-profile <binding-profile-key>]
                            [--security-group <security-group>]
                            [--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
                            [--qos-policy] [--data-plane-status]
                            [--tag <tag> | --all-tag]
                            <port>

Table 59.22. Positional Arguments

ValueSummary

<port>

Port to modify (name or id)

Table 59.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired ip and/or subnet which should be removed from this port (name or ID): subnet=<subnet>,ip- address=<ip-address> (repeat option to unset multiple fixed IP addresses)

--binding-profile <binding-profile-key>

Desired key which should be removed from binding:profile (repeat option to unset multiple binding:profile data)

--security-group <security-group>

Security group which should be removed this port (name or ID) (repeat option to unset multiple security groups)

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

Desired allowed-address pair which should be removed from this port: ip-address=<ip-address>[,mac- address=<mac-address>] (repeat option to unset multiple allowed-address pairs)

--qos-policy

Remove the qos policy attached to the port

--data-plane-status

Clear existing information of data plane status

--tag <tag>

Tag to be removed from the port (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the port

Chapter 60. project

This chapter describes the commands under the project command.

60.1. project create

Create new project

Usage:

openstack project create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--domain <domain>]
                                [--parent <project>]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                [--tag <tag>]
                                <project-name>

Table 60.1. Positional Arguments

ValueSummary

<project-name>

New project name

Table 60.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning the project (name or id)

--parent <project>

Parent of the project (name or id)

--description <description>

Project description

--enable

Enable project

--disable

Disable project

--property <key=value>

Add a property to <name> (repeat option to set multiple properties)

--or-show

Return existing project

--tag <tag>

Tag to be added to the project (repeat option to set multiple tags)

Table 60.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 60.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 60.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.

60.2. project delete

Delete project(s)

Usage:

openstack project delete [-h] [--domain <domain>]
                                <project> [<project> ...]

Table 60.7. Positional Arguments

ValueSummary

<project>

Project(s) to delete (name or id)

Table 60.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <project> (name or id)

60.3. project list

List projects

Usage:

openstack project 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] [--domain <domain>]
                              [--user <user>] [--my-projects] [--long]
                              [--sort <key>[:<direction>]]
                              [--tags <tag>[,<tag>,...]]
                              [--tags-any <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-tags-any <tag>[,<tag>,...]]

Table 60.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Filter projects by <domain> (name or id)

--user <user>

Filter projects by <user> (name or id)

--my-projects

List projects for the authenticated user. supersedes other filters.

--long

List additional fields in output

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc), repeat this option to specify multiple keys and directions.

--tags <tag>[,<tag>,…​]

List projects which have all given tag(s) (comma- separated list of tags)

--tags-any <tag>[,<tag>,…​]

List projects which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude projects which have all given tag(s) (comma- separated list of tags)

--not-tags-any <tag>[,<tag>,…​]

Exclude projects which have any given tag(s) (comma- separated list of tags)

Table 60.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 60.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 60.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.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.

60.4. project purge

Clean resources associated with a project

Usage:

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

Table 60.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dry-run

List a project’s resources

--keep-project

Clean project resources, but don’t delete the project

--auth-project

Delete resources of the project used to authenticate

--project <project>

Project to clean (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.

60.5. project set

Set project properties

Usage:

openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             [--tag <tag>] [--clear-tags] [--remove-tag <tag>]
                             <project>

Table 60.15. Positional Arguments

ValueSummary

<project>

Project to modify (name or id)

Table 60.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set project name

--domain <domain>

Domain owning <project> (name or id)

--description <description>

Set project description

--enable

Enable project

--disable

Disable project

--property <key=value>

Set a property on <project> (repeat option to set multiple properties)

--tag <tag>

Tag to be added to the project (repeat option to set multiple tags)

--clear-tags

Clear tags associated with the project. specify both --tag and --clear-tags to overwrite current tags

--remove-tag <tag>

Tag to be deleted from the project (repeat option to delete multiple tags)

60.6. project show

Display project details

Usage:

openstack project show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--domain <domain>] [--parents]
                              [--children]
                              <project>

Table 60.17. Positional Arguments

ValueSummary

<project>

Project to display (name or id)

Table 60.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <project> (name or id)

--parents

Show the project’s parents as a list

--children

Show project’s subtree (children) as a list

Table 60.19. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 60.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 60.22. 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 61. ptr

This chapter describes the commands under the ptr command.

61.1. ptr record list

List floatingip ptr records

Usage:

openstack ptr record 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] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]

Table 61.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 61.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 61.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 61.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.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.

61.2. ptr record set

Set floatingip ptr record

Usage:

openstack ptr record set [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty]
                                [--description DESCRIPTION | --no-description]
                                [--ttl TTL | --no-ttl] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                floatingip_id ptrdname

Table 61.6. Positional Arguments

ValueSummary

floatingip_id

Floating ip id in format region:floatingip_id

ptrdname

Ptrd name

Table 61.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description

--no-description—​ttl TTL

Ttl

--no-ttl—​all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 61.8. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 61.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.10. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 61.11. 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.

61.3. ptr record show

Show floatingip ptr record details

Usage:

openstack ptr record show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--all-projects]
                                 [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 floatingip_id

Table 61.12. Positional Arguments

ValueSummary

floatingip_id

Floating ip id in format region:floatingip_id

Table 61.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 61.14. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 61.15. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.16. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 61.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.

61.4. ptr record unset

Unset floatingip ptr record

Usage:

openstack ptr record unset [-h] [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  floatingip_id

Table 61.18. Positional Arguments

ValueSummary

floatingip_id

Floating ip id in format region:floatingip_id

Table 61.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Chapter 62. quota

This chapter describes the commands under the quota command.

62.1. quota list

List quotas for all projects with non-default quota values or list detailed quota informations for requested project

Usage:

openstack quota 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]
                            [--project <project>] [--detail]
                            (--compute | --volume | --network)

Table 62.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

List quotas for this project <project> (name or id)

--detail

Show details about quotas usage

--compute

List compute quota

--volume

List volume quota

--network

List network quota

Table 62.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 62.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 62.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.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.

62.2. quota set

Set quotas for project or class

Usage:

openstack quota set [-h] [--class] [--cores <cores>]
                           [--fixed-ips <fixed-ips>]
                           [--injected-file-size <injected-file-size>]
                           [--injected-path-size <injected-path-size>]
                           [--injected-files <injected-files>]
                           [--instances <instances>] [--key-pairs <key-pairs>]
                           [--properties <properties>] [--ram <ram>]
                           [--server-groups <server-groups>]
                           [--server-group-members <server-group-members>]
                           [--backups <backups>]
                           [--backup-gigabytes <backup-gigabytes>]
                           [--gigabytes <gigabytes>]
                           [--per-volume-gigabytes <per-volume-gigabytes>]
                           [--snapshots <snapshots>] [--volumes <volumes>]
                           [--floating-ips <floating-ips>]
                           [--secgroup-rules <secgroup-rules>]
                           [--secgroups <secgroups>] [--networks <networks>]
                           [--subnets <subnets>] [--ports <ports>]
                           [--routers <routers>]
                           [--rbac-policies <rbac-policies>] [--vips <vips>]
                           [--subnetpools <subnetpools>]
                           [--health-monitors <health-monitors>]
                           [--l7policies <l7policies>]
                           [--volume-type <volume-type>]
                           <project/class>

Table 62.6. Positional Arguments

ValueSummary

<project/class>

Set quotas for this project or class (name/id)

Table 62.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--class

Set quotas for <class>

--cores <cores>

New value for the cores quota

--fixed-ips <fixed-ips>

New value for the fixed-ips quota

--injected-file-size <injected-file-size>

New value for the injected-file-size quota

--injected-path-size <injected-path-size>

New value for the injected-path-size quota

--injected-files <injected-files>

New value for the injected-files quota

--instances <instances>

New value for the instances quota

--key-pairs <key-pairs>

New value for the key-pairs quota

--properties <properties>

New value for the properties quota

--ram <ram>

New value for the ram quota

--server-groups <server-groups>

New value for the server-groups quota

--server-group-members <server-group-members>

New value for the server-group-members quota

--backups <backups>

New value for the backups quota

--backup-gigabytes <backup-gigabytes>

New value for the backup-gigabytes quota

--gigabytes <gigabytes>

New value for the gigabytes quota

--per-volume-gigabytes <per-volume-gigabytes>

New value for the per-volume-gigabytes quota

--snapshots <snapshots>

New value for the snapshots quota

--volumes <volumes>

New value for the volumes quota

--floating-ips <floating-ips>

New value for the floating-ips quota

--secgroup-rules <secgroup-rules>

New value for the secgroup-rules quota

--secgroups <secgroups>

New value for the secgroups quota

--networks <networks>

New value for the networks quota

--subnets <subnets>

New value for the subnets quota

--ports <ports>

New value for the ports quota

--routers <routers>

New value for the routers quota

--rbac-policies <rbac-policies>

New value for the rbac-policies quota

--vips <vips>

New value for the vips quota

--subnetpools <subnetpools>

New value for the subnetpools quota

--health-monitors <health-monitors>

New value for the health-monitors quota

--l7policies <l7policies>

New value for the l7policies quota

--volume-type <volume-type>

Set quotas for a specific <volume-type>

62.3. quota show

Show quotas for project or class. Specify ``--os-compute-api-version 2.50`` or higher to see ``server-groups`` and ``server-group-members`` output for a given quota class.

Usage:

openstack quota show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--class | --default]
                            [<project/class>]

Table 62.8. Positional Arguments

ValueSummary

<project/class>

Show quotas for this project or class (name or id)

Table 62.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--class

Show quotas for <class>

--default

Show default quotas for <project>

Table 62.10. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 62.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 62.12. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 62.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.

Chapter 63. recordset

This chapter describes the commands under the recordset command.

63.1. recordset create

Create new recordset

Usage:

openstack recordset create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] --record RECORD --type TYPE
                                  [--ttl TTL] [--description DESCRIPTION]
                                  [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id name

Table 63.1. Positional Arguments

ValueSummary

zone_id

Zone id

name

Recordset name

Table 63.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--record RECORD

Recordset record, repeat if necessary

--type TYPE

Recordset type

--ttl TTL

Time to live (seconds)

--description DESCRIPTION

Description

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 63.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 63.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 63.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 63.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.

63.2. recordset delete

Delete recordset

Usage:

openstack recordset delete [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_id id

Table 63.7. Positional Arguments

ValueSummary

zone_id

Zone id

id

Recordset id

Table 63.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 63.9. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 63.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 63.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 63.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.

63.3. recordset list

List recordsets

Usage:

openstack recordset 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]
                                [--type TYPE] [--data DATA] [--ttl TTL]
                                [--description DESCRIPTION] [--status STATUS]
                                [--action ACTION] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id

Table 63.13. Positional Arguments

ValueSummary

zone_id

Zone id. to list all recordsets specify all

Table 63.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Recordset name

--type TYPE

Recordset type

--data DATA

Recordset record data

--ttl TTL

Time to live (seconds)

--description DESCRIPTION

Description

--status STATUS

Recordset status

--action ACTION

Recordset action

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 63.15. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 63.16. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 63.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 63.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.

63.4. recordset set

Set recordset properties

Usage:

openstack recordset set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--record RECORD]
                               [--description DESCRIPTION | --no-description]
                               [--ttl TTL | --no-ttl] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               zone_id id

Table 63.19. Positional Arguments

ValueSummary

zone_id

Zone id

id

Recordset id

Table 63.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--record RECORD

Recordset record, repeat if necessary

--description DESCRIPTION

Description

--no-description—​ttl TTL

Ttl

--no-ttl—​all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 63.21. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 63.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 63.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 63.24. 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.

63.5. recordset show

Show recordset details

Usage:

openstack recordset show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                zone_id id

Table 63.25. Positional Arguments

ValueSummary

zone_id

Zone id

id

Recordset id

Table 63.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 63.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 63.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 63.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 63.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.

Chapter 64. region

This chapter describes the commands under the region command.

64.1. region create

Create new region

Usage:

openstack region create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--parent-region <region-id>]
                               [--description <description>]
                               <region-id>

Table 64.1. Positional Arguments

ValueSummary

<region-id>

New region id

Table 64.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Parent region id

--description <description>

New region description

Table 64.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 64.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 64.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 64.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.

64.2. region delete

Delete region(s)

Usage:

openstack region delete [-h] <region-id> [<region-id> ...]

Table 64.7. Positional Arguments

ValueSummary

<region-id>

Region id(s) to delete

Table 64.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

64.3. region list

List regions

Usage:

openstack region 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]
                             [--parent-region <region-id>]

Table 64.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

Filter by parent region id

Table 64.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 64.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 64.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 64.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.

64.4. region set

Set region properties

Usage:

openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>

Table 64.14. Positional Arguments

ValueSummary

<region-id>

Region to modify

Table 64.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--parent-region <region-id>

New parent region id

--description <description>

New region description

64.5. region show

Display region details

Usage:

openstack region show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <region-id>

Table 64.16. Positional Arguments

ValueSummary

<region-id>

Region to display

Table 64.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 64.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 64.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 64.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 64.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 65. registered

This chapter describes the commands under the registered command.

65.1. registered limit create

Create a registered limit

Usage:

openstack registered limit create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         [--description <description>]
                                         [--region <region>] --service
                                         <service> --default-limit
                                         <default-limit>
                                         <resource-name>

Table 65.1. Positional Arguments

ValueSummary

<resource-name>

The name of the resource to limit

Table 65.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the registered limit

--region <region>

Region for the registered limit to affect

--service <service>

Service responsible for the resource to limit (required)

--default-limit <default-limit>

The default limit for the resources to assume (required)

Table 65.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 65.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 65.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 65.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.

65.2. registered limit delete

Delete a registered limit

Usage:

openstack registered limit delete [-h]
                                         <registered-limit-id>
                                         [<registered-limit-id> ...]

Table 65.7. Positional Arguments

ValueSummary

<registered-limit-id>

Registered limit to delete (id)

Table 65.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

65.3. registered limit list

List registered limits

Usage:

openstack registered limit 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]
                                       [--service <service>]
                                       [--resource-name <resource-name>]
                                       [--region <region>]

Table 65.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--service <service>

Service responsible for the resource to limit

--resource-name <resource-name>

The name of the resource to limit

--region <region>

Region for the limit to affect.

Table 65.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 65.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 65.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 65.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.

65.4. registered limit set

Update information about a registered limit

Usage:

openstack registered limit set [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--service <service>]
                                      [--resource-name <resource-name>]
                                      [--default-limit <default-limit>]
                                      [--description <description>]
                                      [--region <region>]
                                      <registered-limit-id>

Table 65.14. Positional Arguments

ValueSummary

<registered-limit-id>

Registered limit to update (id)

Table 65.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--service <service>

Service to be updated responsible for the resource to limit. Either --service, --resource-name or --region must be different than existing value otherwise it will be duplicate entry

--resource-name <resource-name>

Resource to be updated responsible for the resource to limit. Either --service, --resource-name or --region must be different than existing value otherwise it will be duplicate entry

--default-limit <default-limit>

The default limit for the resources to assume

--description <description>

Description to update of the registered limit

--region <region>

Region for the registered limit to affect. either --service, --resource-name or --region must be different than existing value otherwise it will be duplicate entry

Table 65.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 65.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 65.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 65.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.

65.5. registered limit show

Display registered limit details

Usage:

openstack registered limit show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <registered-limit-id>

Table 65.20. Positional Arguments

ValueSummary

<registered-limit-id>

Registered limit to display (id)

Table 65.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 65.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 65.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 65.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 65.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.

Chapter 66. request

This chapter describes the commands under the request command.

66.1. request token authorize

Authorize a request token

Usage:

openstack request token authorize [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --request-key
                                         <request-key> --role <role>

Table 66.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--request-key <request-key>

Request token to authorize (id only) (required)

--role <role>

Roles to authorize (name or id) (repeat option to set multiple values) (required)

Table 66.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 66.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 66.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 66.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.

66.2. request token create

Create a request token

Usage:

openstack request 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> --project <project>
                                      [--domain <domain>]

Table 66.6. 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)

--project <project>

Project that consumer wants to access (name or id) (required)

--domain <domain>

Domain owning <project> (name or id)

Table 66.7. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 66.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 66.9. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 66.10. 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 67. resource

This chapter describes the commands under the resource command.

67.1. resource member create

Shares a resource to another tenant.

Usage:

openstack resource member create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        resource_id resource_type member_id

Table 67.1. Positional Arguments

ValueSummary

resource_id

Resource id to be shared.

resource_type

Resource type.

member_id

Project id to whom the resource is shared to.

Table 67.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 67.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 67.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 67.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 67.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.

67.2. resource member delete

Delete a resource sharing relationship.

Usage:

openstack resource member delete [-h] resource resource_type member_id

Table 67.7. Positional Arguments

ValueSummary

resource

Resource id to be shared.

resource_type

Resource type.

member_id

Project id to whom the resource is shared to.

Table 67.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

67.3. resource member list

List all members.

Usage:

openstack resource member 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]
                                      resource_id resource_type

Table 67.9. Positional Arguments

ValueSummary

resource_id

Resource id to be shared.

resource_type

Resource type.

Table 67.10. 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 67.11. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 67.12. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 67.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 67.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.

67.4. resource member show

Show specific member information.

Usage:

openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [-m MEMBER_ID]
                                      resource resource_type

Table 67.15. Positional Arguments

ValueSummary

resource

Resource id to be shared.

resource_type

Resource type.

Table 67.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-m MEMBER_ID, --member-id MEMBER_ID

Project id to whom the resource is shared to. no need to provide this param if you are the resource member.

Table 67.17. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 67.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 67.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 67.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.

67.5. resource member update

Update resource sharing status.

Usage:

openstack resource member update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [-m MEMBER_ID]
                                        [-s {pending,accepted,rejected}]
                                        resource_id resource_type

Table 67.21. Positional Arguments

ValueSummary

resource_id

Resource id to be shared.

resource_type

Resource type.

Table 67.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-m MEMBER_ID, --member-id MEMBER_ID

Project id to whom the resource is shared to. no need to provide this param if you are the resource member.

-s {pending,accepted,rejected}, --status {pending,accepted,rejected}

Status of the sharing.

Table 67.23. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 67.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 67.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 67.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.

Chapter 68. role

This chapter describes the commands under the role command.

68.1. role add

Adds a role assignment to a user or group on the system, a domain, or a project

Usage:

openstack role add [-h]
                          [--system <system> | --domain <domain> | --project <project>]
                          [--user <user> | --group <group>]
                          [--group-domain <group-domain>]
                          [--project-domain <project-domain>]
                          [--user-domain <user-domain>] [--inherited]
                          [--role-domain <role-domain>]
                          <role>

Table 68.1. Positional Arguments

ValueSummary

<role>

Role to add to <user> (name or id)

Table 68.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--system <system>

Include <system> (all)

--domain <domain>

Include <domain> (name or id)

--project <project>

Include <project> (name or id)

--user <user>

Include <user> (name or id)

--group <group>

Include <group> (name or id)

--group-domain <group-domain>

Domain the group belongs to (name or id). this can be used in case collisions between group names exist.

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--inherited

Specifies if the role grant is inheritable to the sub projects

--role-domain <role-domain>

Domain the role belongs to (name or id). this must be specified when the name of a domain specific role is used.

68.2. role assignment list

List role assignments

Usage:

openstack role assignment 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]
                                      [--effective] [--role <role>]
                                      [--role-domain <role-domain>] [--names]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
                                      [--group <group>]
                                      [--group-domain <group-domain>]
                                      [--domain <domain> | --project <project> | --system <system>]
                                      [--project-domain <project-domain>]
                                      [--inherited] [--auth-user]
                                      [--auth-project]

Table 68.3. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--effective

Returns only effective role assignments

--role <role>

Role to filter (name or id)

--role-domain <role-domain>

Domain the role belongs to (name or id). this must be specified when the name of a domain specific role is used.

--names

Display names instead of ids

--user <user>

User to filter (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.

--group <group>

Group to filter (name or id)

--group-domain <group-domain>

Domain the group belongs to (name or id). this can be used in case collisions between group names exist.

--domain <domain>

Domain to filter (name or id)

--project <project>

Project to filter (name or id)

--system <system>

Filter based on system role assignments

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--inherited

Specifies if the role grant is inheritable to the sub projects

--auth-user

Only list assignments for the authenticated user

--auth-project

Only list assignments for the project to which the authenticated user’s token is scoped

Table 68.4. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 68.5. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 68.6. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 68.7. 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.

68.3. role create

Create new role

Usage:

openstack role create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>] [--or-show]
                             <role-name>

Table 68.8. Positional Arguments

ValueSummary

<role-name>

New role name

Table 68.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain the role belongs to (name or id)

--or-show

Return existing role

Table 68.10. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 68.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 68.12. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 68.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.

68.4. role delete

Delete role(s)

Usage:

openstack role delete [-h] [--domain <domain>] <role> [<role> ...]

Table 68.14. Positional Arguments

ValueSummary

<role>

Role(s) to delete (name or id)

Table 68.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain the role belongs to (name or id)

68.5. role list

List roles

Usage:

openstack role 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]
                           [--system <system> | --domain <domain> | --project <project>]
                           [--user <user> | --group <group>]
                           [--group-domain <group-domain>]
                           [--project-domain <project-domain>]
                           [--user-domain <user-domain>] [--inherited]

Table 68.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--system <system>

Include <system> (all)

--domain <domain>

Include <domain> (name or id)

--project <project>

Include <project> (name or id)

--user <user>

Include <user> (name or id)

--group <group>

Include <group> (name or id)

--group-domain <group-domain>

Domain the group belongs to (name or id). this can be used in case collisions between group names exist.

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--inherited

Specifies if the role grant is inheritable to the sub projects

Table 68.17. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 68.18. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 68.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 68.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.

68.6. role remove

Removes a role assignment from system/domain/project : user/group

Usage:

openstack role remove [-h]
                             [--system <system> | --domain <domain> | --project <project>]
                             [--user <user> | --group <group>]
                             [--group-domain <group-domain>]
                             [--project-domain <project-domain>]
                             [--user-domain <user-domain>] [--inherited]
                             [--role-domain <role-domain>]
                             <role>

Table 68.21. Positional Arguments

ValueSummary

<role>

Role to remove (name or id)

Table 68.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--system <system>

Include <system> (all)

--domain <domain>

Include <domain> (name or id)

--project <project>

Include <project> (name or id)

--user <user>

Include <user> (name or id)

--group <group>

Include <group> (name or id)

--group-domain <group-domain>

Domain the group belongs to (name or id). this can be used in case collisions between group names exist.

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--inherited

Specifies if the role grant is inheritable to the sub projects

--role-domain <role-domain>

Domain the role belongs to (name or id). this must be specified when the name of a domain specific role is used.

68.7. role set

Set role properties

Usage:

openstack role set [-h] [--domain <domain>] [--name <name>] <role>

Table 68.23. Positional Arguments

ValueSummary

<role>

Role to modify (name or id)

Table 68.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain the role belongs to (name or id)

--name <name>

Set role name

68.8. role show

Display role details

Usage:

openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <role>

Table 68.25. Positional Arguments

ValueSummary

<role>

Role to display (name or id)

Table 68.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain the role belongs to (name or id)

Table 68.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 68.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 68.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 68.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.

Chapter 69. router

This chapter describes the commands under the router command.

69.1. router add port

Add a port to a router

Usage:

openstack router add port [-h] <router> <port>

Table 69.1. Positional Arguments

ValueSummary

<router>

Router to which port will be added (name or id)

<port>

Port to be added (name or id)

Table 69.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

69.2. router add subnet

Add a subnet to a router

Usage:

openstack router add subnet [-h] <router> <subnet>

Table 69.3. Positional Arguments

ValueSummary

<router>

Router to which subnet will be added (name or id)

<subnet>

Subnet to be added (name or id)

Table 69.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

69.3. router create

Create a new router

Usage:

openstack router create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--enable | --disable]
                               [--distributed | --centralized]
                               [--ha | --no-ha] [--description <description>]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               [--tag <tag> | --no-tag]
                               <name>

Table 69.5. Positional Arguments

ValueSummary

<name>

New router name

Table 69.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable router (default)

--disable

Disable router

--distributed

Create a distributed router

--centralized

Create a centralized router

--ha

Create a highly available router

--no-ha

Create a legacy router

--description <description>

Set router description

--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.

--availability-zone-hint <availability-zone>

Availability zone in which to create this router (Router Availability Zone extension required, repeat option to set multiple availability zones)

--tag <tag>

Tag to be added to the router (repeat option to set multiple tags)

--no-tag

No tags associated with the router

Table 69.7. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 69.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 69.9. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 69.10. 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.

69.4. router delete

Delete router(s)

Usage:

openstack router delete [-h] <router> [<router> ...]

Table 69.11. Positional Arguments

ValueSummary

<router>

Router(s) to delete (name or id)

Table 69.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

69.5. router list

List routers

Usage:

openstack router 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>]
                             [--enable | --disable] [--long]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

Table 69.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

List routers according to their name

--enable

List enabled routers

--disable

List disabled routers

--long

List additional fields in output

--project <project>

List routers 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.

--agent <agent-id>

List routers hosted by an agent (id only)

--tags <tag>[,<tag>,…​]

List routers which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List routers which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude routers which have all given tag(s) (comma- separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude routers which have any given tag(s) (comma- separated list of tags)

Table 69.14. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 69.15. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 69.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 69.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.

69.6. router remove port

Remove a port from a router

Usage:

openstack router remove port [-h] <router> <port>

Table 69.18. Positional Arguments

ValueSummary

<router>

Router from which port will be removed (name or id)

<port>

Port to be removed and deleted (name or id)

Table 69.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

69.7. router remove subnet

Remove a subnet from a router

Usage:

openstack router remove subnet [-h] <router> <subnet>

Table 69.20. Positional Arguments

ValueSummary

<router>

Router from which the subnet will be removed (name or id)

<subnet>

Subnet to be removed (name or id)

Table 69.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

69.8. router set

Set router properties

Usage:

openstack router set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address>]
                            [--no-route] [--ha | --no-ha]
                            [--external-gateway <network>]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--enable-snat | --disable-snat]
                            [--qos-policy <qos-policy> | --no-qos-policy]
                            [--tag <tag>] [--no-tag]
                            <router>

Table 69.22. Positional Arguments

ValueSummary

<router>

Router to modify (name or id)

Table 69.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set router name

--description <description>

Set router description

--enable

Enable router

--disable

Disable router

--distributed

Set router to distributed mode (disabled router only)

--centralized

Set router to centralized mode (disabled router only)

--route destination=<subnet>,gateway=<ip-address>

Routes associated with the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to set multiple routes)

--no-route

Clear routes associated with the router. specify both --route and --no-route to overwrite current value of route.

--ha

Set the router as highly available (disabled router only)

--no-ha

Clear high availability attribute of the router (disabled router only)

--external-gateway <network>

External network used as router’s gateway (name or id)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired ip and/or subnet (name or id) on external gateway: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--enable-snat

Enable source nat on external gateway

--disable-snat

Disable source nat on external gateway

--qos-policy <qos-policy>

Attach qos policy to router gateway ips

--no-qos-policy

Remove qos policy from router gateway ips

--tag <tag>

Tag to be added to the router (repeat option to set multiple tags)

--no-tag

Clear tags associated with the router. specify both --tag and --no-tag to overwrite current tags

69.9. router show

Display router details

Usage:

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <router>

Table 69.24. Positional Arguments

ValueSummary

<router>

Router to display (name or id)

Table 69.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 69.26. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 69.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 69.28. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 69.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.

69.10. router unset

Unset router properties

Usage:

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--qos-policy]
                              [--tag <tag> | --all-tag]
                              <router>

Table 69.30. Positional Arguments

ValueSummary

<router>

Router to modify (name or id)

Table 69.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--route destination=<subnet>,gateway=<ip-address>

Routes to be removed from the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to unset multiple routes)

--external-gateway

Remove external gateway information from the router

--qos-policy

Remove qos policy from router gateway ips

--tag <tag>

Tag to be removed from the router (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the router

Chapter 70. secret

This chapter describes the commands under the secret command.

70.1. secret container create

Store a container in Barbican.

Usage:

openstack secret container create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] [--name NAME]
                                         [--type TYPE] [--secret SECRET]

Table 70.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--type TYPE

Type of container to create (default: generic).

--secret SECRET, -s SECRET

One secret to store in a container (can be set multiple times). Example: --secret "private_key=https://url.test/v1/secrets/1-2-3-4"

Table 70.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.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.

70.2. secret container delete

Delete a container by providing its href.

Usage:

openstack secret container delete [-h] URI

Table 70.6. Positional Arguments

ValueSummary

URI

The uri reference for the container

Table 70.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

70.3. secret container get

Retrieve a container by providing its URI.

Usage:

openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      URI

Table 70.8. Positional Arguments

ValueSummary

URI

The uri reference for the container.

Table 70.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 70.10. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.12. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.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.

70.4. secret container list

List containers.

Usage:

openstack secret container 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] [--offset OFFSET]
                                       [--name NAME] [--type TYPE]

Table 70.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

Specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

Specify the page offset (default: 0)

--name NAME, -n NAME

Specify the container name (default: none)

--type TYPE, -t TYPE

Specify the type filter for the list (default: none).

Table 70.15. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 70.16. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 70.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.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.

70.5. secret delete

Delete a secret by providing its URI.

Usage:

openstack secret delete [-h] URI

Table 70.19. Positional Arguments

ValueSummary

URI

The uri reference for the secret

Table 70.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

70.6. secret get

Retrieve a secret by providing its URI.

Usage:

openstack secret get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            [--decrypt | --payload | --file <filename>]
                            [--payload_content_type PAYLOAD_CONTENT_TYPE]
                            URI

Table 70.21. Positional Arguments

ValueSummary

URI

The uri reference for the secret.

Table 70.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--decrypt, -d

If specified, retrieve the unencrypted secret data.

--payload, -p

If specified, retrieve the unencrypted secret data.

--file <filename>, -F <filename>

If specified, save the payload to a new file with the given filename.

--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

The content type of the decrypted secret (default: text/plain).

Table 70.23. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.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.

70.7. secret list

List secrets.

Usage:

openstack secret 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]
                             [--offset OFFSET] [--name NAME]
                             [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                             [--mode MODE] [--secret-type SECRET_TYPE]

Table 70.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

Specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

Specify the page offset (default: 0)

--name NAME, -n NAME

Specify the secret name (default: none)

--algorithm ALGORITHM, -a ALGORITHM

The algorithm filter for the list(default: none).

--bit-length BIT_LENGTH, -b BIT_LENGTH

The bit length filter for the list (default: 0).

--mode MODE, -m MODE

The algorithm mode filter for the list (default: None).

--secret-type SECRET_TYPE, -s SECRET_TYPE

Specify the secret type (default: none).

Table 70.28. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 70.29. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 70.30. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.31. 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.

70.8. secret order create

Create a new order.

Usage:

openstack secret order create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name NAME] [--algorithm ALGORITHM]
                                     [--bit-length BIT_LENGTH] [--mode MODE]
                                     [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                     [--expiration EXPIRATION]
                                     [--request-type REQUEST_TYPE]
                                     [--subject-dn SUBJECT_DN]
                                     [--source-container-ref SOURCE_CONTAINER_REF]
                                     [--ca-id CA_ID] [--profile PROFILE]
                                     [--request-file REQUEST_FILE]
                                     type

Table 70.32. Positional Arguments

ValueSummary

type

The type of the order (key, asymmetric, certificate) to create.

Table 70.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--algorithm ALGORITHM, -a ALGORITHM

The algorithm to be used with the requested key (default: aes).

--bit-length BIT_LENGTH, -b BIT_LENGTH

The bit length of the requested secret key (default: 256).

--mode MODE, -m MODE

The algorithm mode to be used with the requested key (default: cbc).

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

The type/format of the secret to be generated (default: application/octet-stream).

--expiration EXPIRATION, -x EXPIRATION

The expiration time for the secret in iso 8601 format.

--request-type REQUEST_TYPE

The type of the certificate request.

--subject-dn SUBJECT_DN

The subject of the certificate.

--source-container-ref SOURCE_CONTAINER_REF

The source of the certificate when using stored-key requests.

--ca-id CA_ID

The identifier of the ca to use for the certificate request.

--profile PROFILE

The profile of certificate to use.

--request-file REQUEST_FILE

The file containing the csr.

Table 70.34. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.35. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.36. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.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.

70.9. secret order delete

Delete an order by providing its href.

Usage:

openstack secret order delete [-h] URI

Table 70.38. Positional Arguments

ValueSummary

URI

The uri reference for the order

Table 70.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

70.10. secret order get

Retrieve an order by providing its URI.

Usage:

openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  URI

Table 70.40. Positional Arguments

ValueSummary

URI

The uri reference order.

Table 70.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 70.42. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.44. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.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.

70.11. secret order list

List orders.

Usage:

openstack secret order 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]
                                   [--offset OFFSET]

Table 70.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

Specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

Specify the page offset (default: 0)

Table 70.47. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 70.48. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 70.49. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.50. 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.

70.12. secret store

Store a secret in Barbican.

Usage:

openstack secret store [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--name NAME]
                              [--secret-type SECRET_TYPE]
                              [--payload-content-type PAYLOAD_CONTENT_TYPE]
                              [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                              [--algorithm ALGORITHM]
                              [--bit-length BIT_LENGTH] [--mode MODE]
                              [--expiration EXPIRATION]
                              [--payload PAYLOAD | --file <filename>]

Table 70.51. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--secret-type SECRET_TYPE, -s SECRET_TYPE

The secret type; must be one of symmetric, public, private, certificate, passphrase, opaque (default)

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

The type/format of the provided secret data; "text/plain" is assumed to be UTF-8; required when --payload is supplied.

--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING

Required if --payload-content-type is "application/octet-stream".

--algorithm ALGORITHM, -a ALGORITHM

The algorithm (default: aes).

--bit-length BIT_LENGTH, -b BIT_LENGTH

The bit length (default: 256).

--mode MODE, -m MODE

The algorithm mode; used only for reference (default: cbc)

--expiration EXPIRATION, -x EXPIRATION

The expiration time for the secret in iso 8601 format.

--payload PAYLOAD, -p PAYLOAD

The unencrypted secret data.

--file <filename>, -F <filename>

File containing the secret payload

Table 70.52. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 70.53. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 70.54. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 70.55. 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.

70.13. secret update

Update a secret with no payload in Barbican.

Usage:

openstack secret update [-h] URI payload

Table 70.56. Positional Arguments

ValueSummary

URI

The uri reference for the secret.

payload

The unencrypted secret

Table 70.57. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 71. security

This chapter describes the commands under the security command.

71.1. security group create

Create a new security group

Usage:

openstack security group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--tag <tag> | --no-tag]
                                       <name>

Table 71.1. Positional Arguments

ValueSummary

<name>

New security group name

Table 71.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Security group description

--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.

--tag <tag>

Tag to be added to the security group (repeat option to set multiple tags)

--no-tag

No tags associated with the security group

Table 71.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 71.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.

71.2. security group delete

Delete security group(s)

Usage:

openstack security group delete [-h] <group> [<group> ...]

Table 71.7. Positional Arguments

ValueSummary

<group>

Security group(s) to delete (name or id)

Table 71.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.3. security group list

List security groups

Usage:

openstack security 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]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     [--tags <tag>[,<tag>,...]]
                                     [--any-tags <tag>[,<tag>,...]]
                                     [--not-tags <tag>[,<tag>,...]]
                                     [--not-any-tags <tag>[,<tag>,...]]

Table 71.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

List security groups according to the 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.

--tags <tag>[,<tag>,…​]

List security group which have all given tag(s) (Comma-separated list of tags)

--any-tags <tag>[,<tag>,…​]

List security group which have any given tag(s) (Comma-separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude security group which have all given tag(s) (Comma-separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude security group which have any given tag(s) (Comma-separated list of tags)

Table 71.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 71.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.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.

71.4. security group rule create

Create a new security group rule

Usage:

openstack security group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--remote-ip <ip-address> | --remote-group <group>]
                                            [--description <description>]
                                            [--dst-port <port-range>]
                                            [--icmp-type <icmp-type>]
                                            [--icmp-code <icmp-code>]
                                            [--protocol <protocol>]
                                            [--ingress | --egress]
                                            [--ethertype <ethertype>]
                                            [--project <project>]
                                            [--project-domain <project-domain>]
                                            <group>

Table 71.14. Positional Arguments

ValueSummary

<group>

Create rule in this security group (name or id)

Table 71.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--remote-ip <ip-address>

Remote ip address block (may use cidr notation; default for IPv4 rule: 0.0.0.0/0)

--remote-group <group>

Remote security group (name or id)

--description <description>

Set security group rule description

--dst-port <port-range>

Destination port, may be a single port or a starting and ending port range: 137:139. Required for IP protocols TCP and UDP. Ignored for ICMP IP protocols.

--icmp-type <icmp-type>

Icmp type for icmp ip protocols

--icmp-code <icmp-code>

Icmp code for icmp ip protocols

--protocol <protocol>

Ip protocol (ah, dccp, egp, esp, gre, icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer representations [0-255] or any; default: tcp)

--ingress

Rule applies to incoming network traffic (default)

--egress

Rule applies to outgoing network traffic

--ethertype <ethertype>

Ethertype of network traffic (ipv4, ipv6; default: based on IP protocol)

--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.

Table 71.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 71.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.

71.5. security group rule delete

Delete security group rule(s)

Usage:

openstack security group rule delete [-h] <rule> [<rule> ...]

Table 71.20. Positional Arguments

ValueSummary

<rule>

Security group rule(s) to delete (id only)

Table 71.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

71.6. security group rule list

List security group rules

Usage:

openstack security group 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]
                                          [--protocol <protocol>]
                                          [--ingress | --egress] [--long]
                                          [<group>]

Table 71.22. Positional Arguments

ValueSummary

<group>

List all rules in this security group (name or id)

Table 71.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--protocol <protocol>

List rules by the ip protocol (ah, dhcp, egp, esp, gre, icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer representations [0-255]).

--ingress

List rules applied to incoming network traffic

--egress

List rules applied to outgoing network traffic

--long

List additional fields in output

Table 71.24. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 71.25. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 71.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.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.

71.7. security group rule show

Display security group rule details

Usage:

openstack security group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <rule>

Table 71.28. Positional Arguments

ValueSummary

<rule>

Security group rule to display (id only)

Table 71.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.30. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.32. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 71.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.

71.8. security group set

Set security group properties

Usage:

openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    [--tag <tag>] [--no-tag]
                                    <group>

Table 71.34. Positional Arguments

ValueSummary

<group>

Security group to modify (name or id)

Table 71.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <new-name>

New security group name

--description <description>

New security group description

--tag <tag>

Tag to be added to the security group (repeat option to set multiple tags)

--no-tag

Clear tags associated with the security group. specify both --tag and --no-tag to overwrite current tags

71.9. security group show

Display security group details

Usage:

openstack security group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <group>

Table 71.36. Positional Arguments

ValueSummary

<group>

Security group to display (name or id)

Table 71.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 71.38. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 71.39. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 71.40. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 71.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.

71.10. security group unset

Unset security group properties

Usage:

openstack security group unset [-h] [--tag <tag> | --all-tag] <group>

Table 71.42. Positional Arguments

ValueSummary

<group>

Security group to modify (name or id)

Table 71.43. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Tag to be removed from the security group (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the security group

Chapter 72. server

This chapter describes the commands under the server command.

72.1. server add fixed ip

Add fixed IP address to server

Usage:

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     <server> <network>

Table 72.1. Positional Arguments

ValueSummary

<server>

Server to receive the fixed ip address (name or id)

<network>

Network to allocate the fixed ip address from (name or ID)

Table 72.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--fixed-ip-address <ip-address>

Requested fixed ip address

72.2. server add floating ip

Add floating IP address to server

Usage:

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

Table 72.3. Positional Arguments

ValueSummary

<server>

Server to receive the floating ip address (name or id)

<ip-address>

Floating ip address to assign to the first available server port (IP only)

Table 72.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--fixed-ip-address <ip-address>

Fixed ip address to associate with this floating ip address. The first server port containing the fixed IP address will be used

72.3. server add network

Add network to server

Usage:

openstack server add network [-h] <server> <network>

Table 72.5. Positional Arguments

ValueSummary

<server>

Server to add the network to (name or id)

<network>

Network to add to the server (name or id)

Table 72.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.4. server add port

Add port to server

Usage:

openstack server add port [-h] <server> <port>

Table 72.7. Positional Arguments

ValueSummary

<server>

Server to add the port to (name or id)

<port>

Port to add to the server (name or id)

Table 72.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.5. server add security group

Add security group to server

Usage:

openstack server add security group [-h] <server> <group>

Table 72.9. Positional Arguments

ValueSummary

<server>

Server (name or id)

<group>

Security group to add (name or id)

Table 72.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.6. server add volume

Add volume to server

Usage:

openstack server add volume [-h] [--device <device>] <server> <volume>

Table 72.11. Positional Arguments

ValueSummary

<server>

Server (name or id)

<volume>

Volume to add (name or id)

Table 72.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--device <device>

Server internal device name for volume

72.7. server backup create

Create a server backup image

Usage:

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <image-name>]
                                      [--type <backup-type>]
                                      [--rotate <count>] [--wait]
                                      <server>

Table 72.13. Positional Arguments

ValueSummary

<server>

Server to back up (name or id)

Table 72.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <image-name>

Name of the backup image (default: server name)

--type <backup-type>

Used to populate the backup_type property of the backup image (default: empty)

--rotate <count>

Number of backups to keep (default: 1)

--wait

Wait for backup image create to complete

Table 72.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.17. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.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.

72.8. server create

Create a new server

Usage:

openstack server create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               (--image <image> | --image-property <key=value> | --volume <volume>)
                               --flavor <flavor>
                               [--security-group <security-group>]
                               [--key-name <key-name>]
                               [--property <key=value>]
                               [--file <dest-filename=source-filename>]
                               [--user-data <user-data>]
                               [--availability-zone <zone-name>]
                               [--block-device-mapping <dev-name=mapping>]
                               [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>]
                               [--network <network>] [--port <port>]
                               [--hint <key=value>]
                               [--config-drive <config-drive-volume>|True]
                               [--min <count>] [--max <count>] [--wait]
                               <server-name>

Table 72.19. Positional Arguments

ValueSummary

<server-name>

New server name

Table 72.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--image <image>

Create server boot disk from this image (name or id)

--image-property <key=value>

Image property to be matched

--volume <volume>

Create server using this volume as the boot disk (name or ID). This option automatically creates a block device mapping with a boot index of 0. On many hypervisors (libvirt/kvm for example) this will be device vda. Do not create a duplicate mapping using --block-device- mapping for this volume.

--flavor <flavor>

Create server with this flavor (name or id)

--security-group <security-group>

Security group to assign to this server (name or id) (repeat option to set multiple groups)

--key-name <key-name>

Keypair to inject into this server (optional extension)

--property <key=value>

Set a property on this server (repeat option to set multiple values)

--file <dest-filename=source-filename>

File to inject into image before boot (repeat option to set multiple files)

--user-data <user-data>

User data file to serve from the metadata server

--availability-zone <zone-name>

Select an availability zone for the server

--block-device-mapping <dev-name=mapping>

Create a block device on the server. Block device mapping in the format <dev-name>=<id>:<type>:<size(GB)>:<delete-on- terminate> <dev-name>: block device name, like: vdb, xvdc (required) <id>: UUID of the volume or snapshot (required) <type>: volume or snapshot; default: volume (optional) <size(GB)>: volume size if create from snapshot (optional) <delete-on-terminate>: true or false; default: false (optional) (optional extension)

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>

Create a nic on the server. specify option multiple times to create multiple NICs. Either net-id or port- id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional), none: (v2.37+) no network is attached, auto: (v2.37+) the compute service will automatically allocate a network. Specifying a --nic of auto or none cannot be used with any other --nic value.

--network <network>

Create a nic on the server and connect it to network. Specify option multiple times to create multiple NICs. This is a wrapper for the --nic net-id=<network> parameter that provides simple syntax for the standard use case of connecting a new server to a given network. For more advanced use cases, refer to the -- nic parameter.

--port <port>

Create a nic on the server and connect it to port. Specify option multiple times to create multiple NICs. This is a wrapper for the --nic port-id=<port> parameter that provides simple syntax for the standard use case of connecting a new server to a given port. For more advanced use cases, refer to the --nic parameter.

--hint <key=value>

Hints for the scheduler (optional extension)

--config-drive <config-drive-volume>

True

Use specified volume as the config drive, or true to use an ephemeral drive

--min <count>

Minimum number of servers to launch (default=1)

--max <count>

Maximum number of servers to launch (default=1)

--wait

Table 72.21. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.24. 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.

72.9. server delete

Delete server(s)

Usage:

openstack server delete [-h] [--wait] <server> [<server> ...]

Table 72.25. Positional Arguments

ValueSummary

<server>

Server(s) to delete (name or id)

Table 72.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for delete to complete

72.10. server dump create

Create a dump file in server(s) Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)' memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource.

Usage:

openstack server dump create [-h] <server> [<server> ...]

Table 72.27. Positional Arguments

ValueSummary

<server>

Server(s) to create dump file (name or id)

Table 72.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.11. server event list

List recent events of a server

Usage:

openstack server event 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]
                                   <server>

Table 72.29. Positional Arguments

ValueSummary

<server>

Server to list events (name or id)

Table 72.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 72.31. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 72.32. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 72.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.34. 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.

72.12. server event show

Show server event details. Specify ``--os-compute-api-version 2.51`` or higher to show events for non-admin users.

Usage:

openstack server event show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server> <request-id>

Table 72.35. Positional Arguments

ValueSummary

<server>

Server to show event details (name or id)

<request-id>

Request id of the event to show (id only)

Table 72.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 72.37. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.38. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.39. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.40. 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.

72.13. server group create

Create a new server group.

Usage:

openstack server group create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--policy <policy>]
                                     <name>

Table 72.41. Positional Arguments

ValueSummary

<name>

New server group name

Table 72.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--policy <policy>

Add a policy to <name> (affinity or anti-affinity, defaults to affinity). Specify --os-compute-api- version 2.15 or higher for the soft-affinity or soft-anti-affinity policy.

Table 72.43. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.45. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.46. 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.

72.14. server group delete

Delete existing server group(s).

Usage:

openstack server group delete [-h] <server-group> [<server-group> ...]

Table 72.47. Positional Arguments

ValueSummary

<server-group>

Server group(s) to delete (name or id)

Table 72.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.15. server group list

List all server groups.

Usage:

openstack server 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]
                                   [--all-projects] [--long]

Table 72.49. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Display information from all projects (admin only)

--long

List additional fields in output

Table 72.50. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 72.51. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 72.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.53. 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.

72.16. server group show

Display server group details.

Usage:

openstack server group show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server-group>

Table 72.54. Positional Arguments

ValueSummary

<server-group>

Server group to display (name or id)

Table 72.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 72.56. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.58. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.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.

72.17. server image create

Create a new server disk image from an existing server

Usage:

openstack server image create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <image-name>] [--wait]
                                     <server>

Table 72.60. Positional Arguments

ValueSummary

<server>

Server to create image (name or id)

Table 72.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <image-name>

Name of new disk image (default: server name)

--wait

Wait for operation to complete

Table 72.62. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.64. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.65. 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.

72.18. server list

List servers

Usage:

openstack server 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]
                             [--reservation-id <reservation-id>]
                             [--ip <ip-address-regex>]
                             [--ip6 <ip-address-regex>] [--name <name-regex>]
                             [--instance-name <server-name>]
                             [--status <status>] [--flavor <flavor>]
                             [--image <image>] [--host <hostname>]
                             [--all-projects] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--long] [-n | --name-lookup-one-by-one]
                             [--marker <server>] [--limit <num-servers>]
                             [--deleted] [--changes-since <changes-since>]

Table 72.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reservation-id <reservation-id>

Only return instances that match the reservation

--ip <ip-address-regex>

Regular expression to match ip addresses

--ip6 <ip-address-regex>

Regular expression to match ipv6 addresses. note that this option only applies for non-admin users when using ``--os-compute-api-version`` 2.5 or greater.

--name <name-regex>

Regular expression to match names

--instance-name <server-name>

Regular expression to match instance name (admin only)

--status <status>

Search by server status

--flavor <flavor>

Search by flavor (name or id)

--image <image>

Search by image (name or id)

--host <hostname>

Search by hostname

--all-projects

Include all projects (admin only)

--project <project>

Search by project (admin only) (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.

--user <user>

Search by user (admin only) (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.

--long

List additional fields in output

-n, --no-name-lookup

Skip flavor and image name lookup.mutually exclusive with "--name-lookup-one-by-one" option.

--name-lookup-one-by-one

When looking up flavor and image names, look them upone by one as needed instead of all together (default). Mutually exclusive with "--no-name- lookup

-n" option.

--marker <server>

The last server of the previous page. display list of servers after marker. Display all servers if not specified. (name or ID)

--limit <num-servers>

Maximum number of servers to display. if limit equals -1, all servers will be displayed. If limit is greater than osapi_max_limit option of Nova API, osapi_max_limit will be used instead.

--deleted

Only display deleted servers (admin only).

--changes-since <changes-since>

Table 72.67. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 72.68. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 72.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.70. 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.

72.19. server lock

Lock server(s). A non-admin user will not be able to execute actions

Usage:

openstack server lock [-h] <server> [<server> ...]

Table 72.71. Positional Arguments

ValueSummary

<server>

Server(s) to lock (name or id)

Table 72.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.20. server migrate

Migrate server to different host

Usage:

openstack server migrate [-h] [--live <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

Table 72.73. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--live <hostname>

Target hostname

--shared-migration

Perform a shared live migration (default)

--block-migration

Perform a block live migration

--disk-overcommit

Allow disk over-commit on the destination host

--no-disk-overcommit

Do not over-commit disk on the destination host (default)

--wait

Wait for migrate to complete

72.21. server pause

Pause server(s)

Usage:

openstack server pause [-h] <server> [<server> ...]

Table 72.75. Positional Arguments

ValueSummary

<server>

Server(s) to pause (name or id)

Table 72.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.22. server reboot

Perform a hard or soft server reboot

Usage:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

Table 72.77. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--hard

Perform a hard reboot

--soft

Perform a soft reboot

--wait

Wait for reboot to complete

72.23. server rebuild

Rebuild server

Usage:

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--image <image>]
                                [--password <password>]
                                [--property <key=value>] [--wait]
                                [--key-name <key-name> | --key-unset]
                                <server>

Table 72.79. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--image <image>

Recreate server from the specified image (name or id). Defaults to the currently used one.

--password <password>

Set the password on the rebuilt instance

--property <key=value>

Set a property on the rebuilt instance (repeat option to set multiple values)

--wait

Wait for rebuild to complete

--key-name <key-name>

Set the key name of key pair on the rebuilt instance. Cannot be specified with the --key-unset option. (Supported by API versions 2.54 - 2.latest)

--key-unset

Unset the key name of key pair on the rebuilt instance. Cannot be specified with the --key-name option. (Supported by API versions 2.54 - 2.latest)

Table 72.81. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.83. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.84. 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.

72.24. server remove fixed ip

Remove fixed IP address from server

Usage:

openstack server remove fixed ip [-h] <server> <ip-address>

Table 72.85. Positional Arguments

ValueSummary

<server>

Server to remove the fixed ip address from (name or id)

<ip-address>

Fixed ip address to remove from the server (ip only)

Table 72.86. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.25. server remove floating ip

Remove floating IP address from server

Usage:

openstack server remove floating ip [-h] <server> <ip-address>

Table 72.87. Positional Arguments

ValueSummary

<server>

Server to remove the floating ip address from (name or id)

<ip-address>

Floating ip address to remove from server (ip only)

Table 72.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.26. server remove network

Remove all ports of a network from server

Usage:

openstack server remove network [-h] <server> <network>

Table 72.89. Positional Arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<network>

Network to remove from the server (name or id)

Table 72.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.27. server remove port

Remove port from server

Usage:

openstack server remove port [-h] <server> <port>

Table 72.91. Positional Arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<port>

Port to remove from the server (name or id)

Table 72.92. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.28. server remove security group

Remove security group from server

Usage:

openstack server remove security group [-h] <server> <group>

Table 72.93. Positional Arguments

ValueSummary

<server>

Name or id of server to use

<group>

Name or id of security group to remove from server

Table 72.94. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.29. server remove volume

Remove volume from server

Usage:

openstack server remove volume [-h] <server> <volume>

Table 72.95. Positional Arguments

ValueSummary

<server>

Server (name or id)

<volume>

Volume to remove (name or id)

Table 72.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.30. server rescue

Put server in rescue mode

Usage:

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

Table 72.97. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.98. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--image <image>

Image (name or id) to use for the rescue mode. Defaults to the currently used one.

--password <password>

Set the password on the rescued instance

72.31. server resize

Scale server to a new flavor. A resize operation is implemented by creating a new server and copying the contents of the original disk into a new one. It is also a two-step process for the user: the first is to perform the resize, the second is to either confirm (verify) success and release the old server, or to declare a revert to release the new server and restart the old one.

Usage:

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

Table 72.99. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.100. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--flavor <flavor>

Resize server to specified flavor

--confirm

Confirm server resize is complete

--revert

Restore server state before resize

--wait

Wait for resize to complete

72.32. server restore

Restore server(s)

Usage:

openstack server restore [-h] <server> [<server> ...]

Table 72.101. Positional Arguments

ValueSummary

<server>

Server(s) to restore (name or id)

Table 72.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.33. server resume

Resume server(s)

Usage:

openstack server resume [-h] <server> [<server> ...]

Table 72.103. Positional Arguments

ValueSummary

<server>

Server(s) to resume (name or id)

Table 72.104. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.34. server set

Set server properties

Usage:

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            <server>

Table 72.105. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.106. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <new-name>

New server name

--root-password

Set new root password (interactive only)

--property <key=value>

Property to add/change for this server (repeat option to set multiple properties)

--state <state>

New server state (valid value: active, error)

72.35. server shelve

Shelve server(s)

Usage:

openstack server shelve [-h] <server> [<server> ...]

Table 72.107. Positional Arguments

ValueSummary

<server>

Server(s) to shelve (name or id)

Table 72.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.36. server show

Show server details. Specify ``--os-compute-api-version 2.47`` or higher to see the embedded flavor information for the server.

Usage:

openstack server show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--diagnostics]
                             <server>

Table 72.109. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.110. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--diagnostics

Display server diagnostics information

Table 72.111. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 72.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.113. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 72.114. 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.

72.37. server ssh

SSH to server

Usage:

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

Table 72.115. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--login <login-name>

Login name (ssh -l option)

--port <port>

Destination port (ssh -p option)

--identity <keyfile>

Private key file (ssh -i option)

--option <config-options>

Options in ssh_config(5) format (ssh -o option)

-4

Use only ipv4 addresses

-6

Use only ipv6 addresses

--public

Use public ip address

--private

Use private ip address

--address-type <address-type>

Use other ip address (public, private, etc)

72.38. server start

Start server(s).

Usage:

openstack server start [-h] <server> [<server> ...]

Table 72.117. Positional Arguments

ValueSummary

<server>

Server(s) to start (name or id)

Table 72.118. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.39. server stop

Stop server(s).

Usage:

openstack server stop [-h] <server> [<server> ...]

Table 72.119. Positional Arguments

ValueSummary

<server>

Server(s) to stop (name or id)

Table 72.120. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.40. server suspend

Suspend server(s)

Usage:

openstack server suspend [-h] <server> [<server> ...]

Table 72.121. Positional Arguments

ValueSummary

<server>

Server(s) to suspend (name or id)

Table 72.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.41. server unlock

Unlock server(s)

Usage:

openstack server unlock [-h] <server> [<server> ...]

Table 72.123. Positional Arguments

ValueSummary

<server>

Server(s) to unlock (name or id)

Table 72.124. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.42. server unpause

Unpause server(s)

Usage:

openstack server unpause [-h] <server> [<server> ...]

Table 72.125. Positional Arguments

ValueSummary

<server>

Server(s) to unpause (name or id)

Table 72.126. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.43. server unrescue

Restore server from rescue mode

Usage:

openstack server unrescue [-h] <server>

Table 72.127. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

72.44. server unset

Unset server properties

Usage:

openstack server unset [-h] [--property <key>] <server>

Table 72.129. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 72.130. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property key to remove from server (repeat option to remove multiple values)

72.45. server unshelve

Unshelve server(s)

Usage:

openstack server unshelve [-h] <server> [<server> ...]

Table 72.131. Positional Arguments

ValueSummary

<server>

Server(s) to unshelve (name or id)

Table 72.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 73. service

This chapter describes the commands under the service command.

73.1. service create

Create new service

Usage:

openstack service create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--name <name>]
                                [--description <description>]
                                [--enable | --disable]
                                <type>

Table 73.1. Positional Arguments

ValueSummary

<type>

New service type (compute, image, identity, volume, etc)

Table 73.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New service name

--description <description>

New service description

--enable

Enable service (default)

--disable

Disable service

Table 73.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 73.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.

73.2. service delete

Delete service(s)

Usage:

openstack service delete [-h] <service> [<service> ...]

Table 73.7. Positional Arguments

ValueSummary

<service>

Service(s) to delete (type, name or id)

Table 73.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

73.3. service list

List services

Usage:

openstack service 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]

Table 73.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 73.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 73.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.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.

73.4. service provider create

Create new service provider

Usage:

openstack service provider create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty] --auth-url <auth-url>
                                         [--description <description>]
                                         --service-provider-url <sp-url>
                                         [--enable | --disable]
                                         <name>

Table 73.14. Positional Arguments

ValueSummary

<name>

New service provider name (must be unique)

Table 73.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--auth-url <auth-url>

Authentication url of remote federated service provider (required)

--description <description>

New service provider description

--service-provider-url <sp-url>

A service url where saml assertions are being sent (required)

--enable

Enable the service provider (default)

--disable

Disable the service provider

Table 73.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 73.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.

73.5. service provider delete

Delete service provider(s)

Usage:

openstack service provider delete [-h]
                                         <service-provider>
                                         [<service-provider> ...]

Table 73.20. Positional Arguments

ValueSummary

<service-provider>

Service provider(s) to delete

Table 73.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

73.6. service provider list

List service providers

Usage:

openstack service provider 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]

Table 73.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 73.23. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 73.24. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 73.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.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.

73.7. service provider set

Set service provider properties

Usage:

openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>

Table 73.27. Positional Arguments

ValueSummary

<service-provider>

Service provider to modify

Table 73.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--auth-url <auth-url>

New authentication url of remote federated service provider

--description <description>

New service provider description

--service-provider-url <sp-url>

New service provider url, where saml assertions are sent

--enable

Enable the service provider

--disable

Disable the service provider

73.8. service provider show

Display service provider details

Usage:

openstack service provider show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <service-provider>

Table 73.29. Positional Arguments

ValueSummary

<service-provider>

Service provider to display

Table 73.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 73.31. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 73.34. 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.

73.9. service set

Set service properties

Usage:

openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>

Table 73.35. Positional Arguments

ValueSummary

<service>

Service to modify (type, name or id)

Table 73.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New service type (compute, image, identity, volume, etc)

--name <service-name>

New service name

--description <description>

New service description

--enable

Enable service

--disable

Disable service

73.10. service show

Display service details

Usage:

openstack service show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

Table 73.37. Positional Arguments

ValueSummary

<service>

Service to display (type, name or id)

Table 73.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 73.39. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 73.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 73.41. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 73.42. 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 74. sfc

This chapter describes the commands under the sfc command.

74.1. sfc flow classifier create

Create a flow classifier

Usage:

openstack sfc flow classifier create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--protocol <protocol>]
                                            [--ethertype {IPv4,IPv6}]
                                            [--source-port <min-port>:<max-port>]
                                            [--destination-port <min-port>:<max-port>]
                                            [--source-ip-prefix <source-ip-prefix>]
                                            [--destination-ip-prefix <destination-ip-prefix>]
                                            [--logical-source-port <logical-source-port>]
                                            [--logical-destination-port <logical-destination-port>]
                                            [--l7-parameters L7_PARAMETERS]
                                            <name>

Table 74.1. Positional Arguments

ValueSummary

<name>

Name of the flow classifier

Table 74.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the flow classifier

--protocol <protocol>

Ip protocol name. protocol name should be as per iana standard.

--ethertype {IPv4,IPv6}

L2 ethertype, default is ipv4

--source-port <min-port>:<max-port>

Source protocol port (allowed range [1,65535]. must be specified as a:b, where a=min-port and b=max-port) in the allowed range.

--destination-port <min-port>:<max-port>

Destination protocol port (allowed range [1,65535]. Must be specified as a:b, where a=min-port and b=max- port) in the allowed range.

--source-ip-prefix <source-ip-prefix>

Source ip address in cidr notation

--destination-ip-prefix <destination-ip-prefix>

Destination ip address in cidr notation

--logical-source-port <logical-source-port>

Neutron source port (name or id)

--logical-destination-port <logical-destination-port>

Neutron destination port (name or id)

--l7-parameters L7_PARAMETERS

Dictionary of l7 parameters. currently, no value is supported for this option.

Table 74.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.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.

74.2. sfc flow classifier delete

Delete a given flow classifier

Usage:

openstack sfc flow classifier delete [-h] <flow-classifier>

Table 74.7. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to delete (name or id)

Table 74.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.3. sfc flow classifier list

List flow classifiers

Usage:

openstack sfc flow classifier 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]

Table 74.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 74.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.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.

74.4. sfc flow classifier set

Set flow classifier properties

Usage:

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

Table 74.14. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to modify (name or id)

Table 74.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the flow classifier

--description <description>

Description for the flow classifier

74.5. sfc flow classifier show

Display flow classifier details

Usage:

openstack sfc flow classifier show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <flow-classifier>

Table 74.16. Positional Arguments

ValueSummary

<flow-classifier>

Flow classifier to display (name or id)

Table 74.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.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.

74.6. sfc port chain create

Create a port chain

Usage:

openstack sfc port chain create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--description <description>]
                                       [--flow-classifier <flow-classifier>]
                                       [--chain-parameters correlation=<correlation-type>,symmetric=<boolean>]
                                       --port-pair-group <port-pair-group>
                                       <name>

Table 74.22. Positional Arguments

ValueSummary

<name>

Name of the port chain

Table 74.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port chain

--flow-classifier <flow-classifier>

Add flow classifier (name or id). this option can be repeated.

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

Dictionary of chain parameters. supports correlation=(mpls

nsh) (default is mpls) and symmetric=(true

false).

--port-pair-group <port-pair-group>

Add port pair group (name or id). this option can be repeated.

Table 74.24. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.26. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.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.

74.7. sfc port chain delete

Delete a given port chain

Usage:

openstack sfc port chain delete [-h] <port-chain>

Table 74.28. Positional Arguments

ValueSummary

<port-chain>

Port chain to delete (name or id)

Table 74.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.8. sfc port chain list

List port chains

Usage:

openstack sfc port chain 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]

Table 74.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.31. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 74.32. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.34. 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.

74.9. sfc port chain set

Set port chain properties

Usage:

openstack sfc port chain set [-h] [--name <name>]
                                    [--description <description>]
                                    [--flow-classifier <flow-classifier>]
                                    [--no-flow-classifier]
                                    [--port-pair-group <port-pair-group>]
                                    [--no-port-pair-group]
                                    <port-chain>

Table 74.35. Positional Arguments

ValueSummary

<port-chain>

Port chain to modify (name or id)

Table 74.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port chain

--description <description>

Description for the port chain

--flow-classifier <flow-classifier>

Add flow classifier (name or id). this option can be repeated.

--no-flow-classifier

Remove associated flow classifiers from the port chain

--port-pair-group <port-pair-group>

Add port pair group (name or id). current port pair groups order is kept, the added port pair group will be placed at the end of the port chain. This option can be repeated.

--no-port-pair-group

Remove associated port pair groups from the port chain. At least one --port-pair-group must be specified together.

74.10. sfc port chain show

Display port chain details

Usage:

openstack sfc port chain show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <port-chain>

Table 74.37. Positional Arguments

ValueSummary

<port-chain>

Port chain to display (name or id)

Table 74.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.39. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.41. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.42. 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.

74.11. sfc port chain unset

Unset port chain properties

Usage:

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

Table 74.43. Positional Arguments

ValueSummary

<port-chain>

Port chain to unset (name or id)

Table 74.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--flow-classifier <flow-classifier>

Remove flow classifier(s) from the port chain (name or ID). This option can be repeated.

--all-flow-classifier

Remove all flow classifiers from the port chain

--port-pair-group <port-pair-group>

Remove port pair group(s) from the port chain (name or ID). This option can be repeated.

74.12. sfc port pair create

Create a port pair

Usage:

openstack sfc port pair create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--description <description>]
                                      [--service-function-parameters correlation=<correlation-type>,weight=<weight>]
                                      --ingress <ingress> --egress <egress>
                                      <name>

Table 74.45. Positional Arguments

ValueSummary

<name>

Name of the port pair

Table 74.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port pair

--service-function-parameters correlation=<correlation-type>,weight=<weight>

Dictionary of service function parameters. currently, correlation=(None

mpls

nsh) and weight are supported. Weight is an integer that influences the selection of a port pair within a port pair group for a flow. The higher the weight, the more flows will hash to the port pair. The default weight is 1.

--ingress <ingress>

Ingress neutron port (name or id)

--egress <egress>

Egress neutron port (name or id)

Table 74.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.49. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.50. 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.

74.13. sfc port pair delete

Delete a given port pair

Usage:

openstack sfc port pair delete [-h] <port-pair>

Table 74.51. Positional Arguments

ValueSummary

<port-pair>

Port pair to delete (name or id)

Table 74.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.14. sfc port pair group create

Create a port pair group

Usage:

openstack sfc port pair group create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--description <description>]
                                            [--port-pair <port-pair>]
                                            [--enable-tap | --disable-tap]
                                            [--port-pair-group-parameters lb-fields=<lb-fields>]
                                            <name>

Table 74.53. Positional Arguments

ValueSummary

<name>

Name of the port pair group

Table 74.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the port pair group

--port-pair <port-pair>

Port pair (name or id). this option can be repeated.

--enable-tap

Port pairs of this port pair group are deployed as passive tap service function

--disable-tap

Port pairs of this port pair group are deployed as l3 service function (default)

--port-pair-group-parameters lb-fields=<lb-fields>

Dictionary of port pair group parameters. currently only one parameter lb-fields is supported. <lb-fields> is a & separated list of load-balancing fields.

Table 74.55. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.56. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.57. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.58. 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.

74.15. sfc port pair group delete

Delete a given port pair group

Usage:

openstack sfc port pair group delete [-h] <port-pair-group>

Table 74.59. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to delete (name or id)

Table 74.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.16. sfc port pair group list

List port pair group

Usage:

openstack sfc port pair 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] [--long]

Table 74.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.62. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 74.63. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.65. 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.

74.17. sfc port pair group set

Set port pair group properties

Usage:

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

Table 74.66. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to modify (name or id)

Table 74.67. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port pair group

--description <description>

Description for the port pair group

--port-pair <port-pair>

Port pair (name or id). this option can be repeated.

--no-port-pair

Remove all port pair from port pair group

74.18. sfc port pair group show

Display port pair group details

Usage:

openstack sfc port pair group show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          <port-pair-group>

Table 74.68. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to display (name or id)

Table 74.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.70. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.72. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.73. 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.

74.19. sfc port pair group unset

Unset port pairs from port pair group

Usage:

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

Table 74.74. Positional Arguments

ValueSummary

<port-pair-group>

Port pair group to unset (name or id)

Table 74.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--port-pair <port-pair>

Remove port pair(s) from the port pair group (name or ID). This option can be repeated.

--all-port-pair

Remove all port pairs from the port pair group

74.20. sfc port pair list

List port pairs

Usage:

openstack sfc port pair 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]

Table 74.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.77. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 74.78. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.79. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.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.

74.21. sfc port pair set

Set port pair properties

Usage:

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

Table 74.81. Positional Arguments

ValueSummary

<port-pair>

Port pair to modify (name or id)

Table 74.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the port pair

--description <description>

Description for the port pair

74.22. sfc port pair show

Display port pair details

Usage:

openstack sfc port pair show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <port-pair>

Table 74.83. Positional Arguments

ValueSummary

<port-pair>

Port pair to display (name or id)

Table 74.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.85. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.87. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.88. 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.

74.23. sfc service graph create

Create a service graph.

Usage:

openstack sfc service graph create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--description DESCRIPTION]
                                          --branching-point
                                          SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N
                                          <name>

Table 74.89. Positional Arguments

ValueSummary

<name>

Name of the service graph.

Table 74.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description for the service graph.

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

Service graph branching point: the key is the source Port Chain while the value is a list of destination Port Chains. This option can be repeated.

Table 74.91. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.92. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.93. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.94. 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.

74.24. sfc service graph delete

Delete a given service graph.

Usage:

openstack sfc service graph delete [-h] <service-graph>

Table 74.95. Positional Arguments

ValueSummary

<service-graph>

Id or name of the service graph to delete.

Table 74.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

74.25. sfc service graph list

List service graphs

Usage:

openstack sfc service graph 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]

Table 74.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 74.98. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 74.99. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 74.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.101. 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.

74.26. sfc service graph set

Set service graph properties

Usage:

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

Table 74.102. Positional Arguments

ValueSummary

<service-graph>

Service graph to modify (name or id)

Table 74.103. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the service graph

--description <description>

Description for the service graph

74.27. sfc service graph show

Show information of a given service graph.

Usage:

openstack sfc service graph show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <service-graph>

Table 74.104. Positional Arguments

ValueSummary

<service-graph>

Id or name of the service graph to display.

Table 74.105. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 74.106. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 74.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 74.108. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 74.109. 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 75. snapshot

This chapter describes the commands under the snapshot command.

75.1. snapshot create

Create new snapshot

Usage:

openstack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <name>]
                                 [--description <description>] [--force]
                                 [--property <key=value>]
                                 <volume>

Table 75.1. Positional Arguments

ValueSummary

<volume>

Volume to snapshot (name or id)

Table 75.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the snapshot

--description <description>

Description of the snapshot

--force

Create a snapshot attached to an instance. default is False

--property <key=value>

Set a property to this snapshot (repeat option to set multiple properties)

Table 75.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 75.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 75.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.

75.2. snapshot delete

Delete volume snapshot(s)

Usage:

openstack snapshot delete [-h] <snapshot> [<snapshot> ...]

Table 75.7. Positional Arguments

ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 75.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

75.3. snapshot list

List snapshots

Usage:

openstack snapshot 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] [--all-projects]
                               [--long] [--marker <snapshot>]
                               [--limit <num-snapshots>]

Table 75.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--marker <snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

Table 75.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 75.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 75.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.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.

75.4. snapshot set

Set snapshot properties

Usage:

openstack snapshot set [-h] [--name <name>]
                              [--description <description>]
                              [--property <key=value>] [--state <state>]
                              <snapshot>

Table 75.14. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 75.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New snapshot name

--description <description>

New snapshot description

--property <key=value>

Property to add/change for this snapshot (repeat option to set multiple properties)

--state <state>

New snapshot state. ("available", "error", "creating", "deleting", or "error_deleting") (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using)

75.5. snapshot show

Display snapshot details

Usage:

openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <snapshot>

Table 75.16. Positional Arguments

ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 75.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 75.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 75.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 75.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 75.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.

75.6. snapshot unset

Unset snapshot properties

Usage:

openstack snapshot unset [-h] [--property <key>] <snapshot>

Table 75.22. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 75.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from snapshot (repeat option to remove multiple properties)

Chapter 76. software

This chapter describes the commands under the software command.

76.1. software config create

Create software config

Usage:

openstack software config create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>

Table 76.1. Positional Arguments

ValueSummary

<config-name>

Name of the software config to create

Table 76.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-file <config-file>

Path to json/yaml containing map defining <inputs>, <outputs>, and <options>

--definition-file <destination-file>

Path to software config script/data

--group <group>

Group name of tool expected by the software config

Table 76.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 76.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 76.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.

76.2. software config delete

Delete software configs

Usage:

openstack software config delete [-h] <config> [<config> ...]

Table 76.7. Positional Arguments

ValueSummary

<config>

Ids of the software configs to delete

Table 76.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

76.3. software config list

List software configs

Usage:

openstack software config 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 <id>]

Table 76.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of configs returned

--marker <id>

Return configs that appear after the given config id

Table 76.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 76.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.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.

76.4. software config show

Show software config details

Usage:

openstack software config show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--config-only]
                                      <config>

Table 76.14. Positional Arguments

ValueSummary

<config>

Id of the config

Table 76.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-only

Only display the value of the <config> property.

Table 76.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 76.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 76.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.

76.5. software deployment create

Create a software deployment.

Usage:

openstack software deployment create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>]
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>] --server
                                            <server>
                                            <deployment-name>

Table 76.20. Positional Arguments

ValueSummary

<deployment-name>

Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to the server.

Table 76.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--input-value <key=value>

Input value to set on the deployment. this can be specified multiple times.

--action <action>

Name of an action for this deployment. this can be a custom action, or one of CREATE, UPDATE, DELETE, SUSPEND, RESUME. Default is UPDATE

--config <config>

Id of the configuration to deploy

--signal-transport <signal-transport>

How the server should signal to heat with the deployment output values. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials.NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal

--container <container>

Optional name of container to store temp_url_signal objects in. If not specified a container will be created with a name derived from the DEPLOY_NAME

--timeout <timeout>

Deployment timeout in minutes

--server <server>

Id of the server being deployed to

Table 76.22. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 76.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 76.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.

76.6. software deployment delete

Delete software deployment(s) and correlative config(s).

Usage:

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

Table 76.26. Positional Arguments

ValueSummary

<deployment>

Id of the deployment(s) to delete.

Table 76.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

76.7. software deployment list

List software deployments.

Usage:

openstack software deployment 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]
                                          [--server <server>] [--long]

Table 76.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--server <server>

Id of the server to fetch deployments for

--long

List more fields in output

Table 76.29. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 76.30. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 76.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.32. 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.

76.8. software deployment metadata show

Get deployment configuration metadata for the specified server.

Usage:

openstack software deployment metadata show [-h] <server>

Table 76.33. Positional Arguments

ValueSummary

<server>

Id of the server to fetch deployments for

Table 76.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

76.9. software deployment output show

Show a specific deployment output.

Usage:

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

Table 76.35. Positional Arguments

ValueSummary

<deployment>

Id of deployment to show the output for

<output-name>

Name of an output to display

Table 76.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all deployment outputs

--long

Show full deployment logs in output

76.10. software deployment show

Show SoftwareDeployment Details.

Usage:

openstack software deployment show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--long]
                                          <deployment>

Table 76.37. Positional Arguments

ValueSummary

<deployment>

Id of the deployment

Table 76.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show more fields in output

Table 76.39. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 76.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 76.41. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 76.42. 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 77. stack

This chapter describes the commands under the stack command.

77.1. stack abandon

Abandon stack and output results.

Usage:

openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--output-file <output-file>]
                               <stack>

Table 77.1. Positional Arguments

ValueSummary

<stack>

Name or id of stack to abandon

Table 77.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output abandon results

Table 77.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.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.

77.2. stack adopt

Adopt a stack.

Usage:

openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [-e <environment>]
                             [--timeout <timeout>] [--enable-rollback]
                             [--parameter <key=value>] [--wait] --adopt-file
                             <adopt-file>
                             <stack-name>

Table 77.7. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to adopt

Table 77.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--timeout <timeout>

Stack creation timeout in minutes

--enable-rollback

Enable rollback on create/update failure

--parameter <key=value>

Parameter values used to create the stack. can be specified multiple times

--wait

Wait until stack adopt completes

--adopt-file <adopt-file>

Path to adopt stack data file

Table 77.9. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.11. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.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.

77.3. stack cancel

Cancel current task for a stack. Supported tasks for cancellation: * update * create

Usage:

openstack stack cancel [-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]
                              [--no-rollback]
                              <stack> [<stack> ...]

Table 77.13. Positional Arguments

ValueSummary

<stack>

Stack(s) to cancel (name or id)

Table 77.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for cancel to complete

--no-rollback

Cancel without rollback

Table 77.15. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.16. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.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.

77.4. stack check

Check a stack.

Usage:

openstack stack check [-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]
                             <stack> [<stack> ...]

Table 77.19. Positional Arguments

ValueSummary

<stack>

Stack(s) to check update (name or id)

Table 77.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for check to complete

Table 77.21. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.22. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.24. 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.

77.5. stack create

Create a stack.

Usage:

openstack stack create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-e <environment>]
                              [--timeout <timeout>] [--pre-create <resource>]
                              [--enable-rollback] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run] -t
                              <template>
                              <stack-name>

Table 77.25. Positional Arguments

ValueSummary

<stack-name>

Name of the stack to create

Table 77.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--timeout <timeout>

Stack creating timeout in minutes

--pre-create <resource>

Name of a resource to set a pre-create hook to. Resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``. This can be specified multiple times

--enable-rollback

Enable rollback on create/update failure

--parameter <key=value>

Parameter values used to create the stack. this can be specified multiple times

--parameter-file <key=file>

Parameter values from file used to create the stack. This can be specified multiple times. Parameter values would be the content of the file

--wait

Wait until stack goes to create_complete or CREATE_FAILED

--tags <tag1,tag2…​>

A list of tags to associate with the stack

--dry-run

Do not actually perform the stack create, but show what would be created

-t <template>, --template <template>

Path to the template

Table 77.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.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.

77.6. stack delete

Delete stack(s).

Usage:

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

Table 77.31. Positional Arguments

ValueSummary

<stack>

Stack(s) to delete (name or id)

Table 77.32. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

--wait

Wait for stack delete to complete

77.7. stack environment show

Show a stack’s environment.

Usage:

openstack stack environment show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <NAME or ID>

Table 77.33. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 77.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.35. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.37. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.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.

77.8. stack event list

List events.

Usage:

openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>

Table 77.39. Positional Arguments

ValueSummary

<stack>

Name or id of stack to show events for

Table 77.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource <resource>

Name of resource to show events for. note: this cannot be specified with --nested-depth

--filter <key=value>

Filter parameters to apply on returned events

--limit <limit>

Limit the number of events returned

--marker <id>

Only return events that appear after the given id

--nested-depth <depth>

Depth of nested stacks from which to display events. Note: this cannot be specified with --resource

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple keys. Sort key can be: "event_time" (default), "resource_name", "links", "logical_resource_id", "resource_status", "resource_status_reason", "physical_resource_id", or "id". You can leave the key empty and specify ":desc" for sorting by reverse time.

--follow

Print events until process is halted

Table 77.41. Output Formatters

ValueSummary

output formatter options-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

The output format, defaults to log

-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 77.42. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.44. 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.

77.9. stack event show

Show event details.

Usage:

openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <stack> <resource> <event>

Table 77.45. Positional Arguments

ValueSummary

<stack>

Name or id of stack to show events for

<resource>

Name of the resource event belongs to

<event>

Id of event to display details for

Table 77.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.49. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.50. 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.

77.10. stack export

Export stack data json.

Usage:

openstack stack export [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--output-file <output-file>]
                              <stack>

Table 77.51. Positional Arguments

ValueSummary

<stack>

Name or id of stack to export

Table 77.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-file <output-file>

File to output export data

Table 77.53. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.55. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.56. 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.

77.11. stack failures list

Show information about failed stack resources.

Usage:

openstack stack failures list [-h] [--long] <stack>

Table 77.57. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 77.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show full deployment logs in output

77.12. stack file list

Show a stack’s files map.

Usage:

openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <NAME or ID>

Table 77.59. Positional Arguments

ValueSummary

<NAME or ID>

Name or id of stack to query

Table 77.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.61. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.62. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.63. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.64. 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.

77.13. stack hook clear

Clear resource hooks on a given stack.

Usage:

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

Table 77.65. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

<resource>

Resource names with hooks to clear. resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``

Table 77.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pre-create

Clear the pre-create hooks

--pre-update

Clear the pre-update hooks

--pre-delete

Clear the pre-delete hooks

77.14. stack hook poll

List resources with pending hook for a stack.

Usage:

openstack stack hook poll [-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]
                                 [--nested-depth <nested-depth>]
                                 <stack>

Table 77.67. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 77.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--nested-depth <nested-depth>

Depth of nested stacks from which to display hooks

Table 77.69. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.70. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.71. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.72. 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.

77.15. stack list

List stacks.

Usage:

openstack stack 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]
                            [--deleted] [--nested] [--hidden]
                            [--property <key=value>] [--tags <tag1,tag2...>]
                            [--tag-mode <mode>] [--limit <limit>]
                            [--marker <id>] [--sort <key>[:<direction>]]
                            [--all-projects] [--short] [--long]

Table 77.73. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--deleted

Include soft-deleted stacks in the stack listing

--nested

Include nested stacks in the stack listing

--hidden

Include hidden stacks in the stack listing

--property <key=value>

Filter properties to apply on returned stacks (repeat to filter on multiple properties)

--tags <tag1,tag2…​>

List of tags to filter by. can be combined with --tag- mode to specify how to filter tags

--tag-mode <mode>

Method of filtering tags. must be one of "any", "not", or "not-any". If not specified, multiple tags will be combined with the boolean AND expression

--limit <limit>

The number of stacks returned

--marker <id>

Only return stacks that appear after the given id

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple properties

--all-projects

Include all projects (admin only)

--short

List fewer fields in output

--long

List additional fields in output, this is implied by --all-projects

Table 77.74. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.75. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.76. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.77. 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.

77.16. stack output list

List stack outputs.

Usage:

openstack stack output 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]
                                   <stack>

Table 77.78. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 77.79. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.80. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.81. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.83. 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.

77.17. stack output show

Show stack output.

Usage:

openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--all]
                                   <stack> [<output>]

Table 77.84. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

<output>

Name of an output to display

Table 77.85. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all stack outputs

Table 77.86. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.87. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.88. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.89. 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.

77.18. stack resource list

List stack resources.

Usage:

openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN] [--long]
                                     [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>

Table 77.90. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 77.91. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Enable detailed information presented for each resource in resource list

-n <nested-depth>, --nested-depth <nested-depth>

Depth of nested stacks from which to display resources

--filter <key=value>

Filter parameters to apply on returned resources based on their name, status, type, action, id and physical_resource_id

Table 77.92. Output Formatters

ValueSummary

output formatter options-f {csv,dot,json,table,value,yaml}, --format {csv,dot,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 77.93. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.95. 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.

77.19. stack resource mark unhealthy

Set resource’s health.

Usage:

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

Table 77.96. Positional Arguments

ValueSummary

<stack>

Name or id of stack the resource belongs to

<resource>

Name of the resource

reason

Reason for state change

Table 77.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reset

Set the resource as healthy

77.20. stack resource metadata

Show resource metadata

Usage:

openstack stack resource metadata [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         <stack> <resource>

Table 77.98. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

<resource>

Name of the resource to show the metadata for

Table 77.99. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.100. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to json

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.101. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.102. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.103. 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.

77.21. stack resource show

Display stack resource.

Usage:

openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--with-attr <attribute>]
                                     <stack> <resource>

Table 77.104. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

<resource>

Name of resource

Table 77.105. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--with-attr <attribute>

Attribute to show, can be specified multiple times

Table 77.106. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.108. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.109. 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.

77.22. stack resource signal

Signal a resource with optional data.

Usage:

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

Table 77.110. Positional Arguments

ValueSummary

<stack>

Name or id of stack the resource belongs to

<resource>

Name of the resoure to signal

Table 77.111. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--data <data>

Json data to send to the signal handler

--data-file <data-file>

File containing json data to send to the signal handler

77.23. stack resume

Resume a stack.

Usage:

openstack stack resume [-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]
                              <stack> [<stack> ...]

Table 77.112. Positional Arguments

ValueSummary

<stack>

Stack(s) to resume (name or id)

Table 77.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for resume to complete

Table 77.114. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.115. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.116. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.117. 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.

77.24. stack show

Show stack details.

Usage:

openstack stack show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--no-resolve-outputs]
                            <stack>

Table 77.118. Positional Arguments

ValueSummary

<stack>

Stack to display (name or id)

Table 77.119. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--no-resolve-outputs

Do not resolve outputs of the stack.

Table 77.120. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.122. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.123. 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.

77.25. stack snapshot create

Create stack snapshot.

Usage:

openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--name <name>]
                                       <stack>

Table 77.124. Positional Arguments

ValueSummary

<stack>

Name or id of stack

Table 77.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of snapshot

Table 77.126. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.127. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.128. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.129. 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.

77.26. stack snapshot delete

Delete stack snapshot.

Usage:

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

Table 77.130. Positional Arguments

ValueSummary

<stack>

Name or id of stack

<snapshot>

Id of stack snapshot

Table 77.131. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes)

77.27. stack snapshot list

List stack snapshots.

Usage:

openstack stack snapshot 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]
                                     <stack>

Table 77.132. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshots

Table 77.133. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.134. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.135. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.136. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.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.

77.28. stack snapshot restore

Restore stack snapshot

Usage:

openstack stack snapshot restore [-h] <stack> <snapshot>

Table 77.138. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to restore

Table 77.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

77.29. stack snapshot show

Show stack snapshot.

Usage:

openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack> <snapshot>

Table 77.140. Positional Arguments

ValueSummary

<stack>

Name or id of stack containing the snapshot

<snapshot>

Id of the snapshot to show

Table 77.141. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.142. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.144. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.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.

77.30. stack suspend

Suspend a stack.

Usage:

openstack stack suspend [-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]
                               <stack> [<stack> ...]

Table 77.146. Positional Arguments

ValueSummary

<stack>

Stack(s) to suspend (name or id)

Table 77.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for suspend to complete

Table 77.148. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 77.149. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 77.150. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.151. 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.

77.31. stack template show

Display stack template.

Usage:

openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     <stack>

Table 77.152. Positional Arguments

ValueSummary

<stack>

Name or id of stack to query

Table 77.153. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 77.154. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to yaml

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.155. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.156. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.157. 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.

77.32. stack update

Update a stack.

Usage:

openstack stack update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--show-nested]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait] [--converge]
                              <stack>

Table 77.158. Positional Arguments

ValueSummary

<stack>

Name or id of stack to update

Table 77.159. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-t <template>, --template <template>

Path to the template

-e <environment>, --environment <environment>

Path to the environment. can be specified multiple times

--pre-update <resource>

Name of a resource to set a pre-update hook to. Resources in nested stacks can be set using slash as a separator: ``nested_stack/another/my_resource``. You can use wildcards to match multiple stacks or resources: ``nested_stack/an*/*_resource``. This can be specified multiple times

--timeout <timeout>

Stack update timeout in minutes

--rollback <value>

Set rollback on update failure. value "enabled" sets rollback to enabled. Value "disabled" sets rollback to disabled. Value "keep" uses the value of existing stack to be updated (default)

--dry-run

Do not actually perform the stack update, but show what would be changed

--show-nested

Show nested stacks when performing --dry-run

--parameter <key=value>

Parameter values used to create the stack. this can be specified multiple times

--parameter-file <key=file>

Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file

--existing

Re-use the template, parameters and environment of the current stack. If the template argument is omitted then the existing template is used. If no --environment is specified then the existing environment is used. Parameters specified in --parameter will patch over the existing values in the current stack. Parameters omitted will keep the existing values

--clear-parameter <parameter>

Remove the parameters from the set of parameters of current stack for the stack-update. The default value in the template will be used. This can be specified multiple times

--tags <tag1,tag2…​>

An updated list of tags to associate with the stack

--wait

Wait until stack goes to update_complete or UPDATE_FAILED

--converge

Stack update with observe on reality.

Table 77.160. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 77.161. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 77.162. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 77.163. 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 78. subnet

This chapter describes the commands under the subnet command.

78.1. subnet create

Create a subnet

Usage:

openstack subnet create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--project <project>]
                               [--project-domain <project-domain>]
                               [--subnet-pool <subnet-pool> | --use-prefix-delegation USE_PREFIX_DELEGATION | --use-default-subnet-pool]
                               [--prefix-length <prefix-length>]
                               [--subnet-range <subnet-range>]
                               [--dhcp | --no-dhcp] [--gateway <gateway>]
                               [--ip-version {4,6}]
                               [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
                               [--network-segment <network-segment>] --network
                               <network> [--description <description>]
                               [--allocation-pool start=<ip-address>,end=<ip-address>]
                               [--dns-nameserver <dns-nameserver>]
                               [--host-route destination=<subnet>,gateway=<ip-address>]
                               [--service-type <service-type>]
                               [--tag <tag> | --no-tag]
                               <name>

Table 78.1. Positional Arguments

ValueSummary

<name>

New subnet name

Table 78.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--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.

--subnet-pool <subnet-pool>

Subnet pool from which this subnet will obtain a cidr (Name or ID)

--use-prefix-delegation USE_PREFIX_DELEGATION

Use prefix-delegation if ip is ipv6 format and ip would be delegated externally

--use-default-subnet-pool

Use default subnet pool for --ip-version

--prefix-length <prefix-length>

Prefix length for subnet allocation from subnet pool

--subnet-range <subnet-range>

Subnet range in cidr notation (required if --subnet- pool is not specified, optional otherwise)

--dhcp

Enable dhcp (default)

--no-dhcp

Disable dhcp

--gateway <gateway>

Specify a gateway for the subnet. the three options are: <ip-address>: Specific IP address to use as the gateway, auto: Gateway address should automatically be chosen from within the subnet itself, none: This subnet will not use a gateway, e.g.: --gateway 192.168.9.1, --gateway auto, --gateway none (default is auto).

--ip-version {4,6}

Ip version (default is 4). note that when subnet pool is specified, IP version is determined from the subnet pool and this option is ignored.

--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 ra (router advertisement) mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]

--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}

Ipv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]

--network-segment <network-segment>

Network segment to associate with this subnet (name or ID)

--network <network>

Network this subnet belongs to (name or id)

--description <description>

Set subnet description

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses for this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to add multiple IP addresses)

--dns-nameserver <dns-nameserver>

Dns server for this subnet (repeat option to set multiple DNS servers)

--host-route destination=<subnet>,gateway=<ip-address>

Additional route for this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to add multiple routes)

--service-type <service-type>

Service type for this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to set multiple service types)

--tag <tag>

Tag to be added to the subnet (repeat option to set multiple tags)

--no-tag

No tags associated with the subnet

Table 78.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 78.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 78.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.

78.2. subnet delete

Delete subnet(s)

Usage:

openstack subnet delete [-h] <subnet> [<subnet> ...]

Table 78.7. Positional Arguments

ValueSummary

<subnet>

Subnet(s) to delete (name or id)

Table 78.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

78.3. subnet list

List subnets

Usage:

openstack subnet 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]
                             [--ip-version <ip-version>] [--dhcp | --no-dhcp]
                             [--service-type <service-type>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--network <network>] [--gateway <gateway>]
                             [--name <name>] [--subnet-range <subnet-range>]
                             [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

Table 78.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--ip-version <ip-version>

List only subnets of given ip version in output. Allowed values for IP version are 4 and 6.

--dhcp

List subnets which have dhcp enabled

--no-dhcp

List subnets which have dhcp disabled

--service-type <service-type>

List only subnets of a given service type in output e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to list multiple service types)

--project <project>

List only subnets which belong to a given project in output (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.

--network <network>

List only subnets which belong to a given network in output (name or ID)

--gateway <gateway>

List only subnets of given gateway ip in output

--name <name>

List only subnets of given name in output

--subnet-range <subnet-range>

List only subnets of given subnet range (in cidr notation) in output e.g.: --subnet-range 10.10.0.0/16

--tags <tag>[,<tag>,…​]

List subnets which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List subnets which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude subnets which have all given tag(s) (comma- separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude subnets which have any given tag(s) (comma- separated list of tags)

Table 78.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 78.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 78.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.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.

78.4. subnet pool create

Create subnet pool

Usage:

openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --pool-prefix
                                    <pool-prefix>
                                    [--default-prefix-length <default-prefix-length>]
                                    [--min-prefix-length <min-prefix-length>]
                                    [--max-prefix-length <max-prefix-length>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--address-scope <address-scope>]
                                    [--default | --no-default]
                                    [--share | --no-share]
                                    [--description <description>]
                                    [--default-quota <num-ip-addresses>]
                                    [--tag <tag> | --no-tag]
                                    <name>

Table 78.14. Positional Arguments

ValueSummary

<name>

Name of the new subnet pool

Table 78.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool-prefix <pool-prefix>

Set subnet pool prefixes (in cidr notation) (repeat option to set multiple prefixes)

--default-prefix-length <default-prefix-length>

Set subnet pool default prefix length

--min-prefix-length <min-prefix-length>

Set subnet pool minimum prefix length

--max-prefix-length <max-prefix-length>

Set subnet pool maximum prefix length

--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.

--address-scope <address-scope>

Set address scope associated with the subnet pool (name or ID), prefixes must be unique across address scopes

--default

Set this as a default subnet pool

--no-default

Set this as a non-default subnet pool

--share

Set this subnet pool as shared

--no-share

Set this subnet pool as not shared

--description <description>

Set subnet pool description

--default-quota <num-ip-addresses>

Set default per-project quota for this subnet pool as the number of IP addresses that can be allocated from the subnet pool

--tag <tag>

Tag to be added to the subnet pool (repeat option to set multiple tags)

--no-tag

No tags associated with the subnet pool

Table 78.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 78.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 78.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.

78.5. subnet pool delete

Delete subnet pool(s)

Usage:

openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]

Table 78.20. Positional Arguments

ValueSummary

<subnet-pool>

Subnet pool(s) to delete (name or id)

Table 78.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

78.6. subnet pool list

List subnet pools

Usage:

openstack subnet pool 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]
                                  [--share | --no-share]
                                  [--default | --no-default]
                                  [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--name <name>]
                                  [--address-scope <address-scope>]
                                  [--tags <tag>[,<tag>,...]]
                                  [--any-tags <tag>[,<tag>,...]]
                                  [--not-tags <tag>[,<tag>,...]]
                                  [--not-any-tags <tag>[,<tag>,...]]

Table 78.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--share

List subnet pools shared between projects

--no-share

List subnet pools not shared between projects

--default

List subnet pools used as the default external subnet pool

--no-default

List subnet pools not used as the default external subnet pool

--project <project>

List subnet pools 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.

--name <name>

List only subnet pools of given name in output

--address-scope <address-scope>

List only subnet pools of given address scope in output (name or ID)

--tags <tag>[,<tag>,…​]

List subnet pools which have all given tag(s) (comma- separated list of tags)

--any-tags <tag>[,<tag>,…​]

List subnet pools which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude subnet pools which have all given tag(s) (Comma-separated list of tags)

--not-any-tags <tag>[,<tag>,…​]

Exclude subnet pools which have any given tag(s) (Comma-separated list of tags)

Table 78.23. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 78.24. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 78.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.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.

78.7. subnet pool set

Set subnet pool properties

Usage:

openstack subnet pool set [-h] [--name <name>]
                                 [--pool-prefix <pool-prefix>]
                                 [--default-prefix-length <default-prefix-length>]
                                 [--min-prefix-length <min-prefix-length>]
                                 [--max-prefix-length <max-prefix-length>]
                                 [--address-scope <address-scope> | --no-address-scope]
                                 [--default | --no-default]
                                 [--description <description>]
                                 [--default-quota <num-ip-addresses>]
                                 [--tag <tag>] [--no-tag]
                                 <subnet-pool>

Table 78.27. Positional Arguments

ValueSummary

<subnet-pool>

Subnet pool to modify (name or id)

Table 78.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set subnet pool name

--pool-prefix <pool-prefix>

Set subnet pool prefixes (in cidr notation) (repeat option to set multiple prefixes)

--default-prefix-length <default-prefix-length>

Set subnet pool default prefix length

--min-prefix-length <min-prefix-length>

Set subnet pool minimum prefix length

--max-prefix-length <max-prefix-length>

Set subnet pool maximum prefix length

--address-scope <address-scope>

Set address scope associated with the subnet pool (name or ID), prefixes must be unique across address scopes

--no-address-scope

Remove address scope associated with the subnet pool

--default

Set this as a default subnet pool

--no-default

Set this as a non-default subnet pool

--description <description>

Set subnet pool description

--default-quota <num-ip-addresses>

Set default per-project quota for this subnet pool as the number of IP addresses that can be allocated from the subnet pool

--tag <tag>

Tag to be added to the subnet pool (repeat option to set multiple tags)

--no-tag

Clear tags associated with the subnet pool. specify both --tag and --no-tag to overwrite current tags

78.8. subnet pool show

Display subnet pool details

Usage:

openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <subnet-pool>

Table 78.29. Positional Arguments

ValueSummary

<subnet-pool>

Subnet pool to display (name or id)

Table 78.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 78.31. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 78.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 78.34. 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.

78.9. subnet pool unset

Unset subnet pool properties

Usage:

openstack subnet pool unset [-h] [--tag <tag> | --all-tag]
                                   <subnet-pool>

Table 78.35. Positional Arguments

ValueSummary

<subnet-pool>

Subnet pool to modify (name or id)

Table 78.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Tag to be removed from the subnet pool (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the subnet pool

78.10. subnet set

Set subnet properties

Usage:

openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp]
                            [--gateway <gateway>]
                            [--network-segment <network-segment>]
                            [--description <description>] [--tag <tag>]
                            [--no-tag]
                            [--allocation-pool start=<ip-address>,end=<ip-address>]
                            [--no-allocation-pool]
                            [--dns-nameserver <dns-nameserver>]
                            [--no-dns-nameservers]
                            [--host-route destination=<subnet>,gateway=<ip-address>]
                            [--no-host-route] [--service-type <service-type>]
                            <subnet>

Table 78.37. Positional Arguments

ValueSummary

<subnet>

Subnet to modify (name or id)

Table 78.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Updated name of the subnet

--dhcp

Enable dhcp

--no-dhcp

Disable dhcp

--gateway <gateway>

Specify a gateway for the subnet. the options are: <ip-address>: Specific IP address to use as the gateway, none: This subnet will not use a gateway, e.g.: --gateway 192.168.9.1, --gateway none.

--network-segment <network-segment>

Network segment to associate with this subnet (name or ID). It is only allowed to set the segment if the current value is None, the network must also have only one segment and only one subnet can exist on the network.

--description <description>

Set subnet description

--tag <tag>

Tag to be added to the subnet (repeat option to set multiple tags)

--no-tag

Clear tags associated with the subnet. specify both --tag and --no-tag to overwrite current tags

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses for this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to add multiple IP addresses)

--no-allocation-pool

Clear associated allocation-pools from the subnet. Specify both --allocation-pool and --no-allocation- pool to overwrite the current allocation pool information.

--dns-nameserver <dns-nameserver>

Dns server for this subnet (repeat option to set multiple DNS servers)

--no-dns-nameservers

Clear existing information of dns nameservers. specify both --dns-nameserver and --no-dns-nameserver to overwrite the current DNS Nameserver information.

--host-route destination=<subnet>,gateway=<ip-address>

Additional route for this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to add multiple routes)

--no-host-route

Clear associated host-routes from the subnet. specify both --host-route and --no-host-route to overwrite the current host route information.

--service-type <service-type>

Service type for this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to set multiple service types)

78.11. subnet show

Display subnet details

Usage:

openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <subnet>

Table 78.39. Positional Arguments

ValueSummary

<subnet>

Subnet to display (name or id)

Table 78.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 78.41. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 78.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 78.43. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 78.44. 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.

78.12. subnet unset

Unset subnet properties

Usage:

openstack subnet unset [-h]
                              [--allocation-pool start=<ip-address>,end=<ip-address>]
                              [--dns-nameserver <dns-nameserver>]
                              [--host-route destination=<subnet>,gateway=<ip-address>]
                              [--service-type <service-type>]
                              [--tag <tag> | --all-tag]
                              <subnet>

Table 78.45. Positional Arguments

ValueSummary

<subnet>

Subnet to modify (name or id)

Table 78.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--allocation-pool start=<ip-address>,end=<ip-address>

Allocation pool ip addresses to be removed from this subnet e.g.: start=192.168.199.2,end=192.168.199.254 (repeat option to unset multiple allocation pools)

--dns-nameserver <dns-nameserver>

Dns server to be removed from this subnet (repeat option to unset multiple DNS servers)

--host-route destination=<subnet>,gateway=<ip-address>

Route to be removed from this subnet e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to unset multiple host routes)

--service-type <service-type>

Service type to be removed from this subnet e.g.: network:floatingip_agent_gateway. Must be a valid device owner value for a network port (repeat option to unset multiple service types)

--tag <tag>

Tag to be removed from the subnet (repeat option to remove multiple tags)

--all-tag

Clear all tags associated with the subnet

Chapter 79. task

This chapter describes the commands under the task command.

79.1. task execution list

List all tasks.

Usage:

openstack task 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]
                                     [workflow_execution]

Table 79.1. Positional Arguments

ValueSummary

workflow_execution

Workflow execution id associated with list of tasks.

Table 79.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.

--oldest

Display the executions starting from the oldest entries instead of the newest

Table 79.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 79.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 79.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 79.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.

79.2. task execution published show

Show task published variables.

Usage:

openstack task execution published show [-h] id

Table 79.7. Positional Arguments

ValueSummary

id

Task id

Table 79.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

79.3. task execution rerun

Rerun an existing task.

Usage:

openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--resume] [-e ENV]
                                      id

Table 79.9. Positional Arguments

ValueSummary

id

Task identifier

Table 79.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resume

Rerun only failed or unstarted action executions for with-items task

-e ENV, --env ENV

Environment variables

Table 79.11. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 79.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 79.13. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 79.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.

79.4. task execution result show

Show task output data.

Usage:

openstack task execution result show [-h] id

Table 79.15. Positional Arguments

ValueSummary

id

Task id

Table 79.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

79.5. task execution show

Show specific task.

Usage:

openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     task

Table 79.17. Positional Arguments

ValueSummary

task

Task identifier

Table 79.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 79.19. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 79.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 79.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 79.22. 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 80. tld

This chapter describes the commands under the tld command.

80.1. tld create

Create new tld

Usage:

openstack tld create [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] --name NAME
                            [--description DESCRIPTION] [--all-projects]
                            [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]

Table 80.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tld name

--description DESCRIPTION

Description

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 80.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 80.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 80.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 80.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.

80.2. tld delete

Delete tld

Usage:

openstack tld delete [-h] [--all-projects] [--edit-managed]
                            [--sudo-project-id SUDO_PROJECT_ID]
                            id

Table 80.6. Positional Arguments

ValueSummary

id

Tld id

Table 80.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

80.3. tld list

List tlds

Usage:

openstack tld 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] [--description DESCRIPTION]
                          [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]

Table 80.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tld name

--description DESCRIPTION

Tld description

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 80.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 80.10. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 80.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 80.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.

80.4. tld set

Set tld properties

Usage:

openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                         [--noindent] [--prefix PREFIX]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--name NAME]
                         [--description DESCRIPTION | --no-description]
                         [--all-projects] [--edit-managed]
                         [--sudo-project-id SUDO_PROJECT_ID]
                         id

Table 80.13. Positional Arguments

ValueSummary

id

Tld id

Table 80.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tld name

--description DESCRIPTION

Description

--no-description—​all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 80.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 80.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 80.17. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 80.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.

80.5. tld show

Show tld details

Usage:

openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--all-projects] [--edit-managed]
                          [--sudo-project-id SUDO_PROJECT_ID]
                          id

Table 80.19. Positional Arguments

ValueSummary

id

Tld id

Table 80.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 80.21. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 80.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 80.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 80.24. 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 81. token

This chapter describes the commands under the token command.

81.1. token issue

Issue new token

Usage:

openstack token issue [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]

Table 81.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 81.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 81.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 81.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 81.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.

81.2. token revoke

Revoke existing token

Usage:

openstack token revoke [-h] <token>

Table 81.6. Positional Arguments

ValueSummary

<token>

Token to be deleted

Table 81.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Chapter 82. tripleo

This chapter describes the commands under the tripleo command.

82.1. tripleo config generate ansible

Generate the default ansible.cfg for UC/AIO-standalone deployments.

Usage:

openstack tripleo config generate ansible
                                                 [--deployment-user DEPLOYMENT_USER]
                                                 [--output-dir OUTPUT_DIR]

Table 82.1. Optional Arguments

ValueSummary

--deployment-user DEPLOYMENT_USER

User who executes the tripleo config generate command. Defaults to stack.

--output-dir OUTPUT_DIR

Directory to output ansible.cfg and ansible.log files.

82.2. tripleo container image prepare default

Generate a default ContainerImagePrepare parameter.

Usage:

openstack tripleo container image prepare default [-h]
                                                         [--output-env-file <file path>]
                                                         [--local-push-destination]

Table 82.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--output-env-file <file path>

File to write environment file containing default ContainerImagePrepare value.

--local-push-destination

Include a push_destination to trigger upload to a local registry.

82.3. tripleo container image prepare

Prepare and upload containers from a single command.

Usage:

openstack tripleo container image prepare [-h]
                                                 [--environment-file <file path>]
                                                 [--environment-directory <HEAT ENVIRONMENT DIRECTORY>]
                                                 [--roles-file ROLES_FILE]
                                                 [--output-env-file <file path>]
                                                 [--dry-run]
                                                 [--cleanup <full, partial, none>]

Table 82.3. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--environment-file <file path>, -e <file path>

Environment file containing the containerimageprepare parameter which specifies all prepare actions. Also, environment files specifying which services are containerized. Entries will be filtered to only contain images used by containerized services. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the environment. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--output-env-file <file path>

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.

--dry-run

Do not perform any pull, modify, or push operations. The environment file will still be populated as if these operations were performed.

--cleanup <full, partial, none>

Cleanup behavior for local images left after upload. The default full will attempt to delete all local images. partial will leave images required for deployment on this host. none will do no cleanup.

82.4. tripleo deploy

Deploy containerized Undercloud

Usage:

openstack tripleo deploy [--templates [TEMPLATES]] [--standalone]
                                [--upgrade] [-y] [--stack STACK]
                                [--output-dir OUTPUT_DIR] [--output-only]
                                [--standalone-role STANDALONE_ROLE]
                                [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                [--roles-file ROLES_FILE]
                                [--networks-file NETWORKS_FILE]
                                [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                [--heat-api-port <HEAT_API_PORT>]
                                [--heat-user <HEAT_USER>]
                                [--deployment-user DEPLOYMENT_USER]
                                [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                [--heat-native [HEAT_NATIVE]]
                                [--local-ip <LOCAL_IP>]
                                [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                [--hieradata-override [HIERADATA_OVERRIDE]]
                                [--keep-running] [--inflight-validations]
                                [--force-stack-update | --force-stack-create]

Table 82.4. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

Name for the ephemeral (one-time create and forget) heat stack.

--output-dir OUTPUT_DIR

Directory to output state, processed heat templates, ansible deployment files.

--output-only

Do not execute the ansible playbooks. by default the playbooks are saved to the output-dir and then executed.

--standalone-role STANDALONE_ROLE

The role to use for standalone configuration when populating the deployment actions.

-t <TIMEOUT>, --timeout <TIMEOUT>

Deployment timeout in minutes.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data_undercloud.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Roles file, overrides the default /dev/null in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--heat-api-port <HEAT_API_PORT>

Heat api port to use for the installers private heat API instance. Optional. Default: 8006.)

--heat-user <HEAT_USER>

User to execute the non-privileged heat-all process. Defaults to heat.

--deployment-user DEPLOYMENT_USER

User who executes the tripleo deploy command. defaults to $SUDO_USER. If $SUDO_USER is unset it defaults to stack.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--heat-container-image <HEAT_CONTAINER_IMAGE>

The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly.

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane.

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW.

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run.

--hieradata-override [HIERADATA_OVERRIDE]

Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision.

--keep-running

Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--force-stack-update

Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--force-stack-create

Do a virtual create of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=CREATE.

82.5. tripleo upgrade

Upgrade TripleO

Usage:

openstack tripleo upgrade [--templates [TEMPLATES]] [--standalone]
                                 [--upgrade] [-y] [--stack STACK]
                                 [--output-dir OUTPUT_DIR] [--output-only]
                                 [--standalone-role STANDALONE_ROLE]
                                 [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                 [--roles-file ROLES_FILE]
                                 [--networks-file NETWORKS_FILE]
                                 [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                 [--heat-api-port <HEAT_API_PORT>]
                                 [--heat-user <HEAT_USER>]
                                 [--deployment-user DEPLOYMENT_USER]
                                 [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                 [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                 [--heat-native [HEAT_NATIVE]]
                                 [--local-ip <LOCAL_IP>]
                                 [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                 [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                 [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                 [--hieradata-override [HIERADATA_OVERRIDE]]
                                 [--keep-running] [--inflight-validations]
                                 [--force-stack-update | --force-stack-create]

Table 82.5. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

Name for the ephemeral (one-time create and forget) heat stack.

--output-dir OUTPUT_DIR

Directory to output state, processed heat templates, ansible deployment files.

--output-only

Do not execute the ansible playbooks. by default the playbooks are saved to the output-dir and then executed.

--standalone-role STANDALONE_ROLE

The role to use for standalone configuration when populating the deployment actions.

-t <TIMEOUT>, --timeout <TIMEOUT>

Deployment timeout in minutes.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data_undercloud.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Roles file, overrides the default /dev/null in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--heat-api-port <HEAT_API_PORT>

Heat api port to use for the installers private heat API instance. Optional. Default: 8006.)

--heat-user <HEAT_USER>

User to execute the non-privileged heat-all process. Defaults to heat.

--deployment-user DEPLOYMENT_USER

User who executes the tripleo deploy command. defaults to $SUDO_USER. If $SUDO_USER is unset it defaults to stack.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--heat-container-image <HEAT_CONTAINER_IMAGE>

The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly.

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane.

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW.

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run.

--hieradata-override [HIERADATA_OVERRIDE]

Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision.

--keep-running

Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--force-stack-update

Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--force-stack-create

Do a virtual create of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=CREATE.

82.6. tripleo validator group info

Display Information about Validation Groups

Usage:

openstack tripleo validator group info [-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]

Table 82.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 82.7. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 82.8. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 82.9. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 82.10. 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.

82.7. tripleo validator list

List the available validations

Usage:

openstack tripleo validator 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]
                                        [--group <group>[,<group>,...]]

Table 82.11. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group <group>[,<group>,…​]

List specific group validations, if more than one group is required separate the group names with commas: --group pre-upgrade,prep

Table 82.12. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 82.13. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 82.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 82.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.

82.8. tripleo validator run

Run the available validations

Usage:

openstack tripleo validator run [--plan PLAN] [--workers N]
                                       [--extra-vars EXTRA_VARS | --extra-vars-file EXTRA_VARS_FILE]
                                       (--validation <validation_id>[,<validation_id>,...] | --group <group>[,<group>,...])

Table 82.16. Optional Arguments

ValueSummary

--plan PLAN, --stack PLAN

Execute the validations using a custom plan name (default: overcloud)

--workers N, -w N

The maximum number of threads that can be used to execute the given validations (default: 1)

--extra-vars EXTRA_VARS

Add a dictionary as extra variable to a validation: --extra-vars {"min_undercloud_ram_gb": 24} (default: {})

--extra-vars-file EXTRA_VARS_FILE

Add a json/yaml file containing extra variable to a validation: --extra-vars-file /home/stack/vars.[json

yaml] If using Mistral, only a valid JSON file will be supported. (default: )

--validation <validation_id>[,<validation_id>,…​]

Run specific validations, if more than one validation is required separate the names with commas: --validation check-ftype,512e

--validation 512e (default: [])

--group <group>[,<group>,…​]

Run specific group validations, if more than one group is required separate the group names with commas: --group pre-upgrade,prep

82.9. tripleo validator show parameter

Display Validations Parameters

Usage:

openstack tripleo validator show parameter [-h]
                                                  [--validation <validation_id>[,<validation_id>,...]
                                                  | --group
                                                  <group_id>[,<group_id>,...]]
                                                  [--download [json|yaml]
                                                  /tmp/myvars] [-f <format>]

Table 82.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--validation <validation_id>[,<validation_id>,…​]

List specific validations, if more than one validation is required separate the names with commas: --validation check-ftype,512e

--validation 512e (default: [])

--group <group_id>[,<group_id>,…​]

List specific group validations, if more than one group is required separate the group names with commas: pre-upgrade,prep

openshift-on-openstack (default: [])

--download [json

yaml] /tmp/myvars

Create a json or a yaml file containing all the variables available for the validations: [yaml

json] /tmp/myvars (default: [])

-f <format>, --format <format>

Print representation of the validation. the choices of the output format is json,yaml. (default: json)

82.10. tripleo validator show

Display detailed information about a Validation

Usage:

openstack tripleo validator show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <validation>

Table 82.18. Positional Arguments

ValueSummary

<validation>

Validation id

Table 82.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 82.20. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 82.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 82.22. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 82.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.

Chapter 83. trust

This chapter describes the commands under the trust command.

83.1. trust create

Create new trust

Usage:

openstack trust create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --project <project> --role
                              <role> [--impersonate]
                              [--expiration <expiration>]
                              [--project-domain <project-domain>]
                              [--trustor-domain <trustor-domain>]
                              [--trustee-domain <trustee-domain>]
                              <trustor-user> <trustee-user>

Table 83.1. Positional Arguments

ValueSummary

<trustor-user>

User that is delegating authorization (name or id)

<trustee-user>

User that is assuming authorization (name or id)

Table 83.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Project being delegated (name or id) (required)

--role <role>

Roles to authorize (name or id) (repeat option to set multiple values, required)

--impersonate

Tokens generated from the trust will represent <trustor> (defaults to False)

--expiration <expiration>

Sets an expiration date for the trust (format of yyyy- mm-ddTHH:MM:SS)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--trustor-domain <trustor-domain>

Domain that contains <trustor> (name or id)

--trustee-domain <trustee-domain>

Domain that contains <trustee> (name or id)

Table 83.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 83.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 83.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 83.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.

83.2. trust delete

Delete trust(s)

Usage:

openstack trust delete [-h] <trust> [<trust> ...]

Table 83.7. Positional Arguments

ValueSummary

<trust>

Trust(s) to delete

Table 83.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

83.3. trust list

List trusts

Usage:

openstack trust 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]

Table 83.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 83.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 83.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 83.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 83.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.

83.4. trust show

Display trust details

Usage:

openstack trust show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <trust>

Table 83.14. Positional Arguments

ValueSummary

<trust>

Trust to display

Table 83.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 83.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 83.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 83.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 83.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 84. tsigkey

This chapter describes the commands under the tsigkey command.

84.1. tsigkey create

Create new tsigkey

Usage:

openstack tsigkey create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --name NAME --algorithm
                                ALGORITHM --secret SECRET --scope SCOPE
                                --resource-id RESOURCE_ID [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]

Table 84.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tsigkey name

--algorithm ALGORITHM

Tsigkey algorithm

--secret SECRET

Tsigkey secret

--scope SCOPE

Tsigkey scope

--resource-id RESOURCE_ID

Tsigkey resource_id

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 84.2. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 84.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 84.4. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 84.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.

84.2. tsigkey delete

Delete tsigkey

Usage:

openstack tsigkey delete [-h] [--all-projects] [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                id

Table 84.6. Positional Arguments

ValueSummary

id

Tsigkey id

Table 84.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

84.3. tsigkey list

List tsigkeys

Usage:

openstack tsigkey 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]
                              [--algorithm ALGORITHM] [--scope SCOPE]
                              [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]

Table 84.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tsigkey name

--algorithm ALGORITHM

Tsigkey algorithm

--scope SCOPE

Tsigkey scope

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 84.9. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 84.10. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 84.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 84.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.

84.4. tsigkey set

Set tsigkey properties

Usage:

openstack tsigkey set [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--name NAME]
                             [--algorithm ALGORITHM] [--secret SECRET]
                             [--scope SCOPE] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

Table 84.13. Positional Arguments

ValueSummary

id

Tsigkey id

Table 84.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Tsigkey name

--algorithm ALGORITHM

Tsigkey algorithm

--secret SECRET

Tsigkey secret

--scope SCOPE

Tsigkey scope

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 84.15. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 84.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 84.17. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 84.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.

84.5. tsigkey show

Show tsigkey details

Usage:

openstack tsigkey show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--all-projects]
                              [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

Table 84.19. Positional Arguments

ValueSummary

id

Tsigkey id

Table 84.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 84.21. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 84.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 84.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 84.24. 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 85. undercloud

This chapter describes the commands under the undercloud command.

85.1. undercloud backup

Backup the undercloud

Usage:

openstack undercloud backup [--add-path ADD_PATH]
                                   [--exclude-path EXCLUDE_PATH]

Table 85.1. Optional Arguments

ValueSummary

--add-path ADD_PATH

Add additional files to backup. defaults to: /home/stack/ i.e. --add-path /this/is/a/folder/ --add- path /this/is/a/texfile.txt

--exclude-path EXCLUDE_PATH

Exclude path when performing the undercloud backup, this option can be specified multiple times. Defaults to: none i.e. --exclude-path /this/is/a/folder/ --exclude-path /this/is/a/texfile.txt

85.2. undercloud deploy

Deploy containerized Undercloud

Usage:

openstack undercloud deploy [--templates [TEMPLATES]] [--standalone]
                                   [--upgrade] [-y] [--stack STACK]
                                   [--output-dir OUTPUT_DIR] [--output-only]
                                   [--standalone-role STANDALONE_ROLE]
                                   [-t <TIMEOUT>] [-e <HEAT ENVIRONMENT FILE>]
                                   [--roles-file ROLES_FILE]
                                   [--networks-file NETWORKS_FILE]
                                   [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                   [--heat-api-port <HEAT_API_PORT>]
                                   [--heat-user <HEAT_USER>]
                                   [--deployment-user DEPLOYMENT_USER]
                                   [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER]
                                   [--heat-container-image <HEAT_CONTAINER_IMAGE>]
                                   [--heat-native [HEAT_NATIVE]]
                                   [--local-ip <LOCAL_IP>]
                                   [--control-virtual-ip <CONTROL_VIRTUAL_IP>]
                                   [--public-virtual-ip <PUBLIC_VIRTUAL_IP>]
                                   [--local-domain <LOCAL_DOMAIN>] [--cleanup]
                                   [--hieradata-override [HIERADATA_OVERRIDE]]
                                   [--keep-running] [--inflight-validations]
                                   [--force-stack-update | --force-stack-create]

Table 85.2. Optional Arguments

ValueSummary

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--standalone

Run deployment as a standalone deployment with no undercloud.

--upgrade

Upgrade an existing deployment.

-y, --yes

Skip yes/no prompt (assume yes).

--stack STACK

Name for the ephemeral (one-time create and forget) heat stack.

--output-dir OUTPUT_DIR

Directory to output state, processed heat templates, ansible deployment files.

--output-only

Do not execute the ansible playbooks. by default the playbooks are saved to the output-dir and then executed.

--standalone-role STANDALONE_ROLE

The role to use for standalone configuration when populating the deployment actions.

-t <TIMEOUT>, --timeout <TIMEOUT>

Deployment timeout in minutes.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data_undercloud.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Roles file, overrides the default /dev/null in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--heat-api-port <HEAT_API_PORT>

Heat api port to use for the installers private heat API instance. Optional. Default: 8006.)

--heat-user <HEAT_USER>

User to execute the non-privileged heat-all process. Defaults to heat.

--deployment-user DEPLOYMENT_USER

User who executes the tripleo deploy command. defaults to $SUDO_USER. If $SUDO_USER is unset it defaults to stack.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. If not specified the python version of the openstackclient will be used. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

--heat-container-image <HEAT_CONTAINER_IMAGE>

The container image to use when launching the heat-all process. Defaults to: tripleomaster/centos-binary- heat-all:current-tripleo

--heat-native [HEAT_NATIVE]

Execute the heat-all process natively on this host. This option requires that the heat-all binaries be installed locally on this machine. This option is enabled by default which means heat-all is executed on the host OS directly.

--local-ip <LOCAL_IP>

Local ip/cidr for undercloud traffic. required.

--control-virtual-ip <CONTROL_VIRTUAL_IP>

Control plane vip. this allows the undercloud installer to configure a custom VIP on the control plane.

--public-virtual-ip <PUBLIC_VIRTUAL_IP>

Public nw vip. this allows the undercloud installer to configure a custom VIP on the public (external) NW.

--local-domain <LOCAL_DOMAIN>

Local domain for standalone cloud and its api endpoints

--cleanup

Cleanup temporary files. using this flag will remove the temporary files used during deployment in after the command is run.

--hieradata-override [HIERADATA_OVERRIDE]

Path to hieradata override file. when it points to a heat env file, it is passed in t-h-t via --environment-file. When the file contains legacy instack data, it is wrapped with <role>ExtraConfig and also passed in for t-h-t as a temp file created in --output-dir. Note, instack hiera data may be not t-h-t compatible and will highly likely require a manual revision.

--keep-running

Keep the ephemeral heat running after the stack operation is complete. This is for debugging purposes only. The ephemeral Heat can be used by openstackclient with: OS_AUTH_TYPE=none OS_ENDPOINT=http://127.0.0.1:8006/v1/admin openstack stack list where 8006 is the port specified by --heat- api-port.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--force-stack-update

Do a virtual update of the ephemeral heat stack (it cannot take real updates). New or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--force-stack-create

Do a virtual create of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=CREATE.

85.3. undercloud install

Install and setup the undercloud

Usage:

openstack undercloud install [--force-stack-update] [--no-validations]
                                    [--dry-run] [-y]

Table 85.3. Optional Arguments

ValueSummary

--force-stack-update

Do a virtual update of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations

Do not perform undercloud configuration validations

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

85.4. undercloud upgrade

Upgrade undercloud

Usage:

openstack undercloud upgrade [--force-stack-update] [--no-validations]
                                    [--dry-run] [-y]

Table 85.4. Optional Arguments

ValueSummary

--force-stack-update

Do a virtual update of the ephemeral heat stack. new or failed deployments always have the stack_action=CREATE. This option enforces stack_action=UPDATE.

--no-validations

Do not perform undercloud configuration validations

--dry-run

Print the install command instead of running it

-y, --yes

Skip yes/no prompt (assume yes).

Chapter 86. usage

This chapter describes the commands under the usage command.

86.1. usage list

List resource usage per project

Usage:

openstack usage 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]
                            [--start <start>] [--end <end>]

Table 86.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--start <start>

Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

Table 86.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 86.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 86.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 86.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.

86.2. usage show

Show resource usage for a single project

Usage:

openstack usage show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--project <project>]
                            [--start <start>] [--end <end>]

Table 86.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Name or id of project to show usage for

--start <start>

Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

Table 86.7. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 86.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 86.9. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 86.10. 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 87. user

This chapter describes the commands under the user command.

87.1. user create

Create new user

Usage:

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--enable | --disable] [--or-show]
                             <name>

Table 87.1. Positional Arguments

ValueSummary

<name>

New user name

Table 87.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Default domain (name or id)

--project <project>

Default 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.

--password <password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--description <description>

User description

--enable

Enable user (default)

--disable

Disable user

--or-show

Return existing user

Table 87.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 87.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 87.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 87.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.

87.2. user delete

Delete user(s)

Usage:

openstack user delete [-h] [--domain <domain>] <user> [<user> ...]

Table 87.7. Positional Arguments

ValueSummary

<user>

User(s) to delete (name or id)

Table 87.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <user> (name or id)

87.3. user list

List users

Usage:

openstack user 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]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]

Table 87.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Filter users by <domain> (name or id)

--group <group>

Filter users by <group> membership (name or id)

--project <project>

Filter users by <project> (name or id)

--long

List additional fields in output

Table 87.10. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 87.11. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 87.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 87.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.

87.4. user password set

Change current user password

Usage:

openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]

Table 87.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--password <new-password>

New user password

--original-password <original-password>

Original user password

87.5. user set

Set user properties

Usage:

openstack user set [-h] [--name <name>] [--domain <domain>]
                          [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>] [--enable | --disable]
                          <user>

Table 87.15. Positional Arguments

ValueSummary

<user>

User to modify (name or id)

Table 87.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set user name

--domain <domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--project <project>

Set default 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.

--password <password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--description <description>

Set user description

--enable

Enable user (default)

--disable

Disable user

87.6. user show

Display user details

Usage:

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <user>

Table 87.17. Positional Arguments

ValueSummary

<user>

User to display (name or id)

Table 87.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <user> (name or id)

Table 87.19. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 87.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 87.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 87.22. 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 88. versions

This chapter describes the commands under the versions command.

88.1. versions show

Show available versions of services

Usage:

openstack versions 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]
                               [--all-interfaces | --interface <interface>]
                               [--region-name <region_name>]
                               [--service <region_name>]
                               [--status <region_name>]

Table 88.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-interfaces

Show values for all interfaces

--interface <interface>

Show versions for a specific interface.

--region-name <region_name>

Show versions for a specific region.

--service <region_name>

Show versions for a specific service.

--status <region_name>

Show versions for a specific status. [valid values are SUPPORTED, CURRENT, DEPRECATED, EXPERIMENTAL]

Table 88.2. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 88.3. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 88.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 88.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 89. volume

This chapter describes the commands under the volume command.

89.1. volume backend capability show

Show capability command

Usage:

openstack volume backend capability 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]
                                                <host>

Table 89.1. Positional Arguments

ValueSummary

<host>

List capabilities of specified host (host@backend- name)

Table 89.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.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.

89.2. volume backend pool list

List pool command

Usage:

openstack volume backend pool 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]

Table 89.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show detailed information about pools.

Table 89.8. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.9. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.11. 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.

89.3. volume backup create

Create new volume backup

Usage:

openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <name>]
                                      [--description <description>]
                                      [--container <container>]
                                      [--snapshot <snapshot>] [--force]
                                      [--incremental]
                                      <volume>

Table 89.12. Positional Arguments

ValueSummary

<volume>

Volume to backup (name or id)

Table 89.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the backup

--description <description>

Description of the backup

--container <container>

Optional backup container name

--snapshot <snapshot>

Snapshot to backup (name or id)

--force

Allow to back up an in-use volume

--incremental

Perform an incremental backup

Table 89.14. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.15. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.16. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.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.

89.4. volume backup delete

Delete volume backup(s)

Usage:

openstack volume backup delete [-h] [--force] <backup> [<backup> ...]

Table 89.18. Positional Arguments

ValueSummary

<backup>

Backup(s) to delete (name or id)

Table 89.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Allow delete in state other than error or available

89.5. volume backup list

List volume backups

Usage:

openstack volume backup 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]
                                    [--name <name>] [--status <status>]
                                    [--volume <volume>]
                                    [--marker <volume-backup>]
                                    [--limit <num-backups>] [--all-projects]

Table 89.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--name <name>

Filters results by the backup name

--status <status>

Filters results by the backup status (creating, available, deleting, error, restoring or error_restoring)

--volume <volume>

Filters results by the volume which they backup (name or ID)

--marker <volume-backup>

The last backup of the previous page (name or id)

--limit <num-backups>

Maximum number of backups to display

--all-projects

Include all projects (admin only)

Table 89.21. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.22. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.24. 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.

89.6. volume backup record export

Export volume backup details. Backup information can be imported into a new service instance to be able to restore.

Usage:

openstack volume backup record export [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <backup>

Table 89.25. Positional Arguments

ValueSummary

<backup>

Backup to export (name or id)

Table 89.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.27. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.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.

89.7. volume backup record import

Import volume backup details. Exported backup details contain the metadata necessary to restore to a new or rebuilt service instance

Usage:

openstack volume backup record import [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <backup_service>
                                             <backup_metadata>

Table 89.31. Positional Arguments

ValueSummary

<backup_service>

Backup service containing the backup.

<backup_metadata>

Encoded backup metadata from export.

Table 89.32. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.33. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.34. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.35. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.36. 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.

89.8. volume backup restore

Restore volume backup

Usage:

openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       <backup> <volume>

Table 89.37. Positional Arguments

ValueSummary

<backup>

Backup to restore (name or id)

<volume>

Volume to restore to (name or id)

Table 89.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.39. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.41. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.42. 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.

89.9. volume backup set

Set volume backup properties

Usage:

openstack volume backup set [-h] [--name <name>]
                                   [--description <description>]
                                   [--state <state>]
                                   <backup>

Table 89.43. Positional Arguments

ValueSummary

<backup>

Backup to modify (name or id)

Table 89.44. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New backup name

--description <description>

New backup description

--state <state>

New backup state ("available" or "error") (admin only) (This option simply changes the state of the backup in the database with no regard to actual status, exercise caution when using)

89.10. volume backup show

Display volume backup details

Usage:

openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <backup>

Table 89.45. Positional Arguments

ValueSummary

<backup>

Backup to display (name or id)

Table 89.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.47. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.49. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.50. 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.

89.11. volume create

Create new volume

Usage:

openstack volume create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--size <size>]
                               [--type <volume-type>]
                               [--image <image> | --snapshot <snapshot> | --source <volume>]
                               [--description <description>]
                               [--availability-zone <availability-zone>]
                               [--consistency-group consistency-group>]
                               [--property <key=value>] [--hint <key=value>]
                               [--multi-attach] [--bootable | --non-bootable]
                               [--read-only | --read-write]
                               <name>

Table 89.51. Positional Arguments

ValueSummary

<name>

Volume name

Table 89.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--size <size>

Volume size in gb (required unless --snapshot or --source is specified)

--type <volume-type>

Set the type of volume

--image <image>

Use <image> as source of volume (name or id)

--snapshot <snapshot>

Use <snapshot> as source of volume (name or id)

--source <volume>

Volume to clone (name or id)

--description <description>

Volume description

--availability-zone <availability-zone>

Create volume in <availability-zone>

--consistency-group consistency-group>

Consistency group where the new volume belongs to

--property <key=value>

Set a property to this volume (repeat option to set multiple properties)

--hint <key=value>

Arbitrary scheduler hint key-value pairs to help boot an instance (repeat option to set multiple hints)

--multi-attach

Allow volume to be attached more than once (default to False)

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable (default)

--read-only

Set volume to read-only access mode

--read-write

Set volume to read-write access mode (default)

Table 89.53. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.55. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.56. 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.

89.12. volume delete

Delete volume(s)

Usage:

openstack volume delete [-h] [--force | --purge]
                               <volume> [<volume> ...]

Table 89.57. Positional Arguments

ValueSummary

<volume>

Volume(s) to delete (name or id)

Table 89.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Attempt forced removal of volume(s), regardless of state (defaults to False)

--purge

Remove any snapshots along with volume(s) (defaults to false)

89.13. volume host failover

Failover volume host to different backend

Usage:

openstack volume host failover [-h] --volume-backend <backend-id>
                                      <host-name>

Table 89.59. Positional Arguments

ValueSummary

<host-name>

Name of volume host

Table 89.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume-backend <backend-id>

The id of the volume backend replication target where the host will failover to (required)

89.14. volume host set

Set volume host properties

Usage:

openstack volume host set [-h] [--disable | --enable] <host-name>

Table 89.61. Positional Arguments

ValueSummary

<host-name>

Name of volume host

Table 89.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--disable

Freeze and disable the specified volume host

--enable

Thaw and enable the specified volume host

89.15. volume list

List volumes

Usage:

openstack volume 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] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long] [--marker <volume>]
                             [--limit <num-volumes>]

Table 89.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Filter results by project (name or id) (admin only)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--user <user>

Filter results by user (name or id) (admin only)

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--name <name>

Filter results by volume name

--status <status>

Filter results by status

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--marker <volume>

The last volume id of the previous page

--limit <num-volumes>

Maximum number of volumes to display

Table 89.64. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.65. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.66. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.67. 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.

89.16. volume migrate

Migrate volume to a new host

Usage:

openstack volume migrate [-h] --host <host> [--force-host-copy]
                                [--lock-volume]
                                <volume>

Table 89.68. Positional Arguments

ValueSummary

<volume>

Volume to migrate (name or id)

Table 89.69. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

Destination host (takes the form: host@backend-name#pool)

--force-host-copy

Enable generic host-based force-migration, which bypasses driver optimizations

--lock-volume

If specified, the volume state will be locked and will not allow a migration to be aborted (possibly by another operation)

89.17. volume qos associate

Associate a QoS specification to a volume type

Usage:

openstack volume qos associate [-h] <qos-spec> <volume-type>

Table 89.70. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

<volume-type>

Volume type to associate the qos (name or id)

Table 89.71. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

89.18. volume qos create

Create new QoS specification

Usage:

openstack volume qos create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>

Table 89.72. Positional Arguments

ValueSummary

<name>

New qos specification name

Table 89.73. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--consumer <consumer>

Consumer of the qos. valid consumers: back-end, both, front-end (defaults to both)

--property <key=value>

Set a qos specification property (repeat option to set multiple properties)

Table 89.74. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.75. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.76. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.77. 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.

89.19. volume qos delete

Delete QoS specification

Usage:

openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]

Table 89.78. Positional Arguments

ValueSummary

<qos-spec>

Qos specification(s) to delete (name or id)

Table 89.79. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Allow to delete in-use qos specification(s)

89.20. volume qos disassociate

Disassociate a QoS specification from a volume type

Usage:

openstack volume qos disassociate [-h]
                                         [--volume-type <volume-type> | --all]
                                         <qos-spec>

Table 89.80. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 89.81. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume-type <volume-type>

Volume type to disassociate the qos from (name or id)

--all

Disassociate the qos from every volume type

89.21. volume qos list

List QoS specifications

Usage:

openstack volume qos 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]

Table 89.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.83. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.84. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.85. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.86. 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.

89.22. volume qos set

Set QoS specification properties

Usage:

openstack volume qos set [-h] [--property <key=value>] <qos-spec>

Table 89.87. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 89.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Property to add or modify for this qos specification (repeat option to set multiple properties)

89.23. volume qos show

Display QoS specification details

Usage:

openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <qos-spec>

Table 89.89. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to display (name or id)

Table 89.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.91. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.92. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.93. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.94. 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.

89.24. volume qos unset

Unset QoS specification properties

Usage:

openstack volume qos unset [-h] [--property <key>] <qos-spec>

Table 89.95. Positional Arguments

ValueSummary

<qos-spec>

Qos specification to modify (name or id)

Table 89.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from the qos specification. (repeat option to unset multiple properties)

89.25. volume service list

List service command

Usage:

openstack volume service 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]
                                     [--host <host>] [--service <service>]
                                     [--long]

Table 89.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--service <service>

List only specified service (name only)

--long

List additional fields in output

Table 89.98. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.99. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.101. 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.

89.26. volume service set

Set volume service properties

Usage:

openstack volume service set [-h] [--enable | --disable]
                                    [--disable-reason <reason>]
                                    <host> <service>

Table 89.102. Positional Arguments

ValueSummary

<host>

Name of host

<service>

Name of service (binary name)

Table 89.103. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable volume service

--disable

Disable volume service

--disable-reason <reason>

Reason for disabling the service (should be used with --disable option)

89.27. volume set

Set volume properties

Usage:

openstack volume set [-h] [--name <name>] [--size <size>]
                            [--description <description>] [--no-property]
                            [--property <key=value>]
                            [--image-property <key=value>] [--state <state>]
                            [--attached | --detached] [--type <volume-type>]
                            [--retype-policy <retype-policy>]
                            [--bootable | --non-bootable]
                            [--read-only | --read-write]
                            <volume>

Table 89.104. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 89.105. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New volume name

--size <size>

Extend volume size in gb

--description <description>

New volume description

--no-property

Remove all properties from <volume> (specify both --no-property and --property to remove the current properties before setting new properties.)

--property <key=value>

Set a property on this volume (repeat option to set multiple properties)

--image-property <key=value>

Set an image property on this volume (repeat option to set multiple image properties)

--state <state>

New volume state ("available", "error", "creating", "deleting", "in-use", "attaching", "detaching", "error_deleting" or "maintenance") (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--attached

Set volume attachment status to "attached" (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--detached

Set volume attachment status to "detached" (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using)

--type <volume-type>

New volume type (name or id)

--retype-policy <retype-policy>

Migration policy while re-typing volume ("never" or "on-demand", default is "never" ) (available only when --type option is specified)

--bootable

Mark volume as bootable

--non-bootable

Mark volume as non-bootable

--read-only

Set volume to read-only access mode

--read-write

Set volume to read-write access mode

89.28. volume show

Display volume details

Usage:

openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <volume>

Table 89.106. Positional Arguments

ValueSummary

<volume>

Volume to display (name or id)

Table 89.107. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.108. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.109. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.110. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.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.

89.29. volume snapshot create

Create new volume snapshot

Usage:

openstack volume snapshot create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty] [--volume <volume>]
                                        [--description <description>]
                                        [--force] [--property <key=value>]
                                        [--remote-source <key=value>]
                                        <snapshot-name>

Table 89.112. Positional Arguments

ValueSummary

<snapshot-name>

Name of the new snapshot

Table 89.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--volume <volume>

Volume to snapshot (name or id) (default is <snapshot- name>)

--description <description>

Description of the snapshot

--force

Create a snapshot attached to an instance. default is False

--property <key=value>

Set a property to this snapshot (repeat option to set multiple properties)

--remote-source <key=value>

The attribute(s) of the exsiting remote volume snapshot (admin required) (repeat option to specify multiple attributes) e.g.: --remote-source source- name=test_name --remote-source source-id=test_id

Table 89.114. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.115. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.116. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.117. 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.

89.30. volume snapshot delete

Delete volume snapshot(s)

Usage:

openstack volume snapshot delete [-h] [--force]
                                        <snapshot> [<snapshot> ...]

Table 89.118. Positional Arguments

ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 89.119. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Attempt forced removal of snapshot(s), regardless of state (defaults to False)

89.31. volume snapshot list

List volume snapshots

Usage:

openstack volume snapshot 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]
                                      [--all-projects] [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--long] [--marker <volume-snapshot>]
                                      [--limit <num-snapshots>]
                                      [--name <name>] [--status <status>]
                                      [--volume <volume>]

Table 89.120. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

--project <project>

Filter results by project (name or id) (admin only)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--long

List additional fields in output

--marker <volume-snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

--name <name>

Filters results by a name.

--status <status>

Filters results by a status. (available, error, creating, deleting or error-deleting)

--volume <volume>

Filters results by a volume (name or id).

Table 89.121. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.122. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.123. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.124. 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.

89.32. volume snapshot set

Set volume snapshot properties

Usage:

openstack volume snapshot set [-h] [--name <name>]
                                     [--description <description>]
                                     [--no-property] [--property <key=value>]
                                     [--state <state>]
                                     <snapshot>

Table 89.125. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 89.126. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New snapshot name

--description <description>

New snapshot description

--no-property

Remove all properties from <snapshot> (specify both --no-property and --property to remove the current properties before setting new properties.)

--property <key=value>

Property to add/change for this snapshot (repeat option to set multiple properties)

--state <state>

New snapshot state. ("available", "error", "creating", "deleting", or "error_deleting") (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using)

89.33. volume snapshot show

Display volume snapshot details

Usage:

openstack volume snapshot show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <snapshot>

Table 89.127. Positional Arguments

ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 89.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.129. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.130. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.131. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.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.

89.34. volume snapshot unset

Unset volume snapshot properties

Usage:

openstack volume snapshot unset [-h] [--property <key>] <snapshot>

Table 89.133. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 89.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from snapshot (repeat option to remove multiple properties)

89.35. volume transfer request accept

Accept volume transfer request.

Usage:

openstack volume transfer request accept [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--auth-key <key>]
                                                <transfer-request-id>

Table 89.135. Positional Arguments

ValueSummary

<transfer-request-id>

Volume transfer request to accept (id only)

Table 89.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--auth-key <key>

Volume transfer request authentication key

Table 89.137. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.139. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.140. 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.

89.36. volume transfer request create

Create volume transfer request.

Usage:

openstack volume transfer request create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--name <name>]
                                                <volume>

Table 89.141. Positional Arguments

ValueSummary

<volume>

Volume to transfer (name or id)

Table 89.142. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

New transfer request name (default to none)

Table 89.143. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.144. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.145. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.146. 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.

89.37. volume transfer request delete

Delete volume transfer request(s).

Usage:

openstack volume transfer request delete [-h]
                                                <transfer-request>
                                                [<transfer-request> ...]

Table 89.147. Positional Arguments

ValueSummary

<transfer-request>

Volume transfer request(s) to delete (name or id)

Table 89.148. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

89.38. volume transfer request list

Lists all volume transfer requests.

Usage:

openstack volume transfer request 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]
                                              [--all-projects]

Table 89.149. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

Table 89.150. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.151. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.152. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.153. 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.

89.39. volume transfer request show

Show volume transfer request details.

Usage:

openstack volume transfer request show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <transfer-request>

Table 89.154. Positional Arguments

ValueSummary

<transfer-request>

Volume transfer request to display (name or id)

Table 89.155. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 89.156. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.157. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.158. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.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.

89.40. volume type create

Create new volume type

Usage:

openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    [--project <project>]
                                    [--encryption-provider <provider>]
                                    [--encryption-cipher <cipher>]
                                    [--encryption-key-size <key-size>]
                                    [--encryption-control-location <control-location>]
                                    [--project-domain <project-domain>]
                                    <name>

Table 89.160. Positional Arguments

ValueSummary

<name>

Volume type name

Table 89.161. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

Volume type description

--public

Volume type is accessible to the public

--private

Volume type is not accessible to the public

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project <project>

Allow <project> to access private type (name or id) (Must be used with --private option)

--encryption-provider <provider>

Set the encryption provider format for this volume type (e.g "luks" or "plain") (admin only) (This option is required when setting encryption type of a volume. Consider using other encryption options such as: "-- encryption-cipher", "--encryption-key-size" and "-- encryption-control-location")

--encryption-cipher <cipher>

Set the encryption algorithm or mode for this volume type (e.g "aes-xts-plain64") (admin only)

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--encryption-control-location <control-location>

Set the notional service where the encryption is performed ("front-end" or "back-end") (admin only) (The default value for this option is "front-end" when setting encryption type of a volume. Consider using other encryption options such as: "--encryption- cipher", "--encryption-key-size" and "--encryption- provider")

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

Table 89.162. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.163. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.164. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.165. 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.

89.41. volume type delete

Delete volume type(s)

Usage:

openstack volume type delete [-h] <volume-type> [<volume-type> ...]

Table 89.166. Positional Arguments

ValueSummary

<volume-type>

Volume type(s) to delete (name or id)

Table 89.167. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

89.42. volume type list

List volume types

Usage:

openstack volume type 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]
                                  [--default | --public | --private]
                                  [--encryption-type]

Table 89.168. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--default

List the default volume type

--public

List only public types

--private

List only private types (admin only)

--encryption-type

Display encryption information for each volume type (admin only)

Table 89.169. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 89.170. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 89.171. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.172. 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.

89.43. volume type set

Set volume type properties

Usage:

openstack volume type set [-h] [--name <name>]
                                 [--description <description>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 [--encryption-provider <provider>]
                                 [--encryption-cipher <cipher>]
                                 [--encryption-key-size <key-size>]
                                 [--encryption-control-location <control-location>]
                                 <volume-type>

Table 89.173. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 89.174. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set volume type name

--description <description>

Set volume type description

--property <key=value>

Set a property on this volume type (repeat option to set multiple properties)

--project <project>

Set volume type access to project (name or id) (admin only)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--encryption-provider <provider>

Set the encryption provider format for this volume type (e.g "luks" or "plain") (admin only) (This option is required when setting encryption type of a volume for the first time. Consider using other encryption options such as: "--encryption-cipher", "--encryption- key-size" and "--encryption-control-location")

--encryption-cipher <cipher>

Set the encryption algorithm or mode for this volume type (e.g "aes-xts-plain64") (admin only)

--encryption-key-size <key-size>

Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only)

--encryption-control-location <control-location>

Set the notional service where the encryption is performed ("front-end" or "back-end") (admin only) (The default value for this option is "front-end" when setting encryption type of a volume for the first time. Consider using other encryption options such as: "--encryption-cipher", "--encryption-key-size" and "-- encryption-provider")

89.44. volume type show

Display volume type details

Usage:

openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--encryption-type]
                                  <volume-type>

Table 89.175. Positional Arguments

ValueSummary

<volume-type>

Volume type to display (name or id)

Table 89.176. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--encryption-type

Display encryption information of this volume type (admin only)

Table 89.177. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 89.178. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 89.179. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 89.180. 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.

89.45. volume type unset

Unset volume type properties

Usage:

openstack volume type unset [-h] [--property <key>]
                                   [--project <project>]
                                   [--project-domain <project-domain>]
                                   [--encryption-type]
                                   <volume-type>

Table 89.181. Positional Arguments

ValueSummary

<volume-type>

Volume type to modify (name or id)

Table 89.182. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Remove a property from this volume type (repeat option to remove multiple properties)

--project <project>

Removes volume type access to project (name or id) (admin only)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--encryption-type

Remove the encryption type for this volume type (admin only)

89.46. volume unset

Unset volume properties

Usage:

openstack volume unset [-h] [--property <key>] [--image-property <key>]
                              <volume>

Table 89.183. Positional Arguments

ValueSummary

<volume>

Volume to modify (name or id)

Table 89.184. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Remove a property from volume (repeat option to remove multiple properties)

--image-property <key>

Remove an image property from volume (repeat option to remove multiple image properties)

Chapter 90. workbook

This chapter describes the commands under the workbook command.

90.1. workbook create

Create new workbook.

Usage:

openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--public]
                                 [--namespace [NAMESPACE]]
                                 definition

Table 90.1. Positional Arguments

ValueSummary

definition

Workbook definition file

Table 90.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public

With this flag workbook will be marked as "public".

--namespace [NAMESPACE]

Namespace to create the workbook within.

Table 90.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 90.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 90.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 90.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.

90.2. workbook definition show

Show workbook definition.

Usage:

openstack workbook definition show [-h] name

Table 90.7. Positional Arguments

ValueSummary

name

Workbook name

Table 90.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

90.3. workbook delete

Delete workbook.

Usage:

openstack workbook delete [-h] [--namespace [NAMESPACE]]
                                 workbook [workbook ...]

Table 90.9. Positional Arguments

ValueSummary

workbook

Name of workbook(s).

Table 90.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to delete the workbook(s) from.

90.4. workbook list

List all workbooks.

Usage:

openstack workbook 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]

Table 90.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 90.12. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 90.13. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 90.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 90.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.

90.5. workbook show

Show specific workbook.

Usage:

openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workbook

Table 90.16. Positional Arguments

ValueSummary

workbook

Workbook name

Table 90.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workbook from.

Table 90.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 90.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 90.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 90.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.

90.6. workbook update

Update workbook.

Usage:

openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

Table 90.22. Positional Arguments

ValueSummary

definition

Workbook definition file

Table 90.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to update the workbook in.

--public

With this flag workbook will be marked as "public".

Table 90.24. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 90.25. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 90.26. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 90.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.

90.7. workbook validate

Validate workbook.

Usage:

openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

Table 90.28. Positional Arguments

ValueSummary

definition

Workbook definition file

Table 90.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 90.30. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 90.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 90.32. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 90.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.

Chapter 91. workflow

This chapter describes the commands under the workflow command.

91.1. workflow create

Create new workflow.

Usage:

openstack workflow 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]
                                 [--namespace [NAMESPACE]] [--public]
                                 definition

Table 91.1. Positional Arguments

ValueSummary

definition

Workflow definition file.

Table 91.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.

--namespace [NAMESPACE]

Namespace to create the workflow within.

--public

With this flag workflow will be marked as "public".

Table 91.3. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.4. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.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.

91.2. workflow definition show

Show workflow definition.

Usage:

openstack workflow definition show [-h] [--namespace [NAMESPACE]]
                                          identifier

Table 91.7. Positional Arguments

ValueSummary

identifier

Workflow id or name.

Table 91.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workflow from.

91.3. workflow delete

Delete workflow.

Usage:

openstack workflow delete [-h] [--namespace [NAMESPACE]]
                                 workflow [workflow ...]

Table 91.9. Positional Arguments

ValueSummary

workflow

Name or id of workflow(s).

Table 91.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to delete the workflow from.

91.4. workflow engine service list

List all services.

Usage:

openstack workflow engine service 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]

Table 91.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 91.12. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.13. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.14. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.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.

91.5. workflow env create

Create new environment.

Usage:

openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

Table 91.16. Positional Arguments

ValueSummary

file

Environment configuration file in json or yaml

Table 91.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.18. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.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.

91.6. workflow env delete

Delete environment.

Usage:

openstack workflow env delete [-h] environment [environment ...]

Table 91.22. Positional Arguments

ValueSummary

environment

Name of environment(s).

Table 91.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

91.7. workflow env list

List all environments.

Usage:

openstack workflow env 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]

Table 91.24. 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 91.25. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.26. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.28. 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.

91.8. workflow env show

Show specific environment.

Usage:

openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty] [--export]
                                   environment

Table 91.29. Positional Arguments

ValueSummary

environment

Environment name

Table 91.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--export

Export the environment suitable for import

Table 91.31. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.34. 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.

91.9. workflow env update

Update environment.

Usage:

openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     file

Table 91.35. Positional Arguments

ValueSummary

file

Environment configuration file in json or yaml

Table 91.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.37. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.38. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.39. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.40. 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.

91.10. workflow execution create

Create new execution.

Usage:

openstack workflow execution create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--namespace [NAMESPACE]]
                                           [-d DESCRIPTION]
                                           [-s [SOURCE_EXECUTION_ID]]
                                           [workflow_identifier]
                                           [workflow_input] [params]

Table 91.41. Positional Arguments

ValueSummary

workflow_identifier

Workflow id or name. workflow name will be deprecated since Mitaka.

workflow_input

Workflow input

params

Workflow additional parameters

Table 91.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Workflow namespace.

-d DESCRIPTION, --description DESCRIPTION

Execution description

-s [SOURCE_EXECUTION_ID]

Workflow execution id which will allow operators to create a new workflow execution based on the previously successful executed workflow. Example: mistral execution-create -s 123e4567-e89b-12d3-a456-426655440000

Table 91.43. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.45. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.46. 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.

91.11. workflow execution delete

Delete execution.

Usage:

openstack workflow execution delete [-h] [--force]
                                           execution [execution ...]

Table 91.47. Positional Arguments

ValueSummary

execution

Id of execution identifier(s).

Table 91.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Force the deletion of an execution. might cause a cascade of errors if used for running executions.

91.12. workflow execution input show

Show execution input data.

Usage:

openstack workflow execution input show [-h] id

Table 91.49. Positional Arguments

ValueSummary

id

Execution id

Table 91.50. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

91.13. workflow execution list

List all executions.

Usage:

openstack workflow 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 [TASK]]

Table 91.51. 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

--task [TASK]

Parent task execution id associated with workflow execution list.

Table 91.52. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.53. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.54. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.55. 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.

91.14. workflow execution output show

Show execution output data.

Usage:

openstack workflow execution output show [-h] id

Table 91.56. Positional Arguments

ValueSummary

id

Execution id

Table 91.57. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

91.15. workflow execution show

Show specific execution.

Usage:

openstack workflow execution show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--noindent]
                                         [--prefix PREFIX]
                                         [--max-width <integer>] [--fit-width]
                                         [--print-empty]
                                         execution

Table 91.58. Positional Arguments

ValueSummary

execution

Execution identifier

Table 91.59. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.60. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.61. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.62. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.63. 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.

91.16. workflow execution update

Update execution.

Usage:

openstack workflow execution update [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
                                           [-e ENV] [-d DESCRIPTION]
                                           id

Table 91.64. Positional Arguments

ValueSummary

id

Execution identifier

Table 91.65. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}

Execution state

-e ENV, --env ENV

Environment variables

-d DESCRIPTION, --description DESCRIPTION

Execution description

Table 91.66. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.67. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.68. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.69. 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.

91.17. workflow list

List all workflows.

Usage:

openstack workflow 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]

Table 91.70. 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 91.71. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.72. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.73. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.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.

91.18. workflow show

Show specific workflow.

Usage:

openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--namespace [NAMESPACE]]
                               workflow

Table 91.75. Positional Arguments

ValueSummary

workflow

Workflow id or name.

Table 91.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--namespace [NAMESPACE]

Namespace to get the workflow from.

Table 91.77. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.78. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.79. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.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.

91.19. workflow update

Update workflow.

Usage:

openstack workflow 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] [--namespace [NAMESPACE]]
                                 [--public]
                                 definition

Table 91.81. Positional Arguments

ValueSummary

definition

Workflow definition

Table 91.82. 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

Workflow id.

--namespace [NAMESPACE]

Namespace of the workflow.

--public

With this flag workflow will be marked as "public".

Table 91.83. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 91.84. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 91.85. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.86. 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.

91.20. workflow validate

Validate workflow.

Usage:

openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   definition

Table 91.87. Positional Arguments

ValueSummary

definition

Workflow definition file

Table 91.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 91.89. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 91.90. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 91.91. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 91.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.

Chapter 92. zone

This chapter describes the commands under the zone command.

92.1. zone abandon

Abandon a zone

Usage:

openstack zone abandon [-h] [--all-projects] [--edit-managed]
                              [--sudo-project-id SUDO_PROJECT_ID]
                              id

Table 92.1. Positional Arguments

ValueSummary

id

Zone id

Table 92.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.2. zone axfr

AXFR a zone

Usage:

openstack zone axfr [-h] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

Table 92.3. Positional Arguments

ValueSummary

id

Zone id

Table 92.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.3. zone blacklist create

Create new blacklist

Usage:

openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] --pattern PATTERN
                                       [--description DESCRIPTION]
                                       [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]

Table 92.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pattern PATTERN

Blacklist pattern

--description DESCRIPTION

Description

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.6. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.7. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.8. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.9. 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.

92.4. zone blacklist delete

Delete blacklist

Usage:

openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
                                       [--sudo-project-id SUDO_PROJECT_ID]
                                       id

Table 92.10. Positional Arguments

ValueSummary

id

Blacklist id

Table 92.11. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.5. zone blacklist list

List blacklists

Usage:

openstack zone blacklist 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]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]

Table 92.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.13. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.14. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.15. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.16. 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.

92.6. zone blacklist set

Set blacklist properties

Usage:

openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--pattern PATTERN]
                                    [--description DESCRIPTION | --no-description]
                                    [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    id

Table 92.17. Positional Arguments

ValueSummary

id

Blacklist id

Table 92.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pattern PATTERN

Blacklist pattern

--description DESCRIPTION

Description

--no-description—​all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.19. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.22. 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.

92.7. zone blacklist show

Show blacklist details

Usage:

openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--all-projects] [--edit-managed]
                                     [--sudo-project-id SUDO_PROJECT_ID]
                                     id

Table 92.23. Positional Arguments

ValueSummary

id

Blacklist id

Table 92.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.25. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.27. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.28. 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.

92.8. zone create

Create new zone

Usage:

openstack zone create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--email EMAIL] [--type TYPE]
                             [--ttl TTL] [--description DESCRIPTION]
                             [--masters MASTERS [MASTERS ...]]
                             [--attributes ATTRIBUTES [ATTRIBUTES ...]]
                             [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             name

Table 92.29. Positional Arguments

ValueSummary

name

Zone name

Table 92.30. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--email EMAIL

Zone email

--type TYPE

Zone type

--ttl TTL

Time to live (seconds)

--description DESCRIPTION

Description

--masters MASTERS [MASTERS …​]

Zone masters

--attributes ATTRIBUTES [ATTRIBUTES …​]

Zone attributes

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.31. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.33. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.34. 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.

92.9. zone delete

Delete zone

Usage:

openstack zone delete [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all-projects] [--edit-managed]
                             [--sudo-project-id SUDO_PROJECT_ID]
                             id

Table 92.35. Positional Arguments

ValueSummary

id

Zone id

Table 92.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.37. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.38. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.39. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.40. 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.

92.10. zone export create

Export a Zone

Usage:

openstack zone export create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_id

Table 92.41. Positional Arguments

ValueSummary

zone_id

Zone id

Table 92.42. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.43. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.45. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.46. 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.

92.11. zone export delete

Delete a Zone Export

Usage:

openstack zone export delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_export_id

Table 92.47. Positional Arguments

ValueSummary

zone_export_id

Zone export id

Table 92.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.12. zone export list

List Zone Exports

Usage:

openstack zone export 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] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

Table 92.49. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.50. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.51. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.53. 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.

92.13. zone export show

Show a Zone Export

Usage:

openstack zone export show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_export_id

Table 92.54. Positional Arguments

ValueSummary

zone_export_id

Zone export id

Table 92.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.56. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.58. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.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.

92.14. zone export showfile

Show the zone file for the Zone Export

Usage:

openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--all-projects]
                                      [--edit-managed]
                                      [--sudo-project-id SUDO_PROJECT_ID]
                                      zone_export_id

Table 92.60. Positional Arguments

ValueSummary

zone_export_id

Zone export id

Table 92.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.62. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.64. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.65. 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.

92.15. zone import create

Import a Zone from a file on the filesystem

Usage:

openstack zone import create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] [--all-projects]
                                    [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_file_path

Table 92.66. Positional Arguments

ValueSummary

zone_file_path

Path to a zone file

Table 92.67. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.68. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.70. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.71. 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.

92.16. zone import delete

Delete a Zone Import

Usage:

openstack zone import delete [-h] [--all-projects] [--edit-managed]
                                    [--sudo-project-id SUDO_PROJECT_ID]
                                    zone_import_id

Table 92.72. Positional Arguments

ValueSummary

zone_import_id

Zone import id

Table 92.73. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.17. zone import list

List Zone Imports

Usage:

openstack zone import 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] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]

Table 92.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.75. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.76. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.78. 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.

92.18. zone import show

Show a Zone Import

Usage:

openstack zone import show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  zone_import_id

Table 92.79. Positional Arguments

ValueSummary

zone_import_id

Zone import id

Table 92.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.81. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.83. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.84. 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.

92.19. zone list

List zones

Usage:

openstack 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]
                           [--name NAME] [--email EMAIL] [--type TYPE]
                           [--ttl TTL] [--description DESCRIPTION]
                           [--status STATUS] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]

Table 92.85. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--name NAME

Zone name

--email EMAIL

Zone email

--type TYPE

Zone type

--ttl TTL

Time to live (seconds)

--description DESCRIPTION

Description

--status STATUS

Zone status

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.86. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.87. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.88. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.89. 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.

92.20. zone set

Set zone properties

Usage:

openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--noindent] [--prefix PREFIX]
                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--email EMAIL] [--ttl TTL]
                          [--description DESCRIPTION | --no-description]
                          [--masters MASTERS [MASTERS ...]] [--all-projects]
                          [--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
                          id

Table 92.90. Positional Arguments

ValueSummary

id

Zone id

Table 92.91. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--email EMAIL

Zone email

--ttl TTL

Time to live (seconds)

--description DESCRIPTION

Description

--no-description—​masters MASTERS [MASTERS …​]

Zone masters

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.92. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.93. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.94. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.95. 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.

92.21. zone show

Show zone details

Usage:

openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--all-projects] [--edit-managed]
                           [--sudo-project-id SUDO_PROJECT_ID]
                           id

Table 92.96. Positional Arguments

ValueSummary

id

Zone id

Table 92.97. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.98. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.99. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.100. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.101. 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.

92.22. zone transfer accept list

List Zone Transfer Accepts

Usage:

openstack zone transfer accept 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]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]

Table 92.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.103. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.104. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.105. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.106. 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.

92.23. zone transfer accept request

Accept a Zone Transfer Request

Usage:

openstack zone transfer accept request [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              --transfer-id TRANSFER_ID --key
                                              KEY [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]

Table 92.107. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--transfer-id TRANSFER_ID

Transfer id

--key KEY

Transfer key

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.108. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.109. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.110. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.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.

92.24. zone transfer accept show

Show Zone Transfer Accept

Usage:

openstack zone transfer accept show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

Table 92.112. Positional Arguments

ValueSummary

id

Zone tranfer accept id

Table 92.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.114. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.115. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.116. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.117. 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.

92.25. zone transfer request create

Create new zone transfer request

Usage:

openstack zone transfer request create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--target-project-id TARGET_PROJECT_ID]
                                              [--description DESCRIPTION]
                                              [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              zone_id

Table 92.118. Positional Arguments

ValueSummary

zone_id

Zone id to transfer.

Table 92.119. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--target-project-id TARGET_PROJECT_ID

Target project id to transfer to.

--description DESCRIPTION

Description

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.120. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.121. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.122. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.123. 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.

92.26. zone transfer request delete

Delete a Zone Transfer Request

Usage:

openstack zone transfer request delete [-h] [--all-projects]
                                              [--edit-managed]
                                              [--sudo-project-id SUDO_PROJECT_ID]
                                              id

Table 92.124. Positional Arguments

ValueSummary

id

Zone transfer request id

Table 92.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

92.27. zone transfer request list

List Zone Transfer Requests

Usage:

openstack zone transfer request 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]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]

Table 92.126. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.127. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 92.128. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 92.129. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.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.

92.28. zone transfer request set

Set a Zone Transfer Request

Usage:

openstack zone transfer request set [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--description DESCRIPTION | --no-description]
                                           [--all-projects] [--edit-managed]
                                           [--sudo-project-id SUDO_PROJECT_ID]
                                           id

Table 92.131. Positional Arguments

ValueSummary

id

Zone transfer request id

Table 92.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description

--no-description—​all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.133. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.134. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.135. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.136. 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.

92.29. zone transfer request show

Show Zone Transfer Request Details

Usage:

openstack zone transfer request show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--all-projects] [--edit-managed]
                                            [--sudo-project-id SUDO_PROJECT_ID]
                                            id

Table 92.137. Positional Arguments

ValueSummary

id

Zone tranfer request id

Table 92.138. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Show results from all projects. default: false

--edit-managed

Edit resources marked as managed. default: false

--sudo-project-id SUDO_PROJECT_ID

Project id to impersonate for this command. default: None

Table 92.139. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 92.140. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 92.141. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

Table 92.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.