usage: magnum [--version] [--debug] [--os-cache] [--os-region-name <region-name>]
[--os-auth-url <auth-auth-url>] [--os-user-id <auth-user-id>]
[--os-username <auth-username>] [--os-user-domain-id <auth-user-domain-id>]
[--os-user-domain-name <auth-user-domain-name>] [--os-project-id <auth-project-id>]
[--os-project-name <auth-project-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>] [--os-token <auth-token>]
[--os-password <auth-password>] [--service-type <service-type>]
[--os-endpoint-type <os-endpoint-type>] [--os-cloud <auth-cloud>]
[--magnum-api-version <magnum-api-ver>] [--os-cacert <ca-certificate>]
[--os-endpoint-override <endpoint-override>] [--insecure] [--profile HMAC_KEY]
<subcommand> ...
Command-line interface to the OpenStack Magnum API.
Positional arguments:
<subcommand>
ca-rotate Rotate the CA certificate for a cluster to revoke access.
ca-show Show details about the CA certificate for a cluster.
ca-sign Generate the CA certificate for a cluster.
cluster-config Configure native client to access cluster. You can source the output of
this command to get the native client of the corresponding COE configured
to access the cluster. Example: eval $(magnum cluster-config <cluster-
name>).
cluster-create Create a cluster.
cluster-delete Delete specified cluster.
cluster-list Print a list of available clusters.
cluster-show Show details about the given cluster.
cluster-update Update information about the given cluster.
cluster-template-create
Create a cluster template.
cluster-template-delete
Delete specified cluster template.
cluster-template-list
Print a list of cluster templates.
cluster-template-show
Show details about the given cluster template.
cluster-template-update
Updates one or more cluster template attributes.
service-list Print a list of magnum services.
stats-list Show stats for the given project_id
quotas-create Create a quota.
quotas-delete Delete specified resource quota.
quotas-list Print a list of available quotas.
quotas-show Show details about the given project resource quota.
quotas-update Update information about the given project resource quota.
bash-completion Prints arguments for bash-completion. Prints all of the commands and
options to stdout so that the magnum.bash_completion script doesn't have
to hard code them.
help Display help about this program or one of its subcommands.
Options:
--version show program's version number and exit
--debug Print debugging output.
--os-cache Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.
--os-region-name <region-name>
Region name. Default=env[OS_REGION_NAME].
--os-auth-url <auth-auth-url>
Defaults to env[OS_AUTH_URL].
--os-user-id <auth-user-id>
Defaults to env[OS_USER_ID].
--os-username <auth-username>
Defaults to env[OS_USERNAME].
--os-user-domain-id <auth-user-domain-id>
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-id <auth-project-id>
Defaults to env[OS_PROJECT_ID].
--os-project-name <auth-project-name>
Defaults to env[OS_PROJECT_NAME].
--os-project-domain-id <auth-project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <auth-project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-token <auth-token>
Defaults to env[OS_TOKEN].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--service-type <service-type>
Defaults to container-infra for all actions.
--os-endpoint-type <os-endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE]
--os-cloud <auth-cloud>
Defaults to env[OS_CLOUD].
--magnum-api-version <magnum-api-ver>
Accepts "api", defaults to env[MAGNUM_API_VERSION].
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server
certificate. Defaults to env[OS_CACERT].
--os-endpoint-override <endpoint-override>
Use this API endpoint instead of the Service Catalog.
--insecure Do not verify https connections
--profile HMAC_KEY HMAC key to use for encrypting context data for performance profiling of
operation. This key should be the value of the HMAC key configured for the
OSprofiler middleware in magnum; it is specified in the Magnum
configuration file at "/etc/magnum/magnum.conf". Without the key,
profiling will not be triggered even if OSprofiler is enabled on the
server side.
See "magnum help COMMAND" for help on a specific command.
Options (23)
| Option | Description | Source |
|---|---|---|
--version | show program's version number and exit | help |
--debug | Print debugging output. | help |
--os-cache | Use the auth token cache. | help |
--os-region-name region-name | Region name. | help |
--os-auth-url auth-auth-url | Defaults to env[OS_AUTH_URL]. | help |
--os-user-id auth-user-id | Defaults to env[OS_USER_ID]. | help |
--os-username auth-username | Defaults to env[OS_USERNAME]. | help |
--os-user-domain-id auth-user-domain-id | Defaults to env[OS_USER_DOMAIN_ID]. | help |
--os-user-domain-name auth-user-domain-name | Defaults to env[OS_USER_DOMAIN_NAME]. | help |
--os-project-id auth-project-id | Defaults to env[OS_PROJECT_ID]. | help |
--os-project-name auth-project-name | Defaults to env[OS_PROJECT_NAME]. | help |
--os-project-domain-id auth-project-domain-id | Defaults to env[OS_PROJECT_DOMAIN_ID]. | help |
--os-project-domain-name auth-project-domain-name | Defaults to env[OS_PROJECT_DOMAIN_NAME]. | help |
--os-token auth-token | Defaults to env[OS_TOKEN]. | help |
--os-password auth-password | Defaults to env[OS_PASSWORD]. | help |
--service-type service-type | Defaults to container-infra for all actions. | help |
--os-endpoint-type os-endpoint-type | Defaults to env[OS_ENDPOINT_TYPE] | help |
--os-cloud auth-cloud | Defaults to env[OS_CLOUD]. | help |
--magnum-api-version magnum-api-ver | Accepts "api", defaults to env[MAGNUM_API_VERSION]. | help |
--os-cacert ca-certificate | Specify a CA bundle file to use in verifying a TLS (https) server certificate. | help |
--os-endpoint-override endpoint-override | Use this API endpoint instead of the Service Catalog. | help |
--insecure | Do not verify https connections | help |
--profile HMAC_KEY | HMAC key to use for encrypting context data for performance profiling of operation. | help |