Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 2. OpenStack Command-line Client

The openstack client is a common OpenStack command-line interface (CLI). This chapter documents openstack version 3.2.0.
For help on a specific openstack command, enter:
$ openstack help COMMAND

2.1. openstack Usage

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>] [--timing] [--os-beta-command]
                 [--os-profile hmac-key]
                 [--os-compute-api-version <compute-api-version>]
                 [--os-network-api-version <network-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-application-catalog-api-version <application-catalog-api-version>]
                 [--murano-url MURANO_URL]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-auth-type <auth-type>]
                 [--os-authorization-code <auth-authorization-code>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-protocol <auth-protocol>]
                 [--os-project-name <auth-project-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-access-token <auth-access-token>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-user-id <auth-user-id>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-username <auth-username>]
                 [--os-auth-url <auth-auth-url>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-client-id <auth-client-id>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-access-key <auth-access-key>]
                 [--os-password <auth-password>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-endpoint <auth-endpoint>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-roles <auth-roles>] [--os-url <auth-url>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-token <auth-token>] [--os-passcode <auth-passcode>]
                 [--os-project-id <auth-project-id>]