Chapter 5. Compute command-line client

Subcommands

absolute-limits

Print a list of absolute limits for a user

add-fixed-ip

Add new IP address on a network to server.

add-floating-ip

DEPRECATED, use floating-ip-associate instead.

add-secgroup

Add a Security Group to a server.

agent-create

Create new agent build.

agent-delete

Delete existing agent build.

agent-list

List all builds.

agent-modify

Modify existing agent build.

aggregate-add-host

Add the host to the specified aggregate.

aggregate-create

Create a new aggregate with the specified details.

aggregate-delete

Delete the aggregate.

aggregate-details

Show details of the specified aggregate.

aggregate-list

Print a list of all aggregates.

aggregate-remove-host

Remove the specified host from the specified aggregate.

aggregate-set-metadata

Update the metadata associated with the aggregate.

aggregate-update

Update the aggregate's name and optionally availability zone.

availability-zone-list

List all the availability zones.

backup

Backup a server by creating a 'backup' type snapshot.

boot

Boot a new server.

clear-password

Clear the admin password for a server.

cloudpipe-configure

Update the VPN IP/port of a cloudpipe instance.

cloudpipe-create

Create a cloudpipe instance for the given project.

cloudpipe-list

Print a list of all cloudpipe instances.

console-log

Get console log output of a server.

credentials

Show user credentials returned from auth.

delete

Immediately shut down and delete specified server(s).

diagnostics

Retrieve server diagnostics.

dns-create

Create a DNS entry for domain, name and IP.

dns-create-private-domain

Create the specified DNS domain.

dns-create-public-domain

Create the specified DNS domain.

dns-delete

Delete the specified DNS entry.

dns-delete-domain

Delete the specified DNS domain.

dns-domains

Print a list of available dns domains.

dns-list

List current DNS entries for domain and IP or domain and name.

endpoints

Discover endpoints that get returned from the authenticate services.

evacuate

Evacuate server from failed host.

fixed-ip-get

Retrieve info on a fixed IP.

fixed-ip-reserve

Reserve a fixed IP.

fixed-ip-unreserve

Unreserve a fixed IP.

flavor-access-add

Add flavor access for the given tenant.

flavor-access-list

Print access information about the given flavor.

flavor-access-remove

Remove flavor access for the given tenant.

flavor-create

Create a new flavor

flavor-delete

Delete a specific flavor

flavor-key

Set or unset extra_spec for a flavor.

flavor-list

Print a list of available 'flavors' (sizes of servers).

flavor-show

Show details about the given flavor.

floating-ip-associate

Associate a floating IP address to a server.

floating-ip-bulk-create

Bulk create floating IPs by range.

floating-ip-bulk-delete

Bulk delete floating IPs by range.

floating-ip-bulk-list

List all floating IPs.

floating-ip-create

Allocate a floating IP for the current tenant.

floating-ip-delete

De-allocate a floating IP.

floating-ip-disassociate

Disassociate a floating IP address from a server.

floating-ip-list

List floating IPs.

floating-ip-pool-list

List all floating IP pools.

get-password

Get the admin password for a server.

get-rdp-console

Get a rdp console to a server.

get-serial-console

Get a serial console to a server.

get-spice-console

Get a spice console to a server.

get-vnc-console

Get a vnc console to a server.

host-action

Perform a power action on a host.

host-describe

Describe a specific host.

host-list

List all hosts by service.

host-update

Update host settings.

hypervisor-list

List hypervisors.

hypervisor-servers

List servers belonging to specific hypervisors.

hypervisor-show

Display the details of the specified hypervisor.

hypervisor-stats

Get hypervisor statistics over all compute nodes.

Warning

When using Red Hat Ceph as a back end for ephemeral storage, the Compute service does not calculate the amount of available storage correctly. Specifically, Compute simply adds up the amount of available storage without factoring in replication. This results in grossly overstated available storage, which in turn could cause unexpected storage oversubscription.

To determine the correct ephemeral storage capacity, query the Ceph service directly instead. For more information, see BZ#1236473.

hypervisor-uptime

Display the uptime of the specified hypervisor.

image-create

Create a new image by taking a snapshot of a running server.

image-delete

Delete specified image(s).

image-list

Print a list of available images to boot from.

image-meta

Set or Delete metadata on an image.

image-show

Show details about the given image.

interface-attach

Attach a network interface to a server.

interface-detach

Detach a network interface from a server.

interface-list

List interfaces attached to a server.

keypair-add

Create a new key pair for use with servers.

keypair-delete

Delete keypair given by its name.

keypair-list

Print a list of keypairs for a user

keypair-show

Show details about the given keypair.

list

List active servers.

list-secgroup

List Security Group(s) of a server.

live-migration

Migrate running server to a new machine.

lock

Lock a server. A normal (non-admin) user will not be able to execute actions on a locked server.

meta

Set or Delete metadata on a server.

migrate

Migrate a server. The new host will be selected by the scheduler.

network-associate-host

Associate host with network.

network-associate-project

Associate project with network.

network-create

Create a network.

network-delete

Delete network by label or id.

network-disassociate

Disassociate host and/or project from the given network.

network-list

Print a list of available networks.

network-show

Show details about the given network.

pause

Pause a server.

quota-class-show

List the quotas for a quota class.

quota-class-update

Update the quotas for a quota class.

quota-defaults

List the default quotas for a tenant.

quota-delete

Delete quota for a tenant/user so their quota will Revert back to default.

quota-show

List the quotas for a tenant/user.

quota-update

Update the quotas for a tenant/user.

rate-limits

Print a list of rate limits for a user

reboot

Reboot a server.

rebuild

Shutdown, re-image, and re-boot a server.

refresh-network

Refresh server network information.

remove-fixed-ip

Remove an IP address from a server.

remove-floating-ip

DEPRECATED, use floating-ip-disassociate instead.

remove-secgroup

Remove a Security Group from a server.

rename

Rename a server.

rescue

Reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary.

reset-network

Reset network of a server.

reset-state

Reset the state of a server.

resize

Resize a server.

resize-confirm

Confirm a previous resize.

resize-revert

Revert a previous resize (and return to the previous VM).

resume

Resume a server.

root-password

Change the admin password for a server.

scrub

Delete networks and security groups associated with a project.

secgroup-add-default-rule

Add a rule to the set of rules that will be added to the 'default' security group for new tenants.

secgroup-add-group-rule

Add a source group rule to a security group.

secgroup-add-rule

Add a rule to a security group.

secgroup-create

Create a security group.

secgroup-delete

Delete a security group.

secgroup-delete-default-rule

Delete a rule from the set of rules that will be added to the 'default' security group for new tenants.

secgroup-delete-group-rule

Delete a source group rule from a security group.

secgroup-delete-rule

Delete a rule from a security group.

secgroup-list

List security groups for the current tenant.

secgroup-list-default-rules

List rules that will be added to the 'default' security group for new tenants.

secgroup-list-rules

List rules for a security group.

secgroup-update

Update a security group.

server-group-create

Create a new server group with the specified details.

server-group-delete

Delete specific server group(s).

server-group-get

Get a specific server group.

server-group-list

Print a list of all server groups.

service-delete

Delete the service.

service-disable

Disable the service.

service-enable

Enable the service.

service-list

Show a list of all running services. Filter by host & binary.

shelve

Shelve a server.

shelve-offload

Remove a shelved server from the compute node.

show

Show details about the given server.

ssh

SSH into a server.

start

Start the server(s).

stop

Stop the server(s).

suspend

Suspend a server.

unlock

Unlock a server.

unpause

Unpause a server.

unrescue

Restart the server from normal boot disk again.

unshelve

Unshelve a server.

usage

Show usage data for a single tenant.

usage-list

List usage data for all tenants.

version-list

List all API versions.

volume-attach

Attach a volume to a server.

volume-create

Add a new volume.

volume-delete

Remove volume(s).

volume-detach

Detach a volume from a server.

volume-list

List all the volumes.

volume-show

Show details about a volume.

volume-snapshot-create

Add a new snapshot.

volume-snapshot-delete

Remove a snapshot.

volume-snapshot-list

List all the snapshots.

volume-snapshot-show

Show details about a snapshot.

volume-type-create

Create a new volume type.

volume-type-delete

Delete a specific volume type.

volume-type-list

Print a list of available 'volume types'.

volume-update

Update volume attachment.

x509-create-cert

Create x509 cert for a user in tenant.

x509-get-root-cert

Fetch the x509 root cert.

bash-completion

Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them.

help

Display help about this program or one of its subcommands.

baremetal-interface-add

Add a network interface to a baremetal node.

baremetal-interface-list

List network interfaces associated with a baremetal node.

baremetal-interface-remove

Remove a network interface from a baremetal node.

baremetal-node-create

Create a baremetal node.

baremetal-node-delete

Remove a baremetal node and any associated interfaces.

baremetal-node-list

Print list of available baremetal nodes.

baremetal-node-show

Show information about a baremetal node.

cell-capacities

Get cell capacities for all cells or a given cell.

cell-show

Show details of a given cell.

force-delete

Force delete a server.

restore

Restore a soft-deleted server.

host-evacuate

Evacuate all instances from failed host.

host-evacuate-live

Live migrate all instances of the specified host to other available hosts.

host-servers-migrate

Migrate all instances of the specified host to other available hosts.

instance-action

Show an action.

instance-action-list

List actions on a server.

list-extensions

List all the os-api extensions that are available.

host-meta

Set or Delete metadata on all instances of a host.

migration-list

Print a list of migrations.

net

DEPRECATED, Use tenant-network-show instead.

net-create

DEPRECATED, use tenant-network-create instead.

net-delete

DEPRECATED, use tenant-network-delete instead.

net-list

DEPRECATED, use tenant-network-list instead.

tenant-network-create

Create a tenant network.

tenant-network-delete

Delete a tenant network.

tenant-network-list

List tenant networks.

tenant-network-show

Show a tenant network.

--version

show program's version number and exit

--debug

Print debugging output

--os-cache

Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.

--timings

Print call timing info

--os-auth-token OS_AUTH_TOKEN

Defaults to env[OS_AUTH_TOKEN]

--os-tenant-name <auth-tenant-name>

Defaults to env[OS_TENANT_NAME].

--os-tenant-id <auth-tenant-id>

Defaults to env[OS_TENANT_ID].

--os-region-name <region-name>

Defaults to env[OS_REGION_NAME].

--os-auth-system <auth-system>

Defaults to env[OS_AUTH_SYSTEM].

--service-type <service-type>

Defaults to compute for most actions

--service-name <service-name>

Defaults to env[NOVA_SERVICE_NAME]

--volume-service-name <volume-service-name>

Defaults to env[NOVA_VOLUME_SERVICE_NAME]

--os-endpoint-type <endpoint-type>

Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or publicURL.

--os-compute-api-version <compute-api-ver>

Accepts 1.1 or 3, defaults to env[OS_COMPUTE_API_VERSION].

--bypass-url <bypass-url>

Use this API endpoint instead of the Service Catalog. Defaults to env[NOVACLIENT_BYPASS_URL]

--insecure

Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].

--os-cert <certificate>

Defaults to env[OS_CERT].

--os-key <key>

Defaults to env[OS_KEY].

--timeout <seconds>

Set request timeout (in seconds).

--os-auth-url OS_AUTH_URL

Authentication URL

--os-domain-id OS_DOMAIN_ID

Domain ID to scope to

--os-domain-name OS_DOMAIN_NAME

Domain name to scope to

--os-project-id OS_PROJECT_ID

Project ID to scope to

--os-project-name OS_PROJECT_NAME

Project name to scope to

--os-project-domain-id OS_PROJECT_DOMAIN_ID

Domain ID containing project

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

Domain name containing project

--os-trust-id OS_TRUST_ID

Trust ID

--os-user-id OS_USER_ID

User ID

--os-user-name OS_USERNAME, --os-username OS_USERNAME

Username

--os-user-domain-id OS_USER_DOMAIN_ID

User's domain id

--os-user-domain-name OS_USER_DOMAIN_NAME

User's domain name

--os-password OS_PASSWORD

User's password

Optional arguments

--tenant [<tenant>]

Display information from single tenant (Admin only).

--reserved

Include reservations count.

Positional arguments

<server>

Name or ID of server.

<network-id>

Network ID.

Positional arguments

<server>

Name or ID of server.

<secgroup>

Name of Security Group.

Positional arguments

<os>

type of os.

<architecture>

type of architecture

<version>

version

<url>

url

<md5hash>

md5 hash

<hypervisor>

type of hypervisor.

Positional arguments

<id>

id of the agent-build

Optional arguments

--hypervisor <hypervisor>

type of hypervisor.

Positional arguments

<id>

id of the agent-build

<version>

version

<url>

url

<md5hash>

md5hash

Positional arguments

<aggregate>

Name or ID of aggregate.

<host>

The host to add to the aggregate.

Positional arguments

<name>

Name of aggregate.

<availability-zone>

The availability zone of the aggregate (optional).

Positional arguments

<aggregate>

Name or ID of aggregate to delete.

Positional arguments

<aggregate>

Name or ID of aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate.

<host>

The host to remove from the aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate to update.

<key=value>

Metadata to add/update to aggregate. Specify only the key to delete a metadata item.

Positional arguments

<aggregate>

Name or ID of aggregate to update.

<name>

Name of aggregate.

<availability-zone>

The availability zone of the aggregate.

Positional arguments

<server>

Name or ID of server.

<name>

Name of the backup image.

<backup-type>

The backup type, like "daily" or "weekly".

<rotation>

Int parameter representing how many backups to keep around.

Positional arguments

<node>

ID of node

<address>

MAC address of interface

Optional arguments

--datapath_id <datapath_id>

OpenFlow Datapath ID of interface

--port_no <port_no>

OpenFlow port number of interface

Positional arguments

<node>

ID of node

Positional arguments

<node>

ID of node

<address>

MAC address of interface

Positional arguments

<service_host>

Name of nova compute host which will control this baremetal node

<cpus>

Number of CPUs in the node

<memory_mb>

Megabytes of RAM in the node

<local_gb>

Gigabytes of local storage in the node

<prov_mac_address>

MAC address to provision the node

Optional arguments

--pm_address <pm_address>

Power management IP for the node

--pm_user <pm_user>

Username for the node's power management

--pm_password <pm_password>

Password for the node's power management

--terminal_port <terminal_port>

ShellInABox port?

Positional arguments

<node>

ID of the node to delete.

Positional arguments

<node>

ID of node

Positional arguments

<name>

Name for the new server

Optional arguments

--flavor <flavor>

Name or ID of flavor (see 'nova flavor-list').

--image <image>

Name or ID of image (see 'nova image-list').

--image-with <key=value>

Image metadata property (see 'nova image- show').

--boot-volume <volume_id>

Volume ID to boot from.

--snapshot <snapshot_id>

Snapshot ID to boot from (will create a volume).

--min-count <number>

Boot at least <number> servers (limited by quota).

--max-count <number>

Boot up to <number> servers (limited by quota).

--meta <key=value>

Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times.

--file <dst-path=src-path>

Store arbitrary files from <src-path> locally to <dst-path> on the new server. Limited by the injected_files quota value.

--key-name <key-name>

Key name of keypair that should be created earlier with the command keypair-add

--user-data <user-data>

user data file to pass to be exposed by the metadata server.

--availability-zone <availability-zone>

The availability zone for server placement.

--security-groups <security-groups>

Comma separated list of security group names.

--block-device-mapping <dev-name=mapping>

Block device mapping in the format <dev- name>=<id>:<type>:<size(GB)>:<delete-on- terminate>.

--block-device

key1=value1[,key2=value2...] Block device mapping with the keys: id=UUID (image_id, snapshot_id or volume_id only if using source image, snapshot or volume) source=source type (image, snapshot, volume or blank), dest=destination type of the block device (volume or local), bus=device's bus (e.g. uml, lxc, virtio, ...; if omitted, hypervisor driver chooses a suitable default, honoured only if device type is supplied) type=device type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of the device (e.g. vda, xda, ...; if omitted, hypervisor driver chooses suitable device depending on selected bus), size=size of the block device in GB (if omitted, hypervisor driver calculates size), format=device will be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer used for ordering the boot disks (for image backed instances it is equal to 0, for others need to be specified) and shutdown=shutdown behaviour (either preserve or remove, for local destination set to remove).

--swap <swap_size>

Create and attach a local swap block device of <swap_size> MB.

--ephemeral

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

--hint <key=value>

Send arbitrary key/value pairs to the scheduler for custom use.

--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. net- id: attach NIC to network with this UUID (either port-id or net-id must be provided), v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: attach NIC to port with this UUID (either port-id or net-id must be provided).

--config-drive <value>

Enable config drive

--poll

Report the new server boot progress until it completes.

Optional arguments

--cell <cell-name>

Name of the cell to get the capacities.

Positional arguments

<cell-name>

Name of the cell.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<ip address>

New IP Address.

<port>

New Port.

Positional arguments

<project_id>

UUID of the project to create the cloudpipe for.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--length <length>

Length in lines to tail.

Optional arguments

--wrap <integer>

wrap PKI tokens to a specified length, or 0 to disable

Positional arguments

<server>

Name or ID of server(s).

Positional arguments

<server>

Name or ID of server.

Positional arguments

<ip>

IP address

<name>

DNS name

<domain>

DNS domain

Optional arguments

--type <type>

dns type (e.g. "A")

Positional arguments

<domain>

DNS domain

Optional arguments

--availability-zone <availability-zone>

Limit access to this domain to servers in the specified availability zone.

Positional arguments

<domain>

DNS domain

Optional arguments

--project <project>

Limit access to this domain to users of the specified project.

Positional arguments

<domain>

DNS domain

<name>

DNS name

Positional arguments

<domain>

DNS domain

Positional arguments

<domain>

DNS domain

Optional arguments

--ip <ip> IP

address

--name <name> DNS

name

Positional arguments

<server>

Name or ID of server.

<host>

Name or ID of the target host. If no host is specified, the scheduler will choose one.

Optional arguments

--password <password>

Set the provided admin password on the evacuated server. Not applicable with on-shared-storage flag

--on-shared-storage

Specifies whether server files are located on shared storage

Positional arguments

<fixed_ip>

Fixed IP Address.

Positional arguments

<fixed_ip>

Fixed IP Address.

Positional arguments

<fixed_ip>

Fixed IP Address.

Positional arguments

<flavor>

Flavor name or ID to add access for the given tenant.

<tenant_id>

Tenant ID to add flavor access for.

Optional arguments

--flavor <flavor>

Filter results by flavor name or ID.

--tenant <tenant_id>

Filter results by tenant ID.

Positional arguments

<flavor>

Flavor name or ID to remove access for the given tenant.

<tenant_id>

Tenant ID to remove flavor access for.

Positional arguments

<name>

Name of the new flavor

<id>

Unique ID (integer or UUID) for the new flavor. If specifying 'auto', a UUID will be generated as id

<ram>

Memory size in MB

<disk>

Disk size in GB

<vcpus>

Number of vcpus

Optional arguments

--ephemeral <ephemeral>

Ephemeral space size in GB (default 0)

--swap <swap>

Swap space size in MB (default 0)

--rxtx-factor <factor>

RX/TX factor (default 1)

--is-public <is-public>

Make flavor accessible to the public (default true)

Positional arguments

<flavor>

Name or ID of the flavor to delete

Positional arguments

<flavor>

Name or ID of flavor

<action>

Actions: 'set' or 'unset'

<key=value>

Extra_specs to set/unset (only key is necessary on unset)

Optional arguments

--extra-specs

Get extra-specs of each flavor.

--all

Display all flavors (Admin only).

Positional arguments

<flavor>

Name or ID of flavor

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

Optional arguments

--fixed-address <fixed_address>

Fixed IP Address to associate with.

Positional arguments

<range>

Address range to create

Optional arguments

--pool <pool>

Pool for new Floating IPs

--interface <interface>

Interface for new Floating IPs

Positional arguments

<range>

Address range to delete

Optional arguments

--host <host>

Filter by host

Positional arguments

<floating-ip-pool>

Name of Floating IP Pool. (Optional)

Positional arguments

<address>

IP of Floating IP.

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

Optional arguments

--all-tenants

Display floatingips from all tenants (Admin only).

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

<private-key>

Private key (used locally to decrypt password) (Optional). When specified, the command displays the clear (decrypted) VM password. When not specified, the ciphered VM password is displayed.

Positional arguments

<server>

Name or ID of server.

<console-type>

Type of rdp console ("rdp-html5").

Positional arguments

<server>

Name or ID of server.

Optional arguments

--console_type CONSOLE_TYPE

Type of serial console, default="serial".

Positional arguments

<server>

Name or ID of server.

<console-type>

Type of spice console ("spice-html5").

Positional arguments

<server>

Name or ID of server.

<console-type>

Type of vnc console ("novnc" or "xvpvnc").

Positional arguments

<hostname>

Name of host.

Optional arguments

--action <action> A

power action: startup, reboot, or shutdown.

Positional arguments

<hostname>

Name of host.

Positional arguments

<host>

Name of host.

Optional arguments

--target_host <target_host>

Name of target host. If no host is specified the scheduler will select a target.

--on-shared-storage

Specifies whether all instances files are on shared storage

Positional arguments

<host>

Name of host.

Optional arguments

--target-host <target_host>

Name of target host.

--block-migrate

Enable block migration.

--disk-over-commit

Enable disk overcommit.

Optional arguments

--zone <zone>

Filters the list, returning only those hosts in the availability zone <zone>.

Positional arguments

<host>

Name of host.

<action>

Actions: 'set' or 'delete'

<key=value>

Metadata to set or delete (only key is necessary on delete)

Positional arguments

<host>

Name of host.

Positional arguments

<hostname>

Name of host.

Optional arguments

--status <enable|disable>

Either enable or disable a host.

--maintenance <enable|disable>

Either put or resume host to/from maintenance.

Optional arguments

--matching <hostname>

List hypervisors matching the given <hostname>.

Positional arguments

<hostname>

The hypervisor hostname (or pattern) to search for.

Positional arguments

<hypervisor>

Name or ID of the hypervisor to show the details of.

Positional arguments

<hypervisor>

Name or ID of the hypervisor to show the uptime of.

Positional arguments

<server>

Name or ID of server.

<name>

Name of snapshot.

Optional arguments

--show

Print image info.

--poll

Report the snapshot progress and poll until image creation is complete.

Positional arguments

<image>

Name or ID of image(s).

Optional arguments

--limit <limit>

Number of images to return per request.

Positional arguments

<image>

Name or ID of image

<action>

Actions: 'set' or 'delete'

<key=value>

Metadata to add/update or delete (only key is necessary on delete)

Positional arguments

<image>

Name or ID of image

Positional arguments

<server>

Name or UUID of the server to show an action for.

<request_id>

Request ID of the action to get.

Positional arguments

<server>

Name or UUID of the server to list actions for.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--port-id <port_id>

Port ID.

--net-id <net_id>

Network ID

--fixed-ip <fixed_ip>

Requested fixed IP.

Positional arguments

<server>

Name or ID of server.

<port_id>

Port ID.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<name>

Name of key.

Optional arguments

--pub-key <pub-key>

Path to a public ssh key.

Positional arguments

<name>

Keypair name to delete.

Positional arguments

<keypair>

Name or ID of keypair

Optional arguments

--reservation-id <reservation-id>

Only return servers that match reservation-id.

--ip <ip-regexp>

Search with regular expression match by IP address.

--ip6 <ip6-regexp>

Search with regular expression match by IPv6 address.

--name <name-regexp>

Search with regular expression match by name

--instance-name <name-regexp>

Search with regular expression match by server name.

--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 servers by hostname to which they are assigned (Admin only).

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--tenant [<tenant>]

Display information from single tenant (Admin only). The --all-tenants option must also be provided.

--user [<user>]

Display information from single user (Admin only).

--deleted

Only display deleted servers (Admin only).

--fields <fields>

Comma-separated list of fields to display. Use the show command to see which fields are available.

--minimal

Get only uuid and name.

--sort <key>[:<direction>]

Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. The direction defaults to descending if not specified.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

<host>

destination host name.

Optional arguments

--block-migrate

True in case of block_migration. (Default=False:live_migration)

--disk-over-commit

Allow overcommit.(Default=False)

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server

<action>

Actions: 'set' or 'delete'

<key=value>

Metadata to set or delete (only key is necessary on delete)

Positional arguments

<server>

Name or ID of server.

Optional arguments

--poll

Report the server migration progress until it completes.

Optional arguments

--host <host>

Fetch migrations for the given host.

--status <status>

Fetch migrations for the given status.

--cell_name <cell_name>

Fetch migrations for the given cell_name.

Positional arguments

<network_id>

ID of network

Positional arguments

<network_label>

Network label (ex. my_new_network)

<cidr>

IP block to allocate from (ex. 172.16.0.0/24 or 2001:DB8::/64)

Positional arguments

<network_id>

ID of network

Positional arguments

<network>

uuid of network

<host>

Name of host

Positional arguments

<network>

uuid of network