Chapter 3. OpenStack command-line client

Positional arguments

<aggregate>

Aggregate (name or ID)

<host>

Host to add to <aggregate>

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<aggregate>

Aggregate to delete (name or ID)

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<aggregate>

Aggregate (name or ID)

<host>

Host to remove from <aggregate>

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<aggregate>

Aggregate to display (name or ID)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<backup>

Backup(s) to delete (ID only)

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Positional arguments

<backup>

Backup to display (ID only)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

uuid

rule UUID

Optional arguments

-h, --help

show this help message and exit

Positional arguments

file

JSON file to import, may contain one or several rules

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Optional arguments

-h, --help

show this help message and exit

Positional arguments

uuid

rule UUID

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

uuid

baremetal node UUID

Optional arguments

-h, --help

show this help message and exit

--new-ipmi-username NEW_IPMI_USERNAME

if set, *Ironic Inspector* will update IPMI user name to this value

--new-ipmi-password NEW_IPMI_PASSWORD

if set, *Ironic Inspector* will update IPMI password to this value

Positional arguments

uuid

baremetal node UUID

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<service>

Service to display (type or name)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<id>

ID of agent to delete

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--hypervisor <hypervisor>

Type of hypervisor

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

--host <host>

Name of host

--service <service>

Name of service

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Optional arguments

-h, --help

show this help message and exit

--mask

Attempt to mask passwords (default)

--unmask

Show password in clear text

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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)

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<container-name>

New container name(s)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<container>

Container(s) to delete

Optional arguments

-h, --help

show this help message and exit

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)

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<container>

Container to save

Optional arguments

-h, --help

show this help message and exit

Positional arguments

<container>

Container to display

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<name>

Name of the data source

Optional arguments

-h, --help

show this help message and exit

--type <type>

Type of the data source (swift, hdfs or maprfs) [REQUIRED]

--url <url>

Url for the data source [REQUIRED]

--username <username>

Username for accessing the data source url

--password <password>

Password for accessing the data source url

--description <description>

Description of the data source

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<data-source>

Name or id of the data source to delete

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

--type <type>

List data sources of specific type (swift, hdfs or maprfs)

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<data-source>

Name or id of the data source to display

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<plugin>

Name of the plugin to provide config information about

<version>

Version of the plugin to provide config information about

Optional arguments

-h, --help

show this help message and exit

--file <file>

Destination file (defaults to plugin name)

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<plugin>

Name of the plugin to display

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

--project <project>

Create credentials in project (name or ID; default: current authenticated project)

--user <user>

Create credentials for user (name or ID; default: current authenticated user)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<access-key>

Credentials access key

Optional arguments

-h, --help

show this help message and exit

--user <user>

Delete credentials for user (name or ID)

Optional arguments

-h, --help

show this help message and exit

--user <user>

Filter list by user (name or ID)

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<access-key>

Credentials access key

Optional arguments

-h, --help

show this help message and exit

--user <user>

Show credentials for user (name or ID)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<endpoint-id>

Endpoint ID to delete

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--long

List additional fields in output

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<endpoint-id>

Endpoint ID to display

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<flavor>

Flavor to delete (name or ID)

Optional arguments

-h, --help

show this help message and exit

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

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

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)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<flavor>

Flavor to display (name or ID)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

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)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

--zone <zone>

Only return hosts in the availability zone.

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<host>

Name of host

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Optional arguments

-h, --help

show this help message and exit

--matching <hostname>

Filter hypervisors using <hostname> substring

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<hypervisor>

Hypervisor to display (name or ID)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<image>

Image to share (name or ID)

<project>

Project to associate with image (name or ID)

Optional arguments

-h, --help

show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<image-name>

New image name

Optional arguments

-h, --help

show this help message and exit

--id <id>

Image ID to reserve

--container-format <container-format>

Image container format (default: bare)

--disk-format <disk-format>

Image disk format (default: raw)

--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

--file <file>

Upload image from local file

--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)

--tag <tag>

Set a tag on this image (repeat option to set multiple tags)

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<image>

Image(s) to delete (name or ID)

Optional arguments

-h, --help

show this help message and exit

Optional arguments

-h, --help

show this help message and exit

--public

List only public images

--private

List only private images

--shared

List only shared 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

Output formatters

Output formatter options

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

Positional arguments

<image>

Image to unshare (name or ID)

<project>

Project to disassociate with image (name or ID)

Optional arguments

-h, --help

show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

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)

Positional arguments

<image>

Image to modify (name or ID)

Optional arguments

-h, --help

show this help message and exit

--name <name>

New image name

--architecture <architecture>

Operating system Architecture

--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)

--instance-uuid <instance_uuid>

ID of instance used to create this image

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--kernel-id <kernel-id>

ID of image in Glance that should be used as the kernel when booting an AMI-style image

--os-version <os-version>

Operating system version as specified by the distributor

--disk-format <disk-format>

Format of the disk. Valid values: ['None', 'ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso']

--os-distro <os-distro>

Common name of operating system distribution

--owner <owner>

New Owner of the image

--ramdisk-id <ramdisk-id>

ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image

--min-ram <ram-mb>

Amount of RAM (in MB) required to boot image

--container-format <container-format>

Format of the container. Valid values: ['None', 'ami', 'ari', 'aki', 'bare', 'ovf', 'ova']

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>

Maximum display width, 0 to disable

json formatter:

--noindent

whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")

--prefix PREFIX

add a prefix to all variable names

Positional arguments

<image>

Image to display (name or ID)

Optional arguments

-h, --help

show this help message and exit

Output formatters

Output formatter options

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated