Chapter 72. server

<server>

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

<network>

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

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

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

-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

<server>

Server to add the network to (name or id)

<network>

Network to add to the server (name or id)

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

<server>

Server to add the port to (name or id)

<port>

Port to add to the server (name or id)

-h, --help

Show this help message and exit

--tag <tag>

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

<server>

Server (name or id)

<group>

Security group to add (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

<volume>

Volume to add (name or id)

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

<server>

Server to back up (name or id)

-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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server-name>

New server name

-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. this option requires cloud support.

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server>

Server(s) to delete (name or id)

-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

<server>

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

-h, --help

Show this help message and exit

<server>

Server (name or id)

-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. This option requires cloud support.

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server>

Server to list events (name or id)

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

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<server>

Server to show event details (name or id)

<request-id>

Request id of the event to show (id only)

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<name>

New server group name

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server-group>

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

-h, --help

Show this help message and exit

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

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<server-group>

Server group to display (name or id)

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server>

Server to create image (name or id)

-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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

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

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<server>

Server(s) to lock (name or id)

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

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-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

<server>

Server (name or id)

<migration>

Migration (id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

<migration>

Migration (id)

-h, --help

Show this help message and exit

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

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

<migration>

Migration (id)

-h, --help

Show this help message and exit

<server>

Server(s) to pause (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

--hard

Perform a hard reboot

--soft

Perform a soft reboot

--wait

Wait for reboot to complete

<server>

Server (name or id)

-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. this option requires cloud support.

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server>

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

<ip-address>

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

-h, --help

Show this help message and exit

<server>

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

<ip-address>

Floating ip address to remove from server (ip only)

-h, --help

Show this help message and exit

<server>

Server to remove the port from (name or id)

<network>

Network to remove from the server (name or id)

-h, --help

Show this help message and exit

<server>

Server to remove the port from (name or id)

<port>

Port to remove from the server (name or id)

-h, --help

Show this help message and exit

<server>

Name or id of server to use

<group>

Name or id of security group to remove from server

-h, --help

Show this help message and exit

<server>

Server (name or id)

<volume>

Volume to remove (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-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. this option requires cloud support.

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-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

<server>

Server(s) to restore (name or id)

-h, --help

Show this help message and exit

<server>

Server(s) to resume (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

--name <new-name>

New server name

--password PASSWORD

Set the server password. this option requires cloud support.

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

<server>

Server(s) to shelve (name or id)

-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

<server>

Server (name or id)

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<server>

Server (name or id)

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

<server>

Server(s) to start (name or id)

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

<server>

Server(s) to stop (name or id)

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

<server>

Server(s) to suspend (name or id)

-h, --help

Show this help message and exit

<server>

Server(s) to unlock (name or id)

-h, --help

Show this help message and exit

<server>

Server(s) to unpause (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

-h, --help

Show this help message and exit

<server>

Server (name or id)

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

<server>

Server(s) to unshelve (name or id)

-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

server

Server to list volume attachments for (name or id)

-h, --help

Show this help message and exit

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

server

Server to update volume for (name or id)

volume

Volume (id)

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