Chapter 3. 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 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 to specified one.

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 for this tenant.

floating-ip-pool-list

List all floating ip pools.

get-password

Get password for a server.

get-rdp-console

Get a rdp 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.

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.

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

Rescue a server.

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 root password for a server.

scrub

Delete data associated with the project.

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

List rules for a security group.

secgroup-update

Update a security group.

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

stop

Stop a server.

suspend

Suspend a server.

unlock

Unlock a server.

unpause

Unpause a server.

unrescue

Unrescue a server.

unshelve

Unshelve a server.

usage

Show usage data for a single tenant.

usage-list

List usage data for all tenants.

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 flavor

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.

force-delete

Force delete a server.

restore

Restore a soft-deleted server.

net

Show a network

net-create

Create a network

net-delete

Delete a network

net-list

List networks

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.

host-evacuate

Evacuate all instances from failed host to specified one.

instance-action

Show an action.

instance-action-list

List actions on a server.

migration-list

Print a list of migrations.

host-servers-migrate

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

cell-capacities

Get cell capacities for all cells or a given cell.

cell-show

Show details of a given cell.

host-meta

Set or Delete metadata on all instances of a host.

list-extensions

List all the os-api extensions that are available.

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

--timeout <seconds>

Set HTTP call timeout (in seconds)

--os-auth-token OS_AUTH_TOKEN

Defaults to env[OS_AUTH_TOKEN]

--os-username <auth-user-name>

Defaults to env[OS_USERNAME].

--os-password <auth-password>

Defaults to env[OS_PASSWORD].

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

Defaults to env[OS_AUTH_URL].

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

--endpoint-type <endpoint-type>

Defaults to env[NOVA_ENDPOINT_TYPE] or publicURL.

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

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

--os-cacert <ca-certificate>

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

--insecure

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

--bypass-url <bypass-url>

Use this API endpoint instead of the Service Catalog

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

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

--num-instances <number>

boot multiple servers at a time (limited by quota).

--meta <key=value>

Record arbitrary key/value metadata to /meta.js on the new 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. You may store up to 5 files.

--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=image_id, snapshot_id or volume_id, source=source type (image, snapshot, volume or blank), dest=destination type of the block device (volume or local), bus=device's bus, device=name of the device (e.g. vda, xda, ...), size=size of the block device in GB, format=device will be formatted (e.g. swap, ext3, ntfs, ...), bootindex=integer used for ordering the boot disks, type=device type (e.g. disk, cdrom, ...) and shutdown=shutdown behaviour (either preserve or 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,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 (required if no port-id), v4 -fixed-ip: IPv4 fixed address for NIC (optional), port-id: attach NIC to port with this UUID (required if no net-id)

--config-drive <value>

Enable config drive

--poll

Blocks while server builds so progress can be reported.

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

Optional arguments

--password <password>

Set the provided 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.

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.

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

--on-shared-storage

Specifies whether all instances files are on shared storage

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

Blocks while server snapshots so progress can be reported.

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 (Admin only).

--ip6 <ip6-regexp>

Search with regular expression match by IPv6 address (Admin only).

--name <name-regexp>

Search with regular expression match by name

--instance-name <name-regexp>

Search with regular expression match by server 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 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).

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

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

Blocks while server migrates so progress can be reported.

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

Positional arguments

<network_label>

Label for network

Optional arguments

--fixed-range-v4 <x.x.x.x/yy>

IPv4 subnet (ex: 10.0.0.0/8)

--fixed-range-v6

CIDR_V6 IPv6 subnet (ex: fe80::/64

--vlan <vlan id>

vlan id

--vpn <vpn start>

vpn start

--gateway GATEWAY

gateway

--gateway-v6

GATEWAY_V6 ipv6 gateway

--bridge <bridge>

VIFs on this network are connected to this bridge

--bridge-interface <bridge interface>

the bridge is connected to this interface

--multi-host <'T'|'F'>

Multi host

--dns1 <DNS Address>

First DNS

--dns2 <DNS Address>

Second DNS

--uuid <network uuid>

Network UUID

--fixed-cidr <x.x.x.x/yy>

IPv4 subnet for fixed IPS (ex: 10.20.0.0/16)

--project-id <project id>

Project id

--priority <number>

Network interface priority

Positional arguments

<network>

uuid of network

Optional arguments

--host-only [<0|1>]

--project-only [<0|1>]

Positional arguments

<network>

uuid or label of network

Positional arguments

<server>

Name or ID of server.

Positional arguments

<class>

Name of quota class to list the quotas for.

Positional arguments

<class>

Name of quota class to set the quotas for.

Optional arguments

--instances <instances>

New value for the "instances" quota.

--cores <cores>

New value for the "cores" quota.

--ram <ram>

New value for the "ram" quota.

--floating-ips <floating-ips>

New value for the "floating-ips" quota.

--metadata-items <metadata-items>

New value for the "metadata-items" quota.

--injected-files <injected-files>

New value for the "injected-files" quota.

--injected-file-content-bytes <injected-file-content-bytes>

New value for the "injected-file-content-bytes" quota.

--injected-file-path-bytes <injected-file-path-bytes>

New value for the "injected-file-path-bytes" quota.

--key-pairs <key-pairs>

New value for the "key-pairs" quota.

--security-groups <security-groups>

New value for the "security-groups" quota.

--security-group-rules <security-group-rules>

New value for the "security-group-rules" quota.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the default quotas for.

Optional arguments

--tenant <tenant-id> ID

of tenant to delete quota for.

--user <user-id> ID

of user to delete quota for.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the quotas for.

--user <user-id> ID

of user to list the quotas for.

Positional arguments

<tenant-id>

ID of tenant to set the quotas for.

Optional arguments

--user <user-id> ID

of user to set the quotas for.

--instances <instances>

New value for the "instances" quota.

--cores <cores>

New value for the "cores" quota.

--ram <ram>

New value for the "ram" quota.

--floating-ips <floating-ips>

New value for the "floating-ips" quota.

--fixed-ips <fixed-ips>

New value for the "fixed-ips" quota.

--metadata-items <metadata-items>

New value for the "metadata-items" quota.

--injected-files <injected-files>

New value for the "injected-files" quota.

--injected-file-content-bytes <injected-file-content-bytes>

New value for the "injected-file-content-bytes" quota.

--injected-file-path-bytes <injected-file-path-bytes>

New value for the "injected-file-path-bytes" quota.

--key-pairs <key-pairs>

New value for the "key-pairs" quota.

--security-groups <security-groups>

New value for the "security-groups" quota.

--security-group-rules <security-group-rules>

New value for the "security-group-rules" quota.

--force

Whether force update the quota even if the already used and reserved exceeds the new quota

Positional arguments

<server>

Name or ID of server.

Optional arguments

--hard

Perform a hard reboot (instead of a soft one).

--poll

Blocks while server is rebooting.

Positional arguments

<server>

Name or ID of server.

<image>

Name or ID of new image.

Optional arguments

--rebuild-password <rebuild-password>

Set the provided password on the rebuild server.

--poll

Blocks while server rebuilds so progress can be reported.

--minimal

Skips flavor/image lookups when showing servers

--preserve-ephemeral

Preserve the default ephemeral storage partition on rebuild.

Positional arguments

<server>

Name or ID of a server for which the network cache should be refreshed from neutron (Admin only).

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

Positional arguments

<server>

Name or ID of server.

<secgroup>

Name of Security Group.

Positional arguments

<server>

Name (old name) or ID of server.

<name>

New name for the server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--active

Request the server be reset to "active" state instead of "error" state (the default).

Positional arguments

<server>

Name or ID of server.

<flavor>

Name or ID of new flavor.

Optional arguments

--poll

Blocks while servers resizes so progress can be reported.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<project_id>

The ID of the project.

Positional arguments

<secgroup>

ID or name of security group.

<source-group>

ID or name of source group.

<ip-proto>

IP protocol (icmp, tcp, udp).

<from-port>

Port at start of range.

<to-port>

Port at end of range.

Positional arguments

<secgroup>

ID or name of security group.

<ip-proto>

IP protocol (icmp, tcp, udp).

<from-port>

Port at start of range.

<to-port>

Port at end of range.

<cidr>

CIDR for address range.

Positional arguments

<name>

Name of security group.

<description>

Description of security group.

Positional arguments

<secgroup>

ID or name of security group.

Positional arguments

<secgroup>

ID or name of security group.

<source-group>

ID or name of source group.

<ip-proto>

IP protocol (icmp, tcp, udp).

<from-port>

Port at start of range.

<to-port>

Port at end of range.

Positional arguments

<secgroup>

ID or name of security group.

<ip-proto>

IP protocol (icmp, tcp, udp).

<from-port>

Port at start of range.

<to-port>

Port at end of range.

<cidr>

CIDR for address range.

Optional arguments

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

Display information from all tenants (Admin only).

Positional arguments

<secgroup>

ID or name of security group.

Positional arguments

<secgroup>

ID or name of security group.

<name>

Name of security group.

<description>

Description of security group.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

Optional arguments

--reason <reason>

Reason for disabling service.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

Optional arguments

--host <hostname>

Name of host.

--binary <binary>

Service binary.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--minimal

Skips flavor/image lookups when showing servers

Positional arguments

<server>

Name or ID of server.

Optional arguments

--port PORT

Optional flag to indicate which port to use for ssh. (Default=22)

--private

Optional flag to indicate whether to only use private address attached to an instance. (Default=False). If no public address is found try private address

--ipv6

Optional flag to indicate whether to use an IPv6 address attached to a server. (Defaults to IPv4 address)

--login <login>

Login to use.

-i IDENTITY, --identity IDENTITY

Private key file, same as the -i option to the ssh command.

--extra-opts EXTRA

Extra options to pass to ssh. see: man ssh

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--start <start>

Usage range start date ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

--tenant <tenant-id> UUID

or name of tenant to get usage for.

Optional arguments

--start <start>

Usage range start date ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

Positional arguments

<server>

Name or ID of server.

<volume>

ID of the volume to attach.

<device>

Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if supported)

Positional arguments

<size>

Size of volume in GB

Optional arguments

--snapshot-id <snapshot-id>

Optional snapshot id to create the volume from. (Default=None)

--image-id <image-id>

Optional image id to create the volume from. (Default=None)

--display-name <display-name>

Optional volume name. (Default=None)

--display-description <display-description>

Optional volume description. (Default=None)

--volume-type <volume-type>

Optional volume type. (Default=None)

--availability-zone <availability-zone>

Optional Availability Zone for volume. (Default=None)

Positional arguments

<volume>

Name or ID of the volume(s) to delete.

Positional arguments

<server>

Name or ID of server.

<volume>

Attachment ID of the volume.

Optional arguments

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

Display information from all tenants (Admin only).

Positional arguments

<volume>

Name or ID of the volume.

Positional arguments

<volume-id>

ID of the volume to snapshot

Optional arguments

--force <True|False>

Optional flag to indicate whether to snapshot a volume even if its attached to a server. (Default=False)

--display-name <display-name>

Optional snapshot name. (Default=None)

--display-description <display-description>

Optional snapshot description. (Default=None)

Positional arguments

<snapshot>

Name or ID of the snapshot to delete.

Positional arguments

<snapshot>

Name or ID of the snapshot.

Positional arguments

<name>

Name of the new flavor

Positional arguments

<id>

Unique ID of the volume type to delete

Positional arguments

<server>

Name or ID of server.

<volume>

Attachment ID of the volume.

<volume>

ID of the volume to attach.

Positional arguments

<private-key-filename>

Filename for the private key [Default: pk.pem]

<x509-cert-filename>

Filename for the X.509 certificate [Default: cert.pem]

Positional arguments

<filename>

Filename to write the x509 root cert.