Merge "Update CLI reference for python-novaclient 3.1.0"
This commit is contained in:
commit
9973497f9a
@ -15,7 +15,7 @@
|
||||
interface (CLI) for the OpenStack Compute API and its extensions.
|
||||
|
||||
This chapter documents <command>nova</command> version
|
||||
<literal>2.35.0</literal>.
|
||||
<literal>3.1.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>nova</command>
|
||||
@ -26,24 +26,23 @@
|
||||
<section xml:id="novaclient_command_usage">
|
||||
<title>nova usage</title>
|
||||
<screen><computeroutput>usage: nova [--version] [--debug] [--os-cache] [--timings]
|
||||
[--os-auth-token OS_AUTH_TOKEN]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-tenant-id <auth-tenant-id>] [--os-region-name <region-name>]
|
||||
[--os-auth-system <auth-system>] [--service-type <service-type>]
|
||||
[--os-region-name <region-name>] [--service-type <service-type>]
|
||||
[--service-name <service-name>]
|
||||
[--volume-service-name <volume-service-name>]
|
||||
[--os-endpoint-type <endpoint-type>]
|
||||
[--os-compute-api-version <compute-api-ver>]
|
||||
[--bypass-url <bypass-url>] [--insecure]
|
||||
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
||||
[--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL]
|
||||
[--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
|
||||
[--os-project-id OS_PROJECT_ID]
|
||||
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
|
||||
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
|
||||
[--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
|
||||
[--os-project-name OS_PROJECT_NAME]
|
||||
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
|
||||
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
|
||||
[--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID]
|
||||
[--os-user-name OS_USERNAME]
|
||||
[--os-trust-id OS_TRUST_ID]
|
||||
[--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
|
||||
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
|
||||
[--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME]
|
||||
[--os-user-domain-id OS_USER_DOMAIN_ID]
|
||||
[--os-user-domain-name OS_USER_DOMAIN_NAME]
|
||||
[--os-password OS_PASSWORD]
|
||||
@ -513,6 +512,17 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>get-mks-console</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Get a serial 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]
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>get-password</command></term>
|
||||
<listitem>
|
||||
@ -706,7 +716,10 @@
|
||||
<term><command>keypair-delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Delete keypair given by its name.
|
||||
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]
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -714,7 +727,10 @@
|
||||
<term><command>keypair-list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print a list of keypairs for a user
|
||||
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]
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -723,6 +739,9 @@
|
||||
<listitem>
|
||||
<para>
|
||||
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]
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1205,7 +1224,9 @@
|
||||
<listitem>
|
||||
<para>
|
||||
Force service to down. (Supported by API
|
||||
versions '2.11' - '2.latest')
|
||||
versions '2.11' - '2.latest') [hint: use
|
||||
'--os-compute-api-version' flag to show help
|
||||
message for proper version]
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1339,6 +1360,15 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>virtual-interface-list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show virtual interface info about the given
|
||||
server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>volume-attach</command></term>
|
||||
<listitem>
|
||||
@ -1347,6 +1377,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>volume-attachments</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List all the volumes attached to a server
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>volume-create</command></term>
|
||||
<listitem>
|
||||
@ -1488,10 +1526,52 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>host-evacuate</command></term>
|
||||
<term><command>host-evacuate-live</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Evacuate all instances from failed host.
|
||||
Live migrate all instances of the specified
|
||||
host to other available hosts.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>cell-capacities</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Get cell capacities for all cells or a given
|
||||
cell.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>cell-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show details of a given cell.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>migration-list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print a list of migrations.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>instance-action</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show an action.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>instance-action-list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List actions on a server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1560,19 +1640,19 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>migration-list</command></term>
|
||||
<term><command>host-servers-migrate</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print a list of migrations.
|
||||
Migrate all instances of the specified host to
|
||||
other available hosts.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>list-extensions</command></term>
|
||||
<term><command>host-evacuate</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List all the os-api extensions that are
|
||||
available.
|
||||
Evacuate all instances from failed host.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1586,18 +1666,27 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>instance-action</command></term>
|
||||
<term><command>list-extensions</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show an action.
|
||||
List all the os-api extensions that are
|
||||
available.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>instance-action-list</command></term>
|
||||
<term><command>force-delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List actions on a server.
|
||||
Force delete a server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>restore</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Restore a soft-deleted server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -1660,57 +1749,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>force-delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Force delete a server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>restore</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Restore a soft-deleted server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>host-evacuate-live</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Live migrate all instances of the specified
|
||||
host to other available hosts.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>cell-capacities</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Get cell capacities for all cells or a given
|
||||
cell.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>cell-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show details of a given cell.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>host-servers-migrate</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Migrate all instances of the specified host to
|
||||
other available hosts.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_command_optional">
|
||||
@ -1749,30 +1787,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_AUTH_TOKEN]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-name <auth-tenant-name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_TENANT_ID]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-region-name <region-name></command></term>
|
||||
<listitem>
|
||||
@ -1781,14 +1795,6 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-system <auth-system></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--service-type <service-type></command></term>
|
||||
<listitem>
|
||||
@ -1843,152 +1849,10 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--insecure</command></term>
|
||||
<term><command>--os-auth-type <name>, --os-auth-plugin <name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Explicitly allow client to perform "insecure"
|
||||
TLS (https) requests. The server's certificate
|
||||
will not be verified against any certificate
|
||||
authorities. This option should be used with
|
||||
caution.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-cacert <ca-certificate></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify a CA bundle file to use in verifying a
|
||||
TLS (https) server certificate. Defaults to
|
||||
<code>env[OS_CACERT]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-cert <certificate></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_CERT]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-key <key></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_KEY]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--timeout <seconds></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set request timeout (in seconds).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-url OS_AUTH_URL</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Authentication URL
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-domain-id OS_DOMAIN_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Domain ID to scope to
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-domain-name OS_DOMAIN_NAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Domain name to scope to
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-project-id OS_PROJECT_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Project ID to scope to
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-project-name OS_PROJECT_NAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Project name to scope to
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-project-domain-id OS_PROJECT_DOMAIN_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Domain ID containing project
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-project-domain-name OS_PROJECT_DOMAIN_NAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Domain name containing project
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-trust-id OS_TRUST_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Trust ID
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-user-id OS_USER_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User ID
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-user-name OS_USERNAME, --os-username OS_USERNAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Username
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User's domain id
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User's domain name
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-password OS_PASSWORD</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User's password
|
||||
Authentication type to use
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2636,6 +2500,7 @@ Show information about a baremetal node.
|
||||
[--hint <key=value>]
|
||||
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>]
|
||||
[--config-drive <value>] [--poll] [--admin-pass <value>]
|
||||
[--access-ip-v4 <value>] [--access-ip-v6 <value>]
|
||||
<name></computeroutput></screen>
|
||||
<para>
|
||||
Boot a new server.
|
||||
@ -2794,16 +2659,18 @@ Boot a new server.
|
||||
defaults to 'disk') device=name of the device
|
||||
(e.g. vda, xda, ...; if omitted, hypervisor
|
||||
driver chooses suitable device depending on
|
||||
selected bus), size=size of the block device
|
||||
in 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).
|
||||
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).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2876,6 +2743,22 @@ Boot a new server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--access-ip-v4 <value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Alternative access ip v4 of the instance.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--access-ip-v6 <value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Alternative access ip v6 of the instance.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_cell-capacities">
|
||||
@ -3578,7 +3461,8 @@ Set or unset extra_spec for a flavor.
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_flavor-list">
|
||||
<title>nova flavor-list</title>
|
||||
<screen><computeroutput>usage: nova flavor-list [--extra-specs] [--all]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
|
||||
[--limit <limit>]</computeroutput></screen>
|
||||
<para>
|
||||
Print a list of available 'flavors' (sizes of servers).
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3599,6 +3483,26 @@ Print a list of available 'flavors' (sizes of servers).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--marker <marker></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The last flavor ID of the previous page; displays list of
|
||||
flavors after "marker".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--limit <limit></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_flavor-show">
|
||||
@ -3814,6 +3718,25 @@ Force delete a server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_get-mks-console">
|
||||
<title>nova get-mks-console</title>
|
||||
<screen><computeroutput>usage: nova get-mks-console <server></computeroutput></screen>
|
||||
<para>
|
||||
Get a serial 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]
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><server></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_get-password">
|
||||
@ -4553,7 +4476,9 @@ List interfaces attached to a server.
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_keypair-add">
|
||||
<title>nova keypair-add</title>
|
||||
<screen><computeroutput>usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>] <name></computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
|
||||
[--user <user-id>]
|
||||
<name></computeroutput></screen>
|
||||
<para>
|
||||
Create a new key pair for use with servers.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -4586,13 +4511,24 @@ Create a new key pair for use with servers.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--user <user-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of user to whom to add key-pair (Admin only).
|
||||
(Supported by API versions '2.10' - '2.latest')
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_keypair-delete">
|
||||
<title>nova keypair-delete</title>
|
||||
<screen><computeroutput>usage: nova keypair-delete <name></computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova keypair-delete [--user <user-id>] <name></computeroutput></screen>
|
||||
<para>
|
||||
Delete keypair given by its name.
|
||||
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]
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
@ -4603,20 +4539,45 @@ Delete keypair given by its name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--user <user-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Id of key-pair owner (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_keypair-list">
|
||||
<title>nova keypair-list</title>
|
||||
<screen><computeroutput>usage: nova keypair-list</computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova keypair-list [--user <user-id>]</computeroutput></screen>
|
||||
<para>
|
||||
Print a list of keypairs for a user
|
||||
</para>
|
||||
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]
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--user <user-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List key-pairs of specified user id (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_keypair-show">
|
||||
<title>nova keypair-show</title>
|
||||
<screen><computeroutput>usage: nova keypair-show <keypair></computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova keypair-show [--user <user-id>] <keypair></computeroutput></screen>
|
||||
<para>
|
||||
Show details about the given keypair.
|
||||
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]
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
@ -4627,6 +4588,17 @@ Show details about the given keypair.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--user <user-id></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Id of key-pair owner (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_limits">
|
||||
@ -6058,7 +6030,7 @@ Reset network of a server.
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_reset-state">
|
||||
<title>nova reset-state</title>
|
||||
<screen><computeroutput>usage: nova reset-state [--active] <server> [<server> ...]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Reset the state of a server.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -6074,12 +6046,20 @@ Reset the state of a server.
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--all-tenants</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Reset state server(s) in another tenant by name (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--active</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Request the server be reset to "active" state instead of "error"
|
||||
state (the default).
|
||||
Request the server be reset to "active" state instead of
|
||||
"error" state (the default).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -6765,7 +6745,8 @@ Enable the service.
|
||||
<title>nova service-force-down</title>
|
||||
<screen><computeroutput>usage: nova service-force-down [--unset] <hostname> <binary></computeroutput></screen>
|
||||
<para>
|
||||
Force service to down. (Supported by API versions '2.11' - '2.latest')
|
||||
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]
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
@ -6988,7 +6969,7 @@ SSH into a server.
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_start">
|
||||
<title>nova start</title>
|
||||
<screen><computeroutput>usage: nova start <server> [<server> ...]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova start [--all-tenants] <server> [<server> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Start the server(s).
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -7001,11 +6982,22 @@ Start the server(s).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--all-tenants</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Start server(s) in another tenant by name (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_stop">
|
||||
<title>nova stop</title>
|
||||
<screen><computeroutput>usage: nova stop <server> [<server> ...]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: nova stop [--all-tenants] <server> [<server> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Stop the server(s).
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -7018,6 +7010,17 @@ Stop the server(s).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--all-tenants</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Stop server(s) in another tenant by name (Admin only).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_suspend">
|
||||
@ -7240,6 +7243,23 @@ List usage data for all tenants.
|
||||
List all API versions.
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_virtual-interface-list">
|
||||
<title>nova virtual-interface-list</title>
|
||||
<screen><computeroutput>usage: nova virtual-interface-list <server></computeroutput></screen>
|
||||
<para>
|
||||
Show virtual interface info about the given server.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><server></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_volume-attach">
|
||||
<title>nova volume-attach</title>
|
||||
<screen><computeroutput>usage: nova volume-attach <server> <volume> [<device>]</computeroutput></screen>
|
||||
@ -7268,7 +7288,24 @@ Attach a volume to a server.
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if
|
||||
supported)
|
||||
supported). Libvirt driver will use default device name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_volume-attachments">
|
||||
<title>nova volume-attachments</title>
|
||||
<screen><computeroutput>usage: nova volume-attachments <server></computeroutput></screen>
|
||||
<para>
|
||||
List all the volumes attached to a server
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><server></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
Loading…
x
Reference in New Issue
Block a user