server¶

Compute v2

server add fixed ip¶

Add fixed IP address to server

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

--fixed-ip-address <ip-address>¶: Requested fixed IP address

--tag <tag>¶: Tag for the attached interface. (supported by –os-compute-api-version 2.49 or above)

server¶: Server to receive the fixed IP address (name or ID)

network¶: Network to allocate the fixed IP address from (name or ID)

server add floating ip¶

Add floating IP address to server

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

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

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)

server add network¶

Add network to server

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

--tag <tag>¶: Tag for the attached interface. (supported by –os-compute-api-version 2.49 or above)

server¶: Server to add the network to (name or ID)

network¶: Network to add to the server (name or ID)

server add port¶

Add port to server

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

--tag <tag>¶: Tag for the attached interface. (Supported by API versions ‘2.49’ - ‘2.latest’)

server¶: Server to add the port to (name or ID)

port¶: Port to add to the server (name or ID)

server add security group¶

Add security group to server

openstack server add security group <server> <group>

server¶: Server (name or ID)

group¶: Security group to add (name or ID)

server add volume¶

Add volume to server. Specify --os-compute-api-version 2.20 or higher to add a volume to a server with status SHELVED or SHELVED_OFFLOADED.

openstack server add volume
    [--device <device>]
    [--tag <tag>]
    [--enable-delete-on-termination | --disable-delete-on-termination]
    <server>
    <volume>

--device <device>¶: Server internal device name for volume

--tag <tag>¶: Tag for the attached volume (supported by –os-compute-api-version 2.49 or above)

--enable-delete-on-termination¶: Delete the volume when the server is destroyed (supported by –os-compute-api-version 2.79 or above)

--disable-delete-on-termination¶: Do not delete the volume when the server is destroyed (supported by –os-compute-api-version 2.79 or above)

server¶: Server (name or ID)

volume¶: Volume to add (name or ID)

server create¶

Create a new server

openstack server create
    --flavor <flavor>
    (--image <image> | --image-property <key=value> | --volume <volume> | --snapshot <snapshot>)
    [--boot-from-volume <volume-size>]
    [--block-device-mapping <dev-name=mapping>]
    [--block-device]
    [--swap <swap>]
    [--ephemeral <size=size[,format=format]
    >]
    [--network <network>]
    [--port <port>]
    [--nic <net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag,auto,none>]
    [--password <password>]
    [--security-group <security-group>]
    [--key-name <key-name>]
    [--property <key=value>]
    [--file <dest-filename=source-filename>]
    [--user-data <user-data>]
    [--description <description>]
    [--availability-zone <zone-name>]
    [--host <host>]
    [--hypervisor-hostname <hypervisor-hostname>]
    [--hint <key=value>]
    [--use-config-drive | --no-config-drive | --config-drive <config-drive-volume>|True]
    [--min <count>]
    [--max <count>]
    [--tag <tag>]
    [--hostname <hostname>]
    [--wait]
    [--trusted-image-cert <trusted-cert-id>]
    <server-name>

--flavor <flavor>¶: Create server with this flavor (name or ID)

--image <image>¶: Create server boot disk from this image (name or ID)

--image-property <key=value>¶: Create server using the image that matches the specified property. Property must match exactly one property.

--volume <volume>¶: Create server using this volume as the boot disk (name or ID) This option automatically creates a block device mapping with a boot index of 0. On many hypervisors (libvirt/kvm for example) this will be device vda. Do not create a duplicate mapping using –block-device-mapping for this volume.

--snapshot <snapshot>¶: Create server using this snapshot as the boot disk (name or ID) This option automatically creates a block device mapping with a boot index of 0. On many hypervisors (libvirt/kvm for example) this will be device vda. Do not create a duplicate mapping using –block-device-mapping for this volume.

--boot-from-volume <volume-size>¶: When used in conjunction with the --image or --image-property option, this option automatically creates a block device mapping with a boot index of 0 and tells the compute service to create a volume of the given size (in GB) from the specified image and use it as the root disk of the server. The root volume will not be deleted when the server is deleted. This option is mutually exclusive with the --volume and --snapshot options.

--block-device-mapping <dev-name=mapping>¶: Deprecated Create a block device on the server. Block device mapping in the format <dev-name>=<id>:<type>:<size(GB)>:<delete-on-terminate> <dev-name>: block device name, like: vdb, xvdc (required) <id>: Name or ID of the volume, volume snapshot or image (required) <type>: volume, snapshot or image; default: volume (optional) <size(GB)>: volume size if create from image or snapshot (optional) <delete-on-terminate>: true or false; default: false (optional) Replaced by –block-device

--block-device <BLOCK_DEVICES>¶: Create a block device on the server. Either a path to a JSON file or a CSV-serialized string describing the block device mapping. The following keys are accepted for both: uuid=<uuid>: UUID of the volume, snapshot or ID (required if using source image, snapshot or volume), source_type=<source_type>: source type (one of: image, snapshot, volume, blank), destination_type=<destination_type>: destination type (one of: volume, local) (optional), disk_bus=<disk_bus>: device bus (one of: uml, lxc, virtio, …) (optional), device_type=<device_type>: device type (one of: disk, cdrom, etc. (optional), device_name=<device_name>: name of the device (optional), volume_size=<volume_size>: size of the block device in MiB (for swap) or GiB (for everything else) (optional), guest_format=<guest_format>: format of device (optional), boot_index=<boot_index>: index of disk used to order boot disk (required for volume-backed instances), delete_on_termination=<true|false>: whether to delete the volume upon deletion of server (optional), tag=<tag>: device metadata tag (optional), volume_type=<volume_type>: type of volume to create (name or ID) when source if blank, image or snapshot and dest is volume (optional)

--swap <swap>¶: Create and attach a local swap block device of <swap_size> MiB.

--ephemeral <size=size[,format=format]>¶: Create and attach a local ephemeral block device of <size> GiB and format it to <format>.

--network <network>¶: Create a NIC on the server and connect it to network. Specify option multiple times to create multiple NICs. This is a wrapper for the ‘–nic net-id=<network>’ parameter that provides simple syntax for the standard use case of connecting a new server to a given network. For more advanced use cases, refer to the ‘–nic’ parameter.

--port <port>¶: Create a NIC on the server and connect it to port. Specify option multiple times to create multiple NICs. This is a wrapper for the ‘–nic port-id=<port>’ parameter that provides simple syntax for the standard use case of connecting a new server to a given port. For more advanced use cases, refer to the ‘–nic’ parameter.

--nic <net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag,auto,none>¶

Create a NIC on the server. NIC in the format: net-id=<net-uuid>: attach NIC to network with this UUID, port-id=<port-uuid>: attach NIC to port with this UUID, v4-fixed-ip=<ip-addr>: IPv4 fixed address for NIC (optional), v6-fixed-ip=<ip-addr>: IPv6 fixed address for NIC (optional), tag: interface metadata tag (optional) (supported by –os-compute-api-version 2.43 or above), none: (v2.37+) no network is attached, auto: (v2.37+) the compute service will automatically allocate a network.

Specify option multiple times to create multiple NICs. Specifying a –nic of auto or none cannot be used with any other –nic value. Either net-id or port-id must be provided, but not both.

--password <password>¶: Set the password to this server. This option requires cloud support.

--security-group <security-group>¶: Security group to assign to this server (name or ID) (repeat option to set multiple groups)

--key-name <key-name>¶: Keypair to inject into this server

--property <key=value>¶: Set a property on this server (repeat option to set multiple values)

--file <dest-filename=source-filename>¶: File(s) to inject into image before boot (repeat option to set multiple files)(supported by –os-compute-api-version 2.57 or below)

--user-data <user-data>¶: User data file to serve from the metadata server

--description <description>¶: Set description for the server (supported by –os-compute-api-version 2.19 or above)

--availability-zone <zone-name>¶: Select an availability zone for the server. Host and node are optional parameters. Availability zone in the format <zone-name>:<host-name>:<node-name>, <zone-name>::<node-name>, <zone-name>:<host-name> or <zone-name>

--host <host>¶: Requested host to create servers. (admin only) (supported by –os-compute-api-version 2.74 or above)

--hypervisor-hostname <hypervisor-hostname>¶: Requested hypervisor hostname to create servers. (admin only) (supported by –os-compute-api-version 2.74 or above)

--hint <key=value>¶: Hints for the scheduler

--use-config-drive¶: Enable config drive.

--no-config-drive¶: Disable config drive.

--config-drive <config-drive-volume>|True¶: Deprecated Use specified volume as the config drive, or ‘True’ to use an ephemeral drive. Replaced by ‘–use-config-drive’.

--min <count>¶: Minimum number of servers to launch (default=1)

--max <count>¶: Maximum number of servers to launch (default=1)

--tag <tag>¶: Tags for the server. Specify multiple times to add multiple tags. (supported by –os-compute-api-version 2.52 or above)

--hostname <hostname>¶: Hostname configured for the server in the metadata service. If unset, a hostname will be automatically generated from the server name. A utility such as cloud-init is required to propagate the hostname in the metadata service to the guest OS itself. (supported by –os-compute-api-version 2.90 or above)

--wait¶: Wait for build to complete

--trusted-image-cert <trusted-cert-id>¶: Trusted image certificate IDs used to validate certificates during the image signature verification process. May be specified multiple times to pass multiple trusted image certificate IDs. (supported by –os-compute-api-version 2.63 or above)

server-name¶: New server name

server evacuate¶

Evacuate a server to a different host.

This command is used to recreate a server after the host it was on has failed. It can only be used if the compute service that manages the server is down. This command should only be used by an admin after they have confirmed that the instance is not running on the failed host.

If the server instance was created with an ephemeral root disk on non-shared storage the server will be rebuilt using the original glance image preserving the ports and any attached data volumes.

If the server uses boot for volume or has its root disk on shared storage the root disk will be preserved and reused for the evacuated instance on the new host.

openstack server evacuate
    [--wait]
    [--host <host>]
    [--password <password> | --shared-storage]
    <server>

--wait¶: Wait for evacuation to complete

--host <host>¶: Set the preferred host on which to rebuild the evacuated server. The host will be validated by the scheduler. (supported by –os-compute-api-version 2.29 or above)

--password <password>¶: Set the password on the evacuated instance. This option is mutually exclusive with the –shared-storage option. This option requires cloud support.

--shared-storage¶: Indicate that the instance is on shared storage. This will be auto-calculated with –os-compute-api-version 2.14 and greater and should not be used with later microversions. This option is mutually exclusive with the –password option

server¶: Server (name or ID)

server delete¶

Delete server(s)

openstack server delete
    [--force]
    [--all-projects]
    [--wait]
    <server>
    [<server> ...]

--force¶: Force delete server(s)

--all-projects¶: Delete server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

--wait¶: Wait for delete to complete

server¶: Server(s) to delete (name or ID)

server dump create¶

Create a dump file in server(s)

Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)’ memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource.

This command requires --os-compute-api-version 2.17 or greater.

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

server¶: Server(s) to create dump file (name or ID)

server list¶

List servers

openstack server list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--reservation-id <reservation-id>]
    [--ip <ip-address-regex>]
    [--ip6 <ip-address-regex>]
    [--name <name-regex>]
    [--instance-name <server-name>]
    [--status <status>]
    [--flavor <flavor>]
    [--image <image>]
    [--host <hostname>]
    [--all-projects]
    [--project <project>]
    [--project-domain <project-domain>]
    [--user <user>]
    [--user-domain <user-domain>]
    [--deleted]
    [--availability-zone AVAILABILITY_ZONE]
    [--key-name KEY_NAME]
    [--config-drive | --no-config-drive]
    [--progress PROGRESS]
    [--vm-state <state>]
    [--task-state <state>]
    [--power-state <state>]
    [--long]
    [-n | --name-lookup-one-by-one]
    [--marker <server>]
    [--limit <num-servers>]
    [--changes-before <changes-before>]
    [--changes-since <changes-since>]
    [--locked | --unlocked]
    [--tags <tag>]
    [--not-tags <tag>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--reservation-id <reservation-id>¶: Only return instances that match the reservation

--ip <ip-address-regex>¶: Regular expression to match IP addresses

--ip6 <ip-address-regex>¶: Regular expression to match IPv6 addresses. Note that this option only applies for non-admin users when using --os-compute-api-version 2.5 or greater.

--name <name-regex>¶: Regular expression to match names

--instance-name <server-name>¶: Regular expression to match instance name (admin only)

--status <status>¶: Search by server status

--flavor <flavor>¶: Search by flavor (name or ID)

--image <image>¶: Search by image (name or ID)

--host <hostname>¶: Search by hostname

--all-projects¶: Include all projects (admin only) (can be specified using the ALL_PROJECTS envvar)

--project <project>¶: Search by project (admin only) (name or ID)

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--user <user>¶: Search by user (name or ID) (admin only before microversion 2.83)

--user-domain <user-domain>¶: Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

--deleted¶: Only display deleted servers (admin only)

--availability-zone <AVAILABILITY_ZONE>¶: Search by availability zone (admin only before microversion 2.83)

--key-name <KEY_NAME>¶: Search by keypair name (admin only before microversion 2.83)

--config-drive¶: Only display servers with a config drive attached (admin only before microversion 2.83)

--no-config-drive¶: Only display servers without a config drive attached (admin only before microversion 2.83)

--progress <PROGRESS>¶: Search by progress value (%%) (admin only before microversion 2.83)

--vm-state <state>¶: Search by vm_state value (admin only before microversion 2.83)

--task-state <state>¶: Search by task_state value (admin only before microversion 2.83)

--power-state <state>¶: Search by power_state value (admin only before microversion 2.83)

--long¶: List additional fields in output

-n, --no-name-lookup¶: Skip flavor and image name lookup. Mutually exclusive with “–name-lookup-one-by-one” option.

--name-lookup-one-by-one¶: When looking up flavor and image names, look them upone by one as needed instead of all together (default). Mutually exclusive with “–no-name-lookup|-n” option.

--marker <server>¶: The last server of the previous page. Display list of servers after marker. Display all servers if not specified. When used with --deleted, the marker must be an ID, otherwise a name or ID can be used.

--limit <num-servers>¶: Maximum number of servers to display. If limit equals -1, all servers will be displayed. If limit is greater than ‘osapi_max_limit’ option of Nova API, ‘osapi_max_limit’ will be used instead.

--changes-before <changes-before>¶: List only servers changed before a certain point of time. The provided time should be an ISO 8061 formatted time (e.g., 2016-03-05T06:27:59Z). (supported by –os-compute-api-version 2.66 or above)

--changes-since <changes-since>¶: List only servers changed after a certain point of time. The provided time should be an ISO 8061 formatted time (e.g., 2016-03-04T06:27:59Z).

--locked¶: Only display locked servers (supported by –os-compute-api-version 2.73 or above)

--unlocked¶: Only display unlocked servers (supported by –os-compute-api-version 2.73 or above)

--tags <tag>¶: Only list servers with the specified tag. Specify multiple times to filter on multiple tags. (supported by –os-compute-api-version 2.26 or above)

--not-tags <tag>¶: Only list servers without the specified tag. Specify multiple times to filter on multiple tags. (supported by –os-compute-api-version 2.26 or above)

server lock¶

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

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

--reason <reason>¶: Reason for locking the server(s). Requires --os-compute-api-version 2.73 or greater.

server¶: Server(s) to lock (name or ID)

server migrate¶

Migrate server to different host.

A migrate operation is implemented as a resize operation using the same flavor as the old server. This means that, like resize, migrate works by creating a new server using the same flavor and copying the contents of the original disk into a new one. As with resize, the migrate operation is a two-step process for the user: the first step is to perform the migrate, and the second step is to either confirm (verify) success and release the old server, or to declare a revert to release the new server and restart the old one.

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

--live-migration¶: Live migrate the server; use the --host option to specify a target host for the migration which will be validated by the scheduler

--host <hostname>¶: Migrate the server to the specified host. (supported with –os-compute-api-version 2.30 or above when used with the –live-migration option) (supported with –os-compute-api-version 2.56 or above when used without the –live-migration option)

--shared-migration¶: Perform a shared live migration (default before –os-compute-api-version 2.25, auto after)

--block-migration¶: Perform a block live migration (auto-configured from –os-compute-api-version 2.25)

--disk-overcommit¶: Allow disk over-commit on the destination host(supported with –os-compute-api-version 2.24 or below)

--no-disk-overcommit¶: Do not over-commit disk on the destination host (default)(supported with –os-compute-api-version 2.24 or below)

--wait¶: Wait for migrate to complete

server¶: Server (name or ID)

server migrate confirm¶

DEPRECATED: Confirm server migration.

Use ‘server migration confirm’ instead.

openstack server migrate confirm <server>

server¶: Server (name or ID)

server migrate revert¶

Revert server migration.

Use ‘server migration revert’ instead.

openstack server migrate revert <server>

server¶: Server (name or ID)

server pause¶

Pause server(s)

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

server¶: Server(s) to pause (name or ID)

server reboot¶

Perform a hard or soft server reboot

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

--hard¶: Perform a hard reboot

--soft¶: Perform a soft reboot

--wait¶: Wait for reboot to complete

server¶: Server (name or ID)

server rebuild¶

Rebuild server

openstack server rebuild
    [--image <image>]
    [--name <name>]
    [--password <password>]
    [--property <key=value>]
    [--description <description>]
    [--preserve-ephemeral | --no-preserve-ephemeral]
    [--key-name <key-name> | --no-key-name]
    [--user-data <user-data> | --no-user-data]
    [--trusted-image-cert <trusted-cert-id> | --no-trusted-image-certs]
    [--hostname <hostname>]
    [--reimage-boot-volume]
    [--no-reimage-boot-volume]
    [--wait]
    <server>

--image <image>¶: Recreate server from the specified image (name or ID).Defaults to the currently used one.

--name <name>¶: Set the new name of the rebuilt server

--password <password>¶: Set the password on the rebuilt server. This option requires cloud support.

--property <key=value>¶: Set a new property on the rebuilt server (repeat option to set multiple values)

--description <description>¶: Set a new description on the rebuilt server (supported by –os-compute-api-version 2.19 or above)

--preserve-ephemeral¶: Preserve the default ephemeral storage partition on rebuild.

--no-preserve-ephemeral¶: Do not preserve the default ephemeral storage partition on rebuild.

--key-name <key-name>¶: Set the key name of key pair on the rebuilt server. Cannot be specified with the –key-unset option. (supported by –os-compute-api-version 2.54 or above)

--no-key-name¶: Unset the key name of key pair on the rebuilt server. Cannot be specified with the –key-name option. (supported by –os-compute-api-version 2.54 or above)

--user-data <user-data>¶: Add a new user data file to the rebuilt server. Cannot be specified with the –no-user-data option. (supported by –os-compute-api-version 2.57 or above)

--no-user-data¶: Remove existing user data when rebuilding server. Cannot be specified with the –user-data option. (supported by –os-compute-api-version 2.57 or above)

--trusted-image-cert <trusted-cert-id>¶: Trusted image certificate IDs used to validate certificates during the image signature verification process. May be specified multiple times to pass multiple trusted image certificate IDs. Cannot be specified with the –no-trusted-certs option. (supported by –os-compute-api-version 2.63 or above)

--no-trusted-image-certs¶: Remove any existing trusted image certificates from the server. Cannot be specified with the –trusted-certs option. (supported by –os-compute-api-version 2.63 or above)

--hostname <hostname>¶: Hostname configured for the server in the metadata service. A separate utility running in the guest is required to propagate changes to this value to the guest OS itself. (supported by –os-compute-api-version 2.90 or above)

--reimage-boot-volume¶: Rebuild a volume-backed server. This will wipe the root volume data and overwrite it with the provided image. Defaults to False. (supported by –os-compute-api-version 2.93 or above)

--no-reimage-boot-volume¶: Do not rebuild a volume-backed server. (supported by –os-compute-api-version 2.93 or above)

--wait¶: Wait for rebuild to complete

server¶: Server (name or ID)

server remove fixed ip¶

Remove fixed IP address from server

openstack server remove fixed ip <server> <ip-address>

server¶: Server to remove the fixed IP address from (name or ID)

ip-address¶: Fixed IP address to remove from the server (IP only)

server remove floating ip¶

Remove floating IP address from server

openstack server remove floating ip <server> <ip-address>

server¶: Server to remove the floating IP address from (name or ID)

ip-address¶: Floating IP address to remove from server (IP only)

server remove network¶

Remove all ports of a network from server

openstack server remove network <server> <network>

server¶: Server to remove the port from (name or ID)

network¶: Network to remove from the server (name or ID)

server remove port¶

Remove port from server

openstack server remove port <server> <port>

server¶: Server to remove the port from (name or ID)

port¶: Port to remove from the server (name or ID)

server remove security group¶

Remove security group from server

openstack server remove security group <server> <group>

server¶: Name or ID of server to use

group¶: Name or ID of security group to remove from server

server remove volume¶

Remove volume from server. Specify --os-compute-api-version 2.20 or higher to remove a volume from a server with status SHELVED or SHELVED_OFFLOADED.

openstack server remove volume <server> <volume>

server¶: Server (name or ID)

volume¶: Volume to remove (name or ID)

server rescue¶

Put server in rescue mode

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

--image <image>¶: Image (name or ID) to use for the rescue mode. Defaults to the currently used one.

--password <password>¶: Set the password on the rescued instance. This option requires cloud support.

server¶: Server (name or ID)

server resize¶

Scale server to a new flavor.

A resize operation is implemented by creating a new server and copying the contents of the original disk into a new one. It is a two-step process for the user: the first step is to perform the resize, and the second step is to either confirm (verify) success and release the old server or to declare a revert to release the new server and restart the old one.

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

--flavor <flavor>¶: Resize server to specified flavor

--confirm¶: Deprecated Confirm server resize is complete. Replaced by the ‘openstack server resize confirm’ and ‘openstack server migration confirm’ commands

--revert¶: Deprecated Restore server state before resizeReplaced by the ‘openstack server resize revert’ and ‘openstack server migration revert’ commands

--wait¶: Wait for resize to complete

server¶: Server (name or ID)

server resize confirm¶

Confirm server resize.

Confirm (verify) success of resize operation and release the old server.

openstack server resize confirm <server>

server¶: Server (name or ID)

server resize revert¶

Revert server resize.

Revert the resize operation. Release the new server and restart the old one.

openstack server resize revert <server>

server¶: Server (name or ID)

server restore¶

Restore server(s)

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

server¶: Server(s) to restore (name or ID)

server resume¶

Resume server(s)

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

server¶: Server(s) to resume (name or ID)

server set¶

Set server properties

openstack server set
    [--name <new-name>]
    [--password PASSWORD | --no-password]
    [--property <key=value>]
    [--state <state>]
    [--description <description>]
    [--tag <tag>]
    [--hostname <hostname>]
    <server>

--name <new-name>¶: New server name

--password <PASSWORD>¶: Set the server password. This option requires cloud support.

--no-password¶: Clear the admin password for the server from the metadata service; note that this action does not actually change the server password

--property <key=value>¶: Property to add/change for this server (repeat option to set multiple properties)

--state <state>¶: New server state WARNING This can result in instances that are no longer usable and should be used with caution (admin only)

--description <description>¶: New server description (supported by –os-compute-api-version 2.19 or above)

--tag <tag>¶: Tag for the server. Specify multiple times to add multiple tags. (supported by –os-compute-api-version 2.26 or above)

--hostname <hostname>¶: Hostname configured for the server in the metadata service. A separate utility running in the guest is required to propagate changes to this value to the guest OS itself. (supported by –os-compute-api-version 2.90 or above)

server¶: Server (name or ID)

server shelve¶

Shelve and optionally offload server(s).

Shelving a server creates a snapshot of the server and stores this snapshot before shutting down the server. This shelved server can then be offloaded or deleted from the host, freeing up remaining resources on the host, such as network interfaces. Shelved servers can be unshelved, restoring the server from the snapshot. Shelving is therefore useful where users wish to retain the UUID and IP of a server, without utilizing other resources or disks.

Most clouds are configured to automatically offload shelved servers immediately or after a small delay. For clouds where this is not configured, or where the delay is larger, offloading can be manually specified. This is an admin-only operation by default.

openstack server shelve [--offload] [--wait] <server> [<server> ...]

--offload¶: Remove the shelved server(s) from the host (admin only). Invoking this option on an unshelved server(s) will result in the server being shelved first

--wait¶: Wait for shelve and/or offload operation to complete

server¶: Server(s) to shelve (name or ID)

server show¶

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

openstack server show [--diagnostics | --topology] <server>

--diagnostics¶: Display server diagnostics information

--topology¶: Include topology information in the output (supported by –os-compute-api-version 2.78 or above)

server¶: Server (name or ID)

server ssh¶

SSH to server

openstack server ssh
    [-4 | -6]
    [--public | --private | --address-type <address-type>]
    <server>
    [-- <standard ssh args> [-- <standard ssh args> ...]]

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

server¶: Server (name or ID)

-- <standard ssh args¶: Any argument or option that ssh allows. Use – once between openstackclient args and SSH args.

server start¶

Start server(s).

openstack server start [--all-projects] <server> [<server> ...]

--all-projects¶: Start server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

server¶: Server(s) to start (name or ID)

server stop¶

Stop server(s).

openstack server stop [--all-projects] <server> [<server> ...]

--all-projects¶: Stop server(s) in another project by name (admin only)(can be specified using the ALL_PROJECTS envvar)

server¶: Server(s) to stop (name or ID)

server suspend¶

Suspend server(s)

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

server¶: Server(s) to suspend (name or ID)

server unlock¶

Unlock server(s)

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

server¶: Server(s) to unlock (name or ID)

server unpause¶

Unpause server(s)

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

server¶: Server(s) to unpause (name or ID)

server unrescue¶

Restore server from rescue mode

openstack server unrescue <server>

server¶: Server (name or ID)

server unset¶

Unset server properties and tags

openstack server unset
    [--property <key>]
    [--description]
    [--tag <tag>]
    <server>

--property <key>¶: Property key to remove from server (repeat option to remove multiple values)

--description¶: Unset server description (supported by –os-compute-api-version 2.19 or above)

--tag <tag>¶: Tag to remove from the server. Specify multiple times to remove multiple tags. (supported by –os-compute-api-version 2.26 or above)

server¶: Server (name or ID)

server unshelve¶

Unshelve server(s)

openstack server unshelve
    [--availability-zone AVAILABILITY_ZONE]
    [--wait]
    <server>
    [<server> ...]

--availability-zone <AVAILABILITY_ZONE>¶: Name of the availability zone in which to unshelve a SHELVED_OFFLOADED server (supported by –os-compute-api-version 2.77 or above)

--wait¶: Wait for unshelve operation to complete

server¶: Server(s) to unshelve (name or ID)

server