-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat OpenStack Platform
2.2. openstack Optional Arguments
- --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]. (Env: OS_INTERFACE)
- --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 (Env:
OS_COMPUTE_API_VERSION)
- --os-network-api-version <network-api-version>
Network API version, default=2.0 (Env:
OS_NETWORK_API_VERSION)
- --os-image-api-version <image-api-version>
Image API version, default=2 (Env:
OS_IMAGE_API_VERSION)
- --os-volume-api-version <volume-api-version>
Volume API version, default=2 (Env:
OS_VOLUME_API_VERSION)
- --os-identity-api-version <identity-api-version>
Identity API version, default=3 (Env:
OS_IDENTITY_API_VERSION)
- --os-object-api-version <object-api-version>
Object API version, default=1 (Env:
OS_OBJECT_API_VERSION)
- --os-metrics-api-version <metrics-api-version>
Metrics API version, default=1 (Env:
OS_METRICS_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-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-alarming-api-version <alarming-api-version>
Queues API version, default=2 (Env:
OS_ALARMING_API_VERSION)
- --os-key-manager-api-version <key-manager-api-version>
Barbican API version, default=1 (Env:
OS_KEY_MANAGER_API_VERSION)
- --os-application-catalog-api-version <application-catalog-api-version>
Application catalog API version,
default=1(Env:OS_APPLICATION_CATALOG_API_VERSION)
- --murano-url MURANO_URL
Defaults toenv[MURANO_URL]
.
- --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-container-infra-api-version <container-infra-api-version>
Container-Infra API version, default=1 (Env:
OS_CONTAINER_INFRA_API_VERSION)
- --os-queues-api-version <queues-api-version>
Queues API version, default=2 (Env:
OS_QUEUES_API_VERSION)
- --os-baremetal-api-version <baremetal-api-version>
Baremetal API version, default=1.6 (Env:
OS_BAREMETAL_API_VERSION)
- --os-workflow-api-version <workflow-api-version>
Workflow API version, default=2 (Env:
OS_WORKFLOW_API_VERSION)
- --os-auth-type <auth-type>
Select an authentication type. Available types:
v2token, password, admin_token, v3oidcauthcode,
v3oidcpassword, v2password, v3samlpassword,
v3password, v3oidcaccesstoken, token_endpoint,
v3kerberos, v3totp, token, v3oidcclientcredentials,
v3tokenlessauth, gnocchi-noauth, v3token, v3oauth1,
aodh-noauth, v3fedkerb. Default: selected based on
--os-username/--os-token (Env: OS_AUTH_TYPE)
- --os-authorization-code <auth-authorization-code>
With v3oidcauthcode: OAuth 2.0 Authorization Code
(Env: OS_AUTHORIZATION_CODE)
- --os-project-domain-id <auth-project-domain-id>
With password: Domain ID containing project With
v3oidcauthcode: Domain ID containing project With
v3oidcpassword: Domain ID containing project With
v3samlpassword: Domain ID containing project With
v3password: Domain ID containing project With
v3oidcaccesstoken: Domain ID containing project With
v3kerberos: Domain ID containing project With v3totp:
Domain ID containing project With token: Domain ID
containing project With v3oidcclientcredentials:
Domain ID containing project With v3tokenlessauth:
Domain ID containing project With v3token: Domain ID
containing project With v3fedkerb: Domain ID
containing project (Env: OS_PROJECT_DOMAIN_ID)
- --os-protocol <auth-protocol>
With v3oidcauthcode: Protocol for federated plugin
With v3oidcpassword: Protocol for federated plugin
With v3samlpassword: Protocol for federated plugin
With v3oidcaccesstoken: Protocol for federated plugin
With v3oidcclientcredentials: Protocol for federated
plugin (Env: OS_PROTOCOL)
- --os-project-name <auth-project-name>
With password: Project name to scope to With
v3oidcauthcode: Project name to scope to With
v3oidcpassword: Project name to scope to With
v3samlpassword: Project name to scope to With
v3password: Project name to scope to With
v3oidcaccesstoken: Project name to scope to With
v3kerberos: Project name to scope to With v3totp:
Project name to scope to With token: Project name to
scope to With v3oidcclientcredentials: Project name to
scope to With v3tokenlessauth: Project name to scope
to With v3token: Project name to scope to With
v3fedkerb: Project name to scope to (Env:
OS_PROJECT_NAME)
- --os-trust-id <auth-trust-id>
With v2token: Trust ID With password: Trust ID With
v3oidcauthcode: Trust ID With v3oidcpassword: Trust ID
With v2password: Trust ID With v3samlpassword: Trust
ID With v3password: Trust ID With v3oidcaccesstoken:
Trust ID With v3kerberos: Trust ID With v3totp: Trust
ID With token: Trust ID With v3oidcclientcredentials:
Trust ID With v3token: Trust ID With v3fedkerb: Trust
ID (Env: OS_TRUST_ID)
- --os-consumer-key <auth-consumer-key>
With v3oauth1: OAuth Consumer ID/Key (Env:
OS_CONSUMER_KEY)
- --os-domain-name <auth-domain-name>
With password: Domain name to scope to With
v3oidcauthcode: Domain name to scope to With
v3oidcpassword: Domain name to scope to With
v3samlpassword: Domain name to scope to With
v3password: Domain name to scope to With
v3oidcaccesstoken: Domain name to scope to With
v3kerberos: Domain name to scope to With v3totp:
Domain name to scope to With token: Domain name to
scope to With v3oidcclientcredentials: Domain name to
scope to With v3tokenlessauth: Domain name to scope to
With v3token: Domain name to scope to With v3fedkerb:
Domain name to scope to (Env: OS_DOMAIN_NAME)
- --os-access-secret <auth-access-secret>
With v3oauth1: OAuth Access Secret (Env:
OS_ACCESS_SECRET)
- --os-user-domain-id <auth-user-domain-id>
With password: User's domain id With v3password:
User's domain id With v3totp: User's domain id (Env:
OS_USER_DOMAIN_ID)
- --os-access-token-type <auth-access-token-type>
With v3oidcauthcode: OAuth 2.0 Authorization Server
Introspection token type, it is used to decide which
type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" With v3oidcpassword: OAuth 2.0
Authorization Server Introspection token type, it is
used to decide which type of token will be used when
processing token introspection. Valid values are:
"access_token" or "id_token" With
v3oidcclientcredentials: OAuth 2.0 Authorization
Server Introspection token type, it is used to decide
which type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" (Env: OS_ACCESS_TOKEN_TYPE)
- --os-identity-provider-url <auth-identity-provider-url>
With v3samlpassword: An Identity Provider URL, where
the SAML2 authentication request will be sent. (Env:
OS_IDENTITY_PROVIDER_URL)
- --os-default-domain-name <auth-default-domain-name>
With password: Optional domain name to use with v3 API
and v2 parameters. It will be used for both the user
and project domain in v3 and ignored in v2
authentication. With token: Optional domain name to
use with v3 API and v2 parameters. It will be used for
both the user and project domain in v3 and ignored in
v2 authentication. (Env: OS_DEFAULT_DOMAIN_NAME)
- --os-access-token-endpoint <auth-access-token-endpoint>
With v3oidcauthcode: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcpassword: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcclientcredentials: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. (Env:
OS_ACCESS_TOKEN_ENDPOINT)
- --os-access-token <auth-access-token>
With v3oidcaccesstoken: OAuth 2.0 Access Token (Env:
OS_ACCESS_TOKEN)
- --os-domain-id <auth-domain-id>
With password: Domain ID to scope to With
v3oidcauthcode: Domain ID to scope to With
v3oidcpassword: Domain ID to scope to With
v3samlpassword: Domain ID to scope to With v3password:
Domain ID to scope to With v3oidcaccesstoken: Domain
ID to scope to With v3kerberos: Domain ID to scope to
With v3totp: Domain ID to scope to With token: Domain
ID to scope to With v3oidcclientcredentials: Domain ID
to scope to With v3tokenlessauth: Domain ID to scope
to With v3token: Domain ID to scope to With v3fedkerb:
Domain ID to scope to (Env: OS_DOMAIN_ID)
- --os-user-domain-name <auth-user-domain-name>
With password: User's domain name With v3password:
User's domain name With v3totp: User's domain name
(Env: OS_USER_DOMAIN_NAME)
- --os-openid-scope <auth-openid-scope>
With v3oidcauthcode: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. With v3oidcpassword: OpenID
Connect scope that is requested from authorization
server. Note that the OpenID Connect specification
states that "openid" must be always specified. With
v3oidcclientcredentials: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. (Env: OS_OPENID_SCOPE)
- --os-user-id <auth-user-id>
With password: User id With v2password: User ID to
login with With v3password: User ID With v3totp: User
ID With gnocchi-noauth: User ID With aodh-noauth: User
ID (Env: OS_USER_ID)
- --os-identity-provider <auth-identity-provider>
With v3oidcauthcode: Identity Provider's name With
v3oidcpassword: Identity Provider's name With
v3samlpassword: Identity Provider's name With
v3oidcaccesstoken: Identity Provider's name With
v3oidcclientcredentials: Identity Provider's name
(Env: OS_IDENTITY_PROVIDER)
- --os-username <auth-username>
With password: Username With v3oidcpassword: Username
With v2password: Username to login with With
v3samlpassword: Username With v3password: Username
With v3totp: Username (Env: OS_USERNAME)
- --os-auth-url <auth-auth-url>
With v2token: Authentication URL With password:
Authentication URL With v3oidcauthcode: Authentication
URL With v3oidcpassword: Authentication URL With
v2password: Authentication URL With v3samlpassword:
Authentication URL With v3password: Authentication URL
With v3oidcaccesstoken: Authentication URL With
v3kerberos: Authentication URL With v3totp:
Authentication URL With token: Authentication URL With
v3oidcclientcredentials: Authentication URL With
v3tokenlessauth: Authentication URL With v3token:
Authentication URL With v3oauth1: Authentication URL
With v3fedkerb: Authentication URL (Env: OS_AUTH_URL)
- --os-client-secret <auth-client-secret>
With v3oidcauthcode: OAuth 2.0 Client Secret With
v3oidcpassword: OAuth 2.0 Client Secret With
v3oidcclientcredentials: OAuth 2.0 Client Secret (Env:
OS_CLIENT_SECRET)
- --os-default-domain-id <auth-default-domain-id>
With password: Optional domain ID to use with v3 and
v2 parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
With token: Optional domain ID to use with v3 and v2
parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
(Env: OS_DEFAULT_DOMAIN_ID)
- --os-discovery-endpoint <auth-discovery-endpoint>
With v3oidcauthcode: OpenID Connect Discovery Document
URL. The discovery document will be used to obtain the
values of the access token endpoint and the
authentication endpoint. This URL should look like
https://idp.example.org/.well-known/openid-
configuration With v3oidcpassword: OpenID Connect
Discovery Document URL. The discovery document will be
used to obtain the values of the access token endpoint
and the authentication endpoint. This URL should look
like https://idp.example.org/.well-known/openid-
configuration With v3oidcclientcredentials: OpenID
Connect Discovery Document URL. The discovery document
will be used to obtain the values of the access token
endpoint and the authentication endpoint. This URL
should look like https://idp.example.org/.well-known
/openid-configuration (Env: OS_DISCOVERY_ENDPOINT)
- --os-client-id <auth-client-id>
With v3oidcauthcode: OAuth 2.0 Client ID With
v3oidcpassword: OAuth 2.0 Client ID With
v3oidcclientcredentials: OAuth 2.0 Client ID (Env:
OS_CLIENT_ID)
- --os-project-domain-name <auth-project-domain-name>
With password: Domain name containing project With
v3oidcauthcode: Domain name containing project With
v3oidcpassword: Domain name containing project With
v3samlpassword: Domain name containing project With
v3password: Domain name containing project With
v3oidcaccesstoken: Domain name containing project With
v3kerberos: Domain name containing project With
v3totp: Domain name containing project With token:
Domain name containing project With
v3oidcclientcredentials: Domain name containing
project With v3tokenlessauth: Domain name containing
project With v3token: Domain name containing project
With v3fedkerb: Domain name containing project (Env:
OS_PROJECT_DOMAIN_NAME)
- --os-access-key <auth-access-key>
With v3oauth1: OAuth Access Key (Env: OS_ACCESS_KEY)
- --os-password <auth-password>
With password: User's password With v3oidcpassword:
Password With v2password: Password to use With
v3samlpassword: Password With v3password: User's
password (Env: OS_PASSWORD)
- --os-redirect-uri <auth-redirect-uri>
With v3oidcauthcode: OpenID Connect Redirect URL (Env:
OS_REDIRECT_URI)
- --os-endpoint <auth-endpoint>
With admin_token: The endpoint that will always be
used With gnocchi-noauth: Gnocchi endpoint (Env:
OS_ENDPOINT)
- --os-aodh-endpoint <auth-aodh-endpoint>
With aodh-noauth: Aodh endpoint (Env:
OS_AODH_ENDPOINT)
- --os-roles <auth-roles>
With gnocchi-noauth: Roles With aodh-noauth: Roles
(Env: OS_ROLES)
- --os-url <auth-url>
With token_endpoint: Specific service endpoint to use
(Env: OS_URL)
- --os-consumer-secret <auth-consumer-secret>
With v3oauth1: OAuth Consumer Secret (Env:
OS_CONSUMER_SECRET)
- --os-token <auth-token>
With v2token: Token With admin_token: The token that
will always be used With token_endpoint:
Authentication token to use With token: Token to
authenticate with With v3token: Token to authenticate
with (Env: OS_TOKEN)
- --os-passcode <auth-passcode>
With v3totp: User's TOTP passcode (Env: OS_PASSCODE)
- --os-project-id <auth-project-id>
With password: Project ID to scope to With
v3oidcauthcode: Project ID to scope to With
v3oidcpassword: Project ID to scope to With
v3samlpassword: Project ID to scope to With
v3password: Project ID to scope to With
v3oidcaccesstoken: Project ID to scope to With
v3kerberos: Project ID to scope to With v3totp:
Project ID to scope to With token: Project ID to scope
to With v3oidcclientcredentials: Project ID to scope
to With v3tokenlessauth: Project ID to scope to With
gnocchi-noauth: Project ID With v3token: Project ID to
scope to With aodh-noauth: Project ID With v3fedkerb:
Project ID to scope to (Env: OS_PROJECT_ID)