python-openstackclient/doc/source/cli/command-objects/server.rst

server

Compute v2

server add fixed ip

Add fixed IP address to server

server add fixed ip

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

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

Requested fixed IP address

<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

server add floating ip

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

<server>

Server to receive the floating IP address (name or ID)

<ip-address>

Floating IP address to assign to server (IP only)

server add port

Add port to server

server add port

openstack server add port
    <server>
    <port>

<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

server add security group

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

server add volume

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

--device <device>

Server internal device name for volume

<server>

Server (name or ID)

<volume>

Volume to add (name or ID)

server create

Create a new server

server create

openstack server create
    --image <image> | --volume <volume>
    --flavor <flavor>
    [--security-group <security-group-name> [...] ]
    [--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 <value>|True ]
    [--min <count>]
    [--max <count>]
    [--wait]
    <server-name>

--image <image>

Create server boot disk from this image (name or ID)

--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. For more options on NICs see --nic parameter. network: attach NIC to this network

--port <port>

Create a NIC on the server and connect it to port. Specify option multiple times to create multiple NICs. For more options on NICs see --nic parameter. port: attach NIC to this port

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

Wait for build to complete

<server-name>

New server name

The parameters --network <network> and --port <port> are actually wrappers to --nic net-id=<network> and --nic port-id=<port>. --nic also provides additional options to specify an IP address, automatic network assignment and NICs which are not assigned to any port. This functionality is not part of --network and --port, which aim to provide a simple syntax for the standard use cases of connecting a new server to a given network or port.

server delete

Delete server(s)

server delete

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

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

server dump create

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

<server>

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

server list

List servers

openstack server list
    [--reservation-id <reservation-id>]
    [--ip <ip-address-regex>]
    [--ip6 <ip6-address-regex>]
    [--name <name-regex>]
    [--instance-name <instance-name-regex>]
    [--status <status>]
    [--flavor <flavor>]
    [--image <image>]
    [--host <hostname>]
    [--all-projects]
    [--project <project> [--project-domain <project-domain>]]
    [--long]
    [-n | --no-name-lookup]
    [--marker <server>]
    [--limit <num-servers>]
    [--deleted]
    [--changes-since <changes-since>]

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

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

--no-name-lookup

Skips image and flavor names 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.

server lock

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

server lock

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

<server>

Server(s) to lock (name or ID)

server migrate

Migrate server to different host

server migrate

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

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

<server>

Server to migrate (name or ID)

server pause

Pause server(s)

server pause

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

<server>

Server(s) to pause (name or ID)

server reboot

Perform a hard or soft server reboot

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

server rebuild

openstack server rebuild
    [--image <image>]
    [--password <password>]
    [--wait]
    <server>

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

<server>

Server (name or ID)

server remove fixed ip

Remove fixed IP address from server

server remove fixed ip

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

server remove floating ip

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 port

Remove port from server

server remove port

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

server remove security group

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

server remove volume

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

server rescue

openstack server rescue
    <server>

<server>

Server (name or ID)

server resize

Scale server to a new flavor

server resize

openstack server resize
    --flavor <flavor>
    [--wait]
    <server>

openstack server resize
    --confirm | --revert
    <server>

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

<server>

Server (name or ID)

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.

server restore

Restore server(s) from soft-deleted state

server restore

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

<server>

Server(s) to restore (name or ID)

server resume

Resume server(s)

server resume

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

<server>

Server(s) to resume (name or ID)

server set

Set server properties

server set

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

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

<server>

Server (name or ID)

server shelve

Shelve server(s)

server shelve

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

<server>

Server(s) to shelve (name or ID)

server show

Show server details

server show

openstack server show
    [--diagnostics]
    <server>

--diagnostics

Display server diagnostics information

<server>

Server (name or ID)

server ssh

SSH to server

server ssh

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

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

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

server start

Start server(s)

server start

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

<server>

Server(s) to start (name or ID)

server stop

Stop server(s)

server stop

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

<server>

Server(s) to stop (name or ID)

server suspend

Suspend server(s)

server suspend

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

<server>

Server(s) to suspend (name or ID)

server unlock

Unlock server(s)

server unlock

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

<server>

Server(s) to unlock (name or ID)

server unpause

Unpause server(s)

server unpause

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

<server>

Server(s) to unpause (name or ID)

server unrescue

Restore server from rescue mode

server unrescue

openstack server unrescue
    <server>

<server>

Server (name or ID)

server unset

Unset server properties

server unset

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

--property <key>

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

<server>

Server (name or ID)

server unshelve

Unshelve server(s)

server unshelve

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

<server>

Server(s) to unshelve (name or ID)