Subcommands

absolute-limits

        DEPRECATED, use limits instead.

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

        DEPRECATED, use aggregate-show instead.

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

        Show details of the specified aggregate.

aggregate-update

        Update the aggregate's name and optionally
      availability zone.

availability-zone-list

        List all the availability zones.

backup

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

boot

        Boot a new server.

clear-password

        Clear the admin password for a server from the
      metadata server. This action does not actually
      change the instance server password.

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

        DEPRECATED: Create a DNS entry for domain,
      name, and IP.

dns-create-private-domain

        DEPRECATED: Create the specified DNS domain.

dns-create-public-domain

        DEPRECATED: Create the specified DNS domain.

dns-delete

        DEPRECATED: Delete the specified DNS entry.

dns-delete-domain

        DEPRECATED: Delete the specified DNS domain.

dns-domains

        DEPRECATED: Print a list of available dns
      domains.

dns-list

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

endpoints

        Discover endpoints that get returned from the
      authenticate services.

evacuate

        Evacuate server from failed host.

fixed-ip-get

        DEPRECATED: Retrieve info on a fixed IP.

fixed-ip-reserve

        DEPRECATED: Reserve a fixed IP.

fixed-ip-unreserve

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

        DEPRECATED: Bulk create floating IPs by range
      (nova-network only).

floating-ip-bulk-delete

        DEPRECATED: Bulk delete floating IPs by range
      (nova-network only).

floating-ip-bulk-list

        DEPRECATED: List all floating IPs (nova-
      network only).

floating-ip-create

        DEPRECATED: Allocate a floating IP for the
      current tenant.

floating-ip-delete

        DEPRECATED: De-allocate a floating IP.

floating-ip-disassociate

        Disassociate a floating IP address from a
      server.

floating-ip-list

        DEPRECATED: List floating IPs.

floating-ip-pool-list

        DEPRECATED: List all floating IP pools.

get-mks-console

        Get an MKS console to a server. (Supported by
      API versions '2.8' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

get-password

        Get the admin password for a server. This
      operation calls the metadata service to query
      metadata information and does not read
      password information from the server itself.

get-rdp-console

        Get a rdp console to a server.

get-serial-console

        Get a serial console to a server.

get-spice-console

        Get a spice console to a server.

get-vnc-console

        Get a vnc console to a server.

host-action

        Perform a power action on a host.

host-describe

        Describe a specific host.

host-list

        List all hosts by service.

host-update

        Update host settings.

hypervisor-list

        List hypervisors. (Supported by API versions
      '2.0' - '2.latest') [hint: use '--os-compute-
      api-version' flag to show help message for
      proper version]

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

        DEPRECATED: Delete specified image(s).

image-list

        DEPRECATED: Print a list of available images
      to boot from.

image-meta

        DEPRECATED: Set or delete metadata on an
      image.

image-show

        DEPRECATED: 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. (Supported
      by API versions '2.0' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

keypair-list

        Print a list of keypairs for a user (Supported
      by API versions '2.0' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

keypair-show

        Show details about the given keypair.
      (Supported by API versions '2.0' - '2.latest')
      [hint: use '--os-compute-api-version' flag to
      show help message for proper version]

limits

        Print rate and absolute limits.

list

        List active servers.

list-secgroup

        List Security Group(s) of a server.

live-migration

        Migrate running server to a new machine.

live-migration-abort

        Abort an on-going live migration. (Supported
      by API versions '2.24' - '2.latest') [hint:
      use '--os-compute-api-version' flag to show
      help message for proper version]

live-migration-force-complete

      Force on-going live migration to complete.
      (Supported by API versions '2.22' -
      '2.latest') [hint: use '--os-compute-api-
      version' flag to show help message for proper
      version]

lock

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

meta

        Set or delete metadata on a server.

migrate

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

network-associate-host

        DEPRECATED: Associate host with network.

network-associate-project

        DEPRECATED: Associate project with network.

network-create

        DEPRECATED: Create a network.

network-delete

        DEPRECATED: Delete network by label or id.

network-disassociate

        DEPRECATED: Disassociate host and/or project
      from the given network.

network-list

        DEPRECATED: Print a list of available
      networks.

network-show

        DEPRECATED: 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.
      (Supported by API versions '2.0' - '2.latest')
      [hint: use '--os-compute-api-version' flag to
      show help message for proper version]

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.
      (Supported by API versions '2.0' - '2.latest')
      [hint: use '--os-compute-api-version' flag to
      show help message for proper version]

rate-limits

        DEPRECATED, use limits instead.

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

        DEPRECATED, use update instead.

rescue

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

reset-network

        Reset network of a server.

reset-state

        Reset the state of a server.

resize

        Resize a server.

resize-confirm

        Confirm a previous resize.

resize-revert

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

resume

        Resume a server.

root-password

        DEPRECATED, use set-password instead.

scrub

        DEPRECATED: Delete networks and security
      groups associated with a project.

secgroup-add-default-rule

        DEPRECATED: Add a rule to the set of rules
      that will be added to the 'default' security
      group for new tenants (nova-network only).

secgroup-add-group-rule

        DEPRECATED: Add a source group rule to a
      security group.

secgroup-add-rule

        DEPRECATED: Add a rule to a security group.

secgroup-create

        DEPRECATED: Create a security group.

secgroup-delete

        DEPRECATED: Delete a security group.

secgroup-delete-default-rule

      DEPRECATED: Delete a rule from the set of
      rules that will be added to the 'default'
      security group for new tenants (nova-network
      only).

secgroup-delete-group-rule

        DEPRECATED: Delete a source group rule from a
      security group.

secgroup-delete-rule

        DEPRECATED: Delete a rule from a security
      group.

secgroup-list

        DEPRECATED: List security groups for the
      current tenant.

secgroup-list-default-rules

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

secgroup-list-rules

        DEPRECATED: List rules for a security group.

secgroup-update

        DEPRECATED: Update a security group.

server-group-create

        Create a new server group with the specified
      details.

server-group-delete

        Delete specific server group(s).

server-group-get

        Get a specific server group.

server-group-list

        Print a list of all server groups.

server-migration-list

        Get the migrations list of specified server.
      (Supported by API versions '2.23' -
      '2.latest') [hint: use '--os-compute-api-
      version' flag to show help message for proper
      version]

server-migration-show

        Get the migration of specified server.
      (Supported by API versions '2.23' -
      '2.latest') [hint: use '--os-compute-api-
      version' flag to show help message for proper
      version]

server-tag-add

        Add single tag to a server. (Supported by API
      versions '2.26' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

server-tag-delete

        Delete single tag from a server. (Supported by
      API versions '2.26' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

server-tag-delete-all

        Delete all tags from a server. (Supported by
      API versions '2.26' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

server-tag-list

        Get list of tags from a server. (Supported by
      API versions '2.26' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

server-tag-set

        Set list of tags to a server. (Supported by
      API versions '2.26' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

service-delete

        Delete the service.

service-disable

        Disable the service.

service-enable

        Enable the service.

service-force-down

        Force service to down. (Supported by API
      versions '2.11' - '2.latest') [hint: use
      '--os-compute-api-version' flag to show help
      message for proper version]

service-list

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

set-password

        Change the admin password for a server.

shelve

        Shelve a server.

shelve-offload

        Remove a shelved server from the compute node.

show

        Show details about the given server.

ssh

        SSH into a server.

start

        Start the server(s).

stop

        Stop the server(s).

suspend

        Suspend a server.

trigger-crash-dump

        Trigger crash dump in an instance. (Supported
      by API versions '2.17' - '2.latest') [hint:
      use '--os-compute-api-version' flag to show
      help message for proper version]

unlock

        Unlock a server.

unpause

        Unpause a server.

unrescue

        Restart the server from normal boot disk
      again.

unshelve

        Unshelve a server.

update

        Update the name or the description for a
      server.

usage

        Show usage data for a single tenant.

usage-list

        List usage data for all tenants.

version-list

        List all API versions.

virtual-interface-list

        Show virtual interface info about the given
      server.

volume-attach

        Attach a volume to a server.

volume-attachments

        List all the volumes attached to a server.

volume-detach

        Detach a volume from a server.

volume-update

        Update volume attachment.

x509-create-cert

        Create x509 cert for a user in tenant.

x509-get-root-cert

        Fetch the x509 root cert.

bash-completion

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

help

        Display help about this program or one of its
      subcommands.

baremetal-interface-list

        DEPRECATED: List network interfaces associated
      with a baremetal node.

baremetal-node-list

        DEPRECATED: Print list of available baremetal
      nodes.

baremetal-node-show

        DEPRECATED: Show information about a baremetal
      node.

cell-capacities

        Get cell capacities for all cells or a given
      cell.

cell-show

        Show details of a given cell.

force-delete

        Force delete a server.

restore

        Restore a soft-deleted server.

host-evacuate

        Evacuate all instances from failed host.

host-evacuate-live

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

host-servers-migrate

        Cold migrate all instances off the specified
      host to other available hosts.

instance-action

        Show an action.

instance-action-list

        List actions on a server.

list-extensions

        List all the os-api extensions that are
      available.

host-meta

        Set or Delete metadata on all instances of a
      host.

migration-list

        Print a list of migrations.

net

        DEPRECATED, use tenant-network-show instead.

net-create

        DEPRECATED, use tenant-network-create instead.

net-delete

        DEPRECATED, use tenant-network-delete instead.

net-list

        DEPRECATED, use tenant-network-list instead.

tenant-network-create

        DEPRECATED: Create a tenant network.

tenant-network-delete

        DEPRECATED: Delete a tenant network.

tenant-network-list

        DEPRECATED: List tenant networks.

tenant-network-show

        DEPRECATED: Show a tenant network.

--version

        show program's version number and exit

--debug

        Print debugging output.

--os-cache

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

--timings

        Print call timing info.

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

      Defaults to env[OS_REGION_NAME].

--service-type <service-type>

      Defaults to compute for most actions.

--service-name <service-name>

      Defaults to env[NOVA_SERVICE_NAME].

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

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

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

      Accepts X, X.Y (where X is major and Y is
      minor part) or "X.latest", defaults to
      env[OS_COMPUTE_API_VERSION].

--bypass-url <bypass-url>

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

--os-auth-type <name>, --os-auth-plugin <name>

      Authentication type to use

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

        MD5 hash.

Positional arguments

<aggregate>

        Name or ID of aggregate.

<host>

        The host to add to the aggregate.

Positional arguments

<name>

        Name of aggregate.

<availability-zone>

        The availability zone of the aggregate (optional).

Positional arguments

<aggregate>

        Name or ID of aggregate to delete.

Positional arguments

<aggregate>

        Name or ID of aggregate.

Positional arguments

<aggregate>

        Name or ID of aggregate.

<host>

        The host to remove from the aggregate.

Positional arguments

<aggregate>

        Name or ID of aggregate to update.

<key=value>

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

Positional arguments

<aggregate>

        Name or ID of aggregate.

Positional arguments

<aggregate>

        Name or ID of aggregate to update.

Optional arguments

--name NAME

        Name of aggregate.

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

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 'glance image-list').

--image-with <key=value>

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

--boot-volume <volume_id>

        Volume ID to boot from.

--snapshot <snapshot_id>

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

--min-count <number>

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

--max-count <number>

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

--meta <key=value>

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

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

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

--key-name <key-name>

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

--user-data <user-data>

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

--availability-zone <availability-zone>

      The availability zone for server placement.

--security-groups <security-groups>

      Comma separated list of security group names.

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

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

--block-device

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

--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 <auto,none,net-id=net-uuid,net-name=network-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>

      Create a NIC on the server. Specify option
      multiple times to create multiple nics unless
      using the special 'auto' or 'none' values.
      auto: automatically allocate network resources
      if none are available. This cannot be
      specified with any other nic value and cannot
      be specified multiple times. none: do not
      attach a NIC at all. This cannot be specified
      with any other nic value and cannot be
      specified multiple times. net-id: attach NIC
      to network with a specific UUID. net-name:
      attach NIC to network with this name (either
      port-id or net-id or net-name must be
      provided), v4-fixed-ip: IPv4 fixed address for
      NIC (optional), v6-fixed-ip: IPv6 fixed
      address for NIC (optional), port-id: attach
      NIC to port with this UUID tag: interface
      metadata tag (optional) (either port-id or
      net-id must be provided). (Supported by API
      versions '2.37' - '2.latest')

--config-drive <value>

        Enable config drive.

--poll

        Report the new server boot progress until it
      completes.

--admin-pass <value>

        Admin password for the instance.

--access-ip-v4 <value>

        Alternative access IPv4 of the instance.

--access-ip-v6 <value>

        Alternative access IPv6 of the instance.

--description <description>

        Description for the server. (Supported by API
      versions '2.19' - '2.latest')

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

Optional arguments

--all-tenants

        Delete server(s) in another tenant by name (Admin only).

Positional arguments

<server>

        Name or ID of server.

Positional arguments

<ip>

        IP address.

<name>

        DNS name.

<domain>

        DNS domain.

Optional arguments

--type <type> DNS

        type (e.g. "A")

Positional arguments

<domain>

        DNS domain.

Optional arguments

--availability-zone <availability-zone>

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

Positional arguments

<domain>

        DNS domain.

Optional arguments

--project <project>

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

Positional arguments

<domain>

        DNS domain.

<name>

        DNS name.

Positional arguments

<domain>

        DNS domain.

Positional arguments

<domain>

        DNS domain.

Optional arguments

--ip <ip> IP

        address.

--name <name> DNS

        name.

Positional arguments

<server>

        Name or ID of server.

<host>

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

Optional arguments

--password <password>

        Set the provided admin password on the evacuated
      server. Not applicable if the server is on shared
      storage.

--force

        Force to not verify the scheduler if a host is
      provided. (Supported by API versions '2.29' -
      '2.latest')

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. (Deprecated; this option
      is not supported, and will be removed in version
      5.0.0.)

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>

        Unique name of the new flavor.

<id>

        Unique ID of the new flavor. Specifying 'auto' will
      generated a UUID for the 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).

--marker <marker>

        The last flavor ID of the previous page; displays list of
      flavors after "marker".

--limit <limit>

        Maximum number of flavors to display. If limit == -1, all
      flavors will be displayed. If limit is bigger than
      'osapi_max_limit' option of Nova API, limit
      'osapi_max_limit' will be used instead.

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.

Positional arguments

<server>

        Name or ID of server.

<private-key>

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

Positional arguments

<server>

        Name or ID of server.

<console-type>

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

Positional arguments

<server>

        Name or ID of server.

Optional arguments

--console-type CONSOLE_TYPE

        Type of serial console, default="serial".

Positional arguments

<server>

        Name or ID of server.

<console-type>

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

Positional arguments

<server>

        Name or ID of server.

<console-type>

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

Positional arguments

<hostname>

        Name of host.

Optional arguments

--action <action> A

        power action: startup, reboot, or shutdown.

Positional arguments

<hostname>

        Name of host.

Positional arguments

<host>

        Name of host.

Optional arguments

--target_host <target_host>

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

--force

        Force to not verify the scheduler if a host is
      provided. (Supported by API versions '2.29' -
      '2.latest')

Positional arguments

<host>

        Name of host.

Optional arguments

--target-host <target_host>

        Name of target host.

--block-migrate

        Enable block migration. (Default=auto)
      (Supported by API versions '2.25' - '2.latest')

--max-servers <max_servers>

        Maximum number of servers to live migrate
      simultaneously

--force

        Force to not verify the scheduler if a host is
      provided. (Supported by API versions '2.30' -
      '2.latest')

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>. If
      matching is used limit and marker options will be
      ignored.

--marker <marker>

        The last hypervisor of the previous page; displays
      list of hypervisors after "marker".

--limit <limit>

        Maximum number of hypervisors to display. If limit ==
      -1, all hypervisors will be displayed. If limit is
      bigger than 'osapi_max_limit' option of Nova API,
      limit 'osapi_max_limit' will be used instead.

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.

Optional arguments

--wrap <integer>

        Wrap the output to a specified length. Default is 40 or 0
      to disable

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

--metadata <key=value>

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

--show

        Print image info.

--poll

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

Positional arguments

<image>

        Name or ID of image(s).

Optional arguments

--limit <limit>

        Number of images to return per request.

Positional arguments

<image>

        Name or ID of image.

<action>

        Actions: 'set' or 'delete'.

<key=value>

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

Positional arguments

<image>

        Name or ID of image.

Positional arguments

<server>

        Name or UUID of the server to show actions for. Only UUID can
      be used to show actions for a deleted server. (Supported by
      API versions '2.21' - '2.latest')

<request_id>

        Request ID of the action to get.

Positional arguments

<server>

        Name or UUID of the server to list actions for. Only UUID can be
      used to list actions on a deleted server. (Supported by API
      versions '2.21' - '2.latest')

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.

--key-type <key-type>

        Keypair type. Can be ssh or x509. (Supported by API
      versions '2.2' - '2.latest')

--user <user-id> ID

        of user to whom to add key-pair (Admin only).
      (Supported by API versions '2.10' - '2.latest')

Positional arguments

<name>

        Keypair name to delete.

Optional arguments

--user <user-id> ID

        of key-pair owner (Admin only).

Optional arguments

--user <user-id>

        List key-pairs of specified user ID (Admin only).

--marker <marker>

        The last keypair of the previous page; displays list of
      keypairs after "marker".

--limit <limit>

        Maximum number of keypairs to display. If limit == -1,
      all keypairs will be displayed. If limit is bigger than
      'osapi_max_limit' option of Nova API, limit
      'osapi_max_limit' will be used instead.

Positional arguments

<keypair>

        Name of keypair.

Optional arguments

--user <user-id> ID

        of key-pair owner (Admin only).

Optional arguments

--tenant [<tenant>]

        Display information from single tenant (Admin only).

--reserved

        Include reservations count.

Optional arguments

--reservation-id <reservation-id>

      Only return servers that match reservation-id.

--ip <ip-regexp>

        Search with regular expression match by IP
      address.

--ip6 <ip6-regexp>

        Search with regular expression match by IPv6
      address.

--name <name-regexp>

        Search with regular expression match by name.

--instance-name <name-regexp>

      Search with regular expression match by server
      name.

--status <status>

        Search by server status.

--flavor <flavor>

        Search by flavor name or ID.

--image <image>

        Search by image name or ID.

--host <hostname>

        Search servers by hostname to which they are
      assigned (Admin only).

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

        Display information from all tenants (Admin
      only).

--tenant [<tenant>]

        Display information from single tenant (Admin
      only).

--user [<user>]

        Display information from single user (Admin
      only).

--deleted

        Only display deleted servers (Admin only).

--fields <fields>

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

--minimal

        Get only UUID and name.

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

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

--marker <marker>

        The last server UUID of the previous page;
      displays list of servers after "marker".

--limit <limit>

        Maximum number of servers to display. If limit
      == -1, all servers will be displayed. If limit
      is bigger than 'osapi_max_limit' option of
      Nova API, limit 'osapi_max_limit' will be used
      instead.

--changes-since <changes_since>

      List only servers changed after a certain
      point of time.The provided time should be an
      ISO 8061 formatted time.ex
      2016-03-04T06:27:59Z .

--tags <tags>

        The given tags must all be present for a
      server to be included in the list result.
      Boolean expression in this case is 't1 AND
      t2'. Tags must be separated by commas: --tags
      <tag1,tag2> (Supported by API versions '2.26'
      - '2.latest')

--tags-any <tags-any>

        If one of the given tags is present the server
      will be included in the list result. Boolean
      expression in this case is 't1 OR t2'. Tags
      must be separated by commas: --tags-any
      <tag1,tag2> (Supported by API versions '2.26'
      - '2.latest')

--not-tags <not-tags>

        Only the servers that do not have any of the
      given tags willbe included in the list
      results. Boolean expression in this case is
      'NOT(t1 AND t2)'. Tags must be separated by
      commas: --not-tags <tag1,tag2> (Supported by
      API versions '2.26' - '2.latest')

--not-tags-any <not-tags-any>

      Only the servers that do not have at least one
      of the given tagswill be included in the list
      result. Boolean expression in this case is
      'NOT(t1 OR t2)'. Tags must be separated by
      commas: --not-tags-any <tag1,tag2> (Supported
      by API versions '2.26' - '2.latest')

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=auto:live_migration) (Supported by API versions
      '2.25' - '2.latest')

--force

        Force to not verify the scheduler if a host is provided.
      (Supported by API versions '2.30' - '2.latest')

Positional arguments

<server>

        Name or ID of server.

<migration>

        ID of migration.

Positional arguments

<server>

        Name or ID of server.

<migration>

        ID of migration.

Positional arguments

<server>

        Name or ID of server.

Positional arguments

<server>

        Name or ID of server.

<action>

        Actions: 'set' or 'delete'.

<key=value>

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

Positional arguments

<server>

        Name or ID of server.

Optional arguments

--poll

        Report the server migration progress until it completes.

Optional arguments

--host <host>

        Fetch migrations for the given host.

--status <status>

        Fetch migrations for the given status.

--cell_name <cell_name>

        Fetch migrations for the given cell_name.

Positional arguments

<network_id>

        ID of network

Positional arguments

<network_label>

        Network label (ex. my_new_network)

<cidr>

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

Positional arguments

<network_id>

        ID of network

Positional arguments

<network>

        UUID of network.

<host>

        Name of host

Positional arguments

<network>

        UUID of network.

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>

        The vlan ID to be assigned to the project.

--vlan-start <vlan start>

        First vlan ID to be assigned to the project.
      Subsequent vlan IDs will be assigned
      incrementally.

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

--mtu MTU MTU

        for network.

--enable-dhcp <'T'|'F'>

        Enable DHCP.

--dhcp-server DHCP_SERVER

        DHCP-server address (defaults to gateway
      address)

--share-address <'T'|'F'>

        Share address

--allowed-start ALLOWED_START

      Start of allowed addresses for instances.

--allowed-end ALLOWED_END

        End of allowed addresses for instances.

Positional arguments

<network>

        UUID or label of network.

Positional arguments

<network>

        UUID of network.

Optional arguments

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

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

Optional arguments

--fields <fields>

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

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.

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

--server-groups <server-groups>

      New value for the "server-groups" quota.

--server-group-members <server-group-members>

      New value for the "server-group-members"
      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.

--detail

        Show detailed info (limit, reserved, in-use).

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.

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

--server-groups <server-groups>

      New value for the "server-groups" quota.

--server-group-members <server-group-members>

      New value for the "server-group-members"
      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(s).

Optional arguments

--hard

        Perform a hard reboot (instead of a soft one). Note: Ironic does
      not currently support soft reboot; consequently, bare metal nodes
      will always do a hard reboot, regardless of the use of this
      option.

--poll

        Poll until reboot is complete.

Positional arguments

<server>

        Name or ID of server.

<image>

        Name or ID of new image.

Optional arguments

--rebuild-password <rebuild-password>

      Set the provided admin password on the rebuilt
      server.

--poll

        Report the server rebuild progress until it
      completes.

--minimal

        Skips flavor/image lookups when showing
      servers.

--preserve-ephemeral

        Preserve the default ephemeral storage
      partition on rebuild.

--name <name>

        Name for the new server.

--description <description>

        New description for the server. (Supported by
      API versions '2.19' - '2.latest')

--meta <key=value>

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

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

        Store arbitrary files from <src-path> locally
      to <dst-path> on the new server. You may store
      up to 5 files.

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.

Optional arguments

--password <password>

        The admin password to be set in the rescue
      environment.

--image <image>

        The image to rescue with.

Positional arguments

<server>

        Name or ID of server.

Positional arguments

<server>

        Name or ID of server(s).

Optional arguments

--all-tenants

        Reset state server(s) in another tenant by name (Admin only).

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

        Report the server resize progress until it completes.

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

<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

<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

<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

<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

<name>

        Server group name.

<policy>

        Policies for the server groups.

Positional arguments

<id>

        Unique ID(s) of the server group to delete.

Positional arguments

<id>

        Unique ID of the server group to get.

Optional arguments

--all-projects

        Display server groups from all projects (Admin only).

Positional arguments

<server>

        Name or ID of server.

Positional arguments

<server>

        Name or ID of server.

<migration>

        ID of migration.

Positional arguments

<server>

        Name or ID of server.

<tag>

        Tag to add.

Positional arguments

<server>

        Name or ID of server.

<tag>

        Tag to delete.

Positional arguments

<server>

        Name or ID of server.

Positional arguments

<server>

        Name or ID of server.

Positional arguments