Command Line Interface Reference
Command-line clients for Red Hat OpenStack Platform
Abstract
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Providing feedback on Red Hat documentation
We appreciate your input on our documentation. Tell us how we can make it better.
Using the Direct Documentation Feedback (DDF) function
Use the Add Feedback DDF function for direct comments on specific sentences, paragraphs, or code blocks.
- View the documentation in the Multi-page HTML format.
- Ensure that you see the Feedback button in the upper right corner of the document.
- Highlight the part of text that you want to comment on.
- Click Add Feedback.
- Complete the Add Feedback field with your comments.
- Optional: Add your email address so that the documentation team can contact you for clarification on your issue.
- Click Submit.
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 4.0.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-user-id <auth-user-id>] [--os-project-id <auth-project-id>] [--os-endpoint <auth-endpoint>] [--os-auth-url <auth-auth-url>] [--os-consumer-key <auth-consumer-key>] [--os-consumer-secret <auth-consumer-secret>] [--os-access-key <auth-access-key>] [--os-access-secret <auth-access-secret>] [--os-system-scope <auth-system-scope>] [--os-domain-id <auth-domain-id>] [--os-domain-name <auth-domain-name>] [--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-username <auth-username>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--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-passcode <auth-passcode>] [--os-identity-provider <auth-identity-provider>] [--os-protocol <auth-protocol>] [--os-access-token <auth-access-token>] [--os-password <auth-password>] [--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-user <auth-user>] [--os-token <auth-token>] [--os-auth-methods <auth-auth-methods>] [--os-redirect-uri <auth-redirect-uri>] [--os-code <auth-code>] [--os-default-domain-id <auth-default-domain-id>] [--os-default-domain-name <auth-default-domain-name>] [--os-roles <auth-roles>] [--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-aodh-endpoint <auth-aodh-endpoint>]
Value | Summary |
---|---|
--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=3 (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: noauth, v3oauth1, v3applicationcredential, v3totp, v3oidcaccesstoken, v3password, v3oidcclientcredentials, gnocchi-basic, admin_token, v2token, v3multifactor, v3oidcauthcode, none, v1password, token, v3token, v3tokenlessauth, v3oidcpassword, password, gnocchi-noauth, v3samlpassword, v3adfspassword, aodh-noauth, v2password. Default: selected based on --os- username/--os-token (Env: OS_AUTH_TYPE) |
--os-user-id <auth-user-id> | With noauth: user id with v3applicationcredential: User ID With v3totp: User ID With v3password: User ID With password: User id With gnocchi-noauth: User ID With aodh-noauth: User ID With v2password: User ID to login with (Env: OS_USER_ID) |
--os-project-id <auth-project-id> | With noauth: project id with v3applicationcredential: Project ID to scope to With v3totp: Project ID to scope to With v3oidcaccesstoken: Project ID to scope to With v3password: Project ID to scope to With v3oidcclientcredentials: Project ID to scope to With v3multifactor: Project ID to scope to With v3oidcauthcode: Project ID to scope to With token: Project ID to scope to With v3token: Project ID to scope to With v3tokenlessauth: Project ID to scope to With v3oidcpassword: Project ID to scope to With password: Project ID to scope to With gnocchi-noauth: Project ID With v3samlpassword: Project ID to scope to With v3adfspassword: Project ID to scope to With aodh- noauth: Project ID (Env: OS_PROJECT_ID) |
--os-endpoint <auth-endpoint> | With noauth: cinder endpoint with gnocchi-basic: Gnocchi endpoint With admin_token: The endpoint that will always be used With none: The endpoint that will always be used With gnocchi-noauth: Gnocchi endpoint (Env: OS_ENDPOINT) |
--os-auth-url <auth-auth-url> | With v3oauth1: authentication url with v3applicationcredential: Authentication URL With v3totp: Authentication URL With v3oidcaccesstoken: Authentication URL With v3password: Authentication URL With v3oidcclientcredentials: Authentication URL With v2token: Authentication URL With v3multifactor: Authentication URL With v3oidcauthcode: Authentication URL With v1password: Authentication URL With token: Authentication URL With v3token: Authentication URL With v3tokenlessauth: Authentication URL With v3oidcpassword: Authentication URL With password: Authentication URL With v3samlpassword: Authentication URL With v3adfspassword: Authentication URL With v2password: Authentication URL (Env: OS_AUTH_URL) |
--os-consumer-key <auth-consumer-key> | With v3oauth1: oauth consumer id/key (env: OS_CONSUMER_KEY) |
--os-consumer-secret <auth-consumer-secret> | With v3oauth1: oauth consumer secret (env: OS_CONSUMER_SECRET) |
--os-access-key <auth-access-key> | With v3oauth1: oauth access key (env: os_access_key) |
--os-access-secret <auth-access-secret> | With v3oauth1: oauth access secret (env: OS_ACCESS_SECRET) |
--os-system-scope <auth-system-scope> | With v3applicationcredential: scope for system operations With v3totp: Scope for system operations With v3oidcaccesstoken: Scope for system operations With v3password: Scope for system operations With v3oidcclientcredentials: Scope for system operations With v3multifactor: Scope for system operations With v3oidcauthcode: Scope for system operations With token: Scope for system operations With v3token: Scope for system operations With v3oidcpassword: Scope for system operations With password: Scope for system operations With v3samlpassword: Scope for system operations With v3adfspassword: Scope for system operations (Env: OS_SYSTEM_SCOPE) |
--os-domain-id <auth-domain-id> | With v3applicationcredential: domain id to scope to With v3totp: Domain ID to scope to With v3oidcaccesstoken: Domain ID to scope to With v3password: Domain ID to scope to With v3oidcclientcredentials: Domain ID to scope to With v3multifactor: Domain ID to scope to With v3oidcauthcode: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to With v3tokenlessauth: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With password: Domain ID to scope to With v3samlpassword: Domain ID to scope to With v3adfspassword: Domain ID to scope to (Env: OS_DOMAIN_ID) |
--os-domain-name <auth-domain-name> | With v3applicationcredential: domain name to scope to With v3totp: Domain name to scope to With v3oidcaccesstoken: Domain name to scope to With v3password: Domain name to scope to With v3oidcclientcredentials: Domain name to scope to With v3multifactor: Domain name to scope to With v3oidcauthcode: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to With v3tokenlessauth: Domain name to scope to With v3oidcpassword: Domain name to scope to With password: Domain name to scope to With v3samlpassword: Domain name to scope to With v3adfspassword: Domain name to scope to (Env: OS_DOMAIN_NAME) |
--os-project-name <auth-project-name> | With v3applicationcredential: project name to scope to With v3totp: Project name to scope to With v3oidcaccesstoken: Project name to scope to With v3password: Project name to scope to With v3oidcclientcredentials: Project name to scope to With v3multifactor: Project name to scope to With v3oidcauthcode: Project name to scope to With v1password: Swift account to use With token: Project name to scope to With v3token: Project name to scope to With v3tokenlessauth: Project name to scope to With v3oidcpassword: Project name to scope to With password: Project name to scope to With v3samlpassword: Project name to scope to With v3adfspassword: Project name to scope to (Env: OS_PROJECT_NAME) |
--os-project-domain-id <auth-project-domain-id> | With v3applicationcredential: domain id containing project With v3totp: Domain ID containing project With v3oidcaccesstoken: Domain ID containing project With v3password: Domain ID containing project With v3oidcclientcredentials: Domain ID containing project With v3multifactor: Domain ID containing project With v3oidcauthcode: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With v3tokenlessauth: Domain ID containing project With v3oidcpassword: Domain ID containing project With password: Domain ID containing project With v3samlpassword: Domain ID containing project With v3adfspassword: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID) |
--os-project-domain-name <auth-project-domain-name> | With v3applicationcredential: domain name containing project With v3totp: Domain name containing project With v3oidcaccesstoken: Domain name containing project With v3password: Domain name containing project With v3oidcclientcredentials: Domain name containing project With v3multifactor: Domain name containing project With v3oidcauthcode: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With v3tokenlessauth: Domain name containing project With v3oidcpassword: Domain name containing project With password: Domain name containing project With v3samlpassword: Domain name containing project With v3adfspassword: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME) |
--os-trust-id <auth-trust-id> | With v3applicationcredential: trust id with v3totp: Trust ID With v3oidcaccesstoken: Trust ID With v3password: Trust ID With v3oidcclientcredentials: Trust ID With v2token: Trust ID With v3multifactor: Trust ID With v3oidcauthcode: Trust ID With token: Trust ID With v3token: Trust ID With v3oidcpassword: Trust ID With password: Trust ID With v3samlpassword: Trust ID With v3adfspassword: Trust ID With v2password: Trust ID (Env: OS_TRUST_ID) |
--os-username <auth-username> | With v3applicationcredential: username with v3totp: Username With v3password: Username With v1password: Username to login with With v3oidcpassword: Username With password: Username With v3samlpassword: Username With v3adfspassword: Username With v2password: Username to login with (Env: OS_USERNAME) |
--os-user-domain-id <auth-user-domain-id> | With v3applicationcredential: user’s domain id with v3totp: User’s domain id With v3password: User’s domain id With password: User’s domain id (Env: OS_USER_DOMAIN_ID) |
--os-user-domain-name <auth-user-domain-name> | With v3applicationcredential: user’s domain name with v3totp: User’s domain name With v3password: User’s domain name With password: User’s domain name (Env: OS_USER_DOMAIN_NAME) |
--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-passcode <auth-passcode> | With v3totp: user’s totp passcode (env: os_passcode) |
--os-identity-provider <auth-identity-provider> | With v3oidcaccesstoken: identity provider’s name with v3oidcclientcredentials: Identity Provider’s name With v3oidcauthcode: Identity Provider’s name With v3oidcpassword: Identity Provider’s name With v3samlpassword: Identity Provider’s name With v3adfspassword: Identity Provider’s name (Env: OS_IDENTITY_PROVIDER) |
--os-protocol <auth-protocol> | With v3oidcaccesstoken: protocol for federated plugin With v3oidcclientcredentials: Protocol for federated plugin With v3oidcauthcode: Protocol for federated plugin With v3oidcpassword: Protocol for federated plugin With v3samlpassword: Protocol for federated plugin With v3adfspassword: Protocol for federated plugin (Env: OS_PROTOCOL) |
--os-access-token <auth-access-token> | With v3oidcaccesstoken: oauth 2.0 access token (env: OS_ACCESS_TOKEN) |
--os-password <auth-password> | With v3password: user’s password with v1password: Password to use With v3oidcpassword: Password With password: User’s password With v3samlpassword: Password With v3adfspassword: Password With v2password: Password to use (Env: OS_PASSWORD) |
--os-client-id <auth-client-id> | With v3oidcclientcredentials: oauth 2.0 client id with v3oidcauthcode: OAuth 2.0 Client ID With v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID) |
--os-client-secret <auth-client-secret> | With v3oidcclientcredentials: oauth 2.0 client secret With v3oidcauthcode: OAuth 2.0 Client Secret With v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET) |
--os-openid-scope <auth-openid-scope> | 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. With v3oidcpassword: OpenID Connect scope that is requested from authorization server. Note that the OpenID Connect specification states that "openid" must be always specified. (Env: OS_OPENID_SCOPE) |
--os-access-token-endpoint <auth-access-token-endpoint> | With 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. With v3oidcpassword: OpenID Connect Provider Token Endpoint. Note that if a discovery document is being passed this option will override the endpoint provided by the server in the discovery document. (Env: OS_ACCESS_TOKEN_ENDPOINT) |
--os-discovery-endpoint <auth-discovery-endpoint> | With 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 With v3oidcpassword: OpenID Connect Discovery Document URL. The discovery document will be used to obtain the values of the access token endpoint and the authentication endpoint. This URL should look like https://idp.example.org/.well-known/openid- configuration (Env: OS_DISCOVERY_ENDPOINT) |
--os-access-token-type <auth-access-token-type> | With 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" With v3oidcpassword: OAuth 2.0 Authorization Server Introspection token type, it is used to decide which type of token will be used when processing token introspection. Valid values are: "access_token" or "id_token" (Env: OS_ACCESS_TOKEN_TYPE) |
--os-user <auth-user> | With gnocchi-basic: user (env: os_user) |
--os-token <auth-token> | With admin_token: the token that will always be used With v2token: Token With token: Token to authenticate with With v3token: Token to authenticate with (Env: OS_TOKEN) |
--os-auth-methods <auth-auth-methods> | With v3multifactor: methods to authenticate with. (Env: OS_AUTH_METHODS) |
--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-default-domain-id <auth-default-domain-id> | With token: optional domain id to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. With password: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. (Env: OS_DEFAULT_DOMAIN_ID) |
--os-default-domain-name <auth-default-domain-name> | With token: optional domain name to use with v3 api and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. With password: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. (Env: OS_DEFAULT_DOMAIN_NAME) |
--os-roles <auth-roles> | With gnocchi-noauth: roles with aodh-noauth: roles (Env: OS_ROLES) |
--os-identity-provider-url <auth-identity-provider-url> | With v3samlpassword: an identity provider url, where the SAML2 authentication request will be sent. With v3adfspassword: An Identity Provider URL, where the SAML authentication request will be sent. (Env: OS_IDENTITY_PROVIDER_URL) |
--os-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-aodh-endpoint <auth-aodh-endpoint> | With aodh-noauth: aodh endpoint (env: OS_AODH_ENDPOINT) |
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>
Value | Summary |
---|---|
-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) |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
URI | The uri reference for the secret or container. |
Value | Summary |
---|---|
-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
Value | Summary |
---|---|
URI | The uri reference for the secret or container. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
URI | The uri reference for the secret or container. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
URI | The uri reference for the secret or container. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
URI | The uri reference for the secret or container. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
definition | Action definition file |
Value | Summary |
---|---|
-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". |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
name | Action name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
4.3. action definition delete
Delete action.
Usage:
openstack action definition delete [-h] action [action ...]
Value | Summary |
---|---|
action | Name or id of action(s). |
Value | Summary |
---|---|
-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]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
action | Action (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
definition | Action definition file |
Value | Summary |
---|---|
-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". |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 ...]
Value | Summary |
---|---|
action_execution | Id of action execution identifier(s). |
Value | Summary |
---|---|
-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
Value | Summary |
---|---|
id | Action execution id. |
Value | Summary |
---|---|
-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]
Value | Summary |
---|---|
task_execution_id | Task execution id. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
id | Action execution id. |
Value | Summary |
---|---|
-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]
Value | Summary |
---|---|
name | Action name to execute. |
input | Action input. |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
action_execution | Action execution id. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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
Value | Summary |
---|---|
id | Action execution id. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED} | Action execution state |
--output OUTPUT | Action execution output |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<name> | New address scope name |
Value | Summary |
---|---|
-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) |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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> ...]
Value | Summary |
---|---|
<address-scope> | Address scope(s) to delete (name or id) |
Value | Summary |
---|---|
-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]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<address-scope> | Address scope to modify (name or id) |
Value | Summary |
---|---|
-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>
Value | Summary |
---|---|
<address-scope> | Address scope to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<aggregate> | Aggregate (name or id) |
<host> | Host to add to <aggregate> |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<name> | New aggregate name |
Value | Summary |
---|---|
-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) |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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> ...]
Value | Summary |
---|---|
<aggregate> | Aggregate(s) to delete (name or id) |
Value | Summary |
---|---|
-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]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<aggregate> | Aggregate (name or id) |
<host> | Host to remove from <aggregate> |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<aggregate> | Aggregate to modify (name or id) |
Value | Summary |
---|---|
-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>
Value | Summary |
---|---|
<aggregate> | Aggregate to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<aggregate> | Aggregate to modify (name or id) |
Value | Summary |
---|---|
-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>]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
Value | Summary |
---|---|
--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. |
Value | Summary |
---|---|
--event-type <EVENT_TYPE> | Event type to evaluate against |
Value | Summary |
---|---|
--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 |
Value | Summary |
---|---|
--resource-type <RESOURCE_TYPE> | The type of resource. |
--resource-id <RESOURCE_ID> | The id of a resource. |
Value | Summary |
---|---|
--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>]
Value | Summary |
---|---|
<ALARM ID or NAME> | Id or name of an alarm. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <NAME> | Name of the alarm |
7.3. alarm-history search
Show history for all alarms based on query
Usage:
openstack alarm-history search [-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]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.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>
Value | Summary |
---|---|
<alarm-id> | Id of an alarm |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]
Value | Summary |
---|---|
<ALARM ID or NAME> | Id or name of an alarm. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <NAME> | Name of the alarm |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]
Value | Summary |
---|---|
<ALARM ID or NAME> | Id or name of an alarm. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <NAME> | Name of the alarm |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]
Value | Summary |
---|---|
<ALARM ID or NAME> | Id or name of an alarm. |
Value | Summary |
---|---|
-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] |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]
Value | Summary |
---|---|
<ALARM ID or NAME> | Id or name of an alarm. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
Value | Summary |
---|---|
--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. |
Value | Summary |
---|---|
--event-type <EVENT_TYPE> | Event type to evaluate against |
Value | Summary |
---|---|
--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 |
Value | Summary |
---|---|
--resource-type <RESOURCE_TYPE> | The type of resource. |
--resource-id <RESOURCE_ID> | The id of a resource. |
Value | Summary |
---|---|
--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]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<name> | Name of the application credential |
Value | Summary |
---|---|
-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) |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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> ...]
Value | Summary |
---|---|
<application-credential> | Application credentials(s) to delete (name or id) |
Value | Summary |
---|---|
-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>]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>
Value | Summary |
---|---|
<application-credential> | Application credential to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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>]] [--node NODE]
Value | Summary |
---|---|
-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. |
--node NODE | Backfill this allocation from the provided node that has already been deployed. Bypasses the normal allocation process. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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> ...]
Value | Summary |
---|---|
<allocation> | Allocations(s) to delete (name or uuid). |
Value | Summary |
---|---|
-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> ...]]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 set
Set baremetal allocation properties.
Usage:
openstack baremetal allocation set [-h] [--name <name>] [--extra <key=value>] <allocation>
Value | Summary |
---|---|
<allocation> | Name or uuid of the allocation |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | Set the name of the allocation |
--extra <key=value> | Extra property to set on this allocation (repeat option to set multiple extra properties) |
11.5. 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>
Value | Summary |
---|---|
<id> | Uuid or name of the allocation |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 allocation unset
Unset baremetal allocation properties.
Usage:
openstack baremetal allocation unset [-h] [--name] [--extra <key>] <allocation>
Value | Summary |
---|---|
<allocation> | Name or uuid of the allocation |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name | Unset the name of the allocation |
--extra <key> | Extra property to unset on this baremetal allocation (repeat option to unset multiple extra property). |
11.7. 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>]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 delete
Delete a chassis.
Usage:
openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]
Value | Summary |
---|---|
<chassis> | Uuids of chassis to delete |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.9. 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>]]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 set
Set chassis properties.
Usage:
openstack baremetal chassis set [-h] [--description <description>] [--extra <key=value>] <chassis>
Value | Summary |
---|---|
<chassis> | Uuid of the chassis |
Value | Summary |
---|---|
-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.11. 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>
Value | Summary |
---|---|
<chassis> | Uuid of the chassis |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 chassis unset
Unset chassis properties.
Usage:
openstack baremetal chassis unset [-h] [--description] [--extra <key>] <chassis>
Value | Summary |
---|---|
<chassis> | Uuid of the chassis |
Value | Summary |
---|---|
-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.13. 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> ...]]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.14. 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>
Value | Summary |
---|---|
<conductor> | Hostname of the conductor |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 create
Create resources from files
Usage:
openstack baremetal create [-h] <file> [<file> ...]
Value | Summary |
---|---|
<file> | File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.16. 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>
Value | Summary |
---|---|
<name> | Unique name for this deploy template. must be a valid trait name |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 delete
Delete deploy template(s).
Usage:
openstack baremetal deploy template delete [-h] <template> [<template> ...]
Value | Summary |
---|---|
<template> | Name(s) or uuid(s) of the deploy template(s) to delete. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.18. 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> ...]]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 set
Set baremetal deploy template properties.
Usage:
openstack baremetal deploy template set [-h] [--name <name>] [--steps <steps>] [--extra <key=value>] <template>
Value | Summary |
---|---|
<template> | Name or uuid of the deploy template |
Value | Summary |
---|---|
-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.20. 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>
Value | Summary |
---|---|
<template> | Name or uuid of the deploy template. |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 deploy template unset
Unset baremetal deploy template properties.
Usage:
openstack baremetal deploy template unset [-h] [--extra <key>] <template>
Value | Summary |
---|---|
<template> | Name or uuid of the deploy template |
Value | Summary |
---|---|
-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.22. 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]
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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>
Value | Summary |
---|---|
<driver> | Name of the driver. |
<method> | Vendor passthru method to be called. |
Value | Summary |
---|---|
-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. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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>
Value | Summary |
---|---|
<driver> | Name of the driver. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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>
Value | Summary |
---|---|
<driver> | Name of the driver. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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>
Value | Summary |
---|---|
<driver> | Name of the driver. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.27. 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>
Value | Summary |
---|---|
<driver> | Name of the driver. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.28. baremetal introspection abort
Abort running introspection for node.
Usage:
openstack baremetal introspection abort [-h] node
Value | Summary |
---|---|
node | Baremetal node uuid or name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.29. baremetal introspection data save
Save or display raw introspection data.
Usage:
openstack baremetal introspection data save [-h] [--file <filename>] node
Value | Summary |
---|---|
node | Baremetal node uuid or name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--file <filename> | Downloaded introspection data filename (default: stdout) |
11.30. 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
Value | Summary |
---|---|
node_ident | Baremetal node uuid or name |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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
Value | Summary |
---|---|
node_ident | Baremetal node uuid or name |
interface | Interface name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--fields <field> [<field> …] | Display one or more fields. |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.32. 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]
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.33. baremetal introspection reprocess
Reprocess stored introspection data
Usage:
openstack baremetal introspection reprocess [-h] node
Value | Summary |
---|---|
node | Baremetal node uuid or name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.34. baremetal introspection rule delete
Delete an introspection rule.
Usage:
openstack baremetal introspection rule delete [-h] uuid
Value | Summary |
---|---|
uuid | Rule uuid |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.35. 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
Value | Summary |
---|---|
file | Json or yaml file to import, may contain one or several rules |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.36. 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]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 rule purge
Drop all introspection rules.
Usage:
openstack baremetal introspection rule purge [-h]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.38. 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
Value | Summary |
---|---|
uuid | Rule uuid |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 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 ...]
Value | Summary |
---|---|
node | Baremetal node uuid(s) or name(s) |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.40. 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
Value | Summary |
---|---|
node | Baremetal node uuid or name |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.41. baremetal node abort
Set provision state of baremetal node to abort
Usage:
openstack baremetal node abort [-h] <node>
Value | Summary |
---|---|
<node> | Name or uuid of the node. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.42. baremetal node add trait
Add traits to a node.
Usage:
openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
Value | Summary |
---|---|
<node> | Name or uuid of the node |
<trait> | Trait(s) to add |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.43. baremetal node adopt
Set provision state of baremetal node to adopt
Usage:
openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
Value | Summary |
---|---|
<node> | Name or uuid of the node. |
Value | Summary |
---|---|
-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.44. 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>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.45. 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>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
<setting name> | Setting name to show |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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 boot device set
Set the boot device for a node
Usage:
openstack baremetal node boot device set [-h] [--persistent] <node> <device>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
<device> | One of bios, cdrom, disk, pxe, safe, wanboot |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--persistent | Make changes persistent for all future boots |
11.47. 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>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--supported | Show the supported boot devices |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.48. 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>
Value | Summary |
---|---|
<node> | Name or uuid of the node. |
Value | Summary |
---|---|
-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.49. baremetal node console disable
Disable console access for a node
Usage:
openstack baremetal node console disable [-h] <node>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.50. baremetal node console enable
Enable console access for a node
Usage:
openstack baremetal node console enable [-h] <node>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
11.51. 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>
Value | Summary |
---|---|
<node> | Name or uuid of the node |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 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.52. 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>]
Value | Summary |
---|---|
-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 driv |