Compute v2
Add fixed IP address to server
os server add fixed ip
<server>
<network>
Server (name or ID) to receive the fixed IP address
Network (name or ID) to allocate the fixed IP address from
Add floating IP address to server
os server add floating ip
<server>
<ip-address>
Server (name or ID) to receive the floating IP address
Floating IP address (IP address only) to assign to server
Add security group to server
os server add security group
<server>
<group>
Server (name or ID)
Security group to add (name or ID)
Add volume to server
os server add volume
[--device <device>]
<server>
<volume>
Server internal device name for volume
Server (name or ID)
Volume to add (name or ID)
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>
Create server from this image (name or ID)
Create server from this volume (name or ID)
Create server with this flavor (name or ID)
Security group to assign to this server (name or ID) (repeat option to set multiple groups)
Keypair to inject into this server (optional extension)
Set a property on this server (repeat option to set multiple values)
File to inject into image before boot (repeat option to set multiple files)
User data file to serve from the metadata server
Select an availability zone for the server
Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)
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).
Hints for the scheduler (optional extension)
Use specified volume as the config drive, or ‘True’ to use an ephemeral drive
Minimum number of servers to launch (default=1)
Maximum number of servers to launch (default=1)
Wait for build to complete
New server name
Delete server(s)
os server delete
<server> [<server> ...] [--wait]
Wait for delete to complete
Server(s) to delete (name or ID)
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(s) to create dump file (name or ID)
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>]
Only return instances that match the reservation
Regular expression to match IP addresses
Regular expression to match IPv6 addresses
Regular expression to match names
Regular expression to match instance name (admin only)
Search by server status
Search by flavor (name or ID)
Search by image (name or ID)
Search by hostname
Include all projects (admin only)
Search by project (admin only) (name or ID)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Search by user (admin only) (name or ID)
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
List additional fields in output
The last server (name or ID) of the previous page. Display list of servers after marker. Display all servers if not specified.
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.
Lock server(s). A non-admin user will not be able to execute actions
os server lock
<server> [<server> ...]
Server(s) to lock (name or ID)
Migrate server to different host
os server migrate
--live <host>
[--shared-migration | --block-migration]
[--disk-overcommit | --no-disk-overcommit]
[--wait]
<server>
Target hostname
Perform a shared live migration (default)
Perform a block live migration
Allow disk over-commit on the destination host
Do not over-commit disk on the destination host (default)
Wait for resize to complete
Server to migrate (name or ID)
Pause server(s)
os server pause
<server> [<server> ...]
Server(s) to pause (name or ID)
Perform a hard or soft server reboot
os server reboot
[--hard | --soft]
[--wait]
<server>
Perform a hard reboot
Perform a soft reboot
Wait for reboot to complete
Server (name or ID)
Rebuild server
os server rebuild
[--image <image>]
[--password <password>]
[--wait]
<server>
Recreate server from the specified image (name or ID). Defaults to the currently used one.
Set the password on the rebuilt instance
Wait for rebuild to complete
Server (name or ID)
Remove fixed IP address from server
os server remove fixed ip
<server>
<ip-address>
Server (name or ID) to remove the fixed IP address from
Fixed IP address (IP address only) to remove from the server
Remove floating IP address from server
os server remove floating ip
<server>
<ip-address>
Server (name or ID) to remove the floating IP address from
Floating IP address (IP address only) to remove from server
Remove security group from server
os server remove security group
<server>
<group>
Name or ID of server to use
Name or ID of security group to remove from server
Remove volume from server
os server remove volume
<server>
<volume>
Server (name or ID)
Volume to remove (name or ID)
Scale server to a new flavor
os server resize
--flavor <flavor>
[--wait]
<server>
os server resize
--confirm | --revert
<server>
Resize server to specified flavor
Confirm server resize is complete
Restore server state before resize
Wait for resize to complete
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.
Restore server(s) from soft-deleted state
os server restore
<server> [<server> ...]
Server(s) to restore (name or ID)
Resume server(s)
os server resume
<server> [<server> ...]
Server(s) to resume (name or ID)
Set server properties
os server set
--name <new-name>
--property <key=value>
[--property <key=value>] ...
--root-password
--state <state>
<server>
New server name
Set new root password (interactive only)
Property to add/change for this server (repeat option to set multiple properties)
New server state (valid value: active, error)
Server (name or ID)
Shelve server(s)
os server shelve
<server> [<server> ...]
Server(s) to shelve (name or ID)
Show server details
os server show
[--diagnostics]
<server>
Display server diagnostics information
Server (name or ID)
SSH to server
os server ssh
[--login <login-name>]
[--port <port>]
[--identity <keyfile>]
[--option <config-options>]
[--public | --private | --address-type <address-type>]
<server>
Login name (ssh -l option)
Destination port (ssh -p option)
Private key file (ssh -i option)
Options in ssh_config(5) format (ssh -o option)
Use public IP address
Use private IP address
Use other IP address (public, private, etc)
Server (name or ID)
Start server(s)
os server start
<server> [<server> ...]
Server(s) to start (name or ID)
Stop server(s)
os server stop
<server> [<server> ...]
Server(s) to stop (name or ID)
Suspend server(s)
os server suspend
<server> [<server> ...]
Server(s) to suspend (name or ID)
Unlock server(s)
os server unlock
<server> [<server> ...]
Server(s) to unlock (name or ID)
Unpause server(s)
os server unpause
<server> [<server> ...]
Server(s) to unpause (name or ID)
Restore server from rescue mode
os server unrescue
<server>
Server (name or ID)
Unset server properties
os server unset
--property <key>
[--property <key>] ...
<server>
Property key to remove from server (repeat option to remove multiple values)
Server (name or ID)
Unshelve server(s)
os server unshelve
<server> [<server> ...]
Server(s) to unshelve (name or ID)