Chapter 61. server
This chapter describes the commands under the server
command.
61.1. server add fixed ip Copy linkLink copied to clipboard!
Usage:
openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>] <server> <network>
openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
<server> <network>
Add fixed IP address to server
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) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--fixed-ip-address <ip-address> | Requested fixed IP address |
61.2. server add floating ip Copy linkLink copied to clipboard!
Usage:
openstack server add floating ip [-h] [--fixed-ip-address <ip-address>] <server> <ip-address>
openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
<server> <ip-address>
Add floating IP address to server
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) |
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 |
61.3. server add network Copy linkLink copied to clipboard!
Usage:
openstack server add network [-h] <server> <network>
openstack server add network [-h] <server> <network>
Add network to server
Value | Summary |
---|---|
<server> | Server to add the network to (name or id) |
<network> | Network to add to the server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.4. server add port Copy linkLink copied to clipboard!
Usage:
openstack server add port [-h] <server> <port>
openstack server add port [-h] <server> <port>
Add port to server
Value | Summary |
---|---|
<server> | Server to add the port to (name or id) |
<port> | Port to add to the server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.5. server add security group Copy linkLink copied to clipboard!
Usage:
openstack server add security group [-h] <server> <group>
openstack server add security group [-h] <server> <group>
Add security group to server
Value | Summary |
---|---|
<server> | Server (name or id) |
<group> | Security group to add (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.6. server add volume Copy linkLink copied to clipboard!
Usage:
openstack server add volume [-h] [--device <device>] <server> <volume>
openstack server add volume [-h] [--device <device>] <server> <volume>
Add volume to server
Value | Summary |
---|---|
<server> | Server (name or id) |
<volume> | Volume to add (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--device <device> | Server internal device name for volume |
61.7. server backup create Copy linkLink copied to clipboard!
Usage:
Create a server backup image
Value | Summary |
---|---|
<server> | Server to back up (name or id) |
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.8. server create Copy linkLink copied to clipboard!
Usage:
Create a new server
Value | Summary |
---|---|
<server-name> | New server name |
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 |
--availability-zone <zone-name> | Select an availability zone for the server |
--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>: UUID of the volume or snapshot (required) | |
<type>: volume or snapshot; default: volume (optional) | |
<size(GB)>: volume size if create from 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=<pord>' 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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.9. server delete Copy linkLink copied to clipboard!
Usage:
openstack server delete [-h] [--wait] <server> [<server> ...]
openstack server delete [-h] [--wait] <server> [<server> ...]
Delete server(s)
Value | Summary |
---|---|
<server> | Server(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--wait | Wait for delete to complete |
61.10. server dump create Copy linkLink copied to clipboard!
Usage:
openstack server dump create [-h] <server> [<server> ...]
openstack server dump create [-h] <server> [<server> ...]
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.
Value | Summary |
---|---|
<server> | Server(s) to create dump file (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.11. server event list Copy linkLink copied to clipboard!
Usage:
List recent events of a server
Value | Summary |
---|---|
<server> | Server to list events (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
61.12. server event show Copy linkLink copied to clipboard!
Usage:
Show server event details
Value | Summary |
---|---|
<server> | Server to show event details (name or id) |
<request-id> | Request id of the event to show (id only) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.13. server group create Copy linkLink copied to clipboard!
Usage:
Create a new server group.
Value | Summary |
---|---|
<name> | New server group name |
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. |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.14. server group delete Copy linkLink copied to clipboard!
Usage:
openstack server group delete [-h] <server-group> [<server-group> ...]
openstack server group delete [-h] <server-group> [<server-group> ...]
Delete existing server group(s).
Value | Summary |
---|---|
<server-group> | Server group(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.15. server group list Copy linkLink copied to clipboard!
Usage:
List all server groups.
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
61.16. server group show Copy linkLink copied to clipboard!
Usage:
Display server group details.
Value | Summary |
---|---|
<server-group> | Server group to display (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.17. server image create Copy linkLink copied to clipboard!
Usage:
Create a new server disk image from an existing server
Value | Summary |
---|---|
<server> | Server to create image (name or id) |
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.18. server list Copy linkLink copied to clipboard!
Usage:
List servers
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 |
--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. |
--marker <server> | The last server of the previous 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-since <changes-since> | List only servers changed after a certain point of time. The provided time should be an ISO 8061 formatted time. ex 2016-03-04T06:27:59Z . |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | when to include quotes, defaults to nonnumeric |
61.19. server lock Copy linkLink copied to clipboard!
Usage:
openstack server lock [-h] <server> [<server> ...]
openstack server lock [-h] <server> [<server> ...]
Lock server(s). A non-admin user will not be able to execute actions
Value | Summary |
---|---|
<server> | Server(s) to lock (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.20. server migrate Copy linkLink copied to clipboard!
Usage:
Migrate server to different host
Value | Summary |
---|---|
<server> | Server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--live <hostname> | Target hostname |
--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 |
61.21. server pause Copy linkLink copied to clipboard!
Usage:
openstack server pause [-h] <server> [<server> ...]
openstack server pause [-h] <server> [<server> ...]
Pause server(s)
Value | Summary |
---|---|
<server> | Server(s) to pause (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.22. server reboot Copy linkLink copied to clipboard!
Usage:
openstack server reboot [-h] [--hard | --soft] [--wait] <server>
openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Perform a hard or soft server reboot
Value | Summary |
---|---|
<server> | Server (name or id) |
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 |
61.23. server rebuild Copy linkLink copied to clipboard!
Usage:
Rebuild server
Value | Summary |
---|---|
<server> | Server (name or id) |
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 |
--wait | Wait for rebuild to complete |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.24. server remove fixed ip Copy linkLink copied to clipboard!
Usage:
openstack server remove fixed ip [-h] <server> <ip-address>
openstack server remove fixed ip [-h] <server> <ip-address>
Remove fixed IP address from server
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) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.25. server remove floating ip Copy linkLink copied to clipboard!
Usage:
openstack server remove floating ip [-h] <server> <ip-address>
openstack server remove floating ip [-h] <server> <ip-address>
Remove floating IP address from server
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) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.26. server remove network Copy linkLink copied to clipboard!
Usage:
openstack server remove network [-h] <server> <network>
openstack server remove network [-h] <server> <network>
Remove all ports of a network from server
Value | Summary |
---|---|
<server> | Server to remove the port from (name or id) |
<network> | Network to remove from the server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.27. server remove port Copy linkLink copied to clipboard!
Usage:
openstack server remove port [-h] <server> <port>
openstack server remove port [-h] <server> <port>
Remove port from server
Value | Summary |
---|---|
<server> | Server to remove the port from (name or id) |
<port> | Port to remove from the server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.28. server remove security group Copy linkLink copied to clipboard!
Usage:
openstack server remove security group [-h] <server> <group>
openstack server remove security group [-h] <server> <group>
Remove security group from server
Value | Summary |
---|---|
<server> | Name or id of server to use |
<group> | Name or id of security group to remove from server |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.29. server remove volume Copy linkLink copied to clipboard!
Usage:
openstack server remove volume [-h] <server> <volume>
openstack server remove volume [-h] <server> <volume>
Remove volume from server
Value | Summary |
---|---|
<server> | Server (name or id) |
<volume> | Volume to remove (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.30. server rescue Copy linkLink copied to clipboard!
Usage:
openstack server rescue [-h] [--image <image>] [--password <password>] <server>
openstack server rescue [-h] [--image <image>] [--password <password>]
<server>
Put server in rescue mode
Value | Summary |
---|---|
<server> | Server (name or id) |
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 |
61.31. server resize Copy linkLink copied to clipboard!
Usage:
openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
[--wait]
<server>
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.
Value | Summary |
---|---|
<server> | Server (name or id) |
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 |
61.32. server restore Copy linkLink copied to clipboard!
Usage:
openstack server restore [-h] <server> [<server> ...]
openstack server restore [-h] <server> [<server> ...]
Restore server(s)
Value | Summary |
---|---|
<server> | Server(s) to restore (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.33. server resume Copy linkLink copied to clipboard!
Usage:
openstack server resume [-h] <server> [<server> ...]
openstack server resume [-h] <server> [<server> ...]
Resume server(s)
Value | Summary |
---|---|
<server> | Server(s) to resume (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.34. server set Copy linkLink copied to clipboard!
Usage:
openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] [--state <state>] <server>
openstack server set [-h] [--name <new-name>] [--root-password]
[--property <key=value>] [--state <state>]
<server>
Set server properties
Value | Summary |
---|---|
<server> | Server (name or id) |
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) |
61.35. server shelve Copy linkLink copied to clipboard!
Usage:
openstack server shelve [-h] <server> [<server> ...]
openstack server shelve [-h] <server> [<server> ...]
Shelve server(s)
Value | Summary |
---|---|
<server> | Server(s) to shelve (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.36. server show Copy linkLink copied to clipboard!
Usage:
Show server details. Specify --os-compute-api-version 2.47
or higher to see the embedded flavor information for the server.
Value | Summary |
---|---|
<server> | Server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--diagnostics | Display server diagnostics information |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
61.37. server ssh Copy linkLink copied to clipboard!
Usage:
SSH to server
Value | Summary |
---|---|
<server> | Server (name or id) |
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) |
61.38. server start Copy linkLink copied to clipboard!
Usage:
openstack server start [-h] <server> [<server> ...]
openstack server start [-h] <server> [<server> ...]
Start server(s).
Value | Summary |
---|---|
<server> | Server(s) to start (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.39. server stop Copy linkLink copied to clipboard!
Usage:
openstack server stop [-h] <server> [<server> ...]
openstack server stop [-h] <server> [<server> ...]
Stop server(s).
Value | Summary |
---|---|
<server> | Server(s) to stop (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.40. server suspend Copy linkLink copied to clipboard!
Usage:
openstack server suspend [-h] <server> [<server> ...]
openstack server suspend [-h] <server> [<server> ...]
Suspend server(s)
Value | Summary |
---|---|
<server> | Server(s) to suspend (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.41. server unlock Copy linkLink copied to clipboard!
Usage:
openstack server unlock [-h] <server> [<server> ...]
openstack server unlock [-h] <server> [<server> ...]
Unlock server(s)
Value | Summary |
---|---|
<server> | Server(s) to unlock (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.42. server unpause Copy linkLink copied to clipboard!
Usage:
openstack server unpause [-h] <server> [<server> ...]
openstack server unpause [-h] <server> [<server> ...]
Unpause server(s)
Value | Summary |
---|---|
<server> | Server(s) to unpause (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.43. server unrescue Copy linkLink copied to clipboard!
Usage:
openstack server unrescue [-h] <server>
openstack server unrescue [-h] <server>
Restore server from rescue mode
Value | Summary |
---|---|
<server> | Server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
61.44. server unset Copy linkLink copied to clipboard!
Usage:
openstack server unset [-h] [--property <key>] <server>
openstack server unset [-h] [--property <key>] <server>
Unset server properties
Value | Summary |
---|---|
<server> | Server (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property key to remove from server (repeat option to remove multiple values) |
61.45. server unshelve Copy linkLink copied to clipboard!
Usage:
openstack server unshelve [-h] <server> [<server> ...]
openstack server unshelve [-h] <server> [<server> ...]
Unshelve server(s)
Value | Summary |
---|---|
<server> | Server(s) to unshelve (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |