Chapter 72. server
Chapter 72. server This chapter describes the commands under the server command. 72.1. server add fixed ip Add fixed IP address to server Usage: Table 72.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 72.2. Optional Arguments Value Summary -h, --help Show this help message and exit --fixed-ip-address <ip-address> Requested fixed ip address 72.2. server add floating ip Add floating IP address to server Usage: Table 72.3. 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 72.4. Optional 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 72.3. server add network Add network to server Usage: Table 72.5. 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 72.6. Optional Arguments Value Summary -h, --help Show this help message and exit 72.4. server add port Add port to server Usage: Table 72.7. 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 72.8. Optional Arguments Value Summary -h, --help Show this help message and exit 72.5. server add security group Add security group to server Usage: Table 72.9. Positional Arguments Value Summary <server> Server (name or id) <group> Security group to add (name or id) Table 72.10. Optional Arguments Value Summary -h, --help Show this help message and exit 72.6. server add volume Add volume to server. Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``. Usage: Table 72.11. Positional Arguments Value Summary <server> Server (name or id) <volume> Volume to add (name or id) Table 72.12. Optional Arguments Value Summary -h, --help Show this help message and exit --device <device> Server internal device name for volume 72.7. server backup create Create a server backup image Usage: Table 72.13. Positional Arguments Value Summary <server> Server to back up (name or id) Table 72.14. Optional 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 72.15. Output Formatters 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 Table 72.16. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.17. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.18. Table Formatter 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. 72.8. server create Create a new server Usage: Table 72.19. Positional Arguments Value Summary <server-name> New server name Table 72.20. Optional Arguments Value Summary -h, --help Show this help message and exit --image <image> Create server boot disk from this image (name or id) --image-property <key=value> Image property to be matched --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. --flavor <flavor> Create server with this flavor (name or id) --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 (optional extension) --property <key=value> Set a property on this server (repeat option to set multiple values) --file <dest-filename=source-filename> File to inject into image before boot (repeat option to set multiple files) --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 <host> Requested host to create servers. admin only by default. (supported by --os-compute-api-version 2.74 or above) --hypervisor-hostname <hypervisor-hostname> Requested hypervisor hostname to create servers. admin only by default. (supported by --os-compute-api- version 2.74 or above) --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`` option. --block-device-mapping <dev-name=mapping> 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) (optional extension) --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none> Create a nic on the server. specify option multiple times to create multiple NICs. Either net-id or port- id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional), none: (v2.37+) no network is attached, auto: (v2.37+) the compute service will automatically allocate a network. Specifying a --nic of auto or none cannot be used with any other --nic value. --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. --hint <key=value> Hints for the scheduler (optional extension) --config-drive <config-drive-volume> True Use specified volume as the config drive, or true to use an ephemeral drive --min <count> Minimum number of servers to launch (default=1) --max <count> Maximum number of servers to launch (default=1) --wait Table 72.21. Output Formatters 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 Table 72.22. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.23. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.24. Table Formatter 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. 72.9. server delete Delete server(s) Usage: Table 72.25. Positional Arguments Value Summary <server> Server(s) to delete (name or id) Table 72.26. Optional Arguments Value Summary -h, --help Show this help message and exit --wait Wait for delete to complete 72.10. server dump create Create a dump file in server(s) Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)' memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource. This command requires ``--os-compute-api- version`` 2.17 or greater. Usage: Table 72.27. Positional Arguments Value Summary <server> Server(s) to create dump file (name or id) Table 72.28. Optional Arguments Value Summary -h, --help Show this help message and exit 72.11. 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. Usage: Table 72.29. Positional Arguments Value Summary <server> Server to list events (name or id) Table 72.30. Optional Arguments Value Summary -h, --help Show this help message and exit --long List additional fields in output Table 72.31. Output Formatters 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 --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 Table 72.32. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 72.33. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.34. Table Formatter 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. 72.12. server event show Show server event details. Specify ``--os-compute-api-version 2.21`` or higher to show event details for a deleted server. Specify ``--os-compute-api-version 2.51`` or higher to show event details for non-admin users. Usage: Table 72.35. 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 72.36. Optional Arguments Value Summary -h, --help Show this help message and exit Table 72.37. Output Formatters 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 Table 72.38. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.39. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.40. Table Formatter 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. 72.13. server group create Create a new server group. Usage: Table 72.41. Positional Arguments Value Summary <name> New server group name Table 72.42. Optional Arguments Value Summary -h, --help Show this help message and exit --policy <policy> Add a policy to <name> ( affinity or anti-affinity , defaults to affinity ). Specify --os-compute-api- version 2.15 or higher for the soft-affinity or soft-anti-affinity policy. Table 72.43. Output Formatters 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 Table 72.44. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.45. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.46. Table Formatter 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. 72.14. server group delete Delete existing server group(s). Usage: Table 72.47. Positional Arguments Value Summary <server-group> Server group(s) to delete (name or id) Table 72.48. Optional Arguments Value Summary -h, --help Show this help message and exit 72.15. server group list List all server groups. Usage: Table 72.49. Optional 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 Table 72.50. Output Formatters 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 --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 Table 72.51. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 72.52. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.53. Table Formatter 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. 72.16. server group show Display server group details. Usage: Table 72.54. Positional Arguments Value Summary <server-group> Server group to display (name or id) Table 72.55. Optional Arguments Value Summary -h, --help Show this help message and exit Table 72.56. Output Formatters 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 Table 72.57. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.58. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.59. Table Formatter 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. 72.17. server image create Create a new server disk image from an existing server Usage: Table 72.60. Positional Arguments Value Summary <server> Server to create image (name or id) Table 72.61. Optional Arguments Value Summary -h, --help Show this help message and exit --name <image-name> Name of new disk image (default: server name) --wait Wait for operation to complete Table 72.62. Output Formatters 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 Table 72.63. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.64. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.65. Table Formatter 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. 72.18. server list List servers Usage: Table 72.66. Optional 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) --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 (admin only) (name or id) --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. --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. (name or ID) --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. --deleted Only display deleted servers (admin only). --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 API versions 2.66 - 2.latest ) --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. requires ``--os-compute- api-version`` 2.73 or greater. --unlocked Table 72.67. Output Formatters 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 --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 Table 72.68. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 72.69. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.70. Table Formatter 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. 72.19. server lock Lock server(s). A non-admin user will not be able to execute actions Usage: Table 72.71. Positional Arguments Value Summary <server> Server(s) to lock (name or id) Table 72.72. Optional 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. 72.20. server migrate Migrate server to different host Usage: Table 72.73. Positional Arguments Value Summary <server> Server (name or id) Table 72.74. Optional 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. --live <hostname> deprecated this option is problematic in that it requires a host and prior to compute API version 2.30, specifying a host during live migration will bypass validation by the scheduler which could result in failures to actually migrate the server to the specified host or over-subscribe the host. Use the ``--live-migration`` option instead. If both this option and ``--live-migration`` are used, ``--live- migration`` takes priority. --host <hostname> Migrate the server to the specified host. requires ``--os-compute-api-version`` 2.30 or greater when used with the ``--live-migration`` option, otherwise requires ``--os-compute-api-version`` 2.56 or greater. --shared-migration Perform a shared live migration (default) --block-migration Perform a block live migration --disk-overcommit Allow disk over-commit on the destination host --no-disk-overcommit Do not over-commit disk on the destination host (default) --wait Wait for migrate to complete 72.21. server pause Pause server(s) Usage: Table 72.75. Positional Arguments Value Summary <server> Server(s) to pause (name or id) Table 72.76. Optional Arguments Value Summary -h, --help Show this help message and exit 72.22. server reboot Perform a hard or soft server reboot Usage: Table 72.77. Positional Arguments Value Summary <server> Server (name or id) Table 72.78. Optional 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 72.23. server rebuild Rebuild server Usage: Table 72.79. Positional Arguments Value Summary <server> Server (name or id) Table 72.80. Optional 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. --password <password> Set the password on the rebuilt instance --property <key=value> Set a property on the rebuilt instance (repeat option to set multiple values) --description <description> New description for the server (supported by --os- compute-api-version 2.19 or above --wait Wait for rebuild to complete --key-name <key-name> Set the key name of key pair on the rebuilt instance. Cannot be specified with the --key-unset option. (Supported by API versions 2.54 - 2.latest ) --key-unset Unset the key name of key pair on the rebuilt instance. Cannot be specified with the --key-name option. (Supported by API versions 2.54 - 2.latest ) Table 72.81. Output Formatters 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 Table 72.82. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.83. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.84. Table Formatter 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. 72.24. server remove fixed ip Remove fixed IP address from server Usage: Table 72.85. 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 72.86. Optional Arguments Value Summary -h, --help Show this help message and exit 72.25. server remove floating ip Remove floating IP address from server Usage: Table 72.87. 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 72.88. Optional Arguments Value Summary -h, --help Show this help message and exit 72.26. server remove network Remove all ports of a network from server Usage: Table 72.89. 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 72.90. Optional Arguments Value Summary -h, --help Show this help message and exit 72.27. server remove port Remove port from server Usage: Table 72.91. 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 72.92. Optional Arguments Value Summary -h, --help Show this help message and exit 72.28. server remove security group Remove security group from server Usage: Table 72.93. Positional Arguments Value Summary <server> Name or id of server to use <group> Name or id of security group to remove from server Table 72.94. Optional Arguments Value Summary -h, --help Show this help message and exit 72.29. 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 72.95. Positional Arguments Value Summary <server> Server (name or id) <volume> Volume to remove (name or id) Table 72.96. Optional Arguments Value Summary -h, --help Show this help message and exit 72.30. server rescue Put server in rescue mode Usage: Table 72.97. Positional Arguments Value Summary <server> Server (name or id) Table 72.98. Optional 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 72.31. server resize confirm Confirm server resize. Confirm (verify) success of resize operation and release the old server. Usage: Table 72.99. Positional Arguments Value Summary <server> Server (name or id) Table 72.100. Optional Arguments Value Summary -h, --help Show this help message and exit 72.32. server resize revert Revert server resize. Revert the resize operation. Release the new server and restart the old one. Usage: Table 72.101. Positional Arguments Value Summary <server> Server (name or id) Table 72.102. Optional Arguments Value Summary -h, --help Show this help message and exit 72.33. 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 also a two-step process for the user: the first is to perform the resize, the second 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 72.103. Positional Arguments Value Summary <server> Server (name or id) Table 72.104. Optional Arguments Value Summary -h, --help Show this help message and exit --flavor <flavor> Resize server to specified flavor --confirm Confirm server resize is complete --revert Restore server state before resize --wait Wait for resize to complete 72.34. server restore Restore server(s) Usage: Table 72.105. Positional Arguments Value Summary <server> Server(s) to restore (name or id) Table 72.106. Optional Arguments Value Summary -h, --help Show this help message and exit 72.35. server resume Resume server(s) Usage: Table 72.107. Positional Arguments Value Summary <server> Server(s) to resume (name or id) Table 72.108. Optional Arguments Value Summary -h, --help Show this help message and exit 72.36. server set Set server properties Usage: Table 72.109. Positional Arguments Value Summary <server> Server (name or id) Table 72.110. Optional Arguments Value Summary -h, --help Show this help message and exit --name <new-name> New server name --root-password Set new root password (interactive only) --property <key=value> Property to add/change for this server (repeat option to set multiple properties) --state <state> New server state (valid value: active, error) --description <description> New server description (supported by --os-compute-api- version 2.19 or above) 72.37. server shelve Shelve server(s) Usage: Table 72.111. Positional Arguments Value Summary <server> Server(s) to shelve (name or id) Table 72.112. Optional Arguments Value Summary -h, --help Show this help message and exit 72.38. 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 72.113. Positional Arguments Value Summary <server> Server (name or id) Table 72.114. Optional Arguments Value Summary -h, --help Show this help message and exit --diagnostics Display server diagnostics information Table 72.115. Output Formatters 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 Table 72.116. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 72.117. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 72.118. Table Formatter 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. 72.39. server ssh SSH to server Usage: Table 72.119. Positional Arguments Value Summary <server> Server (name or id) Table 72.120. Optional Arguments Value Summary -h, --help Show this help message and exit --login <login-name> Login name (ssh -l option) --port <port> Destination port (ssh -p option) --identity <keyfile> Private key file (ssh -i option) --option <config-options> Options in ssh_config(5) format (ssh -o option) -4 Use only ipv4 addresses -6 Use only ipv6 addresses --public Use public ip address --private Use private ip address --address-type <address-type> Use other ip address (public, private, etc) 72.40. server start Start server(s). Usage: Table 72.121. Positional Arguments Value Summary <server> Server(s) to start (name or id) Table 72.122. Optional Arguments Value Summary -h, --help Show this help message and exit 72.41. server stop Stop server(s). Usage: Table 72.123. Positional Arguments Value Summary <server> Server(s) to stop (name or id) Table 72.124. Optional Arguments Value Summary -h, --help Show this help message and exit 72.42. server suspend Suspend server(s) Usage: Table 72.125. Positional Arguments Value Summary <server> Server(s) to suspend (name or id) Table 72.126. Optional Arguments Value Summary -h, --help Show this help message and exit 72.43. server unlock Unlock server(s) Usage: Table 72.127. Positional Arguments Value Summary <server> Server(s) to unlock (name or id) Table 72.128. Optional Arguments Value Summary -h, --help Show this help message and exit 72.44. server unpause Unpause server(s) Usage: Table 72.129. Positional Arguments Value Summary <server> Server(s) to unpause (name or id) Table 72.130. Optional Arguments Value Summary -h, --help Show this help message and exit 72.45. server unrescue Restore server from rescue mode Usage: Table 72.131. Positional Arguments Value Summary <server> Server (name or id) Table 72.132. Optional Arguments Value Summary -h, --help Show this help message and exit 72.46. server unset Unset server properties Usage: Table 72.133. Positional Arguments Value Summary <server> Server (name or id) Table 72.134. Optional 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) 72.47. server unshelve Unshelve server(s) Usage: Table 72.135. Positional Arguments Value Summary <server> Server(s) to unshelve (name or id) Table 72.136. Optional 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)
openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>] <server> <network> openstack server add floating ip [-h] [--fixed-ip-address <ip-address>] <server> <ip-address> openstack server add network [-h] <server> <network> openstack server add port [-h] <server> <port> openstack server add security group [-h] <server> <group> openstack server add volume [-h] [--device <device>] <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] (--image <image> | --image-property <key=value> | --volume <volume>) --flavor <flavor> [--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>] [--boot-from-volume <volume-size>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none>] [--network <network>] [--port <port>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name> openstack server delete [-h] [--wait] <server> [<server> ...] openstack server dump create [-h] <server> [<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] [--long] <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>] <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] [--all-projects] [--long] 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>] [--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] [--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>] [--long] [-n | --name-lookup-one-by-one] [--marker <server>] [--limit <num-servers>] [--deleted] [--changes-before <changes-before>] [--changes-since <changes-since>] [--locked | --unlocked] openstack server lock [-h] [--reason <reason>] <server> [<server> ...] openstack server migrate [-h] [--live-migration] [--live <hostname> | --host <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server> 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>] [--password <password>] [--property <key=value>] [--description <description>] [--wait] [--key-name <key-name> | --key-unset] <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>] [--root-password] [--property <key=value>] [--state <state>] [--description <description>] <server> openstack server shelve [-h] <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] <server> openstack server ssh [-h] [--login <login-name>] [--port <port>] [--identity <keyfile>] [--option <config-options>] [-4 | -6] [--public | --private | --address-type <address-type>] <server> openstack server start [-h] <server> [<server> ...] openstack server stop [-h] <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] <server> openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE] <server> [<server> ...]