Chapter 72. server

This chapter describes the commands under the server command.

72.1. server add fixed ip

Add fixed IP address to server

Usage:

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     [--tag <tag>]
                                     <server> <network>

Table 72.1. Positional arguments

ValueSummary

<server>

Server to receive the fixed ip address (name or id)

<network>

Network to allocate the fixed ip address from (name or ID)

Table 72.2. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--fixed-ip-address <ip-address>

Requested fixed ip address

--tag <tag>

Tag for the attached interface. (supported by --os- compute-api-version 2.52 or above)

72.2. server add floating ip

Add floating IP address to server

Usage:

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

Table 72.3. Positional arguments

ValueSummary

<server>

Server to receive the floating ip address (name or id)

<ip-address>

Floating ip address to assign to the first available server port (IP only)

Table 72.4. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--fixed-ip-address <ip-address>

Fixed ip address to associate with this floating ip address. The first server port containing the fixed IP address will be used

72.3. server add network

Add network to server

Usage:

openstack server add network [-h] [--tag <tag>] <server> <network>

Table 72.5. Positional arguments

ValueSummary

<server>

Server to add the network to (name or id)

<network>

Network to add to the server (name or id)

Table 72.6. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Tag for the attached interface. (supported by --os-compute-api- version 2.49 or above)

72.4. server add port

Add port to server

Usage:

openstack server add port [-h] [--tag <tag>] <server> <port>

Table 72.7. Positional arguments

ValueSummary

<server>

Server to add the port to (name or id)

<port>

Port to add to the server (name or id)

Table 72.8. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

Tag for the attached interface. (supported by api versions 2.49 - 2.latest)

72.5. server add security group

Add security group to server

Usage:

openstack server add security group [-h] <server> <group>

Table 72.9. Positional arguments

ValueSummary

<server>

Server (name or id)

<group>

Security group to add (name or id)

Table 72.10. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.6. server add volume

Add volume to server. Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.

Usage:

openstack server add volume [-h] [--device <device>] [--tag <tag>]
                                   [--enable-delete-on-termination | --disable-delete-on-termination]
                                   <server> <volume>

Table 72.11. Positional arguments

ValueSummary

<server>

Server (name or id)

<volume>

Volume to add (name or id)

Table 72.12. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--device <device>

Server internal device name for volume

--tag <tag>

Tag for the attached volume (supported by --os- compute-api-version 2.49 or above)

--enable-delete-on-termination

Delete the volume when the server is destroyed (supported by --os-compute-api-version 2.79 or above)

--disable-delete-on-termination

Do not delete the volume when the server is destroyed (supported by --os-compute-api-version 2.79 or above)

72.7. server backup create

Create a server backup image

Usage:

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--name <image-name>]
                                      [--type <backup-type>]
                                      [--rotate <count>] [--wait]
                                      <server>

Table 72.13. Positional arguments

ValueSummary

<server>

Server to back up (name or id)

Table 72.14. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--name <image-name>

Name of the backup image (default: server name)

--type <backup-type>

Used to populate the backup_type property of the backup image (default: empty)

--rotate <count>

Number of backups to keep (default: 1)

--wait

Wait for backup image create to complete

Table 72.15. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.16. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.17. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.18. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.8. server create

Create a new server

Usage:

openstack server create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] --flavor <flavor>
                               (--image <image> | --image-property <key=value> | --volume <volume> | --snapshot <snapshot>)
                               [--boot-from-volume <volume-size>]
                               [--block-device-mapping <dev-name=mapping>]
                               [--block-device] [--swap <swap>]
                               [--ephemeral <size=size[,format=format]>]
                               [--network <network>] [--port <port>]
                               [--nic <net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag,auto,none>]
                               [--password <password>]
                               [--security-group <security-group>]
                               [--key-name <key-name>]
                               [--property <key=value>]
                               [--file <dest-filename=source-filename>]
                               [--user-data <user-data>]
                               [--description <description>]
                               [--availability-zone <zone-name>]
                               [--host <host>]
                               [--hypervisor-hostname <hypervisor-hostname>]
                               [--hint <key=value>]
                               [--use-config-drive | --no-config-drive | --config-drive <config-drive-volume>|True]
                               [--min <count>] [--max <count>] [--tag <tag>]
                               [--wait]
                               <server-name>

Table 72.19. Positional arguments

ValueSummary

<server-name>

New server name

Table 72.20. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--flavor <flavor>

Create server with this flavor (name or id)

--image <image>

Create server boot disk from this image (name or id)

--image-property <key=value>

Create server using the image that matches the specified property. Property must match exactly one property.

--volume <volume>

Create server using this volume as the boot disk (name or ID) This option automatically creates a block device mapping with a boot index of 0. On many hypervisors (libvirt/kvm for example) this will be device vda. Do not create a duplicate mapping using --block-device- mapping for this volume.

--snapshot <snapshot>

Create server using this snapshot as the boot disk (name or ID) This option automatically creates a block device mapping with a boot index of 0. On many hypervisors (libvirt/kvm for example) this will be device vda. Do not create a duplicate mapping using --block-device- mapping for this volume.

--boot-from-volume <volume-size>

When used in conjunction with the ``--image`` or ``--image-property`` option, this option automatically creates a block device mapping with a boot index of 0 and tells the compute service to create a volume of the given size (in GB) from the specified image and use it as the root disk of the server. The root volume will not be deleted when the server is deleted. This option is mutually exclusive with the ``--volume`` and ``--snapshot`` options.

--block-device-mapping <dev-name=mapping>

deprecated create a block device on the server. Block device mapping in the format <dev-name>=<id>:<type>:<size(GB)>:<delete-on- terminate> <dev-name>: block device name, like: vdb, xvdc (required) <id>: Name or ID of the volume, volume snapshot or image (required) <type>: volume, snapshot or image; default: volume (optional) <size(GB)>: volume size if create from image or snapshot (optional) <delete-on-terminate>: true or false; default: false (optional) Replaced by --block-device

--block-device

Create a block device on the server. Either a path to a JSON file or a CSV-serialized string describing the block device mapping. The following keys are accepted for both: uuid=<uuid>: UUID of the volume, snapshot or ID (required if using source image, snapshot or volume), source_type=<source_type>: source type (one of: image, snapshot, volume, blank), destination_typ=<destination_type>: destination type (one of: volume, local) (optional), disk_bus=<disk_bus>: device bus (one of: uml, lxc, virtio, …​) (optional), device_type=<device_type>: device type (one of: disk, cdrom, etc. (optional), device_name=<device_name>: name of the device (optional), volume_size=<volume_size>: size of the block device in MiB (for swap) or GiB (for everything else) (optional), guest_format=<guest_format>: format of device (optional), boot_index=<boot_index>: index of disk used to order boot disk (required for volume-backed instances), delete_on_termination=<true|false>: whether to delete the volume upon deletion of server (optional), tag=<tag>: device metadata tag (optional), volume_type=<volume_type>: type of volume to create (name or ID) when source if blank, image or snapshot and dest is volume (optional)

--swap <swap>

Create and attach a local swap block device of <swap_size> MiB.

--ephemeral <size=size[,format=format]>

Create and attach a local ephemeral block device of <size> GiB and format it to <format>.

--network <network>

Create a nic on the server and connect it to network. Specify option multiple times to create multiple NICs. This is a wrapper for the --nic net-id=<network> parameter that provides simple syntax for the standard use case of connecting a new server to a given network. For more advanced use cases, refer to the -- nic parameter.

--port <port>

Create a nic on the server and connect it to port. Specify option multiple times to create multiple NICs. This is a wrapper for the --nic port-id=<port> parameter that provides simple syntax for the standard use case of connecting a new server to a given port. For more advanced use cases, refer to the --nic parameter.

--nic <net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag,auto,none>

Create a nic on the server. NIC in the format: net-id=<net-uuid>: attach NIC to network with this UUID, port-id=<port-uuid>: attach NIC to port with this UUID, v4-fixed-ip=<ip-addr>: IPv4 fixed address for NIC (optional), v6-fixed-ip=<ip-addr>: IPv6 fixed address for NIC (optional), tag: interface metadata tag (optional) (supported by --os-compute-api-version 2.43 or above), none: (v2.37+) no network is attached, auto: (v2.37+) the compute service will automatically allocate a network. Specify option multiple times to create multiple NICs. Specifying a --nic of auto or none cannot be used with any other --nic value. Either net-id or port-id must be provided, but not both.

--password <password>

Set the password to this server

--security-group <security-group>

Security group to assign to this server (name or id) (repeat option to set multiple groups)

--key-name <key-name>

Keypair to inject into this server

--property <key=value>

Set a property on this server (repeat option to set multiple values)

--file <dest-filename=source-filename>

File(s) to inject into image before boot (repeat option to set multiple files)(supported by --os- compute-api-version 2.57 or below)

--user-data <user-data>

User data file to serve from the metadata server

--description <description>

Set description for the server (supported by --os- compute-api-version 2.19 or above)

--availability-zone <zone-name>

Select an availability zone for the server. host and node are optional parameters. Availability zone in the format <zone-name>:<host-name>:<node-name>, <zone- name>::<node-name>, <zone-name>:<host-name> or <zone- name>

--host <host>

Requested host to create servers. (admin only) (supported by --os-compute-api-version 2.74 or above)

--hypervisor-hostname <hypervisor-hostname>

Requested hypervisor hostname to create servers. (admin only) (supported by --os-compute-api-version 2.74 or above)

--hint <key=value>

Hints for the scheduler

--use-config-drive

Enable config drive.

--no-config-drive

Disable config drive.

--config-drive <config-drive-volume>|True

deprecated use specified volume as the config drive, or True to use an ephemeral drive. Replaced by --use-config-drive.

--min <count>

Minimum number of servers to launch (default=1)

--max <count>

Maximum number of servers to launch (default=1)

--tag <tag>

Tags for the server. specify multiple times to add multiple tags. (supported by --os-compute-api-version 2.52 or above)

--wait

Wait for build to complete

Table 72.21. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.22. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.23. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.24. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.9. server delete

Delete server(s)

Usage:

openstack server delete [-h] [--force] [--all-projects] [--wait]
                               <server> [<server> ...]

Table 72.25. Positional arguments

ValueSummary

<server>

Server(s) to delete (name or id)

Table 72.26. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--force

Force delete server(s)

--all-projects

Delete server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

--wait

Wait for delete to complete

72.10. server dump create

Create a dump file in server(s) Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)' memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource. This command requires ``--os-compute-api- version`` 2.17 or greater.

Usage:

openstack server dump create [-h] <server> [<server> ...]

Table 72.27. Positional arguments

ValueSummary

<server>

Server(s) to create dump file (name or id)

Table 72.28. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.11. server evacuate

Evacuate a server to a different host. This command is used to recreate a server after the host it was on has failed. It can only be used if the compute service that manages the server is down. This command should only be used by an admin after they have confirmed that the instance is not running on the failed host. If the server instance was created with an ephemeral root disk on non-shared storage the server will be rebuilt using the original glance image preserving the ports and any attached data volumes. If the server uses boot for volume or has its root disk on shared storage the root disk will be preserved and reused for the evacuated instance on the new host.

Usage:

openstack server evacuate [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--wait] [--host <host>]
                                 [--password <password> | --shared-storage]
                                 <server>

Table 72.29. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.30. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for evacuation to complete

--host <host>

Set the preferred host on which to rebuild the evacuated server. The host will be validated by the scheduler. (supported by --os-compute-api-version 2.29 or above)

--password <password>

Set the password on the evacuated instance. this option is mutually exclusive with the --shared-storage option

--shared-storage

Indicate that the instance is on shared storage. this will be auto-calculated with --os-compute-api-version 2.14 and greater and should not be used with later microversions. This option is mutually exclusive with the --password option

Table 72.31. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.32. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.33. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.34. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.12. server event list

List recent events of a server. Specify ``--os-compute-api-version 2.21`` or higher to show events for a deleted server, specified by ID only.

Usage:

openstack server event list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--sort-ascending | --sort-descending]
                                   [--long] [--changes-since <changes-since>]
                                   [--changes-before <changes-before>]
                                   [--marker MARKER] [--limit LIMIT]
                                   <server>

Table 72.35. Positional arguments

ValueSummary

<server>

Server to list events (name or id)

Table 72.36. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--changes-since <changes-since>

List only server events changed later or equal to a certain point of time. The provided time should be an ISO 8061 formatted time, e.g. ``2016-03-04T06:27:59Z``. (supported with --os- compute-api-version 2.58 or above)

--changes-before <changes-before>

List only server events changed earlier or equal to a certain point of time. The provided time should be an ISO 8061 formatted time, e.g. ``2016-03-04T06:27:59Z``. (supported with --os- compute-api-version 2.66 or above)

--marker MARKER

The last server event id of the previous page (supported by --os-compute-api-version 2.58 or above)

--limit LIMIT

Maximum number of server events to display (supported by --os-compute-api-version 2.58 or above)

Table 72.37. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 72.38. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 72.39. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.40. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.13. server event show

Show server event details. Specify ``--os-compute-api-version 2.21`` or higher to show event details for a deleted server, specified by ID only. Specify ``--os-compute-api-version 2.51`` or higher to show event details for non- admin users.

Usage:

openstack server event show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server> <request-id>

Table 72.41. Positional arguments

ValueSummary

<server>

Server to show event details (name or id)

<request-id>

Request id of the event to show (id only)

Table 72.42. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 72.43. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.44. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.45. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.46. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.14. server group create

Create a new server group.

Usage:

openstack server group create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--policy <policy>] [--rule <key=value>]
                                     <name>

Table 72.47. Positional arguments

ValueSummary

<name>

New server group name

Table 72.48. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--policy <policy>

Add a policy to <name> specify --os-compute-api- version 2.15 or higher for the soft-affinity or soft-anti-affinity policy.

--rule <key=value>

A rule for the policy. currently, only the max_server_per_host rule is supported for the anti- affinity policy.

Table 72.49. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.50. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.51. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.52. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.15. server group delete

Delete existing server group(s).

Usage:

openstack server group delete [-h] <server-group> [<server-group> ...]

Table 72.53. Positional arguments

ValueSummary

<server-group>

Server group(s) to delete (name or id)

Table 72.54. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.16. server group list

List all server groups.

Usage:

openstack server group list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--sort-ascending | --sort-descending]
                                   [--all-projects] [--long]
                                   [--offset <offset>] [--limit <limit>]

Table 72.55. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Display information from all projects (admin only)

--long

List additional fields in output

--offset <offset>

Index from which to start listing servers. this should typically be a factor of --limit. Display all servers groups if not specified.

--limit <limit>

Maximum number of server groups to display. if limit is greater than osapi_max_limit option of Nova API, osapi_max_limit will be used instead.

Table 72.56. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 72.57. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 72.58. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.59. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.17. server group show

Display server group details.

Usage:

openstack server group show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <server-group>

Table 72.60. Positional arguments

ValueSummary

<server-group>

Server group to display (name or id)

Table 72.61. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 72.62. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.63. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.64. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.65. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.18. server image create

Create a new server disk image from an existing server

Usage:

openstack server image create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--name <image-name>]
                                     [--property <key=value>] [--wait]
                                     <server>

Table 72.66. Positional arguments

ValueSummary

<server>

Server to create image (name or id)

Table 72.67. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--name <image-name>

Name of new disk image (default: server name)

--property <key=value>

Set a new property to meta_data.json on the metadata server (repeat option to set multiple values)

--wait

Wait for operation to complete

Table 72.68. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.69. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.70. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.71. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.19. server list

List servers

Usage:

openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--sort-ascending | --sort-descending]
                             [--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] [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--deleted]
                             [--availability-zone AVAILABILITY_ZONE]
                             [--key-name KEY_NAME]
                             [--config-drive | --no-config-drive]
                             [--progress PROGRESS] [--vm-state <state>]
                             [--task-state <state>] [--power-state <state>]
                             [--long] [-n | --name-lookup-one-by-one]
                             [--marker <server>] [--limit <num-servers>]
                             [--changes-before <changes-before>]
                             [--changes-since <changes-since>]
                             [--locked | --unlocked] [--tags <tag>]
                             [--not-tags <tag>]

Table 72.72. Command arguments

ValueSummary

-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. note that this option only applies for non-admin users when using ``--os-compute-api-version`` 2.5 or greater.

--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 (name or id)

--image <image>

Search by image (name or id)

--host <hostname>

Search by hostname

--all-projects

Include all projects (admin only) (can be specified using the ALL_PROJECTS envvar)

--project <project>

Search by project (admin only) (name or id)

--project-domain <project-domain>

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

--user <user>

Search by user (name or id) (admin only before microversion 2.83)

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

--deleted

Only display deleted servers (admin only)

--availability-zone AVAILABILITY_ZONE

Search by availability zone (admin only before microversion 2.83)

--key-name KEY_NAME

Search by keypair name (admin only before microversion 2.83)

--config-drive

Only display servers with a config drive attached (admin only before microversion 2.83)

--no-config-drive

Only display servers without a config drive attached (admin only before microversion 2.83)

--progress PROGRESS

Search by progress value (%) (admin only before microversion 2.83)

--vm-state <state>

Search by vm_state value (admin only before microversion 2.83)

--task-state <state>

Search by task_state value (admin only before microversion 2.83)

--power-state <state>

Search by power_state value (admin only before microversion 2.83)

--long

List additional fields in output

-n, --no-name-lookup

Skip flavor and image name lookup. mutually exclusive with "--name-lookup-one-by-one" option.

--name-lookup-one-by-one

When looking up flavor and image names, look them upone by one as needed instead of all together (default). Mutually exclusive with "--no-name- lookup|-n" option.

--marker <server>

The last server of the previous page. display list of servers after marker. Display all servers if not specified. When used with ``--deleted``, the marker must be an ID, otherwise a name or ID can be used.

--limit <num-servers>

Maximum number of servers to display. if limit equals -1, all servers will be displayed. If limit is greater than osapi_max_limit option of Nova API, osapi_max_limit will be used instead.

--changes-before <changes-before>

List only servers changed before a certain point of time. The provided time should be an ISO 8061 formatted time (e.g., 2016-03-05T06:27:59Z). (supported by --os-compute-api-version 2.66 or above)

--changes-since <changes-since>

List only servers changed after a certain point of time. The provided time should be an ISO 8061 formatted time (e.g., 2016-03-04T06:27:59Z).

--locked

Only display locked servers (supported by --os- compute-api-version 2.73 or above)

--unlocked

Only display unlocked servers (supported by --os- compute-api-version 2.73 or above)

--tags <tag>

Only list servers with the specified tag. specify multiple times to filter on multiple tags. (supported by --os-compute-api-version 2.26 or above)

--not-tags <tag>

Only list servers without the specified tag. specify multiple times to filter on multiple tags. (supported by --os-compute-api-version 2.26 or above)

Table 72.73. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 72.74. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 72.75. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.76. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.20. server lock

Lock server(s). A non-admin user will not be able to execute actions

Usage:

openstack server lock [-h] [--reason <reason>] <server> [<server> ...]

Table 72.77. Positional arguments

ValueSummary

<server>

Server(s) to lock (name or id)

Table 72.78. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for locking the server(s). requires ``--os- compute-api-version`` 2.73 or greater.

72.21. server migrate confirm

DEPRECATED: Confirm server migration. Use server migration confirm instead.

Usage:

openstack server migrate confirm [-h] <server>

Table 72.79. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.80. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.22. server migrate revert

Revert server migration. Use server migration revert instead.

Usage:

openstack server migrate revert [-h] <server>

Table 72.81. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.82. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.23. server migrate

Migrate server to different host. A migrate operation is implemented as a resize operation using the same flavor as the old server. This means that, like resize, migrate works by creating a new server using the same flavor and copying the contents of the original disk into a new one. As with resize, the migrate operation is a two-step process for the user: the first step is to perform the migrate, and the second step is to either confirm (verify) success and release the old server, or to declare a revert to release the new server and restart the old one.

Usage:

openstack server migrate [-h] [--live-migration] [--host <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

Table 72.83. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.84. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--live-migration

Live migrate the server; use the ``--host`` option to specify a target host for the migration which will be validated by the scheduler

--host <hostname>

Migrate the server to the specified host. (supported with --os-compute-api-version 2.30 or above when used with the --live-migration option) (supported with --os-compute-api-version 2.56 or above when used without the --live-migration option)

--shared-migration

Perform a shared live migration (default before --os- compute-api-version 2.25, auto after)

--block-migration

Perform a block live migration (auto-configured from --os-compute-api-version 2.25)

--disk-overcommit

Allow disk over-commit on the destination host(supported with --os-compute-api-version 2.24 or below)

--no-disk-overcommit

Do not over-commit disk on the destination host (default)(supported with --os-compute-api-version 2.24 or below)

--wait

Wait for migrate to complete

72.24. server migration abort

Cancel an ongoing live migration. This command requires ``--os-compute-api- version`` 2.24 or greater.

Usage:

openstack server migration abort [-h] <server> <migration>

Table 72.85. Positional arguments

ValueSummary

<server>

Server (name or id)

<migration>

Migration (id)

Table 72.86. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.25. server migration confirm

Confirm server migration. Confirm (verify) success of the migration operation and release the old server.

Usage:

openstack server migration confirm [-h] <server>

Table 72.87. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.88. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.26. server migration force complete

Force an ongoing live migration to complete. This command requires ``--os- compute-api-version`` 2.22 or greater.

Usage:

openstack server migration force complete [-h] <server> <migration>

Table 72.89. Positional arguments

ValueSummary

<server>

Server (name or id)

<migration>

Migration (id)

Table 72.90. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.27. server migration list

List server migrations

Usage:

openstack server migration list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--sort-ascending | --sort-descending]
                                       [--server <server>] [--host <host>]
                                       [--status <status>] [--type <type>]
                                       [--marker <marker>] [--limit <limit>]
                                       [--changes-since <changes-since>]
                                       [--changes-before <changes-before>]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--user <user>]
                                       [--user-domain <user-domain>]

Table 72.91. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--server <server>

Filter migrations by server (name or id)

--host <host>

Filter migrations by source or destination host

--status <status>

Filter migrations by status

--type <type>

Filter migrations by type

--marker <marker>

The last migration of the previous page; displays list of migrations after marker. Note that the marker is the migration UUID. (supported with --os-compute-api- version 2.59 or above)

--limit <limit>

Maximum number of migrations to display. note that there is a configurable max limit on the server, and the limit that is used will be the minimum of what is requested here and what is configured in the server. (supported with --os-compute-api-version 2.59 or above)

--changes-since <changes-since>

List only migrations changed later or equal to a certain point of time. The provided time should be an ISO 8061 formatted time, e.g. ``2016-03-04T06:27:59Z``. (supported with --os- compute-api-version 2.59 or above)

--changes-before <changes-before>

List only migrations changed earlier or equal to a certain point of time. The provided time should be an ISO 8061 formatted time, e.g. ``2016-03-04T06:27:59Z``. (supported with --os- compute-api-version 2.66 or above)

--project <project>

Filter migrations by project (name or id) (supported with --os-compute-api-version 2.80 or above)

--project-domain <project-domain>

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

--user <user>

Filter migrations by user (name or id) (supported with --os-compute-api-version 2.80 or above)

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

Table 72.92. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 72.93. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 72.94. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.95. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.28. server migration revert

Revert server migration. Revert the migration operation. Release the new server and restart the old one.

Usage:

openstack server migration revert [-h] <server>

Table 72.96. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.97. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.29. server migration show

Show a migration for a given server.

Usage:

openstack server migration show [-h] <server> <migration>

Table 72.98. Positional arguments

ValueSummary

<server>

Server (name or id)

<migration>

Migration (id)

Table 72.99. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.30. server pause

Pause server(s)

Usage:

openstack server pause [-h] <server> [<server> ...]

Table 72.100. Positional arguments

ValueSummary

<server>

Server(s) to pause (name or id)

Table 72.101. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.31. server reboot

Perform a hard or soft server reboot

Usage:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

Table 72.102. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.103. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--hard

Perform a hard reboot

--soft

Perform a soft reboot

--wait

Wait for reboot to complete

72.32. server rebuild

Rebuild server

Usage:

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] [--image <image>]
                                [--name <name>] [--password <password>]
                                [--property <key=value>]
                                [--description <description>]
                                [--preserve-ephemeral | --no-preserve-ephemeral]
                                [--key-name <key-name> | --no-key-name]
                                [--user-data <user-data> | --no-user-data]
                                [--trusted-image-cert <trusted-cert-id> | --no-trusted-image-certs]
                                [--wait]
                                <server>

Table 72.104. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.105. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--image <image>

Recreate server from the specified image (name or ID).Defaults to the currently used one.

--name <name>

Set the new name of the rebuilt server

--password <password>

Set the password on the rebuilt server

--property <key=value>

Set a new property on the rebuilt server (repeat option to set multiple values)

--description <description>

Set a new description on the rebuilt server (supported by --os-compute-api-version 2.19 or above)

--preserve-ephemeral

Preserve the default ephemeral storage partition on rebuild.

--no-preserve-ephemeral

Do not preserve the default ephemeral storage partition on rebuild.

--key-name <key-name>

Set the key name of key pair on the rebuilt server. Cannot be specified with the --key-unset option. (supported by --os-compute-api-version 2.54 or above)

--no-key-name

Unset the key name of key pair on the rebuilt server. Cannot be specified with the --key-name option. (supported by --os-compute-api-version 2.54 or above)

--user-data <user-data>

Add a new user data file to the rebuilt server. cannot be specified with the --no-user-data option. (supported by --os-compute-api-version 2.57 or above)

--no-user-data

Remove existing user data when rebuilding server. Cannot be specified with the --user-data option. (supported by --os-compute-api-version 2.57 or above)

--trusted-image-cert <trusted-cert-id>

Trusted image certificate ids used to validate certificates during the image signature verification process. Defaults to env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS]. May be specified multiple times to pass multiple trusted image certificate IDs. Cannot be specified with the --no-trusted-certs option. (supported by --os-compute- api-version 2.63 or above)

--no-trusted-image-certs

Remove any existing trusted image certificates from the server. Cannot be specified with the --trusted- certs option. (supported by --os-compute-api-version 2.63 or above)

--wait

Wait for rebuild to complete

Table 72.106. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.107. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.108. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.109. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.33. server remove fixed ip

Remove fixed IP address from server

Usage:

openstack server remove fixed ip [-h] <server> <ip-address>

Table 72.110. Positional arguments

ValueSummary

<server>

Server to remove the fixed ip address from (name or id)

<ip-address>

Fixed ip address to remove from the server (ip only)

Table 72.111. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.34. server remove floating ip

Remove floating IP address from server

Usage:

openstack server remove floating ip [-h] <server> <ip-address>

Table 72.112. Positional arguments

ValueSummary

<server>

Server to remove the floating ip address from (name or id)

<ip-address>

Floating ip address to remove from server (ip only)

Table 72.113. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.35. server remove network

Remove all ports of a network from server

Usage:

openstack server remove network [-h] <server> <network>

Table 72.114. Positional arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<network>

Network to remove from the server (name or id)

Table 72.115. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.36. server remove port

Remove port from server

Usage:

openstack server remove port [-h] <server> <port>

Table 72.116. Positional arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<port>

Port to remove from the server (name or id)

Table 72.117. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.37. server remove security group

Remove security group from server

Usage:

openstack server remove security group [-h] <server> <group>

Table 72.118. Positional arguments

ValueSummary

<server>

Name or id of server to use

<group>

Name or id of security group to remove from server

Table 72.119. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.38. server remove volume

Remove volume from server. Specify ``--os-compute-api-version 2.20`` or higher to remove a volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.

Usage:

openstack server remove volume [-h] <server> <volume>

Table 72.120. Positional arguments

ValueSummary

<server>

Server (name or id)

<volume>

Volume to remove (name or id)

Table 72.121. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.39. server rescue

Put server in rescue mode

Usage:

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

Table 72.122. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.123. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--image <image>

Image (name or id) to use for the rescue mode. Defaults to the currently used one.

--password <password>

Set the password on the rescued instance

72.40. server resize confirm

Confirm server resize. Confirm (verify) success of resize operation and release the old server.

Usage:

openstack server resize confirm [-h] <server>

Table 72.124. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.125. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.41. server resize revert

Revert server resize. Revert the resize operation. Release the new server and restart the old one.

Usage:

openstack server resize revert [-h] <server>

Table 72.126. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.127. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.42. server resize

Scale server to a new flavor. A resize operation is implemented by creating a new server and copying the contents of the original disk into a new one. It is a two-step process for the user: the first step is to perform the resize, and the second step is to either confirm (verify) success and release the old server or to declare a revert to release the new server and restart the old one.

Usage:

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

Table 72.128. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.129. Command arguments

ValueSummary

-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

72.43. server restore

Restore server(s)

Usage:

openstack server restore [-h] <server> [<server> ...]

Table 72.130. Positional arguments

ValueSummary

<server>

Server(s) to restore (name or id)

Table 72.131. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.44. server resume

Resume server(s)

Usage:

openstack server resume [-h] <server> [<server> ...]

Table 72.132. Positional arguments

ValueSummary

<server>

Server(s) to resume (name or id)

Table 72.133. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.45. server set

Set server properties

Usage:

openstack server set [-h] [--name <new-name>]
                            [--password PASSWORD | --no-password]
                            [--property <key=value>] [--state <state>]
                            [--description <description>] [--tag <tag>]
                            <server>

Table 72.134. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.135. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--name <new-name>

New server name

--password PASSWORD

Set the server password

--no-password

Clear the admin password for the server from the metadata service; note that this action does not actually change the server password

--property <key=value>

Property to add/change for this server (repeat option to set multiple properties)

--state <state>

New server state (valid value: active, error)

--description <description>

New server description (supported by --os-compute-api- version 2.19 or above)

--tag <tag>

Tag for the server. specify multiple times to add multiple tags. (supported by --os-compute-api-version 2.26 or above)

72.46. server shelve

Shelve and optionally offload server(s). Shelving a server creates a snapshot of the server and stores this snapshot before shutting down the server. This shelved server can then be offloaded or deleted from the host, freeing up remaining resources on the host, such as network interfaces. Shelved servers can be unshelved, restoring the server from the snapshot. Shelving is therefore useful where users wish to retain the UUID and IP of a server, without utilizing other resources or disks. Most clouds are configured to automatically offload shelved servers immediately or after a small delay. For clouds where this is not configured, or where the delay is larger, offloading can be manually specified. This is an admin-only operation by default.

Usage:

openstack server shelve [-h] [--offload] [--wait]
                               <server> [<server> ...]

Table 72.136. Positional arguments

ValueSummary

<server>

Server(s) to shelve (name or id)

Table 72.137. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--offload

Remove the shelved server(s) from the host (admin only). Invoking this option on an unshelved server(s) will result in the server being shelved first

--wait

Wait for shelve and/or offload operation to complete

72.47. server show

Show server details. Specify ``--os-compute-api-version 2.47`` or higher to see the embedded flavor information for the server.

Usage:

openstack server show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--diagnostics | --topology]
                             <server>

Table 72.138. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.139. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--diagnostics

Display server diagnostics information

--topology

Include topology information in the output (supported by --os-compute-api-version 2.78 or above)

Table 72.140. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 72.141. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.142. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 72.143. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.48. server ssh

SSH to server

Usage:

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

Table 72.144. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.145. Command arguments

ValueSummary

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

72.49. server start

Start server(s).

Usage:

openstack server start [-h] [--all-projects] <server> [<server> ...]

Table 72.146. Positional arguments

ValueSummary

<server>

Server(s) to start (name or id)

Table 72.147. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Start server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

72.50. server stop

Stop server(s).

Usage:

openstack server stop [-h] [--all-projects] <server> [<server> ...]

Table 72.148. Positional arguments

ValueSummary

<server>

Server(s) to stop (name or id)

Table 72.149. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--all-projects

Stop server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

72.51. server suspend

Suspend server(s)

Usage:

openstack server suspend [-h] <server> [<server> ...]

Table 72.150. Positional arguments

ValueSummary

<server>

Server(s) to suspend (name or id)

Table 72.151. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.52. server unlock

Unlock server(s)

Usage:

openstack server unlock [-h] <server> [<server> ...]

Table 72.152. Positional arguments

ValueSummary

<server>

Server(s) to unlock (name or id)

Table 72.153. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.53. server unpause

Unpause server(s)

Usage:

openstack server unpause [-h] <server> [<server> ...]

Table 72.154. Positional arguments

ValueSummary

<server>

Server(s) to unpause (name or id)

Table 72.155. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.54. server unrescue

Restore server from rescue mode

Usage:

openstack server unrescue [-h] <server>

Table 72.156. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.157. Command arguments

ValueSummary

-h, --help

Show this help message and exit

72.55. server unset

Unset server properties and tags

Usage:

openstack server unset [-h] [--property <key>] [--description]
                              [--tag <tag>]
                              <server>

Table 72.158. Positional arguments

ValueSummary

<server>

Server (name or id)

Table 72.159. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property key to remove from server (repeat option to remove multiple values)

--description

Unset server description (supported by --os-compute-api- version 2.19 or above)

--tag <tag>

Tag to remove from the server. specify multiple times to remove multiple tags. (supported by --os-compute-api- version 2.26 or above)

72.56. server unshelve

Unshelve server(s)

Usage:

openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE]
                                 [--wait]
                                 <server> [<server> ...]

Table 72.160. Positional arguments

ValueSummary

<server>

Server(s) to unshelve (name or id)

Table 72.161. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--availability-zone AVAILABILITY_ZONE

Name of the availability zone in which to unshelve a SHELVED_OFFLOADED server (supported by --os-compute- api-version 2.77 or above)

--wait

Wait for unshelve operation to complete

72.57. server volume list

List all the volumes attached to a server.

Usage:

openstack server volume list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--sort-ascending | --sort-descending]
                                    server

Table 72.162. Positional arguments

ValueSummary

server

Server to list volume attachments for (name or id)

Table 72.163. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 72.164. Output formatter options

ValueSummary

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

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 72.165. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 72.166. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 72.167. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

72.58. server volume update

Update a volume attachment on the server.

Usage:

openstack server volume update [-h]
                                      [--delete-on-termination | --preserve-on-termination]
                                      server volume

Table 72.168. Positional arguments

ValueSummary

server

Server to update volume for (name or id)

volume

Volume (id)

Table 72.169. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--delete-on-termination

Delete the volume when the server is destroyed (supported by --os-compute-api-version 2.85 or above)

--preserve-on-termination

Preserve the volume when the server is destroyed (supported by --os-compute-api-version 2.85 or above)