[cli-ref] Update python-novaclient to 7.0.0
Change-Id: I879034c6592342772cebb807e8dac589e34ae935
This commit is contained in:
@@ -9,7 +9,7 @@ Compute service (nova) command-line client
|
|||||||
The nova client is the command-line interface (CLI) for
|
The nova client is the command-line interface (CLI) for
|
||||||
the Compute service (nova) API and its extensions.
|
the Compute service (nova) API and its extensions.
|
||||||
|
|
||||||
This chapter documents :command:`nova` version ``6.0.0``.
|
This chapter documents :command:`nova` version ``7.0.0``.
|
||||||
|
|
||||||
For help on a specific :command:`nova` command, enter:
|
For help on a specific :command:`nova` command, enter:
|
||||||
|
|
||||||
@@ -29,7 +29,7 @@ nova usage
|
|||||||
[--service-name <service-name>]
|
[--service-name <service-name>]
|
||||||
[--os-endpoint-type <endpoint-type>]
|
[--os-endpoint-type <endpoint-type>]
|
||||||
[--os-compute-api-version <compute-api-ver>]
|
[--os-compute-api-version <compute-api-ver>]
|
||||||
[--bypass-url <bypass-url>] [--insecure]
|
[--endpoint-override <bypass-url>] [--insecure]
|
||||||
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
||||||
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
|
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
|
||||||
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
|
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
|
||||||
@@ -48,15 +48,9 @@ nova usage
|
|||||||
|
|
||||||
**Subcommands:**
|
**Subcommands:**
|
||||||
|
|
||||||
``absolute-limits``
|
|
||||||
**DEPRECATED**, use limits instead.
|
|
||||||
|
|
||||||
``add-fixed-ip``
|
``add-fixed-ip``
|
||||||
Add new IP address on a network to server.
|
Add new IP address on a network to server.
|
||||||
|
|
||||||
``add-floating-ip``
|
|
||||||
**DEPRECATED**, use floating-ip-associate instead.
|
|
||||||
|
|
||||||
``add-secgroup``
|
``add-secgroup``
|
||||||
Add a Security Group to a server.
|
Add a Security Group to a server.
|
||||||
|
|
||||||
@@ -82,9 +76,6 @@ nova usage
|
|||||||
``aggregate-delete``
|
``aggregate-delete``
|
||||||
Delete the aggregate.
|
Delete the aggregate.
|
||||||
|
|
||||||
``aggregate-details``
|
|
||||||
**DEPRECATED**, use aggregate-show instead.
|
|
||||||
|
|
||||||
``aggregate-list``
|
``aggregate-list``
|
||||||
Print a list of all aggregates.
|
Print a list of all aggregates.
|
||||||
|
|
||||||
@@ -113,6 +104,13 @@ nova usage
|
|||||||
``boot``
|
``boot``
|
||||||
Boot a new server.
|
Boot a new server.
|
||||||
|
|
||||||
|
``cell-capacities``
|
||||||
|
Get cell capacities for all cells or a given
|
||||||
|
cell.
|
||||||
|
|
||||||
|
``cell-show``
|
||||||
|
Show details of a given cell.
|
||||||
|
|
||||||
``clear-password``
|
``clear-password``
|
||||||
Clear the admin password for a server from the
|
Clear the admin password for a server from the
|
||||||
metadata server. This action does not actually
|
metadata server. This action does not actually
|
||||||
@@ -132,9 +130,6 @@ nova usage
|
|||||||
``console-log``
|
``console-log``
|
||||||
Get console log output of a server.
|
Get console log output of a server.
|
||||||
|
|
||||||
``credentials``
|
|
||||||
Show user credentials returned from auth.
|
|
||||||
|
|
||||||
``delete``
|
``delete``
|
||||||
Immediately shut down and delete specified
|
Immediately shut down and delete specified
|
||||||
server(s).
|
server(s).
|
||||||
@@ -166,10 +161,6 @@ nova usage
|
|||||||
**DEPRECATED**: List current DNS entries for
|
**DEPRECATED**: List current DNS entries for
|
||||||
domain and IP or domain and name.
|
domain and IP or domain and name.
|
||||||
|
|
||||||
``endpoints``
|
|
||||||
Discover endpoints that get returned from the
|
|
||||||
authenticate services.
|
|
||||||
|
|
||||||
``evacuate``
|
``evacuate``
|
||||||
Evacuate server from failed host.
|
Evacuate server from failed host.
|
||||||
|
|
||||||
@@ -239,6 +230,9 @@ nova usage
|
|||||||
``floating-ip-pool-list``
|
``floating-ip-pool-list``
|
||||||
**DEPRECATED**: List all floating IP pools.
|
**DEPRECATED**: List all floating IP pools.
|
||||||
|
|
||||||
|
``force-delete``
|
||||||
|
Force delete a server.
|
||||||
|
|
||||||
``get-mks-console``
|
``get-mks-console``
|
||||||
Get an MKS console to a server. (Supported by
|
Get an MKS console to a server. (Supported by
|
||||||
API versions '2.8' - '2.latest') [hint: use
|
API versions '2.8' - '2.latest') [hint: use
|
||||||
@@ -269,9 +263,24 @@ nova usage
|
|||||||
``host-describe``
|
``host-describe``
|
||||||
Describe a specific host.
|
Describe a specific host.
|
||||||
|
|
||||||
|
``host-evacuate``
|
||||||
|
Evacuate all instances from failed host.
|
||||||
|
|
||||||
|
``host-evacuate-live``
|
||||||
|
Live migrate all instances of the specified
|
||||||
|
host to other available hosts.
|
||||||
|
|
||||||
``host-list``
|
``host-list``
|
||||||
List all hosts by service.
|
List all hosts by service.
|
||||||
|
|
||||||
|
``host-meta``
|
||||||
|
Set or Delete metadata on all instances of a
|
||||||
|
host.
|
||||||
|
|
||||||
|
``host-servers-migrate``
|
||||||
|
Cold migrate all instances off the specified
|
||||||
|
host to other available hosts.
|
||||||
|
|
||||||
``host-update``
|
``host-update``
|
||||||
Update host settings.
|
Update host settings.
|
||||||
|
|
||||||
@@ -316,6 +325,12 @@ nova usage
|
|||||||
**DEPRECATED**: Show details about the given
|
**DEPRECATED**: Show details about the given
|
||||||
image.
|
image.
|
||||||
|
|
||||||
|
``instance-action``
|
||||||
|
Show an action.
|
||||||
|
|
||||||
|
``instance-action-list``
|
||||||
|
List actions on a server.
|
||||||
|
|
||||||
``interface-attach``
|
``interface-attach``
|
||||||
Attach a network interface to a server.
|
Attach a network interface to a server.
|
||||||
|
|
||||||
@@ -352,6 +367,10 @@ nova usage
|
|||||||
``list``
|
``list``
|
||||||
List active servers.
|
List active servers.
|
||||||
|
|
||||||
|
``list-extensions``
|
||||||
|
List all the os-api extensions that are
|
||||||
|
available.
|
||||||
|
|
||||||
``list-secgroup``
|
``list-secgroup``
|
||||||
List Security Group(s) of a server.
|
List Security Group(s) of a server.
|
||||||
|
|
||||||
@@ -390,6 +409,9 @@ nova usage
|
|||||||
Migrate a server. The new host will be
|
Migrate a server. The new host will be
|
||||||
selected by the scheduler.
|
selected by the scheduler.
|
||||||
|
|
||||||
|
``migration-list``
|
||||||
|
Print a list of migrations.
|
||||||
|
|
||||||
``network-associate-host``
|
``network-associate-host``
|
||||||
**DEPRECATED**: Associate host with network.
|
**DEPRECATED**: Associate host with network.
|
||||||
|
|
||||||
@@ -442,9 +464,6 @@ nova usage
|
|||||||
[hint: use ':option:`--os-compute-api-version`' flag to
|
[hint: use ':option:`--os-compute-api-version`' flag to
|
||||||
show help message for proper version]
|
show help message for proper version]
|
||||||
|
|
||||||
``rate-limits``
|
|
||||||
**DEPRECATED**, use limits instead.
|
|
||||||
|
|
||||||
``reboot``
|
``reboot``
|
||||||
Reboot a server.
|
Reboot a server.
|
||||||
|
|
||||||
@@ -457,16 +476,9 @@ nova usage
|
|||||||
``remove-fixed-ip``
|
``remove-fixed-ip``
|
||||||
Remove an IP address from a server.
|
Remove an IP address from a server.
|
||||||
|
|
||||||
``remove-floating-ip``
|
|
||||||
**DEPRECATED**, use floating-ip-disassociate
|
|
||||||
instead.
|
|
||||||
|
|
||||||
``remove-secgroup``
|
``remove-secgroup``
|
||||||
Remove a Security Group from a server.
|
Remove a Security Group from a server.
|
||||||
|
|
||||||
``rename``
|
|
||||||
**DEPRECATED**, use update instead.
|
|
||||||
|
|
||||||
``rescue``
|
``rescue``
|
||||||
Reboots a server into rescue mode, which
|
Reboots a server into rescue mode, which
|
||||||
starts the machine from either the initial
|
starts the machine from either the initial
|
||||||
@@ -489,12 +501,12 @@ nova usage
|
|||||||
Revert a previous resize (and return to the
|
Revert a previous resize (and return to the
|
||||||
previous VM).
|
previous VM).
|
||||||
|
|
||||||
|
``restore``
|
||||||
|
Restore a soft-deleted server.
|
||||||
|
|
||||||
``resume``
|
``resume``
|
||||||
Resume a server.
|
Resume a server.
|
||||||
|
|
||||||
``root-password``
|
|
||||||
**DEPRECATED**, use set-password instead.
|
|
||||||
|
|
||||||
``scrub``
|
``scrub``
|
||||||
**DEPRECATED**: Delete networks and security
|
**DEPRECATED**: Delete networks and security
|
||||||
groups associated with a project.
|
groups associated with a project.
|
||||||
@@ -734,44 +746,6 @@ nova usage
|
|||||||
**DEPRECATED**: Show information about a baremetal
|
**DEPRECATED**: Show information about a baremetal
|
||||||
node.
|
node.
|
||||||
|
|
||||||
``host-meta``
|
|
||||||
Set or Delete metadata on all instances of a
|
|
||||||
host.
|
|
||||||
|
|
||||||
``force-delete``
|
|
||||||
Force delete a server.
|
|
||||||
|
|
||||||
``restore``
|
|
||||||
Restore a soft-deleted server.
|
|
||||||
|
|
||||||
``cell-capacities``
|
|
||||||
Get cell capacities for all cells or a given
|
|
||||||
cell.
|
|
||||||
|
|
||||||
``cell-show``
|
|
||||||
Show details of a given cell.
|
|
||||||
|
|
||||||
``host-servers-migrate``
|
|
||||||
Cold migrate all instances off the specified
|
|
||||||
host to other available hosts.
|
|
||||||
|
|
||||||
``list-extensions``
|
|
||||||
List all the os-api extensions that are
|
|
||||||
available.
|
|
||||||
|
|
||||||
``host-evacuate-live``
|
|
||||||
Live migrate all instances of the specified
|
|
||||||
host to other available hosts.
|
|
||||||
|
|
||||||
``migration-list``
|
|
||||||
Print a list of migrations.
|
|
||||||
|
|
||||||
``instance-action``
|
|
||||||
Show an action.
|
|
||||||
|
|
||||||
``instance-action-list``
|
|
||||||
List actions on a server.
|
|
||||||
|
|
||||||
``net``
|
``net``
|
||||||
**DEPRECATED**, use tenant-network-show instead.
|
**DEPRECATED**, use tenant-network-show instead.
|
||||||
|
|
||||||
@@ -796,9 +770,6 @@ nova usage
|
|||||||
``tenant-network-show``
|
``tenant-network-show``
|
||||||
**DEPRECATED**: Show a tenant network.
|
**DEPRECATED**: Show a tenant network.
|
||||||
|
|
||||||
``host-evacuate``
|
|
||||||
Evacuate all instances from failed host.
|
|
||||||
|
|
||||||
.. _nova_command_options:
|
.. _nova_command_options:
|
||||||
|
|
||||||
nova optional arguments
|
nova optional arguments
|
||||||
@@ -835,10 +806,10 @@ nova optional arguments
|
|||||||
minor part) or "X.latest", defaults to
|
minor part) or "X.latest", defaults to
|
||||||
``env[OS_COMPUTE_API_VERSION]``.
|
``env[OS_COMPUTE_API_VERSION]``.
|
||||||
|
|
||||||
``--bypass-url <bypass-url>``
|
``--endpoint-override <bypass-url>``
|
||||||
Use this API endpoint instead of the Service
|
Use this API endpoint instead of the Service
|
||||||
Catalog. Defaults to
|
Catalog. Defaults to
|
||||||
``env[NOVACLIENT_BYPASS_URL]``.
|
``env[NOVACLIENT_ENDPOINT_OVERRIDE]``.
|
||||||
|
|
||||||
``--os-auth-type <name>, --os-auth-plugin <name>``
|
``--os-auth-type <name>, --os-auth-plugin <name>``
|
||||||
Authentication type to use
|
Authentication type to use
|
||||||
@@ -1444,22 +1415,6 @@ Get console log output of a server.
|
|||||||
``--length <length>``
|
``--length <length>``
|
||||||
Length in lines to tail.
|
Length in lines to tail.
|
||||||
|
|
||||||
.. _nova_credentials:
|
|
||||||
|
|
||||||
nova credentials
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
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:
|
.. _nova_delete:
|
||||||
|
|
||||||
nova delete
|
nova delete
|
||||||
@@ -1497,17 +1452,6 @@ Retrieve server diagnostics.
|
|||||||
``<server>``
|
``<server>``
|
||||||
Name or ID of server.
|
Name or ID of server.
|
||||||
|
|
||||||
.. _nova_endpoints:
|
|
||||||
|
|
||||||
nova endpoints
|
|
||||||
--------------
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: nova endpoints
|
|
||||||
|
|
||||||
Discover endpoints that get returned from the authenticate services.
|
|
||||||
|
|
||||||
.. _nova_evacuate:
|
.. _nova_evacuate:
|
||||||
|
|
||||||
nova evacuate
|
nova evacuate
|
||||||
@@ -1690,7 +1634,9 @@ nova flavor-list
|
|||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
|
usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
|
||||||
[--limit <limit>]
|
[--min-disk <min-disk>] [--min-ram <min-ram>]
|
||||||
|
[--limit <limit>] [--sort-key <sort-key>]
|
||||||
|
[--sort-dir <sort-dir>]
|
||||||
|
|
||||||
Print a list of available 'flavors' (sizes of servers).
|
Print a list of available 'flavors' (sizes of servers).
|
||||||
|
|
||||||
@@ -1703,14 +1649,25 @@ Print a list of available 'flavors' (sizes of servers).
|
|||||||
Display all flavors (Admin only).
|
Display all flavors (Admin only).
|
||||||
|
|
||||||
``--marker <marker>``
|
``--marker <marker>``
|
||||||
The last flavor ID of the previous page; displays list of
|
The last flavor ID of the previous page; displays
|
||||||
flavors after "marker".
|
list of flavors after "marker".
|
||||||
|
|
||||||
|
``--min-disk <min-disk>``
|
||||||
|
Filters the flavors by a minimum disk space, in GiB.
|
||||||
|
|
||||||
|
``--min-ram <min-ram>``
|
||||||
|
Filters the flavors by a minimum RAM, in MB.
|
||||||
|
|
||||||
``--limit <limit>``
|
``--limit <limit>``
|
||||||
Maximum number of flavors to display. If limit == -1, all
|
Maximum number of flavors to display. If limit is
|
||||||
flavors will be displayed. If limit is bigger than
|
bigger than 'CONF.api.max_limit' option of Nova API,
|
||||||
'osapi_max_limit' option of Nova API, limit
|
limit 'CONF.api.max_limit' will be used instead.
|
||||||
'osapi_max_limit' will be used instead.
|
|
||||||
|
``--sort-key <sort-key>``
|
||||||
|
Flavors list sort key.
|
||||||
|
|
||||||
|
``--sort-dir <sort-dir>``
|
||||||
|
Flavors list sort direction.
|
||||||
|
|
||||||
.. _nova_flavor-show:
|
.. _nova_flavor-show:
|
||||||
|
|
||||||
@@ -2129,10 +2086,9 @@ version]
|
|||||||
list of hypervisors after "marker".
|
list of hypervisors after "marker".
|
||||||
|
|
||||||
``--limit <limit>``
|
``--limit <limit>``
|
||||||
Maximum number of hypervisors to display. If limit ==
|
Maximum number of hypervisors to display. If limit is
|
||||||
-1, all hypervisors will be displayed. If limit is
|
bigger than 'CONF.api.max_limit' option of Nova API,
|
||||||
bigger than 'osapi_max_limit' option of Nova API,
|
limit 'CONF.api.max_limit' will be used instead.
|
||||||
limit 'osapi_max_limit' will be used instead.
|
|
||||||
|
|
||||||
.. _nova_hypervisor-servers:
|
.. _nova_hypervisor-servers:
|
||||||
|
|
||||||
@@ -2430,10 +2386,9 @@ for proper version]
|
|||||||
keypairs after "marker".
|
keypairs after "marker".
|
||||||
|
|
||||||
``--limit <limit>``
|
``--limit <limit>``
|
||||||
Maximum number of keypairs to display. If limit == -1,
|
Maximum number of keypairs to display. If limit is bigger
|
||||||
all keypairs will be displayed. If limit is bigger than
|
than 'CONF.api.max_limit' option of Nova API, limit
|
||||||
'osapi_max_limit' option of Nova API, limit
|
'CONF.api.max_limit' will be used instead.
|
||||||
'osapi_max_limit' will be used instead.
|
|
||||||
|
|
||||||
.. _nova_keypair-show:
|
.. _nova_keypair-show:
|
||||||
|
|
||||||
@@ -2574,9 +2529,9 @@ List active servers.
|
|||||||
``--limit <limit>``
|
``--limit <limit>``
|
||||||
Maximum number of servers to display. If limit
|
Maximum number of servers to display. If limit
|
||||||
== -1, all servers will be displayed. If limit
|
== -1, all servers will be displayed. If limit
|
||||||
is bigger than 'osapi_max_limit' option of
|
is bigger than 'CONF.api.max_limit' option of
|
||||||
Nova API, limit 'osapi_max_limit' will be used
|
Nova API, limit 'CONF.api.max_limit' will be
|
||||||
instead.
|
used instead.
|
||||||
|
|
||||||
``--changes-since <changes_since>``
|
``--changes-since <changes_since>``
|
||||||
List only servers changed after a certain
|
List only servers changed after a certain
|
||||||
@@ -3353,7 +3308,7 @@ nova server-group-create
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: nova server-group-create <name> [<policy> [<policy> ...]]
|
usage: nova server-group-create <name> <policy> [<policy> ...]
|
||||||
|
|
||||||
Create a new server group with the specified details.
|
Create a new server group with the specified details.
|
||||||
|
|
||||||
@@ -3404,12 +3359,22 @@ nova server-group-list
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: nova server-group-list [--all-projects]
|
usage: nova server-group-list [--limit <limit>] [--offset <offset>]
|
||||||
|
[--all-projects]
|
||||||
|
|
||||||
Print a list of all server groups.
|
Print a list of all server groups.
|
||||||
|
|
||||||
**Optional arguments:**
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``--limit <limit>``
|
||||||
|
Maximum number of server groups to display. If limit is
|
||||||
|
biggerthan 'CONF.api.max_limit' option of Nova API,
|
||||||
|
limit'CONF.api.max_limit' will be used instead.
|
||||||
|
|
||||||
|
``--offset <offset>``
|
||||||
|
The offset of groups list to display; use with limit to
|
||||||
|
return a slice of server groups.
|
||||||
|
|
||||||
``--all-projects``
|
``--all-projects``
|
||||||
Display server groups from all projects (Admin only).
|
Display server groups from all projects (Admin only).
|
||||||
|
|
||||||
@@ -3778,7 +3743,7 @@ nova show
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: nova show [--minimal] <server>
|
usage: nova show [--minimal] [--wrap <integer>] <server>
|
||||||
|
|
||||||
Show details about the given server.
|
Show details about the given server.
|
||||||
|
|
||||||
@@ -3792,6 +3757,9 @@ Show details about the given server.
|
|||||||
``--minimal``
|
``--minimal``
|
||||||
Skips flavor/image lookups when showing servers.
|
Skips flavor/image lookups when showing servers.
|
||||||
|
|
||||||
|
``--wrap <integer>``
|
||||||
|
Wrap the output to a specified length, or 0 to disable.
|
||||||
|
|
||||||
.. _nova_ssh:
|
.. _nova_ssh:
|
||||||
|
|
||||||
nova ssh
|
nova ssh
|
||||||
|
Reference in New Issue
Block a user