From df0bb18c614cd232cef43a02acd2f4e030a4df87 Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Fri, 2 Oct 2015 08:33:36 +0900 Subject: [PATCH] Update CLI reference for python-novaclient 2.31.0 Change-Id: I4b0f79e172f51d8bff76536e9b5e29ca5e3f4574 --- .../generated/ch_cli_nova_commands.xml | 221 +++++++++--------- 1 file changed, 112 insertions(+), 109 deletions(-) diff --git a/doc/cli-reference/generated/ch_cli_nova_commands.xml b/doc/cli-reference/generated/ch_cli_nova_commands.xml index 78b248c135..cd9bfe6131 100644 --- a/doc/cli-reference/generated/ch_cli_nova_commands.xml +++ b/doc/cli-reference/generated/ch_cli_nova_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the OpenStack Compute API and its extensions. This chapter documents nova version - 2.30.0. + 2.31.0. For help on a specific nova @@ -278,7 +278,7 @@ dns-create - Create a DNS entry for domain, name and IP. + Create a DNS entry for domain, name, and IP. @@ -401,7 +401,7 @@ flavor-create - Create a new flavor + Create a new flavor. @@ -1728,7 +1728,7 @@ --debug - Print debugging output + Print debugging output. @@ -1745,7 +1745,7 @@ --timings - Print call timing info + Print call timing info. @@ -1753,7 +1753,7 @@ --os-auth-token OS_AUTH_TOKEN - Defaults to env[OS_AUTH_TOKEN] + Defaults to env[OS_AUTH_TOKEN]. @@ -1793,7 +1793,7 @@ --service-type <service-type> - Defaults to compute for most actions + Defaults to compute for most actions. @@ -1801,7 +1801,7 @@ --service-name <service-name> - Defaults to env[NOVA_SERVICE_NAME] + Defaults to env[NOVA_SERVICE_NAME]. @@ -1809,7 +1809,7 @@ --volume-service-name <volume-service-name> - Defaults to env[NOVA_VOLUME_SERVICE_NAME] + Defaults to env[NOVA_VOLUME_SERVICE_NAME]. @@ -1838,7 +1838,7 @@ Use this API endpoint instead of the Service Catalog. Defaults to - env[NOVACLIENT_BYPASS_URL] + env[NOVACLIENT_BYPASS_URL]. @@ -2056,7 +2056,7 @@ Create new agent build. <os> - type of os. + Type of OS. @@ -2064,7 +2064,7 @@ Create new agent build. <architecture> - type of architecture + Type of architecture. @@ -2072,7 +2072,7 @@ Create new agent build. <version> - version + Version. @@ -2080,7 +2080,7 @@ Create new agent build. <url> - url + URL. @@ -2088,7 +2088,7 @@ Create new agent build. <md5hash> - md5 hash + MD5 hash. @@ -2096,7 +2096,7 @@ Create new agent build. <hypervisor> - type of hypervisor. + Type of hypervisor. @@ -2113,7 +2113,7 @@ Delete existing agent build. <id> - id of the agent-build + ID of the agent-build. @@ -2130,7 +2130,7 @@ List all builds. --hypervisor <hypervisor> - type of hypervisor. + Type of hypervisor. @@ -2147,7 +2147,7 @@ Modify existing agent build. <id> - id of the agent-build + ID of the agent-build. @@ -2155,7 +2155,7 @@ Modify existing agent build. <version> - version + Version. @@ -2163,7 +2163,7 @@ Modify existing agent build. <url> - url + URL @@ -2171,7 +2171,7 @@ Modify existing agent build. <md5hash> - md5hash + MD5 hash. @@ -2645,7 +2645,7 @@ Boot a new server. <name> - Name for the new server + Name for the new server. @@ -2737,7 +2737,7 @@ Boot a new server. Key name of keypair that should be created - earlier with the command keypair-add + earlier with the command keypair-add. @@ -2855,7 +2855,7 @@ Boot a new server. --config-drive <value> - Enable config drive + Enable config drive. @@ -2872,7 +2872,7 @@ Boot a new server. --admin-pass <value> - Admin password for the instance + Admin password for the instance. @@ -3017,7 +3017,7 @@ Show user credentials returned from auth. --wrap <integer> - wrap PKI tokens to a specified length, or 0 to disable + Wrap PKI tokens to a specified length, or 0 to disable. @@ -3072,14 +3072,14 @@ Retrieve server diagnostics. nova dns-create usage: nova dns-create [--type <type>] <ip> <name> <domain> -Create a DNS entry for domain, name and IP. +Create a DNS entry for domain, name, and IP. Positional arguments <ip> - IP address + IP address. @@ -3087,7 +3087,7 @@ Create a DNS entry for domain, name and IP. <name> - DNS name + DNS name. @@ -3095,7 +3095,7 @@ Create a DNS entry for domain, name and IP. <domain> - DNS domain + DNS domain. @@ -3106,7 +3106,7 @@ Create a DNS entry for domain, name and IP. --type <type> - dns type (e.g. "A") + DNS type (e.g. "A") @@ -3125,7 +3125,7 @@ Create the specified DNS domain. <domain> - DNS domain + DNS domain. @@ -3154,7 +3154,7 @@ Create the specified DNS domain. <domain> - DNS domain + DNS domain. @@ -3183,7 +3183,7 @@ Delete the specified DNS entry. <domain> - DNS domain + DNS domain. @@ -3191,7 +3191,7 @@ Delete the specified DNS entry. <name> - DNS name + DNS name. @@ -3208,7 +3208,7 @@ Delete the specified DNS domain. <domain> - DNS domain + DNS domain. @@ -3232,7 +3232,7 @@ List current DNS entries for domain and IP or domain and name. <domain> - DNS domain + DNS domain. @@ -3243,7 +3243,7 @@ List current DNS entries for domain and IP or domain and name. --ip <ip> - IP address + IP address. @@ -3251,7 +3251,7 @@ List current DNS entries for domain and IP or domain and name. --name <name> - DNS name + DNS name. @@ -3297,7 +3297,7 @@ Evacuate server from failed host. Set the provided admin password on the evacuated - server. Not applicable with on-shared-storage flag + server. Not applicable with on-shared-storage flag. @@ -3306,7 +3306,7 @@ Evacuate server from failed host. Specifies whether server files are located on shared - storage + storage. @@ -3444,14 +3444,14 @@ Remove flavor access for the given tenant. [--rxtx-factor <factor>] [--is-public <is-public>] <name> <id> <ram> <disk> <vcpus> -Create a new flavor +Create a new flavor. Positional arguments <name> - Name of the new flavor + Name of the new flavor. @@ -3460,7 +3460,7 @@ Create a new flavor Unique ID (integer or UUID) for the new flavor. If - specifying 'auto', a UUID will be generated as id + specifying 'auto', a UUID will be generated as ID. @@ -3468,7 +3468,7 @@ Create a new flavor <ram> - Memory size in MB + Memory size in MB. @@ -3476,7 +3476,7 @@ Create a new flavor <disk> - Disk size in GB + Disk size in GB. @@ -3495,7 +3495,7 @@ Create a new flavor --ephemeral <ephemeral> - Ephemeral space size in GB (default 0) + Ephemeral space size in GB (default 0). @@ -3503,7 +3503,7 @@ Create a new flavor --swap <swap> - Swap space size in MB (default 0) + Swap space size in MB (default 0). @@ -3511,7 +3511,7 @@ Create a new flavor --rxtx-factor <factor> - RX/TX factor (default 1) + RX/TX factor (default 1). @@ -3519,7 +3519,8 @@ Create a new flavor --is-public <is-public> - Make flavor accessible to the public (default true) + Make flavor accessible to the public (default + true). @@ -3536,7 +3537,7 @@ Delete a specific flavor <flavor> - Name or ID of the flavor to delete + Name or ID of the flavor to delete. @@ -3553,7 +3554,7 @@ Set or unset extra_spec for a flavor. <flavor> - Name or ID of flavor + Name or ID of flavor. @@ -3561,7 +3562,7 @@ Set or unset extra_spec for a flavor. <action> - Actions: 'set' or 'unset' + Actions: 'set' or 'unset'. @@ -3569,7 +3570,7 @@ Set or unset extra_spec for a flavor. <key=value> - Extra_specs to set/unset (only key is necessary on unset) + Extra_specs to set/unset (only key is necessary on unset). @@ -3611,7 +3612,7 @@ Show details about the given flavor. <flavor> - Name or ID of flavor + Name or ID of flavor. @@ -3666,7 +3667,7 @@ Bulk create floating IPs by range (nova-network only). <range> - Address range to create + Address range to create. @@ -3677,7 +3678,7 @@ Bulk create floating IPs by range (nova-network only). --pool <pool> - Pool for new Floating IPs + Pool for new Floating IPs. @@ -3685,7 +3686,7 @@ Bulk create floating IPs by range (nova-network only). --interface <interface> - Interface for new Floating IPs + Interface for new Floating IPs. @@ -3702,7 +3703,7 @@ Bulk delete floating IPs by range (nova-network only). <range> - Address range to delete + Address range to delete. @@ -3719,7 +3720,7 @@ List all floating IPs (nova-network only). --host <host> - Filter by host + Filter by host. @@ -4369,7 +4370,7 @@ Set or Delete metadata on an image. <image> - Name or ID of image + Name or ID of image. @@ -4377,7 +4378,7 @@ Set or Delete metadata on an image. <action> - Actions: 'set' or 'delete' + Actions: 'set' or 'delete'. @@ -4386,7 +4387,7 @@ Set or Delete metadata on an image. Metadata to add/update or delete (only key is necessary on - delete) + delete). @@ -4403,7 +4404,7 @@ Show details about the given image. <image> - Name or ID of image + Name or ID of image. @@ -4686,7 +4687,7 @@ List active servers. --name <name-regexp> - Search with regular expression match by name + Search with regular expression match by name. @@ -4703,7 +4704,7 @@ List active servers. --status <status> - Search by server status + Search by server status. @@ -4711,7 +4712,7 @@ List active servers. --flavor <flavor> - Search by flavor name or ID + Search by flavor name or ID. @@ -4719,7 +4720,7 @@ List active servers. --image <image> - Search by image name or ID + Search by image name or ID. @@ -4781,7 +4782,7 @@ List active servers. --minimal - Get only uuid and name. + Get only UUID and name. @@ -4800,7 +4801,7 @@ List active servers. --marker <marker> - The last server uuid of the previous page; + The last server UUID of the previous page; displays list of servers after "marker". @@ -4863,7 +4864,7 @@ Migrate running server to a new machine. <host> - destination host name. + Destination host name. @@ -4883,7 +4884,7 @@ Migrate running server to a new machine. --disk-over-commit - Allow overcommit.(Default=False) + Allow overcommit. (Default=False) @@ -4918,7 +4919,7 @@ Set or Delete metadata on a server. <server> - Name or ID of server + Name or ID of server. @@ -4926,7 +4927,7 @@ Set or Delete metadata on a server. <action> - Actions: 'set' or 'delete' + Actions: 'set' or 'delete'. @@ -4934,7 +4935,7 @@ Set or Delete metadata on a server. <key=value> - Metadata to set or delete (only key is necessary on delete) + Metadata to set or delete (only key is necessary on delete). @@ -5013,7 +5014,7 @@ Associate host with network. <network> - uuid of network + UUID of network. @@ -5038,7 +5039,7 @@ Associate project with network. <network> - uuid of network + UUID of network. @@ -5164,7 +5165,7 @@ Create a network. --dns1 <DNS Address> - First DNS + First DNS. @@ -5172,7 +5173,7 @@ Create a network. --dns2 <DNS Address> - Second DNS + Second DNS. @@ -5180,7 +5181,7 @@ Create a network. --uuid <network uuid> - Network UUID + Network UUID. @@ -5188,7 +5189,7 @@ Create a network. --fixed-cidr <x.x.x.x/yy> - IPv4 subnet for fixed IPs (ex: 10.20.0.0/16) + IPv4 subnet for fixed IPs (ex: 10.20.0.0/16). @@ -5196,7 +5197,7 @@ Create a network. --project-id <project id> - Project ID + Project ID. @@ -5204,7 +5205,7 @@ Create a network. --priority <number> - Network interface priority + Network interface priority. @@ -5212,7 +5213,7 @@ Create a network. --mtu MTU - MTU for network + MTU for network. @@ -5220,7 +5221,7 @@ Create a network. --enable-dhcp <'T'|'F'> - Enable dhcp + Enable DHCP. @@ -5228,7 +5229,8 @@ Create a network. --dhcp-server DHCP_SERVER - Dhcp-server (defaults to gateway address) + DHCP-server address (defaults to gateway + address) @@ -5244,7 +5246,7 @@ Create a network. --allowed-start ALLOWED_START - Start of allowed addresses for instances + Start of allowed addresses for instances. @@ -5252,7 +5254,7 @@ Create a network. --allowed-end ALLOWED_END - End of allowed addresses for instances + End of allowed addresses for instances. @@ -5269,7 +5271,7 @@ Delete network by label or id. <network> - uuid or label of network + UUID or label of network. @@ -5288,7 +5290,7 @@ Disassociate host and/or project from the given network. <network> - uuid of network + UUID of network. @@ -5340,7 +5342,7 @@ Show details about the given network. <network> - uuid or label of network + UUID or label of network. @@ -5757,7 +5759,7 @@ Update the quotas for a tenant/user. Whether force update the quota even if the already used and reserved exceeds the new - quota + quota. @@ -5851,7 +5853,7 @@ Shutdown, re-image, and re-boot a server. Skips flavor/image lookups when showing - servers + servers. @@ -5868,7 +5870,7 @@ Shutdown, re-image, and re-boot a server. --name <name> - Name for the new server + Name for the new server. @@ -6613,7 +6615,7 @@ Create a new server group with the specified details. <policy> - Policies for the server groups ("affinity" or "anti-affinity") + Policies for the server groups. ("affinity" or "anti-affinity") @@ -6630,7 +6632,7 @@ Delete specific server group(s). <id> - Unique ID(s) of the server group to delete + Unique ID(s) of the server group to delete. @@ -6647,7 +6649,7 @@ Get a specific server group. <id> - Unique ID of the server group to get + Unique ID of the server group to get. @@ -6681,7 +6683,7 @@ Delete the service. <id> - Id of service. + ID of service. @@ -6778,7 +6780,7 @@ Force service to down. (Supported by API versions '2.11' - '2.latest') --unset - Unset the force state down of service + Unset the force state down of service. @@ -6882,7 +6884,7 @@ Show details about the given server. --minimal - Skips flavor/image lookups when showing servers + Skips flavor/image lookups when showing servers. @@ -6967,7 +6969,7 @@ SSH into a server. --extra-opts EXTRA - Extra options to pass to ssh. see: man ssh + Extra options to pass to ssh. see: man ssh. @@ -7170,8 +7172,8 @@ Show usage data for a single tenant. --start <start> - Usage range start date ex 2012-01-20 (default: 4 weeks - ago) + Usage range start date ex 2012-01-20. (default: 4 + weeks ago) @@ -7179,7 +7181,7 @@ Show usage data for a single tenant. --end <end> - Usage range end date, ex 2012-01-20 (default: + Usage range end date, ex 2012-01-20. (default: tomorrow) @@ -7205,7 +7207,8 @@ List usage data for all tenants. --start <start> - Usage range start date ex 2012-01-20 (default: 4 weeks ago) + Usage range start date ex 2012-01-20. (default: 4 weeks + ago) @@ -7213,7 +7216,7 @@ List usage data for all tenants. --end <end> - Usage range end date, ex 2012-01-20 (default: tomorrow) + Usage range end date, ex 2012-01-20. (default: tomorrow) @@ -7329,7 +7332,7 @@ Create x509 cert for a user in tenant. <private-key-filename> - Filename for the private key [Default: pk.pem] + Filename for the private key. [Default: pk.pem] @@ -7337,7 +7340,7 @@ Create x509 cert for a user in tenant. <x509-cert-filename> - Filename for the X.509 certificate [Default: + Filename for the X.509 certificate. [Default: cert.pem]