Chapter 57. server

This chapter describes the commands under the server command.

57.1. server add fixed ip

Add fixed IP address to server

Usage:

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

Table 57.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)

Table 57.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Requested fixed ip address

57.2. server add floating ip

Add floating IP address to server

Usage:

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

Table 57.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)

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

57.3. server add network

Add network to server

Usage:

openstack server add network [-h] <server> <network>

Table 57.5. Positional Arguments

ValueSummary

<server>

Server to add the network to (name or id)

<network>

Network to add to the server (name or id)

Table 57.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.4. server add port

Add port to server

Usage:

openstack server add port [-h] <server> <port>

Table 57.7. Positional Arguments

ValueSummary

<server>

Server to add the port to (name or id)

<port>

Port to add to the server (name or id)

Table 57.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.5. server add security group

Add security group to server

Usage:

openstack server add security group [-h] <server> <group>

Table 57.9. Positional Arguments

ValueSummary

<server>

Server (name or id)

<group>

Security group to add (name or id)

Table 57.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.6. server add volume

Add volume to server

Usage:

openstack server add volume [-h] [--device <device>] <server> <volume>

Table 57.11. Positional Arguments

ValueSummary

<volume>

Volume to add (name or id)

<server>

Server (name or id)

Table 57.12. Optional Arguments

ValueSummary

--device <device>

Server internal device name for volume

-h, --help

Show this help message and exit

57.7. server backup create

Create a server backup image

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>

Table 57.13. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.14. Positional Arguments

ValueSummary

<server>

Server to back up (name or id)

Table 57.15. Output Formatters

ValueSummary

output formatter options-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 57.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.17. Optional Arguments

ValueSummary

--type <backup-type>

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

-h, --help

Show this help message and exit

--wait

Wait for backup image create to complete

--rotate <count>

Number of backups to keep (default: 1)

--name <image-name>

Name of the backup image (default: server name)

Table 57.18. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.8. server create

Create a new server

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

Table 57.19. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.20. Positional Arguments

ValueSummary

<server-name>

New server name

Table 57.21. Output Formatters

ValueSummary

output formatter options-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 57.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.23. Optional Arguments

ValueSummary

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

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

--availability-zone <zone-name>

Select an availability zone for the server

--hint <key=value>

Hints for the scheduler (optional extension)

--wait

Wait for build to complete

--max <count>

Maximum number of servers to launch (default=1)

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

--config-drive <config-drive-volume>

True

Use specified volume as the config drive, or true to use an ephemeral drive

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

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

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

--security-group <security-group>

Security group to assign to this server (name or id) (repeat option to set multiple groups)

--min <count>

Minimum number of servers to launch (default=1)

--key-name <key-name>

Keypair to inject into this server (optional extension)

-h, --help

Show this help message and exit

--user-data <user-data>

User data file to serve from the metadata server

--flavor <flavor>

Create server with this flavor (name or id)

--image <image>

Table 57.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.9. server delete

Delete server(s)

Usage:

openstack server delete [-h] [--wait] <server> [<server> ...]

Table 57.25. Positional Arguments

ValueSummary

<server>

Server(s) to delete (name or id)

Table 57.26. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for delete to complete

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

Usage:

openstack server dump create [-h] <server> [<server> ...]

Table 57.27. Positional Arguments

ValueSummary

<server>

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

Table 57.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.11. server event list

List recent events of a server

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>

Table 57.29. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.30. Positional Arguments

ValueSummary

<server>

Server to list events (name or id)

Table 57.31. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 57.32. Output Formatters

ValueSummary

output formatter options-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 57.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

57.12. server event show

Show server event details

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>

Table 57.35. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.36. Positional Arguments

ValueSummary

<server>

Server to show event details (name or id)

<request-id>

Request id of the event to show (id only)

Table 57.37. Output Formatters

ValueSummary

output formatter options-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 57.38. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 57.40. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.13. server group create

Create a new server group.

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>

Table 57.41. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.42. Positional Arguments

ValueSummary

<name>

New server group name

Table 57.43. Output Formatters

ValueSummary

output formatter options-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 57.44. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.45. Optional Arguments

ValueSummary

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

-h, --help

Show this help message and exit

Table 57.46. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.14. server group delete

Delete existing server group(s).

Usage:

openstack server group delete [-h] <server-group> [<server-group> ...]

Table 57.47. Positional Arguments

ValueSummary

<server-group>

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

Table 57.48. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.15. server group list

List all server groups.

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]

Table 57.49. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.50. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 57.51. Output Formatters

ValueSummary

output formatter options-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 57.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.53. Optional Arguments

ValueSummary

--all-projects

Display information from all projects (admin only)

-h, --help

Show this help message and exit

--long

List additional fields in output

57.16. server group show

Display server group details.

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>

Table 57.54. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.55. Positional Arguments

ValueSummary

<server-group>

Server group to display (name or id)

Table 57.56. Output Formatters

ValueSummary

output formatter options-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 57.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 57.59. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.17. server image create

Create a new server disk image from an existing server

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>

Table 57.60. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.61. Positional Arguments

ValueSummary

<server>

Server to create image (name or id)

Table 57.62. Output Formatters

ValueSummary

output formatter options-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 57.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.64. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for operation to complete

--name <image-name>

Name of new disk image (default: server name)

Table 57.65. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.18. server list

List servers

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

Table 57.66. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.67. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 57.68. Output Formatters

ValueSummary

output formatter options-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 57.69. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.70. Optional Arguments

ValueSummary

--image <image>

Search by image (name or id)

--marker <server>

The last server of the previous page. display list of servers after marker. Display all servers if not specified. (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.

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

--all-projects

Include all projects (admin only)

--user <user>

Search by user (admin only) (name or id)

-n, --no-name-lookup

Skip flavor and image name lookup.

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

--ip <ip-address-regex>

Regular expression to match ip addresses

--reservation-id <reservation-id>

Only return instances that match the reservation

--long

List additional fields in output

--project <project>

Search by project (admin only) (name or id)

--status <status>

Search by server status

--host <hostname>

Search by hostname

--deleted

Only display deleted servers (admin only).

--name <name-regex>

Regular expression to match names

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

-h, --help

Show this help message and exit

--ip6 <ip-address-regex>

Regular expression to match ipv6 addresses

--flavor <flavor>

Search by flavor (name or id)

--instance-name <server-name>

Regular expression to match instance name (admin only)

57.19. server lock

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

Usage:

openstack server lock [-h] <server> [<server> ...]

Table 57.71. Positional Arguments

ValueSummary

<server>

Server(s) to lock (name or id)

Table 57.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.20. server migrate

Migrate server to different host

Usage:

openstack server migrate [-h] [--live <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

Table 57.73. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.74. Optional Arguments

ValueSummary

--wait

Wait for migrate to complete

--disk-overcommit

Allow disk over-commit on the destination host

--block-migration

Perform a block live migration

--no-disk-overcommit

Do not over-commit disk on the destination host (default)

-h, --help

Show this help message and exit

--shared-migration

Perform a shared live migration (default)

--live <hostname>

Target hostname

57.21. server pause

Pause server(s)

Usage:

openstack server pause [-h] <server> [<server> ...]

Table 57.75. Positional Arguments

ValueSummary

<server>

Server(s) to pause (name or id)

Table 57.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.22. server reboot

Perform a hard or soft server reboot

Usage:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

Table 57.77. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.78. Optional Arguments

ValueSummary

--soft

Perform a soft reboot

-h, --help

Show this help message and exit

--hard

Perform a hard reboot

--wait

Wait for reboot to complete

57.23. server rebuild

Rebuild server

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>

Table 57.79. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.80. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.81. Output Formatters

ValueSummary

output formatter options-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 57.82. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.83. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for rebuild to complete

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

Table 57.84. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.24. server remove fixed ip

Remove fixed IP address from server

Usage:

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

Table 57.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)

Table 57.86. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.25. server remove floating ip

Remove floating IP address from server

Usage:

openstack server remove floating ip [-h] <server> <ip-address>

Table 57.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)

Table 57.88. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.26. server remove network

Remove all ports of a network from server

Usage:

openstack server remove network [-h] <server> <network>

Table 57.89. Positional Arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<network>

Network to remove from the server (name or id)

Table 57.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.27. server remove port

Remove port from server

Usage:

openstack server remove port [-h] <server> <port>

Table 57.91. Positional Arguments

ValueSummary

<server>

Server to remove the port from (name or id)

<port>

Port to remove from the server (name or id)

Table 57.92. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.28. server remove security group

Remove security group from server

Usage:

openstack server remove security group [-h] <server> <group>

Table 57.93. Positional Arguments

ValueSummary

<server>

Name or id of server to use

<group>

Name or id of security group to remove from server

Table 57.94. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.29. server remove volume

Remove volume from server

Usage:

openstack server remove volume [-h] <server> <volume>

Table 57.95. Positional Arguments

ValueSummary

<volume>

Volume to remove (name or id)

<server>

Server (name or id)

Table 57.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.30. server rescue

Put server in rescue mode

Usage:

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

Table 57.97. Positional Arguments

ValueSummary

<server>

Server (name or id)

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

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

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

Table 57.99. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.100. Optional Arguments

ValueSummary

--revert

Restore server state before resize

-h, --help

Show this help message and exit

--confirm

Confirm server resize is complete

--flavor <flavor>

Resize server to specified flavor

--wait

Wait for resize to complete

57.32. server restore

Restore server(s)

Usage:

openstack server restore [-h] <server> [<server> ...]

Table 57.101. Positional Arguments

ValueSummary

<server>

Server(s) to restore (name or id)

Table 57.102. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.33. server resume

Resume server(s)

Usage:

openstack server resume [-h] <server> [<server> ...]

Table 57.103. Positional Arguments

ValueSummary

<server>

Server(s) to resume (name or id)

Table 57.104. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.34. server set

Set server properties

Usage:

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            <server>

Table 57.105. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.106. Optional Arguments

ValueSummary

--state <state>

New server state (valid value: active, error)

-h, --help

Show this help message and exit

--name <new-name>

New server name

--property <key=value>

Property to add/change for this server (repeat option to set multiple properties)

--root-password

Set new root password (interactive only)

57.35. server shelve

Shelve server(s)

Usage:

openstack server shelve [-h] <server> [<server> ...]

Table 57.107. Positional Arguments

ValueSummary

<server>

Server(s) to shelve (name or id)

Table 57.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.36. server show

Show server details

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>

Table 57.109. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 57.110. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.111. Output Formatters

ValueSummary

output formatter options-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 57.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 57.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--diagnostics

Display server diagnostics information

Table 57.114. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

57.37. server ssh

SSH to server

Usage:

openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>

Table 57.115. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.116. Optional Arguments

ValueSummary

--login <login-name>

Login name (ssh -l option)

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

-4

Use only ipv4 addresses

--identity <keyfile>

Private key file (ssh -i option)

--port <port>

Destination port (ssh -p option)

--option <config-options>

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

-h, --help

Show this help message and exit

57.38. server start

Start server(s).

Usage:

openstack server start [-h] <server> [<server> ...]

Table 57.117. Positional Arguments

ValueSummary

<server>

Server(s) to start (name or id)

Table 57.118. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.39. server stop

Stop server(s).

Usage:

openstack server stop [-h] <server> [<server> ...]

Table 57.119. Positional Arguments

ValueSummary

<server>

Server(s) to stop (name or id)

Table 57.120. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.40. server suspend

Suspend server(s)

Usage:

openstack server suspend [-h] <server> [<server> ...]

Table 57.121. Positional Arguments

ValueSummary

<server>

Server(s) to suspend (name or id)

Table 57.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.41. server unlock

Unlock server(s)

Usage:

openstack server unlock [-h] <server> [<server> ...]

Table 57.123. Positional Arguments

ValueSummary

<server>

Server(s) to unlock (name or id)

Table 57.124. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.42. server unpause

Unpause server(s)

Usage:

openstack server unpause [-h] <server> [<server> ...]

Table 57.125. Positional Arguments

ValueSummary

<server>

Server(s) to unpause (name or id)

Table 57.126. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.43. server unrescue

Restore server from rescue mode

Usage:

openstack server unrescue [-h] <server>

Table 57.127. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

57.44. server unset

Unset server properties

Usage:

openstack server unset [-h] [--property <key>] <server>

Table 57.129. Positional Arguments

ValueSummary

<server>

Server (name or id)

Table 57.130. Optional Arguments

ValueSummary

--property <key>

Property key to remove from server (repeat option to remove multiple values)

-h, --help

Show this help message and exit

57.45. server unshelve

Unshelve server(s)

Usage:

openstack server unshelve [-h] <server> [<server> ...]

Table 57.131. Positional Arguments

ValueSummary

<server>

Server(s) to unshelve (name or id)

Table 57.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit