Chapter 61. server


This chapter describes the commands under the server command.

61.1. server add fixed ip

Usage:

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

                                   <server> <network>
Copy to Clipboard Toggle word wrap

Add fixed IP address to server

Expand
Table 61.1. Positional Arguments
ValueSummary

<server>

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

<network>

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

Expand
Table 61.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

Requested fixed IP address

61.2. server add floating ip

Usage:

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

                                      <server> <ip-address>
Copy to Clipboard Toggle word wrap

Add floating IP address to server

Expand
Table 61.3. Positional Arguments
ValueSummary

<server>

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

<ip-address>

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

Expand
Table 61.4. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

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

61.3. server add network

Usage:

openstack server add network [-h] <server> <network>
Copy to Clipboard Toggle word wrap

Add network to server

Expand
Table 61.5. Positional Arguments
ValueSummary

<server>

Server to add the network to (name or id)

<network>

Network to add to the server (name or id)

Expand
Table 61.6. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.4. server add port

Usage:

openstack server add port [-h] <server> <port>
Copy to Clipboard Toggle word wrap

Add port to server

Expand
Table 61.7. Positional Arguments
ValueSummary

<server>

Server to add the port to (name or id)

<port>

Port to add to the server (name or id)

Expand
Table 61.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.5. server add security group

Usage:

openstack server add security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap

Add security group to server

Expand
Table 61.9. Positional Arguments
ValueSummary

<server>

Server (name or id)

<group>

Security group to add (name or id)

Expand
Table 61.10. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.6. server add volume

Usage:

openstack server add volume [-h] [--device <device>] <server> <volume>
Copy to Clipboard Toggle word wrap

Add volume to server

Expand
Table 61.11. Positional Arguments
ValueSummary

<server>

Server (name or id)

<volume>

Volume to add (name or id)

Expand
Table 61.12. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--device <device>

Server internal device name for volume

61.7. server backup create

Usage:

openstack server backup create [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent] [--prefix PREFIX]
                                    [--name <image-name>]
                                    [--type <backup-type>]
                                    [--rotate <count>] [--wait]
                                    <server>
Copy to Clipboard Toggle word wrap

Create a server backup image

Expand
Table 61.13. Positional Arguments
ValueSummary

<server>

Server to back up (name or id)

Expand
Table 61.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <image-name>

Name of the backup image (default: server name)

--type <backup-type>

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

--rotate <count>

Number of backups to keep (default: 1)

--wait

Wait for backup image create to complete

Expand
Table 61.15. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.16. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.17. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.18. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.8. server create

Usage:

openstack server create [-h] [-f {json,shell,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--prefix PREFIX]
                             (--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>]
                             [--availability-zone <zone-name>]
                             [--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>
Copy to Clipboard Toggle word wrap

Create a new server

Expand
Table 61.19. Positional Arguments
ValueSummary

<server-name>

New server name

Expand
Table 61.20. Optional Arguments
ValueSummary

-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

Expand
Table 61.21. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.22. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.23. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.24. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.9. server delete

Usage:

openstack server delete [-h] [--wait] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Delete server(s)

Expand
Table 61.25. Positional Arguments
ValueSummary

<server>

Server(s) to delete (name or id)

Expand
Table 61.26. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for delete to complete

61.10. server dump create

Usage:

openstack server dump create [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

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.

Expand
Table 61.27. Positional Arguments
ValueSummary

<server>

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

Expand
Table 61.28. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.11. server event list

Usage:

openstack server event list [-h] [-f {csv,json,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN] [--long]
                                 <server>
Copy to Clipboard Toggle word wrap

List recent events of a server

Expand
Table 61.29. Positional Arguments
ValueSummary

<server>

Server to list events (name or id)

Expand
Table 61.30. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 61.31. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

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

Expand
Table 61.32. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.33. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.34. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

61.12. server event show

Usage:

openstack server event show [-h] [-f {json,shell,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <server> <request-id>
Copy to Clipboard Toggle word wrap

Show server event details

Expand
Table 61.35. Positional Arguments
ValueSummary

<server>

Server to show event details (name or id)

<request-id>

Request id of the event to show (id only)

Expand
Table 61.36. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 61.37. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.38. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.39. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.40. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.13. server group create

Usage:

openstack server group create [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent] [--prefix PREFIX]
                                   [--policy <policy>]
                                   <name>
Copy to Clipboard Toggle word wrap

Create a new server group.

Expand
Table 61.41. Positional Arguments
ValueSummary

<name>

New server group name

Expand
Table 61.42. Optional Arguments
ValueSummary

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

Expand
Table 61.43. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.44. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.45. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.46. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.14. server group delete

Usage:

openstack server group delete [-h] <server-group> [<server-group> ...]
Copy to Clipboard Toggle word wrap

Delete existing server group(s).

Expand
Table 61.47. Positional Arguments
ValueSummary

<server-group>

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

Expand
Table 61.48. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.15. server group list

Usage:

openstack server group list [-h] [-f {csv,json,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--all-projects] [--long]
Copy to Clipboard Toggle word wrap

List all server groups.

Expand
Table 61.49. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--all-projects

Display information from all projects (admin only)

--long

List additional fields in output

Expand
Table 61.50. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

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

Expand
Table 61.51. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.52. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.53. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

61.16. server group show

Usage:

openstack server group show [-h] [-f {json,shell,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <server-group>
Copy to Clipboard Toggle word wrap

Display server group details.

Expand
Table 61.54. Positional Arguments
ValueSummary

<server-group>

Server group to display (name or id)

Expand
Table 61.55. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 61.56. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.57. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.58. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.59. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.17. server image create

Usage:

openstack server image create [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent] [--prefix PREFIX]
                                   [--name <image-name>] [--wait]
                                   <server>
Copy to Clipboard Toggle word wrap

Create a new server disk image from an existing server

Expand
Table 61.60. Positional Arguments
ValueSummary

<server>

Server to create image (name or id)

Expand
Table 61.61. Optional Arguments
ValueSummary

-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

Expand
Table 61.62. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.63. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.64. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.65. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.18. server list

Usage:

openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--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] [--marker <server>]
                           [--limit <num-servers>] [--deleted]
                           [--changes-since <changes-since>]
Copy to Clipboard Toggle word wrap

List servers

Expand
Table 61.66. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--reservation-id <reservation-id>

Only return instances that match the reservation

--ip <ip-address-regex>

Regular expression to match IP addresses

--ip6 <ip-address-regex>

Regular expression to match IPv6 addresses

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

Expand
Table 61.67. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

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

Expand
Table 61.68. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.69. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.70. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

61.19. server lock

Usage:

openstack server lock [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

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

Expand
Table 61.71. Positional Arguments
ValueSummary

<server>

Server(s) to lock (name or id)

Expand
Table 61.72. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.20. server migrate

Usage:

openstack server migrate [-h] [--live <hostname>]

                              [--shared-migration | --block-migration]
                              [--disk-overcommit | --no-disk-overcommit]
                              [--wait]
                              <server>
Copy to Clipboard Toggle word wrap

Migrate server to different host

Expand
Table 61.73. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.74. Optional Arguments
ValueSummary

-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

Usage:

openstack server pause [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Pause server(s)

Expand
Table 61.75. Positional Arguments
ValueSummary

<server>

Server(s) to pause (name or id)

Expand
Table 61.76. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.22. server reboot

Usage:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Copy to Clipboard Toggle word wrap

Perform a hard or soft server reboot

Expand
Table 61.77. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.78. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--hard

Perform a hard reboot

--soft

Perform a soft reboot

--wait

Wait for reboot to complete

61.23. server rebuild

Usage:

openstack server rebuild [-h] [-f {json,shell,table,value,yaml}]

                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--image <image>]
                              [--password <password>] [--wait]
                              <server>
Copy to Clipboard Toggle word wrap

Rebuild server

Expand
Table 61.79. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.80. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--image <image>

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

--password <password>

Set the password on the rebuilt instance

--wait

Wait for rebuild to complete

Expand
Table 61.81. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.82. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.83. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.84. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.24. server remove fixed ip

Usage:

openstack server remove fixed ip [-h] <server> <ip-address>
Copy to Clipboard Toggle word wrap

Remove fixed IP address from server

Expand
Table 61.85. Positional Arguments
ValueSummary

<server>

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

<ip-address>

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

Expand
Table 61.86. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.25. server remove floating ip

Usage:

openstack server remove floating ip [-h] <server> <ip-address>
Copy to Clipboard Toggle word wrap

Remove floating IP address from server

Expand
Table 61.87. Positional Arguments
ValueSummary

<server>

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

<ip-address>

Floating ip address to remove from server (ip only)

Expand
Table 61.88. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.26. server remove network

Usage:

openstack server remove network [-h] <server> <network>
Copy to Clipboard Toggle word wrap

Remove all ports of a network from server

Expand
Table 61.89. Positional Arguments
ValueSummary

<server>

Server to remove the port from (name or id)

<network>

Network to remove from the server (name or id)

Expand
Table 61.90. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.27. server remove port

Usage:

openstack server remove port [-h] <server> <port>
Copy to Clipboard Toggle word wrap

Remove port from server

Expand
Table 61.91. Positional Arguments
ValueSummary

<server>

Server to remove the port from (name or id)

<port>

Port to remove from the server (name or id)

Expand
Table 61.92. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.28. server remove security group

Usage:

openstack server remove security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap

Remove security group from server

Expand
Table 61.93. Positional Arguments
ValueSummary

<server>

Name or id of server to use

<group>

Name or id of security group to remove from server

Expand
Table 61.94. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.29. server remove volume

Usage:

openstack server remove volume [-h] <server> <volume>
Copy to Clipboard Toggle word wrap

Remove volume from server

Expand
Table 61.95. Positional Arguments
ValueSummary

<server>

Server (name or id)

<volume>

Volume to remove (name or id)

Expand
Table 61.96. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.30. server rescue

Usage:

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

                             <server>
Copy to Clipboard Toggle word wrap

Put server in rescue mode

Expand
Table 61.97. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.98. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--image <image>

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

--password <password>

Set the password on the rescued instance

61.31. server resize

Usage:

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

                             [--wait]
                             <server>
Copy to Clipboard Toggle word wrap

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.

Expand
Table 61.99. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.100. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--flavor <flavor>

Resize server to specified flavor

--confirm

Confirm server resize is complete

--revert

Restore server state before resize

--wait

Wait for resize to complete

61.32. server restore

Usage:

openstack server restore [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Restore server(s)

Expand
Table 61.101. Positional Arguments
ValueSummary

<server>

Server(s) to restore (name or id)

Expand
Table 61.102. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.33. server resume

Usage:

openstack server resume [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Resume server(s)

Expand
Table 61.103. Positional Arguments
ValueSummary

<server>

Server(s) to resume (name or id)

Expand
Table 61.104. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.34. server set

Usage:

openstack server set [-h] [--name <new-name>] [--root-password]

                          [--property <key=value>] [--state <state>]
                          <server>
Copy to Clipboard Toggle word wrap

Set server properties

Expand
Table 61.105. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.106. Optional Arguments
ValueSummary

-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

Usage:

openstack server shelve [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Shelve server(s)

Expand
Table 61.107. Positional Arguments
ValueSummary

<server>

Server(s) to shelve (name or id)

Expand
Table 61.108. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.36. server show

Usage:

openstack server show [-h] [-f {json,shell,table,value,yaml}]

                           [-c COLUMN] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           [--diagnostics]
                           <server>
Copy to Clipboard Toggle word wrap

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

Expand
Table 61.109. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.110. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--diagnostics

Display server diagnostics information

Expand
Table 61.111. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 61.112. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 61.113. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 61.114. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

61.37. server ssh

Usage:

openstack server ssh [-h] [--login <login-name>] [--port <port>]

                          [--identity <keyfile>] [--option <config-options>]
                          [-4 | -6]
                          [--public | --private | --address-type <address-type>]
                          <server>
Copy to Clipboard Toggle word wrap

SSH to server

Expand
Table 61.115. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.116. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--login <login-name>

Login name (ssh -l option)

--port <port>

Destination port (ssh -p option)

--identity <keyfile>

Private key file (ssh -i option)

--option <config-options>

Options in ssh_config(5) format (ssh -o option)

-4

Use only ipv4 addresses

-6

Use only ipv6 addresses

--public

Use public ip address

--private

Use private ip address

--address-type <address-type>

Use other IP address (public, private, etc)

61.38. server start

Usage:

openstack server start [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Start server(s).

Expand
Table 61.117. Positional Arguments
ValueSummary

<server>

Server(s) to start (name or id)

Expand
Table 61.118. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.39. server stop

Usage:

openstack server stop [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Stop server(s).

Expand
Table 61.119. Positional Arguments
ValueSummary

<server>

Server(s) to stop (name or id)

Expand
Table 61.120. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.40. server suspend

Usage:

openstack server suspend [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Suspend server(s)

Expand
Table 61.121. Positional Arguments
ValueSummary

<server>

Server(s) to suspend (name or id)

Expand
Table 61.122. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.41. server unlock

Usage:

openstack server unlock [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Unlock server(s)

Expand
Table 61.123. Positional Arguments
ValueSummary

<server>

Server(s) to unlock (name or id)

Expand
Table 61.124. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.42. server unpause

Usage:

openstack server unpause [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Unpause server(s)

Expand
Table 61.125. Positional Arguments
ValueSummary

<server>

Server(s) to unpause (name or id)

Expand
Table 61.126. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.43. server unrescue

Usage:

openstack server unrescue [-h] <server>
Copy to Clipboard Toggle word wrap

Restore server from rescue mode

Expand
Table 61.127. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.128. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

61.44. server unset

Usage:

openstack server unset [-h] [--property <key>] <server>
Copy to Clipboard Toggle word wrap

Unset server properties

Expand
Table 61.129. Positional Arguments
ValueSummary

<server>

Server (name or id)

Expand
Table 61.130. Optional Arguments
ValueSummary

-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

Usage:

openstack server unshelve [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap

Unshelve server(s)

Expand
Table 61.131. Positional Arguments
ValueSummary

<server>

Server(s) to unshelve (name or id)

Expand
Table 61.132. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat