Atom feed of this document
  
 

 Chapter 3. Compute command-line client

nova usage
nova optional arguments
nova absolute-limits command
nova add-fixed-ip command
nova add-secgroup command
nova agent-create command
nova agent-delete command
nova agent-list command
nova agent-modify command
nova aggregate-add-host command
nova aggregate-create command
nova aggregate-delete command
nova aggregate-details command
nova aggregate-list command
nova aggregate-remove-host command
nova aggregate-set-metadata command
nova aggregate-update command
nova availability-zone-list command
nova backup command
nova baremetal-interface-add command
nova baremetal-interface-list command
nova baremetal-interface-remove command
nova baremetal-node-create command
nova baremetal-node-delete command
nova baremetal-node-list command
nova baremetal-node-show command
nova boot command
nova cell-capacities command
nova cell-show command
nova clear-password command
nova cloudpipe-configure command
nova cloudpipe-create command
nova cloudpipe-list command
nova console-log command
nova credentials command
nova delete command
nova diagnostics command
nova dns-create command
nova dns-create-private-domain command
nova dns-create-public-domain command
nova dns-delete command
nova dns-delete-domain command
nova dns-domains command
nova dns-list command
nova endpoints command
nova evacuate command
nova fixed-ip-get command
nova fixed-ip-reserve command
nova fixed-ip-unreserve command
nova flavor-access-add command
nova flavor-access-list command
nova flavor-access-remove command
nova flavor-create command
nova flavor-delete command
nova flavor-key command
nova flavor-list command
nova flavor-show command
nova floating-ip-associate command
nova floating-ip-bulk-create command
nova floating-ip-bulk-delete command
nova floating-ip-bulk-list command
nova floating-ip-create command
nova floating-ip-delete command
nova floating-ip-disassociate command
nova floating-ip-list command
nova floating-ip-pool-list command
nova force-delete command
nova get-password command
nova get-rdp-console command
nova get-spice-console command
nova get-vnc-console command
nova host-action command
nova host-describe command
nova host-evacuate command
nova host-list command
nova host-meta command
nova host-servers-migrate command
nova host-update command
nova hypervisor-list command
nova hypervisor-servers command
nova hypervisor-show command
nova hypervisor-stats command
nova hypervisor-uptime command
nova image-create command
nova image-delete command
nova image-list command
nova image-meta command
nova image-show command
nova instance-action command
nova instance-action-list command
nova interface-attach command
nova interface-detach command
nova interface-list command
nova keypair-add command
nova keypair-delete command
nova keypair-list command
nova keypair-show command
nova list command
nova list-extensions command
nova list-secgroup command
nova live-migration command
nova lock command
nova meta command
nova migrate command
nova migration-list command
nova net command
nova net-create command
nova net-delete command
nova net-list command
nova network-associate-host command
nova network-associate-project command
nova network-create command
nova network-disassociate command
nova network-list command
nova network-show command
nova pause command
nova quota-class-show command
nova quota-class-update command
nova quota-defaults command
nova quota-delete command
nova quota-show command
nova quota-update command
nova rate-limits command
nova reboot command
nova rebuild command
nova refresh-network command
nova remove-fixed-ip command
nova remove-secgroup command
nova rename command
nova rescue command
nova reset-network command
nova reset-state command
nova resize command
nova resize-confirm command
nova resize-revert command
nova restore command
nova resume command
nova root-password command
nova scrub command
nova secgroup-add-group-rule command
nova secgroup-add-rule command
nova secgroup-create command
nova secgroup-delete command
nova secgroup-delete-group-rule command
nova secgroup-delete-rule command
nova secgroup-list command
nova secgroup-list-rules command
nova secgroup-update command
nova service-disable command
nova service-enable command
nova service-list command
nova shelve command
nova shelve-offload command
nova show command
nova ssh command
nova start command
nova stop command
nova suspend command
nova unlock command
nova unpause command
nova unrescue command
nova unshelve command
nova usage command
nova usage-list command
nova volume-attach command
nova volume-create command
nova volume-delete command
nova volume-detach command
nova volume-list command
nova volume-show command
nova volume-snapshot-create command
nova volume-snapshot-delete command
nova volume-snapshot-list command
nova volume-snapshot-show command
nova volume-type-create command
nova volume-type-delete command
nova volume-type-list command
nova volume-update command
nova x509-create-cert command
nova x509-get-root-cert command

The nova client is the command-line interface (CLI) for the OpenStack Compute API and its extensions. This chapter documents nova version 2.17.0.

For help on a specific nova command, enter:

$ nova help COMMAND

 nova usage

usage: nova [--version] [--debug] [--os-cache] [--timings]
            [--timeout <seconds>] [--os-auth-token OS_AUTH_TOKEN]
            [--os-username <auth-user-name>] [--os-password <auth-password>]
            [--os-tenant-name <auth-tenant-name>]
            [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
            [--os-region-name <region-name>] [--os-auth-system <auth-system>]
            [--service-type <service-type>] [--service-name <service-name>]
            [--volume-service-name <volume-service-name>]
            [--endpoint-type <endpoint-type>]
            [--os-compute-api-version <compute-api-ver>]
            [--os-cacert <ca-certificate>] [--insecure]
            [--bypass-url <bypass-url>]
            <subcommand> ...

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.

 nova optional arguments

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

 nova absolute-limits command

usage: nova absolute-limits [--tenant [<tenant>]] [--reserved]
        

Print a list of absolute limits for a user

Optional arguments

--tenant [<tenant>]

Display information from single tenant (Admin only).

--reserved

Include reservations count.

 nova add-fixed-ip command

usage: nova add-fixed-ip <server> <network-id>
        

Add new IP address on a network to server.

Positional arguments

<server>

Name or ID of server.

<network-id>

Network ID.

 nova add-secgroup command

usage: nova add-secgroup <server> <secgroup>
        

Add a Security Group to a server.

Positional arguments

<server>

Name or ID of server.

<secgroup>

Name of Security Group.

 nova agent-create command

usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
                         <hypervisor>
        

Create new agent build.

Positional arguments

<os>

type of os.

<architecture>

type of architecture

<version>

version

<url>

url

<md5hash>

md5 hash

<hypervisor>

type of hypervisor.

 nova agent-delete command

usage: nova agent-delete <id>
        

Delete existing agent build.

Positional arguments

<id>

id of the agent-build

 nova agent-list command

usage: nova agent-list [--hypervisor <hypervisor>]
        

List all builds.

Optional arguments

--hypervisor <hypervisor>

type of hypervisor.

 nova agent-modify command

usage: nova agent-modify <id> <version> <url> <md5hash>
        

Modify existing agent build.

Positional arguments

<id>

id of the agent-build

<version>

version

<url>

url

<md5hash>

md5hash

 nova aggregate-add-host command

usage: nova aggregate-add-host <aggregate> <host>
        

Add the host to the specified aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate.

<host>

The host to add to the aggregate.

 nova aggregate-create command

usage: nova aggregate-create <name> [<availability-zone>]
        

Create a new aggregate with the specified details.

Positional arguments

<name>

Name of aggregate.

<availability-zone>

The availability zone of the aggregate (optional).

 nova aggregate-delete command

usage: nova aggregate-delete <aggregate>
        

Delete the aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate to delete.

 nova aggregate-details command

usage: nova aggregate-details <aggregate>
        

Show details of the specified aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate.

 nova aggregate-list command

usage: nova aggregate-list
        

Print a list of all aggregates.

 nova aggregate-remove-host command

usage: nova aggregate-remove-host <aggregate> <host>
        

Remove the specified host from the specified aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate.

<host>

The host to remove from the aggregate.

 nova aggregate-set-metadata command

usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
        

Update the metadata associated with the aggregate.

Positional arguments

<aggregate>

Name or ID of aggregate to update.

<key=value>

Metadata to add/update to aggregate

 nova aggregate-update command

usage: nova aggregate-update <aggregate> <name> [<availability-zone>]
        

Update the aggregate's name and optionally availability zone.

Positional arguments

<aggregate>

Name or ID of aggregate to update.

<name>

Name of aggregate.

<availability-zone>

The availability zone of the aggregate.

 nova availability-zone-list command

usage: nova availability-zone-list
        

List all the availability zones.

 nova backup command

usage: nova backup <server> <name> <backup-type> <rotation>
        

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

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.

 nova baremetal-interface-add command

usage: nova baremetal-interface-add [--datapath_id <datapath_id>]
                                    [--port_no <port_no>]
                                    <node> <address>
        

Add a network interface to a baremetal node.

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

 nova baremetal-interface-list command

usage: nova baremetal-interface-list <node>
        

List network interfaces associated with a baremetal node.

Positional arguments

<node>

ID of node

 nova baremetal-interface-remove command

usage: nova baremetal-interface-remove <node> <address>
        

Remove a network interface from a baremetal node.

Positional arguments

<node>

ID of node

<address>

MAC address of interface

 nova baremetal-node-create command

usage: nova baremetal-node-create [--pm_address <pm_address>]
                                  [--pm_user <pm_user>]
                                  [--pm_password <pm_password>]
                                  [--terminal_port <terminal_port>]
                                  <service_host> <cpus> <memory_mb> <local_gb>
                                  <prov_mac_address>
        

Create a baremetal node.

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?

 nova baremetal-node-delete command

usage: nova baremetal-node-delete <node>
        

Remove a baremetal node and any associated interfaces.

Positional arguments

<node>

ID of the node to delete.

 nova baremetal-node-list command

usage: nova baremetal-node-list
        

Print list of available baremetal nodes.

 nova baremetal-node-show command

usage: nova baremetal-node-show <node>
        

Show information about a baremetal node.

Positional arguments

<node>

ID of node

 nova boot command

usage: nova boot [--flavor <flavor>] [--image <image>]
                 [--image-with <key=value>] [--boot-volume <volume_id>]
                 [--snapshot <snapshot_id>] [--num-instances <number>]
                 [--meta <key=value>] [--file <dst-path=src-path>]
                 [--key-name <key-name>] [--user-data <user-data>]
                 [--availability-zone <availability-zone>]
                 [--security-groups <security-groups>]
                 [--block-device-mapping <dev-name=mapping>]
                 [--block-device key1=value1[,key2=value2...]]
                 [--swap <swap_size>]
                 [--ephemeral size=<size>[,format=<format>]]
                 [--hint <key=value>]
                 [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>]
                 [--config-drive <value>] [--poll]
                 <name>
        

Boot a new server.

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.

 nova cell-capacities command

usage: nova cell-capacities [--cell <cell-name>]
        

Get cell capacities for all cells or a given cell.

Optional arguments

--cell <cell-name>

Name of the cell to get the capacities.

 nova cell-show command

usage: nova cell-show <cell-name>
        

Show details of a given cell.

Positional arguments

<cell-name>

Name of the cell.

 nova clear-password command

usage: nova clear-password <server>
        

Clear password for a server.

Positional arguments

<server>

Name or ID of server.

 nova cloudpipe-configure command

usage: nova cloudpipe-configure <ip address> <port>
        

Update the VPN IP/port of a cloudpipe instance.

Positional arguments

<ip address>

New IP Address.

<port>

New Port.

 nova cloudpipe-create command

usage: nova cloudpipe-create <project_id>
        

Create a cloudpipe instance for the given project.

Positional arguments

<project_id>

UUID of the project to create the cloudpipe for.

 nova cloudpipe-list command

usage: nova cloudpipe-list
        

Print a list of all cloudpipe instances.

 nova console-log command

usage: nova console-log [--length <length>] <server>
        

Get console log output of a server.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--length <length>

Length in lines to tail.

 nova credentials command

usage: nova credentials [--wrap <integer>]
        

Show user credentials returned from auth.

Optional arguments

--wrap <integer>

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

 nova delete command

usage: nova delete <server> [<server> ...]
        

Immediately shut down and delete specified server(s).

Positional arguments

<server>

Name or ID of server(s).

 nova diagnostics command

usage: nova diagnostics <server>
        

Retrieve server diagnostics.

Positional arguments

<server>

Name or ID of server.

 nova dns-create command

usage: nova dns-create [--type <type>] <ip> <name> <domain>
        

Create a DNS entry for domain, name and ip.

Positional arguments

<ip>

ip address

<name>

DNS name

<domain>

DNS domain

Optional arguments

--type <type>

dns type (e.g. "A")

 nova dns-create-private-domain command

usage: nova dns-create-private-domain
                                      [--availability-zone <availability-zone>]
                                      <domain>
        

Create the specified DNS domain.

Positional arguments

<domain>

DNS domain

Optional arguments

--availability-zone <availability-zone>

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

 nova dns-create-public-domain command

usage: nova dns-create-public-domain [--project <project>] <domain>
        

Create the specified DNS domain.

Positional arguments

<domain>

DNS domain

Optional arguments

--project <project>

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

 nova dns-delete command

usage: nova dns-delete <domain> <name>
        

Delete the specified DNS entry.

Positional arguments

<domain>

DNS domain

<name>

DNS name

 nova dns-delete-domain command

usage: nova dns-delete-domain <domain>
        

Delete the specified DNS domain.

Positional arguments

<domain>

DNS domain

 nova dns-domains command

usage: nova dns-domains
        

Print a list of available dns domains.

 nova dns-list command

usage: nova dns-list [--ip <ip>] [--name <name>] <domain>
        

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

Positional arguments

<domain>

DNS domain

Optional arguments

--ip <ip>

ip address

--name <name> DNS

name

 nova endpoints command

usage: nova endpoints
        

Discover endpoints that get returned from the authenticate services.

 nova evacuate command

usage: nova evacuate [--password <password>] [--on-shared-storage]
                     <server> <host>
        

Evacuate server from failed host to specified one.

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

 nova fixed-ip-get command

usage: nova fixed-ip-get <fixed_ip>
        

Retrieve info on a fixed ip.

Positional arguments

<fixed_ip>

Fixed IP Address.

 nova fixed-ip-reserve command

usage: nova fixed-ip-reserve <fixed_ip>
        

Reserve a fixed IP.

Positional arguments

<fixed_ip>

Fixed IP Address.

 nova fixed-ip-unreserve command

usage: nova fixed-ip-unreserve <fixed_ip>
        

Unreserve a fixed IP.

Positional arguments

<fixed_ip>

Fixed IP Address.

 nova flavor-access-add command

usage: nova flavor-access-add <flavor> <tenant_id>
        

Add flavor access for the given tenant.

Positional arguments

<flavor>

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

<tenant_id>

Tenant ID to add flavor access for.

 nova flavor-access-list command

usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]
        

Print access information about the given flavor.

Optional arguments

--flavor <flavor>

Filter results by flavor name or ID.

--tenant <tenant_id>

Filter results by tenant ID.

 nova flavor-access-remove command

usage: nova flavor-access-remove <flavor> <tenant_id>
        

Remove flavor access for the given tenant.

Positional arguments

<flavor>

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

<tenant_id>

Tenant ID to remove flavor access for.

 nova flavor-create command

usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
                          [--rxtx-factor <factor>] [--is-public <is-public>]
                          <name> <id> <ram> <disk> <vcpus>
        

Create a new flavor

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)

 nova flavor-delete command

usage: nova flavor-delete <flavor>
        

Delete a specific flavor

Positional arguments

<flavor>

Name or ID of the flavor to delete

 nova flavor-key command

usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
        

Set or unset extra_spec for a flavor.

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)

 nova flavor-list command

usage: nova flavor-list [--extra-specs] [--all]
        

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

Optional arguments

--extra-specs

Get extra-specs of each flavor.

--all

Display all flavors (Admin only).

 nova flavor-show command

usage: nova flavor-show <flavor>
        

Show details about the given flavor.

Positional arguments

<flavor>

Name or ID of flavor

 nova floating-ip-associate command

usage: nova floating-ip-associate [--fixed-address <fixed_address>]
                                  <server> <address>
        

Associate a floating IP address to a server.

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

Optional arguments

--fixed-address <fixed_address>

Fixed IP Address to associate with.

 nova floating-ip-bulk-create command

usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>]
                                    <range>
        

Bulk create floating ips by range.

Positional arguments

<range>

Address range to create

Optional arguments

--pool <pool>

Pool for new Floating IPs

--interface <interface>

Interface for new Floating IPs

 nova floating-ip-bulk-delete command

usage: nova floating-ip-bulk-delete <range>
        

Bulk delete floating ips by range.

Positional arguments

<range>

Address range to delete

 nova floating-ip-bulk-list command

usage: nova floating-ip-bulk-list [--host <host>]
        

List all floating ips.

Optional arguments

--host <host>

Filter by host

 nova floating-ip-create command

usage: nova floating-ip-create [<floating-ip-pool>]
        

Allocate a floating IP for the current tenant.

Positional arguments

<floating-ip-pool>

Name of Floating IP Pool. (Optional)

 nova floating-ip-delete command

usage: nova floating-ip-delete <address>
        

De-allocate a floating IP.

Positional arguments

<address>

IP of Floating Ip.

 nova floating-ip-disassociate command

usage: nova floating-ip-disassociate <server> <address>
        

Disassociate a floating IP address from a server.

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

 nova floating-ip-list command

usage: nova floating-ip-list
        

List floating ips for this tenant.

 nova floating-ip-pool-list command

usage: nova floating-ip-pool-list
        

List all floating ip pools.

 nova force-delete command

usage: nova force-delete <server>
        

Force delete a server.

Positional arguments

<server>

Name or ID of server.

 nova get-password command

usage: nova get-password <server> [<private-key>]
        

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

 nova get-rdp-console command

usage: nova get-rdp-console <server> <console-type>
        

Get a rdp console to a server.

Positional arguments

<server>

Name or ID of server.

<console-type>

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

 nova get-spice-console command

usage: nova get-spice-console <server> <console-type>
        

Get a spice console to a server.

Positional arguments

<server>

Name or ID of server.

<console-type>

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

 nova get-vnc-console command

usage: nova get-vnc-console <server> <console-type>
        

Get a vnc console to a server.

Positional arguments

<server>

Name or ID of server.

<console-type>

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

 nova host-action command

usage: nova host-action [--action <action>] <hostname>
        

Perform a power action on a host.

Positional arguments

<hostname>

Name of host.

Optional arguments

--action <action> A

power action: startup, reboot, or shutdown.

 nova host-describe command

usage: nova host-describe <hostname>
        

Describe a specific host.

Positional arguments

<hostname>

Name of host.

 nova host-evacuate command

usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage]
                          <host>
        

Evacuate all instances from failed host to specified one.

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

 nova host-list command

usage: nova host-list [--zone <zone>]
        

List all hosts by service.

Optional arguments

--zone <zone>

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

 nova host-meta command

usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
        

Set or Delete metadata on all instances of a host.

Positional arguments

<host>

Name of host.

<action>

Actions: 'set' or 'delete'

<key=value>

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

 nova host-servers-migrate command

usage: nova host-servers-migrate <host>
        

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

Positional arguments

<host>

Name of host.

 nova host-update command

usage: nova host-update [--status <enable|disable>]
                        [--maintenance <enable|disable>]
                        <hostname>
        

Update host settings.

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.

 nova hypervisor-list command

usage: nova hypervisor-list [--matching <hostname>]
        

List hypervisors.

Optional arguments

--matching <hostname>

List hypervisors matching the given <hostname>.

 nova hypervisor-servers command

usage: nova hypervisor-servers <hostname>
        

List servers belonging to specific hypervisors.

Positional arguments

<hostname>

The hypervisor hostname (or pattern) to search for.

 nova hypervisor-show command

usage: nova hypervisor-show <hypervisor>
        

Display the details of the specified hypervisor.

Positional arguments

<hypervisor>

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

 nova hypervisor-stats command

usage: nova hypervisor-stats
        

Get hypervisor statistics over all compute nodes.

 nova hypervisor-uptime command

usage: nova hypervisor-uptime <hypervisor>
        

Display the uptime of the specified hypervisor.

Positional arguments

<hypervisor>

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

 nova image-create command

usage: nova image-create [--show] [--poll] <server> <name>
        

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

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.

 nova image-delete command

usage: nova image-delete <image> [<image> ...]
        

Delete specified image(s).

Positional arguments

<image>

Name or ID of image(s).

 nova image-list command

usage: nova image-list [--limit <limit>]
        

Print a list of available images to boot from.

Optional arguments

--limit <limit>

number of images to return per request

 nova image-meta command

usage: nova image-meta <image> <action> <key=value> [<key=value> ...]
        

Set or Delete metadata on an image.

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)

 nova image-show command

usage: nova image-show <image>
        

Show details about the given image.

Positional arguments

<image>

Name or ID of image

 nova instance-action command

usage: nova instance-action <server> <request_id>
        

Show an action.

Positional arguments

<server>

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

<request_id>

Request ID of the action to get.

 nova instance-action-list command

usage: nova instance-action-list <server>
        

List actions on a server.

Positional arguments

<server>

Name or UUID of the server to list actions for.

 nova interface-attach command

usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
                             [--fixed-ip <fixed_ip>]
                             <server>
        

Attach a network interface to a server.

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.

 nova interface-detach command

usage: nova interface-detach <server> <port_id>
        

Detach a network interface from a server.

Positional arguments

<server>

Name or ID of server.

<port_id>

Port ID.

 nova interface-list command

usage: nova interface-list <server>
        

List interfaces attached to a server.

Positional arguments

<server>

Name or ID of server.

 nova keypair-add command

usage: nova keypair-add [--pub-key <pub-key>] <name>
        

Create a new key pair for use with servers.

Positional arguments

<name>

Name of key.

Optional arguments

--pub-key <pub-key>

Path to a public ssh key.

 nova keypair-delete command

usage: nova keypair-delete <name>
        

Delete keypair given by its name.

Positional arguments

<name>

Keypair name to delete.

 nova keypair-list command

usage: nova keypair-list
        

Print a list of keypairs for a user

 nova keypair-show command

usage: nova keypair-show <keypair>
        

Show details about the given keypair.

Positional arguments

<keypair>

Name or ID of keypair

 nova list command

usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>]
                 [--ip6 <ip6-regexp>] [--name <name-regexp>]
                 [--instance-name <name-regexp>] [--status <status>]
                 [--flavor <flavor>] [--image <image>] [--host <hostname>]
                 [--all-tenants [<0|1>]] [--tenant [<tenant>]] [--deleted]
                 [--fields <fields>] [--minimal]
        

List active servers.

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.

 nova list-extensions command

usage: nova list-extensions
        

List all the os-api extensions that are available.

 nova list-secgroup command

usage: nova list-secgroup <server>
        

List Security Group(s) of a server.

Positional arguments

<server>

Name or ID of server.

 nova live-migration command

usage: nova live-migration [--block-migrate] [--disk-over-commit]
                           <server> [<host>]
        

Migrate running server to a new machine.

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)

 nova lock command

usage: nova lock <server>
        

Lock a server.

Positional arguments

<server>

Name or ID of server.

 nova meta command

usage: nova meta <server> <action> <key=value> [<key=value> ...]
        

Set or Delete metadata on a 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)

 nova migrate command

usage: nova migrate [--poll] <server>
        

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

Positional arguments

<server>

Name or ID of server.

Optional arguments

--poll

Blocks while server migrates so progress can be reported.

 nova migration-list command

usage: nova migration-list [--host <host>] [--status <status>]
                           [--cell_name <cell_name>]
        

Print a list of migrations.

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.

 nova net command

usage: nova net <network_id>
        

Show a network

Positional arguments

<network_id>

ID of network

 nova net-create command

usage: nova net-create <network_label> <cidr>
        

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

 nova net-delete command

usage: nova net-delete <network_id>
        

Delete a network

Positional arguments

<network_id>

ID of network

 nova net-list command

usage: nova net-list
        

List networks

 nova network-associate-host command

usage: nova network-associate-host <network> <host>
        

Associate host with network.

Positional arguments

<network>

uuid of network

<host>

Name of host

 nova network-associate-project command

usage: nova network-associate-project <network>
        

Associate project with network.

Positional arguments

<network>

uuid of network

 nova network-create command

usage: nova network-create [--fixed-range-v4 <x.x.x.x/yy>]
                           [--fixed-range-v6 CIDR_V6] [--vlan <vlan id>]
                           [--vpn <vpn start>] [--gateway GATEWAY]
                           [--gateway-v6 GATEWAY_V6] [--bridge <bridge>]
                           [--bridge-interface <bridge interface>]
                           [--multi-host <'T'|'F'>] [--dns1 <DNS Address>]
                           [--dns2 <DNS Address>] [--uuid <network uuid>]
                           [--fixed-cidr <x.x.x.x/yy>]
                           [--project-id <project id>] [--priority <number>]
                           <network_label>
        

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

 nova network-disassociate command

usage: nova network-disassociate [--host-only [<0|1>]]
                                 [--project-only [<0|1>]]
                                 <network>
        

Disassociate host and/or project from the given network.

Positional arguments

<network>

uuid of network

Optional arguments

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

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

 nova network-list command

usage: nova network-list
        

Print a list of available networks.

 nova network-show command

usage: nova network-show <network>
        

Show details about the given network.

Positional arguments

<network>

uuid or label of network

 nova pause command

usage: nova pause <server>
        

Pause a server.

Positional arguments

<server>

Name or ID of server.

 nova quota-class-show command

usage: nova quota-class-show <class>
        

List the quotas for a quota class.

Positional arguments

<class>

Name of quota class to list the quotas for.

 nova quota-class-update command

usage: nova quota-class-update [--instances <instances>] [--cores <cores>]
                               [--ram <ram>] [--floating-ips <floating-ips>]
                               [--metadata-items <metadata-items>]
                               [--injected-files <injected-files>]
                               [--injected-file-content-bytes <injected-file-content-bytes>]
                               [--injected-file-path-bytes <injected-file-path-bytes>]
                               [--key-pairs <key-pairs>]
                               [--security-groups <security-groups>]
                               [--security-group-rules <security-group-rules>]
                               <class>
        

Update the quotas for a quota class.

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.

 nova quota-defaults command

usage: nova quota-defaults [--tenant <tenant-id>]
        

List the default quotas for a tenant.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the default quotas for.

 nova quota-delete command

usage: nova quota-delete [--tenant <tenant-id>] [--user <user-id>]
        

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

Optional arguments

--tenant <tenant-id> ID

of tenant to delete quota for.

--user <user-id> ID

of user to delete quota for.

 nova quota-show command

usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>]
        

List the quotas for a tenant/user.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the quotas for.

--user <user-id> ID

of user to list the quotas for.

 nova quota-update command

usage: nova quota-update [--user <user-id>] [--instances <instances>]
                         [--cores <cores>] [--ram <ram>]
                         [--floating-ips <floating-ips>]
                         [--fixed-ips <fixed-ips>]
                         [--metadata-items <metadata-items>]
                         [--injected-files <injected-files>]
                         [--injected-file-content-bytes <injected-file-content-bytes>]
                         [--injected-file-path-bytes <injected-file-path-bytes>]
                         [--key-pairs <key-pairs>]
                         [--security-groups <security-groups>]
                         [--security-group-rules <security-group-rules>]
                         [--force]
                         <tenant-id>
        

Update the quotas for a tenant/user.

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

 nova rate-limits command

usage: nova rate-limits
        

Print a list of rate limits for a user

 nova reboot command

usage: nova reboot [--hard] [--poll] <server>
        

Reboot a server.

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.

 nova rebuild command

usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
                    [--minimal] [--preserve-ephemeral]
                    <server> <image>
        

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

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.

 nova refresh-network command

usage: nova refresh-network <server>
        

Refresh server network information.

Positional arguments

<server>

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

 nova remove-fixed-ip command

usage: nova remove-fixed-ip <server> <address>
        

Remove an IP address from a server.

Positional arguments

<server>

Name or ID of server.

<address>

IP Address.

 nova remove-secgroup command

usage: nova remove-secgroup <server> <secgroup>
        

Remove a Security Group from a server.

Positional arguments

<server>

Name or ID of server.

<secgroup>

Name of Security Group.

 nova rename command

usage: nova rename <server> <name>
        

Rename a server.

Positional arguments

<server>

Name (old name) or ID of server.

<name>

New name for the server.

 nova rescue command

usage: nova rescue <server>
        

Rescue a server.

Positional arguments

<server>

Name or ID of server.

 nova reset-network command

usage: nova reset-network <server>
        

Reset network of a server.

Positional arguments

<server>

Name or ID of server.

 nova reset-state command

usage: nova reset-state [--active] <server>
        

Reset the state of a 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).

 nova resize command

usage: nova resize [--poll] <server> <flavor>
        

Resize a server.

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.

 nova resize-confirm command

usage: nova resize-confirm <server>
        

Confirm a previous resize.

Positional arguments

<server>

Name or ID of server.

 nova resize-revert command

usage: nova resize-revert <server>
        

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

Positional arguments

<server>

Name or ID of server.

 nova restore command

usage: nova restore <server>
        

Restore a soft-deleted server.

Positional arguments

<server>

Name or ID of server.

 nova resume command

usage: nova resume <server>
        

Resume a server.

Positional arguments

<server>

Name or ID of server.

 nova root-password command

usage: nova root-password <server>
        

Change the root password for a server.

Positional arguments

<server>

Name or ID of server.

 nova scrub command

usage: nova scrub <project_id>
        

Delete data associated with the project.

Positional arguments

<project_id>

The ID of the project.

 nova secgroup-add-group-rule command

usage: nova secgroup-add-group-rule <secgroup> <source-group> <ip-proto>
                                    <from-port> <to-port>
        

Add a source group rule to a 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.

 nova secgroup-add-rule command

usage: nova secgroup-add-rule <secgroup> <ip-proto> <from-port> <to-port>
                              <cidr>
        

Add a rule to a security group.

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.

 nova secgroup-create command

usage: nova secgroup-create <name> <description>
        

Create a security group.

Positional arguments

<name>

Name of security group.

<description>

Description of security group.

 nova secgroup-delete command

usage: nova secgroup-delete <secgroup>
        

Delete a security group.

Positional arguments

<secgroup>

ID or name of security group.

 nova secgroup-delete-group-rule command

usage: nova secgroup-delete-group-rule <secgroup> <source-group> <ip-proto>
                                       <from-port> <to-port>
        

Delete a source group rule from a 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.

 nova secgroup-delete-rule command

usage: nova secgroup-delete-rule <secgroup> <ip-proto> <from-port> <to-port>
                                 <cidr>
        

Delete a rule from a security group.

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.

 nova secgroup-list command

usage: nova secgroup-list [--all-tenants [<0|1>]]
        

List security groups for the current tenant.

Optional arguments

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

Display information from all tenants (Admin only).

 nova secgroup-list-rules command

usage: nova secgroup-list-rules <secgroup>
        

List rules for a security group.

Positional arguments

<secgroup>

ID or name of security group.

 nova secgroup-update command

usage: nova secgroup-update <secgroup> <name> <description>
        

Update a security group.

Positional arguments

<secgroup>

ID or name of security group.

<name>

Name of security group.

<description>

Description of security group.

 nova service-disable command

usage: nova service-disable [--reason <reason>] <hostname> <binary>
        

Disable the service.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

Optional arguments

--reason <reason>

Reason for disabling service.

 nova service-enable command

usage: nova service-enable <hostname> <binary>
        

Enable the service.

Positional arguments

<hostname>

Name of host.

<binary>

Service binary.

 nova service-list command

usage: nova service-list [--host <hostname>] [--binary <binary>]
        

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

Optional arguments

--host <hostname>

Name of host.

--binary <binary>

Service binary.

 nova shelve command

usage: nova shelve <server>
        

Shelve a server.

Positional arguments

<server>

Name or ID of server.

 nova shelve-offload command

usage: nova shelve-offload <server>
        

Remove a shelved server from the compute node.

Positional arguments

<server>

Name or ID of server.

 nova show command

usage: nova show [--minimal] <server>
        

Show details about the given server.

Positional arguments

<server>

Name or ID of server.

Optional arguments

--minimal

Skips flavor/image lookups when showing servers

 nova ssh command

usage: nova ssh [--port PORT] [--private] [--ipv6] [--login <login>]
                [-i IDENTITY] [--extra-opts EXTRA]
                <server>
        

SSH into a server.

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

 nova start command

usage: nova start <server>
        

Start a server.

Positional arguments

<server>

Name or ID of server.

 nova stop command

usage: nova stop <server>
        

Stop a server.

Positional arguments

<server>

Name or ID of server.

 nova suspend command

usage: nova suspend <server>
        

Suspend a server.

Positional arguments

<server>

Name or ID of server.

 nova unlock command

usage: nova unlock <server>
        

Unlock a server.

Positional arguments

<server>

Name or ID of server.

 nova unpause command

usage: nova unpause <server>
        

Unpause a server.

Positional arguments

<server>

Name or ID of server.

 nova unrescue command

usage: nova unrescue <server>
        

Unrescue a server.

Positional arguments

<server>

Name or ID of server.

 nova unshelve command

usage: nova unshelve <server>
        

Unshelve a server.

Positional arguments

<server>

Name or ID of server.

 nova usage command

usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
        

Show usage data for a single tenant.

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.

 nova usage-list command

usage: nova usage-list [--start <start>] [--end <end>]
        

List usage data for all tenants.

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)

 nova volume-attach command

usage: nova volume-attach <server> <volume> [<device>]
        

Attach a volume to a server.

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)

 nova volume-create command

usage: nova volume-create [--snapshot-id <snapshot-id>]
                          [--image-id <image-id>]
                          [--display-name <display-name>]
                          [--display-description <display-description>]
                          [--volume-type <volume-type>]
                          [--availability-zone <availability-zone>]
                          <size>
        

Add a new volume.

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)

 nova volume-delete command

usage: nova volume-delete <volume> [<volume> ...]
        

Remove volume(s).

Positional arguments

<volume>

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

 nova volume-detach command

usage: nova volume-detach <server> <volume>
        

Detach a volume from a server.

Positional arguments

<server>

Name or ID of server.

<volume>

Attachment ID of the volume.

 nova volume-list command

usage: nova volume-list [--all-tenants [<0|1>]]
        

List all the volumes.

Optional arguments

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

Display information from all tenants (Admin only).

 nova volume-show command

usage: nova volume-show <volume>
        

Show details about a volume.

Positional arguments

<volume>

Name or ID of the volume.

 nova volume-snapshot-create command

usage: nova volume-snapshot-create [--force <True|False>]
                                   [--display-name <display-name>]
                                   [--display-description <display-description>]
                                   <volume-id>
        

Add a new snapshot.

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)

 nova volume-snapshot-delete command

usage: nova volume-snapshot-delete <snapshot>
        

Remove a snapshot.

Positional arguments

<snapshot>

Name or ID of the snapshot to delete.

 nova volume-snapshot-list command

usage: nova volume-snapshot-list
        

List all the snapshots.

 nova volume-snapshot-show command

usage: nova volume-snapshot-show <snapshot>
        

Show details about a snapshot.

Positional arguments

<snapshot>

Name or ID of the snapshot.

 nova volume-type-create command

usage: nova volume-type-create <name>
        

Create a new volume type.

Positional arguments

<name>

Name of the new flavor

 nova volume-type-delete command

usage: nova volume-type-delete <id>
        

Delete a specific flavor

Positional arguments

<id>

Unique ID of the volume type to delete

 nova volume-type-list command

usage: nova volume-type-list
        

Print a list of available 'volume types'.

 nova volume-update command

usage: nova volume-update <server> <volume> <volume>
        

Update volume attachment.

Positional arguments

<server>

Name or ID of server.

<volume>

Attachment ID of the volume.

<volume>

ID of the volume to attach.

 nova x509-create-cert command

usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>]
        

Create x509 cert for a user in tenant.

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]

 nova x509-get-root-cert command

usage: nova x509-get-root-cert [<filename>]
        

Fetch the x509 root cert.

Positional arguments

<filename>

Filename to write the x509 root cert.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...