OpenStack client The openstack client is a common OpenStack command-line interface (CLI). This chapter documents openstack version 1.2.0. For help on a specific openstack command, enter: $ openstack COMMAND
openstack usage usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--timing] [--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-auth-type <auth-type>] [--os-username <auth-username>] [--os-identity-provider <auth-identity-provider>] [--os-project-domain-name <auth-project-domain-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-name <auth-project-name>] [--os-auth-url <auth-auth-url>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-trust-id <auth-trust-id>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-user-domain-id <auth-user-domain-id>] [--os-url <auth-url>] [--os-token <auth-token>] [--os-domain-name <auth-domain-name>] [--os-user-domain-name <auth-user-domain-name>] [--os-domain-id <auth-domain-id>] [--os-user-id <auth-user-id>] [--os-password <auth-password>] [--os-endpoint <auth-endpoint>] [--os-project-id <auth-project-id>] [--os-object-api-version <object-api-version>]
openstack optional arguments --version show program's version number and exit -v, --verbose Increase verbosity of output. Can be repeated. --log-file LOG_FILE Specify a file to log output. Disabled by default. -q, --quiet suppress output except warnings and errors -h, --help show this 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) --verify Verify server certificate (default) --insecure Disable server certificate verification --os-default-domain <auth-domain> Default domain ID, default=default (Env: OS_DEFAULT_DOMAIN) --timing Print API call timing info --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 (Env: OS_NETWORK_API_VERSION) --os-image-api-version <image-api-version> Image API version, default=1 (Env: OS_IMAGE_API_VERSION) --os-volume-api-version <volume-api-version> Volume API version, default=1 (Env: OS_VOLUME_API_VERSION) --os-identity-api-version <identity-api-version> Identity API version, default=2 (Env: OS_IDENTITY_API_VERSION) --os-auth-type <auth-type> Select an auhentication type. Available types: osc_password, token_endpoint, v2token, v2password, v3password, v3scopedsaml, v3unscopedadfs, token, v3token, password, v3unscopedsaml. Default: selected based on --os-username/--os-token (Env: OS_AUTH_TYPE) --os-username <auth-username> With osc_password: Username With v2password: Username to login with With v3password: Username With v3unscopedadfs: Username With password: Username With v3unscopedsaml: Username (Env: OS_USERNAME) --os-identity-provider <auth-identity-provider> With v3unscopedadfs: Identity Provider's name With v3unscopedsaml: Identity Provider's name (Env: OS_IDENTITY_PROVIDER) --os-project-domain-name <auth-project-domain-name> With osc_password: Domain name containing project With v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3unscopedadfs: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With password: Domain name containing project With v3unscopedsaml: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME) --os-project-domain-id <auth-project-domain-id> With osc_password: Domain ID containing project With v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3unscopedadfs: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With password: Domain ID containing project With v3unscopedsaml: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID) --os-project-name <auth-project-name> With osc_password: Project name to scope to With v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With password: Project name to scope to With v3unscopedsaml: Project name to scope to (Env: OS_PROJECT_NAME) --os-auth-url <auth-auth-url> With osc_password: Authentication URL With v2token: Authentication URL With v2password: Authentication URL With v3password: Authentication URL With v3scopedsaml: Authentication URL With v3unscopedadfs: Authentication URL With token: Authentication URL With v3token: Authentication URL With password: Authentication URL With v3unscopedsaml: Authentication URL (Env: OS_AUTH_URL) --os-identity-provider-url <auth-identity-provider-url> With v3unscopedadfs: Identity Provider's URL With v3unscopedsaml: Identity Provider's URL (Env: OS_IDENTITY_PROVIDER_URL) --os-trust-id <auth-trust-id> With osc_password: Trust ID With v2token: Trust ID With v2password: Trust ID With v3password: Trust ID With v3scopedsaml: Trust ID With v3unscopedadfs: Trust ID With token: Trust ID With v3token: Trust ID With password: Trust ID With v3unscopedsaml: Trust ID (Env: OS_TRUST_ID) --os-service-provider-endpoint <auth-service-provider-endpoint> With v3unscopedadfs: Service Provider's Endpoint (Env: OS_SERVICE_PROVIDER_ENDPOINT) --os-user-domain-id <auth-user-domain-id> With osc_password: User's domain id With v3password: User's domain id With password: User's domain id (Env: OS_USER_DOMAIN_ID) --os-url <auth-url> With token_endpoint: Specific service endpoint to use (Env: OS_URL) --os-token <auth-token> With token_endpoint: The token that will always be used With token_endpoint: Authentication token to use With v2token: Token With v3scopedsaml: Token to authenticate with With token: Token to authenticate with With v3token: Token to authenticate with (Env: OS_TOKEN) --os-domain-name <auth-domain-name> With osc_password: Domain name to scope to With v3password: Domain name to scope to With v3scopedsaml: Domain name to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to With password: Domain name to scope to With v3unscopedsaml: Domain name to scope to (Env: OS_DOMAIN_NAME) --os-user-domain-name <auth-user-domain-name> With osc_password: User's domain name With v3password: User's domain name With password: User's domain name (Env: OS_USER_DOMAIN_NAME) --os-domain-id <auth-domain-id> With osc_password: Domain ID to scope to With v3password: Domain ID to scope to With v3scopedsaml: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to With password: Domain ID to scope to With v3unscopedsaml: Domain ID to scope to (Env: OS_DOMAIN_ID) --os-user-id <auth-user-id> With osc_password: User id With v2password: User ID to longin with With v3password: User ID With password: User id (Env: OS_USER_ID) --os-password <auth-password> With osc_password: User's password With v2password: Password to use With v3password: User's password With v3unscopedadfs: Password With password: User's password With v3unscopedsaml: Password (Env: OS_PASSWORD) --os-endpoint <auth-endpoint> With token_endpoint: The endpoint that will always be used (Env: OS_ENDPOINT) --os-project-id <auth-project-id> With osc_password: Project ID to scope to With v3password: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to With v3token: Project ID to scope to With password: Project ID to scope to With v3unscopedsaml: Project ID to scope to (Env: OS_PROJECT_ID) --os-object-api-version <object-api-version> Object API version, default=1 (Env: OS_OBJECT_API_VERSION)
openstack aggregate add host usage: openstack --os-auth-type token aggregate add host [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <aggregate> <host> Add host to aggregate Positional arguments <aggregate> Aggregate (name or ID) <host> Host to add to <aggregate> Optional arguments -h, --help show this help message and exit
openstack aggregate create usage: openstack --os-auth-type token aggregate create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--zone <availability-zone>] [--property <key=value>] <name> Create a new aggregate Positional arguments <name> New aggregate name Optional arguments -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)
openstack aggregate delete usage: openstack --os-auth-type token aggregate delete [-h] <aggregate> Delete an existing aggregate Positional arguments <aggregate> Aggregate to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack aggregate list usage: openstack --os-auth-type token aggregate list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List all aggregates Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack aggregate remove host usage: openstack --os-auth-type token aggregate remove host [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <aggregate> <host> Remove host from aggregate Positional arguments <aggregate> Aggregate (name or ID) <host> Host to remove from <aggregate> Optional arguments -h, --help show this help message and exit
openstack aggregate set usage: openstack --os-auth-type token aggregate set [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--name <name>] [--zone <availability-zone>] [--property <key=value>] <aggregate> Set aggregate properties Positional arguments <aggregate> Aggregate to modify (name or ID) Optional arguments -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)
openstack aggregate show usage: openstack --os-auth-type token aggregate show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <aggregate> Display aggregate details Positional arguments <aggregate> Aggregate to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack availability zone list usage: openstack --os-auth-type token availability zone list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List availability zones and their status Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack backup create usage: openstack --os-auth-type token backup create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--container <container>] [--name <name>] [--description <description>] <volume> Create new backup Positional arguments <volume> Volume to backup (name or ID) Optional arguments -h, --help show this help message and exit --container <container> Optional backup container name --name <name> Name of the backup --description <description> Description of the backup
openstack backup delete usage: openstack --os-auth-type token backup delete [-h] <backup> [<backup> ...] Delete backup(s) Positional arguments <backup> Backup(s) to delete (ID only) Optional arguments -h, --help show this help message and exit
openstack backup list usage: openstack --os-auth-type token backup list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List backups Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack backup restore usage: openstack --os-auth-type token backup restore [-h] <backup> <volume> Restore backup Positional arguments <backup> Backup to restore (ID only) <volume> Volume to restore to (name or ID) Optional arguments -h, --help show this help message and exit
openstack backup show usage: openstack --os-auth-type token backup show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <backup> Display backup details Positional arguments <backup> Backup to display (ID only) Optional arguments -h, --help show this help message and exit
openstack catalog list usage: openstack --os-auth-type token catalog list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] List services in the service catalog Optional arguments -h, --help show this help message and exit
openstack catalog show usage: openstack --os-auth-type token catalog show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <service> Display service catalog details Positional arguments <service> Service to display (type or name) Optional arguments -h, --help show this help message and exit
openstack command list usage: openstack --os-auth-type token command list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] List recognized commands by group Optional arguments -h, --help show this help message and exit
openstack compute agent create usage: openstack --os-auth-type token compute agent create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <os> <architecture> <version> <url> <md5hash> <hypervisor> Create compute agent command Positional arguments <os> Type of OS <architecture> Type of architecture <version> Version <url> URL <md5hash> MD5 hash <hypervisor> Type of hypervisor Optional arguments -h, --help show this help message and exit
openstack compute agent delete usage: openstack --os-auth-type token compute agent delete [-h] <id> Delete compute agent command Positional arguments <id> ID of agent to delete Optional arguments -h, --help show this help message and exit
openstack compute agent list usage: openstack --os-auth-type token compute agent list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--hypervisor <hypervisor>] List compute agent command Optional arguments -h, --help show this help message and exit --hypervisor <hypervisor> Type of hypervisor
openstack compute agent set usage: openstack --os-auth-type token compute agent set [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <id> <version> <url> <md5hash> Set compute agent command Positional arguments <id> ID of the agent <version> Version of the agent <url> URL <md5hash> MD5 hash Optional arguments -h, --help show this help message and exit
openstack compute service list usage: openstack --os-auth-type token compute service list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--host <host>] [--service <service>] List service command Optional arguments -h, --help show this help message and exit --host <host> Name of host --service <service> Name of service
openstack compute service set usage: openstack --os-auth-type token compute service set [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--enable | --disable] <host> <service> Set service command Positional arguments <host> Name of host <service> Name of service Optional arguments -h, --help show this help message and exit --enable Enable a service --disable Disable a service
openstack console log show usage: openstack --os-auth-type token console log show [-h] [--lines <num-lines>] <server> Show server's console output Positional arguments <server> Server to show console log (name or ID) Optional arguments -h, --help show this help message and exit --lines <num-lines> Number of lines to display from the end of the log (default=all)
openstack console url show usage: openstack --os-auth-type token console url show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--novnc | --xvpvnc | --spice] <server> Show server's remote console URL Positional arguments <server> Server to show URL (name or ID) Optional arguments -h, --help show this help message and exit --novnc Show noVNC console URL (default) --xvpvnc Show xpvnc console URL --spice Show SPICE console URL
openstack container create usage: openstack --os-auth-type token container create [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] <container-name> [<container-name> ...] Create new container Positional arguments <container-name> New container name(s) Optional arguments -h, --help show this help message and exit
openstack container delete usage: openstack --os-auth-type token container delete [-h] <container> [<container> ...] Delete container Positional arguments <container> Container(s) to delete Optional arguments -h, --help show this help message and exit
openstack container list usage: openstack --os-auth-type token container list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all] List containers Optional arguments -h, --help show this help message and exit --prefix <prefix> Filter list using <prefix> --marker <marker> Anchor for paging --end-marker <end-marker> End anchor for paging --limit <limit> Limit the number of containers returned --long List additional fields in output --all List all containers (default is 10000)
openstack container save usage: openstack --os-auth-type token container save [-h] <container> Save container contents locally Positional arguments <container> Container to save Optional arguments -h, --help show this help message and exit
openstack container show usage: openstack --os-auth-type token container show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <container> Display container details Positional arguments <container> Container to display Optional arguments -h, --help show this help message and exit
openstack ec2 credentials create usage: openstack --os-auth-type token ec2 credentials create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--project <project>] [--user <user>] Create EC2 credentials Optional arguments -h, --help show this help message and exit --project <project> Specify an alternate project (default: current authenticated project) --user <user> Specify an alternate user (default: current authenticated user)
openstack ec2 credentials delete usage: openstack --os-auth-type token ec2 credentials delete [-h] [--user <user>] <access-key> Delete EC2 credentials Positional arguments <access-key> Credentials access key Optional arguments -h, --help show this help message and exit --user <user> Specify a user
openstack ec2 credentials list usage: openstack --os-auth-type token ec2 credentials list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--user <user>] List EC2 credentials Optional arguments -h, --help show this help message and exit --user <user> Specify a user
openstack ec2 credentials show usage: openstack --os-auth-type token ec2 credentials show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--user <user>] <access-key> Display EC2 credentials details Positional arguments <access-key> Credentials access key Optional arguments -h, --help show this help message and exit --user <user> Specify a user
openstack endpoint create usage: openstack --os-auth-type token endpoint create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] --publicurl <url> [--adminurl <url>] [--internalurl <url>] [--region <region-id>] <service> Create new endpoint Positional arguments <service> New endpoint service (name or ID) Optional arguments -h, --help show this help message and exit --publicurl <url> New endpoint public URL (required) --adminurl <url> New endpoint admin URL --internalurl <url> New endpoint internal URL --region <region-id> New endpoint region ID
openstack endpoint delete usage: openstack --os-auth-type token endpoint delete [-h] <endpoint-id> Delete endpoint Positional arguments <endpoint-id> Endpoint ID to delete Optional arguments -h, --help show this help message and exit
openstack endpoint list usage: openstack --os-auth-type token endpoint list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List endpoints Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack endpoint show usage: openstack --os-auth-type token endpoint show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <endpoint-id> Display endpoint details Positional arguments <endpoint-id> Endpoint ID to display Optional arguments -h, --help show this help message and exit
openstack extension list usage: openstack --os-auth-type token extension list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--compute] [--identity] [--network] [--volume] [--long] List API extensions Optional arguments -h, --help show this help message and exit --compute List extensions for the Compute API --identity List extensions for the Identity API --network List extensions for the Network API --volume List extensions for the Volume API --long List additional fields in output
openstack flavor create usage: openstack --os-auth-type token flavor create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--id <id>] [--ram <size-mb>] [--disk <size-gb>] [--ephemeral <size-gb>] [--swap <size-gb>] [--vcpus <vcpus>] [--rxtx-factor <factor>] [--public | --private] <flavor-name> Create new flavor Positional arguments <flavor-name> New flavor name Optional arguments -h, --help show this help message and exit --id <id> Unique flavor ID; 'auto' creates a UUID (default: auto) --ram <size-mb> Memory size in MB (default 256M) --disk <size-gb> Disk size in GB (default 0G) --ephemeral <size-gb> Ephemeral disk size in GB (default 0G) --swap <size-gb> Swap space size in GB (default 0G) --vcpus <vcpus> Number of vcpus (default 1) --rxtx-factor <factor> RX/TX factor (default 1) --public Flavor is available to other projects (default) --private Flavor is not available to other projects
openstack flavor delete usage: openstack --os-auth-type token flavor delete [-h] <flavor> Delete flavor Positional arguments <flavor> Flavor to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack flavor list usage: openstack --os-auth-type token flavor list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --all] [--long] List flavors Optional arguments -h, --help show this help message and exit --public List only public flavors (default) --private List only private flavors --all List all flavors, whether public or private --long List additional fields in output
openstack flavor set usage: openstack --os-auth-type token flavor set [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--property <key=value>] <flavor> Set flavor properties Positional arguments <flavor> Flavor to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key=value> Property to add or modify for this flavor (repeat option to set multiple properties)
openstack flavor show usage: openstack --os-auth-type token flavor show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <flavor> Display flavor details Positional arguments <flavor> Flavor to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack flavor unset usage: openstack --os-auth-type token flavor unset [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--property <key>] <flavor> Unset flavor properties Positional arguments <flavor> Flavor to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key> Property to remove from flavor (repeat option to unset multiple properties)
openstack host list usage: openstack --os-auth-type token host list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--zone <zone>] List host command Optional arguments -h, --help show this help message and exit --zone <zone> Only return hosts in the availability zone.
openstack host show usage: openstack --os-auth-type token host show [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] <host> Show host command Positional arguments <host> Name of host Optional arguments -h, --help show this help message and exit
openstack hypervisor list usage: openstack --os-auth-type token hypervisor list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--matching <hostname>] List hypervisors Optional arguments -h, --help show this help message and exit --matching <hostname> Filter hypervisors using <hostname> substring
openstack hypervisor show usage: openstack --os-auth-type token hypervisor show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <hypervisor> Display hypervisor details Positional arguments <hypervisor> Hypervisor to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack hypervisor stats show usage: openstack --os-auth-type token hypervisor stats show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] Display hypervisor stats details Optional arguments -h, --help show this help message and exit
openstack image create usage: openstack --os-auth-type token image create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--id <id>] [--store <store>] [--container-format <container-format>] [--disk-format <disk-format>] [--owner <project>] [--size <size>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--location <image-url>] [--copy-from <image-url>] [--file <file>] [--volume <volume>] [--force] [--checksum <checksum>] [--protected | --unprotected] [--public | --private] [--property <key=value>] <image-name> Create/upload an image Positional arguments <image-name> New image name Optional arguments -h, --help show this help message and exit --id <id> Image ID to reserve --store <store> Upload image to this store --container-format <container-format> Image container format (default: bare) --disk-format <disk-format> Image disk format (default: raw) --owner <project> Image owner project name or ID --size <size> Image size, in bytes (only used with --location and --copy-from) --min-disk <disk-gb> Minimum disk size needed to boot image, in gigabytes --min-ram <ram-mb> Minimum RAM size needed to boot image, in megabytes --location <image-url> Download image from an existing URL --copy-from <image-url> Copy image from the data store (similar to --location) --file <file> Upload image from local file --volume <volume> Create image from a volume --force Force image creation if volume is in use (only meaningful with --volume) --checksum <checksum> Image hash used for verification --protected Prevent image from being deleted --unprotected Allow image to be deleted (default) --public Image is accessible to the public --private Image is inaccessible to the public (default) --property <key=value> Set a property on this image (repeat option to set multiple properties)
openstack image delete usage: openstack --os-auth-type token image delete [-h] <image> [<image> ...] Delete image(s) Positional arguments <image> Image(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack image list usage: openstack --os-auth-type token image list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--public | --private] [--property <key=value>] [--long] [--sort <key>[:<direction>]] List available images Optional arguments -h, --help show this help message and exit --public List only public images --private List only private images --property <key=value> Filter output based on property --long List additional fields in output --sort <key>[:<direction>] Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma
openstack image save usage: openstack --os-auth-type token image save [-h] [--file <filename>] <image> Save an image locally Positional arguments <image> Image to save (name or ID) Optional arguments -h, --help show this help message and exit --file <filename> Downloaded image save filename (default: stdout)
openstack image set usage: openstack --os-auth-type token image set [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--name <name>] [--owner <project>] [--min-disk <disk-gb>] [--min-ram <disk-ram>] [--protected | --unprotected] [--public | --private] [--property <key=value>] <image> Set image properties Positional arguments <image> Image to modify (name or ID) Optional arguments -h, --help show this help message and exit --name <name> New image name --owner <project> New image owner project (name or ID) --min-disk <disk-gb> Minimum disk size needed to boot image, in gigabytes --min-ram <disk-ram> Minimum RAM size needed to boot image, in megabytes --protected Prevent image from being deleted --unprotected Allow image to be deleted (default) --public Image is accessible to the public --private Image is inaccessible to the public (default) --property <key=value> Set a property on this image (repeat option to set multiple properties)
openstack image show usage: openstack --os-auth-type token image show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <image> Display image details Positional arguments <image> Image to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack ip fixed add usage: openstack --os-auth-type token ip fixed add [-h] <network> <server> Add fixed-ip command Positional arguments <network> Name of the network to fetch an IP address from <server> Name of the server to receive the IP address Optional arguments -h, --help show this help message and exit
openstack ip fixed remove usage: openstack --os-auth-type token ip fixed remove [-h] <ip-address> <server> Remove fixed-ip command Positional arguments <ip-address> IP address to remove from server <server> Name of the server to remove the IP address from Optional arguments -h, --help show this help message and exit
openstack ip floating add usage: openstack --os-auth-type token ip floating add [-h] <ip-address> <server> Add floating-ip to server Positional arguments <ip-address> IP address to add to server <server> Server to receive the IP address (name or ID) Optional arguments -h, --help show this help message and exit
openstack ip floating create usage: openstack --os-auth-type token ip floating create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <pool> Create new floating-ip Positional arguments <pool> Pool to fetch floating IP from Optional arguments -h, --help show this help message and exit
openstack ip floating delete usage: openstack --os-auth-type token ip floating delete [-h] <ip-address> Delete a floating-ip Positional arguments <ip-address> IP address to delete Optional arguments -h, --help show this help message and exit
openstack ip floating list usage: openstack --os-auth-type token ip floating list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] List floating-ips Optional arguments -h, --help show this help message and exit
openstack ip floating pool list usage: openstack --os-auth-type token ip floating pool list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] List floating-ip-pools Optional arguments -h, --help show this help message and exit
openstack ip floating remove usage: openstack --os-auth-type token ip floating remove [-h] <ip-address> <server> Remove floating-ip from server Positional arguments <ip-address> IP address to remove from server <server> Server to remove the IP address from (name or ID) Optional arguments -h, --help show this help message and exit
openstack keypair create usage: openstack --os-auth-type token keypair create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--public-key <file>] <name> Create new public key Positional arguments <name> New public key name Optional arguments -h, --help show this help message and exit --public-key <file> Filename for public key to add
openstack keypair delete usage: openstack --os-auth-type token keypair delete [-h] <key> Delete public key Positional arguments <key> Public key to delete Optional arguments -h, --help show this help message and exit
openstack keypair list usage: openstack --os-auth-type token keypair list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] List public key fingerprints Optional arguments -h, --help show this help message and exit
openstack keypair show usage: openstack --os-auth-type token keypair show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--public-key] <key> Display public key details Positional arguments <key> Public key to display Optional arguments -h, --help show this help message and exit --public-key Show only bare public key
openstack limits show usage: openstack --os-auth-type token limits show [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--absolute | --rate] [--reserved] [--project <project>] [--domain <domain>] Show compute and volume limits Optional arguments -h, --help show this help message and exit --absolute Show absolute limits --rate Show rate limits --reserved Include reservations count [only valid with --absolute] --project <project> Show limits for a specific project (name or ID) [only valid with --absolute] --domain <domain> Domain that owns --project (name or ID) [only valid with --absolute]
openstack module list usage: openstack --os-auth-type token module list [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--all] List module versions Optional arguments -h, --help show this help message and exit --all Show all modules that have version information
openstack network create usage: openstack --os-auth-type token network create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--enable | --disable] [--share | --no-share] [--project <project>] [--domain <domain>] <name> Create new network Positional arguments <name> New network name Optional arguments -h, --help show this help message and exit --enable Enable network (default) --disable Disable network --share Share the network between projects --no-share Do not share the network between projects --project <project> Owner's project (name or ID) --domain <domain> Owner's domain (name or ID)
openstack network delete usage: openstack --os-auth-type token network delete [-h] <network> [<network> ...] Delete network(s) Positional arguments <network> Network to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack network list usage: openstack --os-auth-type token network list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--external] [--dhcp <dhcp-id>] [--long] List networks Optional arguments -h, --help show this help message and exit --external List external networks --dhcp <dhcp-id> DHCP agent ID --long List additional fields in output
openstack network set usage: openstack --os-auth-type token network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] <network> Set network properties Positional arguments <network> Network to modify (name or ID) Optional arguments -h, --help show this help message and exit --name <name> Set network name --enable Enable network --disable Disable network --share Share the network between projects --no-share Do not share the network between projects
openstack network show usage: openstack --os-auth-type token network show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <network> Show network details Positional arguments <network> Network to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack object create usage: openstack --os-auth-type token object create [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] <container> <filename> [<filename> ...] Upload object to container Positional arguments <container> Container for new object <filename> Local filename(s) to upload Optional arguments -h, --help show this help message and exit
openstack object delete usage: openstack --os-auth-type token object delete [-h] <container> <object> [<object> ...] Delete object from container Positional arguments <container> Delete object(s) from <container> <object> Object(s) to delete Optional arguments -h, --help show this help message and exit
openstack object list usage: openstack --os-auth-type token object list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all] <container> List objects Positional arguments <container> Container to list Optional arguments -h, --help show this help message and exit --prefix <prefix> Filter list using <prefix> --delimiter <delimiter> Roll up items with <delimiter> --marker <marker> Anchor for paging --end-marker <end-marker> End anchor for paging --limit <limit> Limit the number of objects returned --long List additional fields in output --all List all objects in container (default is 10000)
openstack object save usage: openstack --os-auth-type token object save [-h] [--file <filename>] <container> <object> Save object locally Positional arguments <container> Download <object> from <container> <object> Object to save Optional arguments -h, --help show this help message and exit --file <filename> Destination filename (defaults to object name)
openstack object show usage: openstack --os-auth-type token object show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <container> <object> Display object details Positional arguments <container> Display <object> from <container> <object> Object to display Optional arguments -h, --help show this help message and exit
openstack project create usage: openstack --os-auth-type token project create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--description <description>] [--enable | --disable] [--property <key=value>] [--or-show] <project-name> Create new project Positional arguments <project-name> New project name Optional arguments -h, --help show this help message and exit --description <description> Project description --enable Enable project (default) --disable Disable project --property <key=value> Add a property to <name> (repeat option to set multiple properties) --or-show Return existing project
openstack project delete usage: openstack --os-auth-type token project delete [-h] <project> [<project> ...] Delete project(s) Positional arguments <project> Project(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack project list usage: openstack --os-auth-type token project list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List projects Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack project set usage: openstack --os-auth-type token project set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--property <key=value>] <project> Set project properties Positional arguments <project> Project to modify (name or ID) Optional arguments -h, --help show this help message and exit --name <name> Set project name --description <description> Set project description --enable Enable project --disable Disable project --property <key=value> Set a project property (repeat option to set multiple properties)
openstack project show usage: openstack --os-auth-type token project show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <project> Display project details Positional arguments <project> Project to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack project usage list usage: openstack --os-auth-type token project usage list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--start <start>] [--end <end>] List resource usage per project Optional arguments -h, --help show this help message and exit --start <start> Usage range start date, ex 2012-01-20 (default: 4 weeks ago) --end <end> Usage range end date, ex 2012-01-20 (default: tomorrow)
openstack quota set usage: openstack --os-auth-type token quota set [-h] [--class] [--properties <properties>] [--ram <ram>] [--secgroup-rules <secgroup-rules>] [--instances <instances>] [--key-pairs <key-pairs>] [--fixed-ips <fixed-ips>] [--secgroups <secgroups>] [--injected-file-size <injected-file-size>] [--floating-ips <floating-ips>] [--injected-files <injected-files>] [--cores <cores>] [--injected-path-size <injected-path-size>] [--gigabytes <gigabytes>] [--volumes <volumes>] [--snapshots <snapshots>] [--volume-type <volume-type>] <project/class> Set quotas for project or class Positional arguments <project/class> Set quotas for this project or class (name/ID) Optional arguments -h, --help show this help message and exit --class Set quotas for <class> --properties <properties> New value for the properties quota --ram <ram> New value for the ram quota --secgroup-rules <secgroup-rules> New value for the secgroup-rules quota --instances <instances> New value for the instances quota --key-pairs <key-pairs> New value for the key-pairs quota --fixed-ips <fixed-ips> New value for the fixed-ips quota --secgroups <secgroups> New value for the secgroups quota --injected-file-size <injected-file-size> New value for the injected-file-size quota --floating-ips <floating-ips> New value for the floating-ips quota --injected-files <injected-files> New value for the injected-files quota --cores <cores> New value for the cores quota --injected-path-size <injected-path-size> New value for the injected-path-size quota --gigabytes <gigabytes> New value for the gigabytes quota --volumes <volumes> New value for the volumes quota --snapshots <snapshots> New value for the snapshots quota --volume-type <volume-type> Set quotas for a specific <volume-type>
openstack quota show usage: openstack --os-auth-type token quota show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--class | --default] <project/class> Show quotas for project or class Positional arguments <project/class> Show this project or class (name/ID) Optional arguments -h, --help show this help message and exit --class Show quotas for <class> --default Show default quotas for <project>
openstack role add usage: openstack --os-auth-type token role add [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] --project <project> --user <user> <role> Add role to project:user Positional arguments <role> Role to add to <project>:<user> (name or ID) Optional arguments -h, --help show this help message and exit --project <project> Include <project> (name or ID) --user <user> Include <user> (name or ID)
openstack role create usage: openstack --os-auth-type token role create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--or-show] <name> Create new role Positional arguments <name> New role name Optional arguments -h, --help show this help message and exit --or-show Return existing role
openstack role delete usage: openstack --os-auth-type token role delete [-h] <role> [<role> ...] Delete role(s) Positional arguments <role> Role(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack role list usage: openstack --os-auth-type token role list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--user <user>] List roles Optional arguments -h, --help show this help message and exit --project <project> Filter roles by <project> (name or ID) --user <user> Filter roles by <user> (name or ID)
openstack role remove usage: openstack --os-auth-type token role remove [-h] --project <project> --user <user> <role> Remove role from project : user Positional arguments <role> Role to remove (name or ID) Optional arguments -h, --help show this help message and exit --project <project> Include <project> (name or ID) --user <user> Include <user> (name or ID)
openstack role show usage: openstack --os-auth-type token role show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <role> Display role details Positional arguments <role> Role to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack security group create usage: openstack --os-auth-type token security group create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--description <description>] <name> Create a new security group Positional arguments <name> New security group name Optional arguments -h, --help show this help message and exit --description <description> Security group description
openstack security group delete usage: openstack --os-auth-type token security group delete [-h] <group> Delete a security group Positional arguments <group> Name or ID of security group to delete Optional arguments -h, --help show this help message and exit
openstack security group list usage: openstack --os-auth-type token security group list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--all-projects] List all security groups Optional arguments -h, --help show this help message and exit --all-projects Display information from all projects (admin only)
openstack security group rule create usage: openstack --os-auth-type token security group rule create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--proto <proto>] [--src-ip <ip-address>] [--dst-port <port-range>] <group> Create a new security group rule Positional arguments <group> Create rule in this security group Optional arguments -h, --help show this help message and exit --proto <proto> IP protocol (icmp, tcp, udp; default: tcp) --src-ip <ip-address> Source IP (may use CIDR notation; default: 0.0.0.0/0) --dst-port <port-range> Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)
openstack security group rule delete usage: openstack --os-auth-type token security group rule delete [-h] [--proto <proto>] [--src-ip <ip-address>] [--dst-port <port-range>] <group> Delete a security group rule Positional arguments <group> Security group rule to delete (name or ID) Optional arguments -h, --help show this help message and exit --proto <proto> IP protocol (icmp, tcp, udp; default: tcp) --src-ip <ip-address> Source IP (may use CIDR notation; default: 0.0.0.0/0) --dst-port <port-range> Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)
openstack security group rule list usage: openstack --os-auth-type token security group rule list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] <group> List all security group rules Positional arguments <group> List all rules in this security group Optional arguments -h, --help show this help message and exit
openstack security group set usage: openstack --os-auth-type token security group set [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--name <new-name>] [--description <description>] <group> Set security group properties Positional arguments <group> Name or ID of security group to change Optional arguments -h, --help show this help message and exit --name <new-name> New security group name --description <description> New security group name
openstack security group show usage: openstack --os-auth-type token security group show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <group> Show a specific security group Positional arguments <group> Name or ID of security group to change Optional arguments -h, --help show this help message and exit
openstack server add security group usage: openstack --os-auth-type token server add security group [-h] <server> <group> Add security group to server Positional arguments <server> Server (name or ID) <group> Security group to add (name or ID) Optional arguments -h, --help show this help message and exit
openstack server add volume usage: openstack --os-auth-type token server add volume [-h] [--device <device>] <server> <volume> Add volume to server Positional arguments <server> Server (name or ID) <volume> Volume to add (name or ID) Optional arguments -h, --help show this help message and exit --device <device> Server internal device name for volume
openstack server create usage: openstack --os-auth-type token server create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] (--image <image> | --volume <volume>) --flavor <flavor> [--security-group <security-group-name>] [--key-name <key-name>] [--property <key=value>] [--file <dest-filename=source-filename>] [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name> Create a new server Positional arguments <server-name> New server name Optional arguments -h, --help show this help message and exit --image <image> Create server from this image --volume <volume> Create server from this volume --flavor <flavor> Create server with this flavor --security-group <security-group-name> Security group to assign to this server (repeat for multiple groups) --key-name <key-name> Keypair to inject into this server (optional extension) --property <key=value> Set a property on this server (repeat for multiple values) --file <dest-filename=source-filename> File to inject into image before boot (repeat for multiple files) --user-data <user-data> User data file to serve from the metadata server --availability-zone <zone-name> Select an availability zone for the server --block-device-mapping <dev-name=mapping> Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension) --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> Create a NIC on the server. Specify option multiple times to create multiple NICs. Either net-id or port- id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional). --hint <key=value> Hints for the scheduler (optional extension) --config-drive <config-drive-volume>|True Use specified volume as the config drive, or 'True' to use an ephemeral drive --min <count> Minimum number of servers to launch (default=1) --max <count> Maximum number of servers to launch (default=1) --wait Wait for build to complete
openstack server delete usage: openstack --os-auth-type token server delete [-h] <server> [<server> ...] Delete server(s) Positional arguments <server> Server(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack server image create usage: openstack --os-auth-type token server image create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--name <image-name>] [--wait] <server> Create a new disk image from a running server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --name <image-name> Name of new image (default is server name) --wait Wait for image create to complete
openstack server list usage: openstack --os-auth-type token server list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip-address-regex>] [--name <name-regex>] [--instance-name <server-name>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-projects] [--long] List servers Optional arguments -h, --help show this help message and exit --reservation-id <reservation-id> Only return instances that match the reservation --ip <ip-address-regex> Regular expression to match IP addresses --ip6 <ip-address-regex> Regular expression to match IPv6 addresses --name <name-regex> Regular expression to match names --instance-name <server-name> Regular expression to match instance name (admin only) --status <status> Search by server status --flavor <flavor> Search by flavor --image <image> Search by image --host <hostname> Search by hostname --all-projects Include all projects (admin only) --long List additional fields in output
openstack server lock usage: openstack --os-auth-type token server lock [-h] <server> Lock a server. A non-admin user will not be able to execute actions Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server migrate usage: openstack --os-auth-type token server migrate [-h] [--live <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server> Migrate server to different host Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --live <hostname> Target hostname --shared-migration Perform a shared live migration (default) --block-migration Perform a block live migration --disk-overcommit Allow disk over-commit on the destination host --no-disk-overcommit Do not over-commit disk on the destination host (default) --wait Wait for resize to complete
openstack server pause usage: openstack --os-auth-type token server pause [-h] <server> Pause server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server reboot usage: openstack --os-auth-type token server reboot [-h] [--hard | --soft] [--wait] <server> Perform a hard or soft server reboot Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --hard Perform a hard reboot --soft Perform a soft reboot --wait Wait for reboot to complete
openstack server rebuild usage: openstack --os-auth-type token server rebuild [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] --image <image> [--password <password>] [--wait] <server> Rebuild server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --image <image> Recreate server from this image --password <password> Set the password on the rebuilt instance --wait Wait for rebuild to complete
openstack server remove security group usage: openstack --os-auth-type token server remove security group [-h] <server> <group> Remove security group from server Positional arguments <server> Name or ID of server to use <group> Name or ID of security group to remove from server Optional arguments -h, --help show this help message and exit
openstack server remove volume usage: openstack --os-auth-type token server remove volume [-h] <server> <volume> Remove volume from server Positional arguments <server> Server (name or ID) <volume> Volume to remove (name or ID) Optional arguments -h, --help show this help message and exit
openstack server rescue usage: openstack --os-auth-type token server rescue [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <server> Put server in rescue mode Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server resize usage: openstack --os-auth-type token server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server> Scale server to a new flavor Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --flavor <flavor> Resize server to specified flavor --confirm Confirm server resize is complete --revert Restore server state before resize --wait Wait for resize to complete
openstack server resume usage: openstack --os-auth-type token server resume [-h] <server> Resume server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server set usage: openstack --os-auth-type token server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] <server> Set server properties Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --name <new-name> New server name --root-password Set new root password (interactive only) --property <key=value> Property to add/change for this server (repeat option to set multiple properties)
openstack server show usage: openstack --os-auth-type token server show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--diagnostics] <server> Show server details Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --diagnostics Display server diagnostics information
openstack server ssh usage: openstack --os-auth-type token server ssh [-h] [--login <login-name>] [--port <port>] [--identity <keyfile>] [--option <config-options>] [-4 | -6] [--public | --private | --address-type <address-type>] <server> Ssh to server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --login <login-name> Login name (ssh -l option) --port <port> Destination port (ssh -p option) --identity <keyfile> Private key file (ssh -i option) --option <config-options> Options in ssh_config(5) format (ssh -o option) -4 Use only IPv4 addresses -6 Use only IPv6 addresses --public Use public IP address --private Use private IP address --address-type <address-type> Use other IP address (public, private, etc)
openstack server suspend usage: openstack --os-auth-type token server suspend [-h] <server> Suspend server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server unlock usage: openstack --os-auth-type token server unlock [-h] <server> Unlock server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server unpause usage: openstack --os-auth-type token server unpause [-h] <server> Unpause server Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server unrescue usage: openstack --os-auth-type token server unrescue [-h] <server> Restore server from rescue mode Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit
openstack server unset usage: openstack --os-auth-type token server unset [-h] [--property <key>] <server> Unset server properties Positional arguments <server> Server (name or ID) Optional arguments -h, --help show this help message and exit --property <key> Property key to remove from server (repeat to unset multiple values)
openstack service create usage: openstack --os-auth-type token service create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--name <name>] [--description <description>] <type> Create new service Positional arguments <type> New service type (compute, image, identity, volume, etc) Optional arguments -h, --help show this help message and exit --name <name> New service name --description <description> New service description
openstack service delete usage: openstack --os-auth-type token service delete [-h] <service> Delete service Positional arguments <service> Service to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack service list usage: openstack --os-auth-type token service list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List services Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack service show usage: openstack --os-auth-type token service show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--catalog] <service> Display service details Positional arguments <service> Service to display (type, name or ID) Optional arguments -h, --help show this help message and exit --catalog Show service catalog information
openstack snapshot create usage: openstack --os-auth-type token snapshot create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] --name <name> [--description <description>] [--force] <volume> Create new snapshot Positional arguments <volume> Volume to snapshot (name or ID) Optional arguments -h, --help show this help message and exit --name <name> Name of the snapshot --description <description> Description of the snapshot --force Create a snapshot attached to an instance. Default is False
openstack snapshot delete usage: openstack --os-auth-type token snapshot delete [-h] <snapshot> [<snapshot> ...] Delete snapshot(s) Positional arguments <snapshot> Snapshot(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack snapshot list usage: openstack --os-auth-type token snapshot list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List snapshots Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack snapshot set usage: openstack --os-auth-type token snapshot set [-h] [--name <name>] [--description <description>] [--property <key=value>] <snapshot> Set snapshot properties Positional arguments <snapshot> Snapshot to modify (name or ID) Optional arguments -h, --help show this help message and exit --name <name> New snapshot name --description <description> New snapshot description --property <key=value> Property to add/change for this snapshot (repeat option to set multiple properties)
openstack snapshot show usage: openstack --os-auth-type token snapshot show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <snapshot> Display snapshot details Positional arguments <snapshot> Snapshot to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack snapshot unset usage: openstack --os-auth-type token snapshot unset [-h] [--property <key>] <snapshot> Unset snapshot properties Positional arguments <snapshot> Snapshot to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key> Property to remove from snapshot (repeat to remove multiple values)
openstack token issue usage: openstack --os-auth-type token token issue [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] Issue new token Optional arguments -h, --help show this help message and exit
openstack token revoke usage: openstack --os-auth-type token token revoke [-h] <token> Revoke existing token Positional arguments <token> Token to be deleted Optional arguments -h, --help show this help message and exit
openstack usage list usage: openstack --os-auth-type token usage list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--start <start>] [--end <end>] List resource usage per project Optional arguments -h, --help show this help message and exit --start <start> Usage range start date, ex 2012-01-20 (default: 4 weeks ago) --end <end> Usage range end date, ex 2012-01-20 (default: tomorrow)
openstack usage show usage: openstack --os-auth-type token usage show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--project <project>] [--start <start>] [--end <end>] Show resource usage for a single project Optional arguments -h, --help show this help message and exit --project <project> Name or ID of project to show usage for --start <start> Usage range start date, ex 2012-01-20 (default: 4 weeks ago) --end <end> Usage range end date, ex 2012-01-20 (default: tomorrow)
openstack user create usage: openstack --os-auth-type token user create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--project <project>] [--password <password>] [--password-prompt] [--email <email-address>] [--enable | --disable] [--or-show] <name> Create new user Positional arguments <name> New user name Optional arguments -h, --help show this help message and exit --project <project> Default project (name or ID) --password <password> Set user password --password-prompt Prompt interactively for password --email <email-address> Set user email address --enable Enable user (default) --disable Disable user --or-show Return existing user
openstack user delete usage: openstack --os-auth-type token user delete [-h] <user> [<user> ...] Delete user(s) Positional arguments <user> User(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack user list usage: openstack --os-auth-type token user list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--long] List users Optional arguments -h, --help show this help message and exit --project <project> Filter users by project (name or ID) --long List additional fields in output
openstack user role list usage: openstack --os-auth-type token user role list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [<user>] List user-role assignments Positional arguments <user> User to list (name or ID) Optional arguments -h, --help show this help message and exit --project <project> Filter users by <project> (name or ID)
openstack user set usage: openstack --os-auth-type token user set [-h] [--name <name>] [--project <project>] [--password <user-password>] [--password-prompt] [--email <email-address>] [--enable | --disable] <user> Set user properties Positional arguments <user> User to change (name or ID) Optional arguments -h, --help show this help message and exit --name <name> Set user name --project <project> Set default project (name or ID) --password <user-password> Set user password --password-prompt Prompt interactively for password --email <email-address> Set user email address --enable Enable user (default) --disable Disable user
openstack user show usage: openstack --os-auth-type token user show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <user> Display user details Positional arguments <user> User to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack volume create usage: openstack --os-auth-type token volume create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] --size <size> [--snapshot <snapshot>] [--description <description>] [--type <volume-type>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] [--image <image>] [--source <volume>] [--property <key=value>] <name> Create new volume Positional arguments <name> New volume name Optional arguments -h, --help show this help message and exit --size <size> New volume size in GB --snapshot <snapshot> Use <snapshot> as source of new volume --description <description> New volume description --type <volume-type> Use <volume-type> as the new volume type --user <user> Specify an alternate user (name or ID) --project <project> Specify an alternate project (name or ID) --availability-zone <availability-zone> Create new volume in <availability-zone> --image <image> Use <image> as source of new volume (name or ID) --source <volume> Volume to clone (name or ID) --property <key=value> Set a property on this volume (repeat option to set multiple properties)
openstack volume delete usage: openstack --os-auth-type token volume delete [-h] [--force] <volume> [<volume> ...] Delete volume(s) Positional arguments <volume> Volume(s) to delete (name or ID) Optional arguments -h, --help show this help message and exit --force Attempt forced removal of volume(s), regardless of state (defaults to False)
openstack volume list usage: openstack --os-auth-type token volume list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--status <status>] [--name <name>] [--all-projects] [--long] List volumes Optional arguments -h, --help show this help message and exit --status <status> Filter results by status --name <name> Filter results by name --all-projects Include all projects (admin only) --long List additional fields in output
openstack volume set usage: openstack --os-auth-type token volume set [-h] [--name <name>] [--description <description>] [--size <size>] [--property <key=value>] <volume> Set volume properties Positional arguments <volume> Volume to change (name or ID) Optional arguments -h, --help show this help message and exit --name <name> New volume name --description <description> New volume description --size <size> Extend volume size in GB --property <key=value> Property to add or modify for this volume (repeat option to set multiple properties)
openstack volume show usage: openstack --os-auth-type token volume show [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] <volume> Show volume details Positional arguments <volume> Volume to display (name or ID) Optional arguments -h, --help show this help message and exit
openstack volume type create usage: openstack --os-auth-type token volume type create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--property <key=value>] <name> Create new volume type Positional arguments <name> New volume type name Optional arguments -h, --help show this help message and exit --property <key=value> Property to add for this volume type (repeat option to set multiple properties)
openstack volume type delete usage: openstack --os-auth-type token volume type delete [-h] <volume-type> Delete volume type Positional arguments <volume-type> Volume type to delete (name or ID) Optional arguments -h, --help show this help message and exit
openstack volume type list usage: openstack --os-auth-type token volume type list [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] [--long] List volume types Optional arguments -h, --help show this help message and exit --long List additional fields in output
openstack volume type set usage: openstack --os-auth-type token volume type set [-h] [--property <key=value>] <volume-type> Set volume type properties Positional arguments <volume-type> Volume type to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key=value> Property to add or modify for this volume type (repeat option to set multiple properties)
openstack volume type unset usage: openstack --os-auth-type token volume type unset [-h] [--property <key>] <volume-type> Unset volume type properties Positional arguments <volume-type> Volume type to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key> Property to remove from volume type (repeat option to remove multiple properties)
openstack volume unset usage: openstack --os-auth-type token volume unset [-h] [--property <key>] <volume> Unset volume properties Positional arguments <volume> Volume to modify (name or ID) Optional arguments -h, --help show this help message and exit --property <key> Property to remove from volume (repeat option to remove multiple properties)