Chapter 65. server This chapter describes the commands under the server command. 65.1. server add fixed ip Add fixed IP address to server Usage: Table 65.1. Positional arguments Value Summary <server> Server to receive the fixed ip address (name or id) <network> Network to allocate the fixed ip address from (name or ID) Table 65.2. Command arguments Value Summary -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.49 or above) Table 65.3. Output formatter options Value Summary -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 65.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.6. Table formatter options Value Summary --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. 65.2. server add floating ip Add floating IP address to server Usage: Table 65.7. Positional arguments Value Summary <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 65.8. Command arguments Value Summary -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 65.3. server add network Add network to server Usage: Table 65.9. Positional arguments Value Summary <server> Server to add the network to (name or id) <network> Network to add to the server (name or id) Table 65.10. Command arguments Value Summary -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) 65.4. server add port Add port to server Usage: Table 65.11. Positional arguments Value Summary <server> Server to add the port to (name or id) <port> Port to add to the server (name or id) Table 65.12. Command arguments Value Summary -h, --help Show this help message and exit --tag <tag> Tag for the attached interface (supported by --os-compute-api- version 2.49 or later) 65.5. server add security group Add security group to server Usage: Table 65.13. Positional arguments Value Summary <server> Server (name or id) <group> Security group to add (name or id) Table 65.14. Command arguments Value Summary -h, --help Show this help message and exit 65.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: Table 65.15. Positional arguments Value Summary <server> Server (name or id) <volume> Volume to add (name or id) Table 65.16. Command arguments Value Summary -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) Table 65.17. Output formatter options Value Summary -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 65.18. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.19. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.20. Table formatter options Value Summary --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. 65.7. server backup create Create a server backup image Usage: Table 65.21. Positional arguments Value Summary <server> Server to back up (name or id) Table 65.22. Command arguments Value Summary -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 65.23. Output formatter options Value Summary -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 65.24. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.25. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.26. Table formatter options Value Summary --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. 65.8. server create Create a new server Usage: Table 65.27. Positional arguments Value Summary <server-name> New server name Table 65.28. Command arguments Value Summary -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_type=<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. --no-network Do not attach a network to the server. this is a wrapper for the --nic none option that provides a simple syntax for disabling network connectivity for a new server. For more advanced use cases, refer to the --nic parameter. (supported by --os-compute-api- version 2.37 or above) --auto-network Automatically allocate a network to the server. this is the default network allocation policy. This is a wrapper for the --nic auto option that provides a simple syntax for enabling automatic configuration of network connectivity for a new server. For more advanced use cases, refer to the --nic parameter. (supported by --os-compute-api-version 2.37 or above) --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) --hostname <hostname> Hostname configured for the server in the metadata service. If unset, a hostname will be automatically generated from the server name. A utility such as cloud-init is required to propagate the hostname in the metadata service to the guest OS itself. (supported by --os-compute-api-version 2.90 or above) --wait Wait for build to complete --trusted-image-cert <trusted-cert-id> Trusted image certificate ids used to validate certificates during the image signature verification process. May be specified multiple times to pass multiple trusted image certificate IDs. (supported by --os-compute-api-version 2.63 or above) Table 65.29. Output formatter options Value Summary -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 65.30. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.31. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.32. Table formatter options Value Summary --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. 65.9. server delete Delete server(s) Usage: Table 65.33. Positional arguments Value Summary <server> Server(s) to delete (name or id) Table 65.34. Command arguments Value Summary -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 65.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). This is contingent on guest operating system support, and the location of the dump file inside the guest will depend on the exact guest operating system. This command requires ``--os- compute-api-version`` 2.17 or greater. Usage: Table 65.35. Positional arguments Value Summary <server> Server(s) to create dump file (name or id) Table 65.36. Command arguments Value Summary -h, --help Show this help message and exit 65.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: Table 65.37. Positional arguments Value Summary <server> Server (name or id) Table 65.38. Command arguments Value Summary -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 Table 65.39. Output formatter options Value Summary -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 65.40. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.41. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.42. Table formatter options Value Summary --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. 65.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: Table 65.43. Positional arguments Value Summary <server> Server to list events (name or id) Table 65.44. Command arguments Value Summary -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 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 65.45. Output formatter options Value Summary -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 65.46. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 65.47. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.48. Table formatter options Value Summary --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. 65.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: Table 65.49. Positional arguments Value Summary <server> Server to show event details (name or id) <request-id> Request id of the event to show (id only) Table 65.50. Command arguments Value Summary -h, --help Show this help message and exit Table 65.51. Output formatter options Value Summary -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 65.52. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.53. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.54. Table formatter options Value Summary --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. 65.14. server group create Create a new server group. Usage: Table 65.55. Positional arguments Value Summary <name> New server group name Table 65.56. Command arguments Value Summary -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 65.57. Output formatter options Value Summary -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 65.58. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.59. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.60. Table formatter options Value Summary --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. 65.15. server group delete Delete existing server group(s). Usage: Table 65.61. Positional arguments Value Summary <server-group> Server group(s) to delete (name or id) Table 65.62. Command arguments Value Summary -h, --help Show this help message and exit 65.16. server group list List all server groups. Usage: Table 65.63. Command arguments Value Summary -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 65.64. Output formatter options Value Summary -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 65.65. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 65.66. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.67. Table formatter options Value Summary --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. 65.17. server group show Display server group details. Usage: Table 65.68. Positional arguments Value Summary <server-group> Server group to display (name or id) Table 65.69. Command arguments Value Summary -h, --help Show this help message and exit Table 65.70. Output formatter options Value Summary -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 65.71. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.72. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.73. Table formatter options Value Summary --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. 65.18. server image create Create a new server disk image from an existing server Usage: Table 65.74. Positional arguments Value Summary <server> Server to create image (name or id) Table 65.75. Command arguments Value Summary -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 65.76. Output formatter options Value Summary -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 65.77. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.78. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.79. Table formatter options Value Summary --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. 65.19. server list List servers Usage: Table 65.80. Command arguments Value Summary -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 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 65.81. Output formatter options Value Summary -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 65.82. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 65.83. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.84. Table formatter options Value Summary --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. 65.20. server lock Lock server(s) A non-admin user will not be able to execute actions. Usage: Table 65.85. Positional arguments Value Summary <server> Server(s) to lock (name or id) Table 65.86. Command arguments Value Summary -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. 65.21. server migrate confirm DEPRECATED: Use server migration confirm instead. Usage: Table 65.87. Positional arguments Value Summary <server> Server (name or id) Table 65.88. Command arguments Value Summary -h, --help Show this help message and exit 65.22. server migrate revert DEPRECATED: Use server migration revert instead. Usage: Table 65.89. Positional arguments Value Summary <server> Server (name or id) Table 65.90. Command arguments Value Summary -h, --help Show this help message and exit 65.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: Table 65.91. Positional arguments Value Summary <server> Server (name or id) Table 65.92. Command arguments Value Summary -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 65.24. server migration abort Cancel an ongoing live migration. This command requires ``--os-compute-api- version`` 2.24 or greater. Usage: Table 65.93. Positional arguments Value Summary <server> Server (name or id) <migration> Migration (id) Table 65.94. Command arguments Value Summary -h, --help Show this help message and exit 65.25. server migration confirm Confirm server migration. Confirm (verify) success of the migration operation and release the old server. Usage: Table 65.95. Positional arguments Value Summary <server> Server (name or id) Table 65.96. Command arguments Value Summary -h, --help Show this help message and exit 65.26. server migration force complete Force an ongoing live migration to complete. This command requires ``--os- compute-api-version`` 2.22 or greater. Usage: Table 65.97. Positional arguments Value Summary <server> Server (name or id) <migration> Migration (id) Table 65.98. Command arguments Value Summary -h, --help Show this help message and exit 65.27. server migration list List server migrations Usage: Table 65.99. Command arguments Value Summary -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 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 65.100. Output formatter options Value Summary -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 65.101. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 65.102. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.103. Table formatter options Value Summary --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. 65.28. server migration revert Revert server migration. Revert the migration operation. Release the new server and restart the old one. Usage: Table 65.104. Positional arguments Value Summary <server> Server (name or id) Table 65.105. Command arguments Value Summary -h, --help Show this help message and exit 65.29. server migration show Show an in-progress live migration for a given server. Note that it is not possible to show cold migrations or completed live-migrations. Use openstack server migration list to get details for these. Usage: Table 65.106. Positional arguments Value Summary <server> Server (name or id) <migration> Migration (id) Table 65.107. Command arguments Value Summary -h, --help Show this help message and exit Table 65.108. Output formatter options Value Summary -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 65.109. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.110. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.111. Table formatter options Value Summary --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. 65.30. server pause Pause server(s) Usage: Table 65.112. Positional arguments Value Summary <server> Server(s) to pause (name or id) Table 65.113. Command arguments Value Summary -h, --help Show this help message and exit 65.31. server reboot Perform a hard or soft server reboot Usage: Table 65.114. Positional arguments Value Summary <server> Server (name or id) Table 65.115. Command arguments Value Summary -h, --help Show this help message and exit --hard Perform a hard reboot --soft Perform a soft reboot --wait Wait for reboot to complete 65.32. server rebuild Rebuild server Usage: Table 65.116. Positional arguments Value Summary <server> Server (name or id) Table 65.117. Command arguments Value Summary -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. 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) --hostname <hostname> Hostname configured for the server in the metadata service. A separate utility running in the guest is required to propagate changes to this value to the guest OS itself. (supported by --os-compute-api- version 2.90 or above) --reimage-boot-volume Rebuild a volume-backed server. this will wipe the root volume data and overwrite it with the provided image. Defaults to False. (supported by --os-compute- api-version 2.93 or above) --no-reimage-boot-volume Do not rebuild a volume-backed server. (supported by --os-compute-api-version 2.93 or above) --wait Wait for rebuild to complete Table 65.118. Output formatter options Value Summary -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 65.119. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.120. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.121. Table formatter options Value Summary --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. 65.33. server remove fixed ip Remove fixed IP address from server Usage: Table 65.122. Positional arguments Value Summary <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 65.123. Command arguments Value Summary -h, --help Show this help message and exit 65.34. server remove floating ip Remove floating IP address from server Usage: Table 65.124. Positional arguments Value Summary <server> Server to remove the floating ip address from (name or id) <ip-address> Floating ip address to remove from server (ip only) Table 65.125. Command arguments Value Summary -h, --help Show this help message and exit 65.35. server remove network Remove all ports of a network from server Usage: Table 65.126. Positional arguments Value Summary <server> Server to remove the port from (name or id) <network> Network to remove from the server (name or id) Table 65.127. Command arguments Value Summary -h, --help Show this help message and exit 65.36. server remove port Remove port from server Usage: Table 65.128. Positional arguments Value Summary <server> Server to remove the port from (name or id) <port> Port to remove from the server (name or id) Table 65.129. Command arguments Value Summary -h, --help Show this help message and exit 65.37. server remove security group Remove security group from server Usage: Table 65.130. Positional arguments Value Summary <server> Name or id of server to use <group> Name or id of security group to remove from server Table 65.131. Command arguments Value Summary -h, --help Show this help message and exit 65.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: Table 65.132. Positional arguments Value Summary <server> Server (name or id) <volume> Volume to remove (name or id) Table 65.133. Command arguments Value Summary -h, --help Show this help message and exit 65.39. server rescue Put server in rescue mode. Specify ``--os-compute-api-version 2.87`` or higher to rescue a server booted from a volume. Usage: Table 65.134. Positional arguments Value Summary <server> Server (name or id) Table 65.135. Command arguments Value Summary -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. 65.40. server resize confirm Confirm server resize. Confirm (verify) success of resize operation and release the old server. Usage: Table 65.136. Positional arguments Value Summary <server> Server (name or id) Table 65.137. Command arguments Value Summary -h, --help Show this help message and exit 65.41. server resize revert Revert server resize. Revert the resize operation. Release the new server and restart the old one. Usage: Table 65.138. Positional arguments Value Summary <server> Server (name or id) Table 65.139. Command arguments Value Summary -h, --help Show this help message and exit 65.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: Table 65.140. Positional arguments Value Summary <server> Server (name or id) Table 65.141. Command arguments Value Summary -h, --help Show this help message and exit --flavor <flavor> Resize server to specified flavor --confirm deprecated confirm server resize is complete. Replaced by the openstack server resize confirm and openstack server migration confirm commands --revert deprecated restore server state before resizereplaced by the openstack server resize revert and openstack server migration revert commands --wait Wait for resize to complete 65.43. server restore Restore server(s) Usage: Table 65.142. Positional arguments Value Summary <server> Server(s) to restore (name or id) Table 65.143. Command arguments Value Summary -h, --help Show this help message and exit 65.44. server resume Resume server(s) Usage: Table 65.144. Positional arguments Value Summary <server> Server(s) to resume (name or id) Table 65.145. Command arguments Value Summary -h, --help Show this help message and exit 65.45. server set Set server properties Usage: Table 65.146. Positional arguments Value Summary <server> Server (name or id) Table 65.147. Command arguments Value Summary -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 warning this can result in instances that are no longer usable and should be used with caution (admin only) --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) --hostname <hostname> Hostname configured for the server in the metadata service. A separate utility running in the guest is required to propagate changes to this value to the guest OS itself. (supported by --os-compute-api- version 2.90 or above) 65.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: Table 65.148. Positional arguments Value Summary <server> Server(s) to shelve (name or id) Table 65.149. Command arguments Value Summary -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 65.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: Table 65.150. Positional arguments Value Summary <server> Server (name or id) Table 65.151. Command arguments Value Summary -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 65.152. Output formatter options Value Summary -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 65.153. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.154. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 65.155. Table formatter options Value Summary --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. 65.48. server ssh SSH to server Usage: Table 65.156. Positional arguments Value Summary <server> Server (name or id) - <standard ssh args> Any argument or option that ssh allows. use - once between openstackclient args and SSH args. Table 65.157. Command arguments Value Summary -h, --help Show this help message and exit -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) 65.49. server start Start server(s) Usage: Table 65.158. Positional arguments Value Summary <server> Server(s) to start (name or id) Table 65.159. Command arguments Value Summary -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) 65.50. server stop Stop server(s) Usage: Table 65.160. Positional arguments Value Summary <server> Server(s) to stop (name or id) Table 65.161. Command arguments Value Summary -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) 65.51. server suspend Suspend server(s) Usage: Table 65.162. Positional arguments Value Summary <server> Server(s) to suspend (name or id) Table 65.163. Command arguments Value Summary -h, --help Show this help message and exit 65.52. server unlock Unlock server(s) Usage: Table 65.164. Positional arguments Value Summary <server> Server(s) to unlock (name or id) Table 65.165. Command arguments Value Summary -h, --help Show this help message and exit 65.53. server unpause Unpause server(s) Usage: Table 65.166. Positional arguments Value Summary <server> Server(s) to unpause (name or id) Table 65.167. Command arguments Value Summary -h, --help Show this help message and exit 65.54. server unrescue Restore server from rescue mode Usage: Table 65.168. Positional arguments Value Summary <server> Server (name or id) Table 65.169. Command arguments Value Summary -h, --help Show this help message and exit 65.55. server unset Unset server properties and tags Usage: Table 65.170. Positional arguments Value Summary <server> Server (name or id) Table 65.171. Command arguments Value Summary -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) 65.56. server unshelve Unshelve server(s) Usage: Table 65.172. Positional arguments Value Summary <server> Server(s) to unshelve (name or id) Table 65.173. Command arguments Value Summary -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) --no-availability-zone Unpin the availability zone of a shelved_offloaded server. Server will be unshelved on a host without availability zone constraint (supported by --os- compute-api-version 2.91 or above) --host HOST Name of the destination host in which to unshelve a SHELVED_OFFLOADED server (supported by --os-compute- api-version 2.91 or above) --wait Wait for unshelve operation to complete 65.57. server volume list List all the volumes attached to a server. Usage: Table 65.174. Positional arguments Value Summary server Server to list volume attachments for (name or id) Table 65.175. Command arguments Value Summary -h, --help Show this help message and exit Table 65.176. Output formatter options Value Summary -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 65.177. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 65.178. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 65.179. Table formatter options Value Summary --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. 65.58. server volume set Update a volume attachment on the server. Usage: Table 65.180. Positional arguments Value Summary server Server to update volume for (name or id) volume Volume to update attachment for (name or id) Table 65.181. Command arguments Value Summary -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) 65.59. server volume update DEPRECATED: Use server volume set instead. Usage: Table 65.182. Positional arguments Value Summary server Server to update volume for (name or id) volume Volume to update attachment for (name or id) Table 65.183. Command arguments Value Summary -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)

Commands:
openstack server add fixed ip [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fixed-ip-address <ip-address>] [--tag <tag>] <server> <network>
openstack server add floating ip [-h] [--fixed-ip-address <ip-address>] <server> <ip-address>
openstack server add network [-h] [--tag <tag>] <server> <network>
openstack server add port [-h] [--tag <tag>] <server> <port>
openstack server add security group [-h] <server> <group>
openstack server add volume [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--device <device>] [--tag <tag>] [--enable-delete-on-termination | --disable-delete-on-termination] <server> <volume>
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>
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>] [--no-network] [--auto-network] [--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>] [--hostname <hostname>] [--wait] [--trusted-image-cert <trusted-cert-id>] <server-name>
openstack server delete [-h] [--force] [--all-projects] [--wait] <server> [<server> ...]
openstack server dump create [-h] <server> [<server> ...]
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>
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>
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>
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>
openstack server group delete [-h] <server-group> [<server-group> ...]
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>]
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>
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>
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>]
openstack server lock [-h] [--reason <reason>] <server> [<server> ...]
openstack server migrate confirm [-h] <server>
openstack server migrate revert [-h] <server>
openstack server migrate [-h] [--live-migration] [--host <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
openstack server migration abort [-h] <server> <migration>
openstack server migration confirm [-h] <server>
openstack server migration force complete [-h] <server> <migration>
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>]
openstack server migration revert [-h] <server>
openstack server migration show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <server> <migration>
openstack server pause [-h] <server> [<server> ...]
openstack server reboot [-h] [--hard | --soft] [--wait] <server>
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] [--hostname <hostname>] [--reimage-boot-volume] [--no-reimage-boot-volume] [--wait] <server>
openstack server remove fixed ip [-h] <server> <ip-address>
openstack server remove floating ip [-h] <server> <ip-address>
openstack server remove network [-h] <server> <network>
openstack server remove port [-h] <server> <port>
openstack server remove security group [-h] <server> <group>
openstack server remove volume [-h] <server> <volume>
openstack server rescue [-h] [--image <image>] [--password <password>] <server>
openstack server resize confirm [-h] <server>
openstack server resize revert [-h] <server>
openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
openstack server restore [-h] <server> [<server> ...]
openstack server resume [-h] <server> [<server> ...]
openstack server set [-h] [--name <new-name>] [--password PASSWORD | --no-password] [--property <key=value>] [--state <state>] [--description <description>] [--tag <tag>] [--hostname <hostname>] <server>
openstack server shelve [-h] [--offload] [--wait] <server> [<server> ...]
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>
openstack server ssh [-h] [-4 | -6] [--public | --private | --address-type <address-type>] <server> [-- <standard ssh args> ...]
openstack server start [-h] [--all-projects] <server> [<server> ...]
openstack server stop [-h] [--all-projects] <server> [<server> ...]
openstack server suspend [-h] <server> [<server> ...]
openstack server unlock [-h] <server> [<server> ...]
openstack server unpause [-h] <server> [<server> ...]
openstack server unrescue [-h] <server>
openstack server unset [-h] [--property <key>] [--description] [--tag <tag>] <server>
openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE | --no-availability-zone] [--host HOST] [--wait] <server> [<server> ...]
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
openstack server volume set [-h] [--delete-on-termination | --preserve-on-termination] server volume
openstack server volume update [-h] [--delete-on-termination | --preserve-on-termination] server volume