server¶

Compute v2

server add fixed ip¶

Add fixed IP address to server

os server add fixed ip
    <server>
    <network>

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

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

server add floating ip¶

Add floating IP address to server

os server add floating ip
    <server>
    <ip-address>

<server>: Server (name or ID) to receive the floating IP address

<ip-address>: Floating IP address (IP address only) to assign to server

server add security group¶

Add security group to server

os 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

os 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

os 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> [...] ]
    [--hint <key=value> [...] ]
    [--config-drive <value>|True ]
    [--min <count>]
    [--max <count>]
    [--wait]
    <server-name>

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

--volume <volume>¶: Create server from this volume (name or ID)

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

--security-group <security-group-name>¶: 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>¶: Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>¶: 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).

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

server delete¶

Delete server(s)

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

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

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

server list¶

List servers

os 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]
    [--marker <server>]
    [--limit <limit>]

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

--marker <server>¶: The last server (name or ID) of the previous page. Display list of servers after marker. Display all servers if not specified.

--limit <limit>¶: 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.

server lock¶

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

os server lock
    <server> [<server> ...]

<server>: Server(s) to lock (name or ID)

server migrate¶

Migrate server to different host

os 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 resize to complete

<server>: Server to migrate (name or ID)

server pause¶

Pause server(s)

os server pause
    <server> [<server> ...]

<server>: Server(s) to pause (name or ID)

server reboot¶

Perform a hard or soft server reboot

os 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

os 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

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

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

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

server remove floating ip¶

Remove floating IP address from server

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

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

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

server remove security group¶

Remove security group from server

os 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

os server remove volume
    <server>
    <volume>

<server>: Server (name or ID)

<volume>: Volume to remove (name or ID)

server rescue¶

Put server in rescue mode

os server rescue
    <server>

<server>: Server (name or ID)

server resize¶

Scale server to a new flavor

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

os 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

os server restore
    <server> [<server> ...]

<server>: Server(s) to restore (name or ID)

server resume¶

Resume server(s)

os server resume
    <server> [<server> ...]

<server>: Server(s) to resume (name or ID)

server set¶

Set server properties

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

os server shelve
    <server> [<server> ...]

<server>: Server(s) to shelve (name or ID)

server show¶

Show server details

os server show
    [--diagnostics]
    <server>

--diagnostics¶: Display server diagnostics information

<server>: Server (name or ID)

server ssh¶

SSH to server

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

os server start
    <server> [<server> ...]

<server>: Server(s) to start (name or ID)

server stop¶

Stop server(s)

os server stop
    <server> [<server> ...]

<server>: Server(s) to stop (name or ID)

server suspend¶

Suspend server(s)

os server suspend
    <server> [<server> ...]

<server>: Server(s) to suspend (name or ID)

server unlock¶

Unlock server(s)

os server unlock
    <server> [<server> ...]

<server>: Server(s) to unlock (name or ID)

server unpause¶

Unpause server(s)

os server unpause
    <server> [<server> ...]

<server>: Server(s) to unpause (name or ID)

server unrescue¶

Restore server from rescue mode

os server unrescue
    <server>

<server>: Server (name or ID)

server unset¶

Unset server properties

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

os server unshelve
    <server> [<server> ...]

<server>: Server(s) to unshelve (name or ID)

OpenStack

server¶

server add fixed ip¶

server add floating ip¶

server add security group¶

server add volume¶

server create¶

server delete¶

server dump create¶

server list¶

server lock¶

server migrate¶

server pause¶

server reboot¶

server rebuild¶

server remove fixed ip¶

server remove floating ip¶

server remove security group¶

server remove volume¶

server rescue¶

server resize¶

server restore¶

server resume¶

server set¶

server shelve¶

server show¶

server ssh¶

server start¶

server stop¶

server suspend¶

server unlock¶

server unpause¶

server unrescue¶

server unset¶

server unshelve¶

Table Of Contents

Previous topic

Next topic

Project Source

This Page

OpenStack

server¶

server add fixed ip¶

server add floating ip¶

server add security group¶

server add volume¶

server create¶

server delete¶

server dump create¶

server list¶

server lock¶

server migrate¶

server pause¶

server reboot¶

server rebuild¶

server remove fixed ip¶

server remove floating ip¶

server remove security group¶

server remove volume¶

server rescue¶

server resize¶

server restore¶

server resume¶

server set¶

server shelve¶

server show¶

server ssh¶

server start¶

server stop¶

server suspend¶

server unlock¶

server unpause¶

server unrescue¶

server unset¶

server unshelve¶

Table Of Contents

Previous topic

Next topic

Project Source

This Page

Quick search