diff --git a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml index d15e7dcf5c..deb474837f 100644 --- a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml +++ b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Telemetry API and its extensions. This chapter documents ceilometer version - 1.1.0. + 1.2.0. For help on a specific ceilometer diff --git a/doc/cli-reference/generated/ch_cli_cinder_commands.xml b/doc/cli-reference/generated/ch_cli_cinder_commands.xml index ff37cfd6e4..d4a218b9cf 100644 --- a/doc/cli-reference/generated/ch_cli_cinder_commands.xml +++ b/doc/cli-reference/generated/ch_cli_cinder_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents cinder version - 1.1.1. + 1.2.0. For help on a specific cinder @@ -25,11 +25,12 @@
cinder usage - usage: cinder [--version] [--debug] [--os-auth-system <auth-system>] + usage: cinder [--version] [-d] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] - [--os-volume-api-version <volume-api-ver>] [--retries <retries>] + [--os-volume-api-version <volume-api-ver>] + [--bypass-url <bypass-url>] [--retries <retries>] [--os-auth-strategy <auth-strategy>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] @@ -625,7 +626,7 @@ - --debug + -d, --debug Shows debugging output. @@ -683,6 +684,15 @@ + + --bypass-url <bypass-url> + + + Use this API endpoint instead of the Service Catalog. + Defaults to env[CINDERCLIENT_BYPASS_URL] + + + --retries <retries> @@ -1267,7 +1277,8 @@ Attempts force-delete of volume, regardless of state. cinder list usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>] [--status <status>] - [--metadata [<key=value> [<key=value> ...]]] + [--metadata [<key=value> [<key=value> ...]]] + [--tenant [<tenant>]] Lists all volumes. @@ -1305,6 +1316,14 @@ Lists all volumes. + + --tenant [<tenant>] + + + Display information from single tenant (Admin only). + + +
@@ -1333,7 +1352,7 @@ Sets or deletes volume metadata. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -1585,7 +1604,7 @@ Sets or unsets specifications for a qos spec. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -1751,7 +1770,8 @@ Lists quotas for a tenant.
cinder quota-update usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] - [--gigabytes <gigabytes>] + [--gigabytes <gigabytes>] [--backups <backups>] + [--backup-gigabytes <backup_gigabytes>] [--volume-type <volume_type_name>] <tenant_id> @@ -1793,6 +1813,22 @@ Updates quotas for a tenant. + + --backups <backups> + + + The new "backups" quota value. Default=None. + + + + + --backup-gigabytes <backup_gigabytes> + + + The new "backup_gigabytes" quota value. Default=None. + + + --volume-type <volume_type_name> @@ -1914,8 +1950,11 @@ Explicitly updates the volume state. The state to assign to the volume. Valid values are - "available," "error," "creating," "deleting," or - "error_deleting." Default is "available." + "available," "error," "creating," "deleting," "in-use," + "attaching," "detaching" and "error_deleting." NOTE: This + command simply changes the state of the Volume in the + DataBase with no regard to actual status, exercise caution + when using. Default=available. @@ -2180,7 +2219,7 @@ Sets or deletes snapshot metadata. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -2299,8 +2338,11 @@ Explicitly updates the snapshot state. The state to assign to the snapshot. Valid values are - "available," "error," "creating," "deleting," or - "error_deleting." Default is "available." + "available," "error," "creating," "deleting," and + "error_deleting." NOTE: This command simply changes the + state of the Snapshot in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. @@ -2395,10 +2437,20 @@ Undoes a transfer.
cinder transfer-list - usage: cinder transfer-list + usage: cinder transfer-list [--all-tenants [<0|1>]] Lists all transfers. - + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + +
cinder transfer-show @@ -2470,7 +2522,7 @@ Sets or unsets extra_spec for a volume type. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -2954,7 +3006,7 @@ Shows details of a consistency group. [--snapshot-id <snapshot-id>] [--source-volid <source-volid>] [--source-replica <source-replica>] - [--image-id <image-id>] [--name <name>] + [--image-id <image-id>] [--image <image>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] @@ -3019,6 +3071,15 @@ Creates a volume. + + --image <image> + + + Creates a volume from image (ID or name). + Default=None. + + + --name <name> @@ -3248,6 +3309,23 @@ Attempts force-delete of volume, regardless of state. + +
+
+ cinder get-pools (v2) + usage: cinder --os-volume-api-version 2 get-pools [--detail] + +Show pool information for backends. Admin only. + + Optional arguments + + --detail + + + Show detailed information about pools. + + +
@@ -3255,7 +3333,7 @@ Attempts force-delete of volume, regardless of state. usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] - [--sort_key <sort_key>] [--sort_dir <sort_dir>] + [--sort <key>[:<direction>]] [--tenant [<tenant>]] Lists all volumes. @@ -3313,21 +3391,21 @@ Lists all volumes. - --sort_key <sort_key> + --sort <key>[:<direction>] - Key to be sorted, should be (`id`, `status`, `size`, - `availability_zone`, `name`, `bootable`, - `created_at`). OPTIONAL: Default=None. + Comma-separated list of sort keys and directions in + the form of <key>[:<asc|desc>]. Valid keys: id, + status, size, availability_zone, name, bootable, + created_at. OPTIONAL: Default=None. - --sort_dir <sort_dir> + --tenant [<tenant>] - Sort direction, should be `desc` or `asc`. OPTIONAL: - Default=None. + Display information from single tenant (Admin only). @@ -3342,12 +3420,12 @@ Lists all available os-api extensions.
cinder manage (v2) - usage: cinder --os-volume-api-version 2 manage [--source-name <source-name>] [--source-id <source-id>] - [--name <name>] [--description <description>] + usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>] + [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] - <host> [<key=value> [<key=value> ...]] + <host> <identifier> Manage an existing volume. @@ -3356,16 +3434,16 @@ Manage an existing volume. <host> - Cinder host on which the existing volume resides + Cinder host on which the existing volume resides; + takes the form: host@backend-name#pool - <key=value> + <identifier> - Driver-specific reference to the existing volume as - key=value pairs + Name or other Identifier for existing volume @@ -3373,18 +3451,11 @@ Manage an existing volume. Optional arguments - --source-name <source-name> + --id-type <id-type> - Name of the volume to manage (Optional) - - - - - --source-id <source-id> - - - ID of the volume to manage (Optional) + Type of backend device identifier provided, typically + source-name or source-id (Default=source-name) @@ -3392,7 +3463,7 @@ Manage an existing volume. --name <name> - Volume name (Optional, Default=None) + Volume name (Default=None) @@ -3400,7 +3471,7 @@ Manage an existing volume. --description <description> - Volume description (Optional, Default=None) + Volume description (Default=None) @@ -3408,7 +3479,7 @@ Manage an existing volume. --volume-type <volume-type> - Volume type (Optional, Default=None) + Volume type (Default=None) @@ -3416,7 +3487,7 @@ Manage an existing volume. --availability-zone <availability-zone> - Availability zone for volume (Optional, Default=None) + Availability zone for volume (Default=None) @@ -3424,7 +3495,7 @@ Manage an existing volume. --metadata [<key=value> [<key=value> ...]] - Metadata key=value pairs (Optional, Default=None) + Metadata key=value pairs (Default=None) @@ -3458,7 +3529,7 @@ Sets or deletes volume metadata. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -3712,7 +3783,7 @@ Sets or unsets specifications for a qos spec. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -3878,7 +3949,9 @@ Lists quotas for a tenant.
cinder quota-update (v2) usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] - [--gigabytes <gigabytes>] + [--gigabytes <gigabytes>] [--backups <backups>] + [--backup-gigabytes <backup_gigabytes>] + [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] <tenant_id> @@ -3920,6 +3993,30 @@ Updates quotas for a tenant. + + --backups <backups> + + + The new "backups" quota value. Default=None. + + + + + --backup-gigabytes <backup_gigabytes> + + + The new "backup_gigabytes" quota value. Default=None. + + + + + --consistencygroups <consistencygroups> + + + The new "consistencygroups" quota value. Default=None. + + + --volume-type <volume_type_name> @@ -4054,7 +4151,12 @@ Sync the secondary volume with primary for a relationship. cinder reset-state (v2) usage: cinder --os-volume-api-version 2 reset-state [--state <state>] <volume> [<volume> ...] -Explicitly updates the volume state. +Explicitly updates the volume state in the Cinder database. Note that this +does not affect whether the volume is actually attached to the Nova compute +host or instance and can result in an unusable volume. Being a database change +only, this has no impact on the true state of the volume and may not match the +actual state. This can render a volume unusable in the case of change to the +'available' state. Positional arguments @@ -4073,8 +4175,11 @@ Explicitly updates the volume state. The state to assign to the volume. Valid values are - "available," "error," "creating," "deleting," and - "error_deleting." Default=available. + "available," "error," "creating," "deleting," "in-use," + "attaching," "detaching" and "error_deleting." NOTE: This + command simply changes the state of the Volume in the + DataBase with no regard to actual status, exercise caution + when using. Default=available. @@ -4249,6 +4354,7 @@ Shows volume details. cinder snapshot-create (v2) usage: cinder --os-volume-api-version 2 snapshot-create [--force <True|False>] [--name <name>] [--description <description>] + [--metadata [<key=value> [<key=value> ...]]] <volume> Creates a snapshot. @@ -4293,6 +4399,14 @@ Creates a snapshot. + + --metadata [<key=value> [<key=value> ...]] + + + Snapshot metadata key and value pairs. Default=None. + + +
@@ -4374,7 +4488,7 @@ Sets or deletes snapshot metadata. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -4494,7 +4608,10 @@ Explicitly updates the snapshot state. The state to assign to the snapshot. Valid values are "available," "error," "creating," "deleting," and - "error_deleting." Default is "available." + "error_deleting." NOTE: This command simply changes the + state of the Snapshot in the DataBase with no regard to + actual status, exercise caution when using. + Default=available. @@ -4589,10 +4706,20 @@ Undoes a transfer.
cinder transfer-list (v2) - usage: cinder --os-volume-api-version 2 transfer-list + usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]] Lists all transfers. - + + Optional arguments + + --all-tenants [<0|1>] + + + Shows details for all tenants. Admin only. + + + +
cinder transfer-show (v2) @@ -4609,11 +4736,84 @@ Shows transfer details. + +
+
+ cinder type-access-add (v2) + usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id + <project_id> + +Adds volume type access for the given project. + + Optional arguments + + --volume-type <volume_type> + + + Volume type name or ID to add access for the given + project. + + + + + --project-id <project_id> + + + Project ID to add volume type access for. + + + + +
+
+ cinder type-access-list (v2) + usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type> + +Print access information about the given volume type. + + Optional arguments + + --volume-type <volume_type> + + + Filter results by volume type name or ID. + + + + +
+
+ cinder type-access-remove (v2) + usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id + <project_id> + +Removes volume type access for the given project. + + Optional arguments + + --volume-type <volume_type> + + + Volume type name or ID to remove access for the given + project. + + + + + --project-id <project_id> + + + Project ID to remove volume type access for. + + +
cinder type-create (v2) - usage: cinder --os-volume-api-version 2 type-create <name> + usage: cinder --os-volume-api-version 2 type-create [--description <description>] + [--is-public <is-public>] + <name> Creates a volume type. @@ -4627,6 +4827,32 @@ Creates a volume type. + + Optional arguments + + --description <description> + + + Description of new volume type. + + + + + --is-public <is-public> + + + Make type accessible to the public (default true). + + + + +
+
+ cinder type-default (v2) + usage: cinder --os-volume-api-version 2 type-default + +List the default volume type. +
cinder type-delete (v2) @@ -4664,7 +4890,7 @@ Sets or unsets extra_spec for a volume type. <action> - The action. Valid values are 'set' or 'unset.' + The action. Valid values are "set" or "unset." @@ -4681,15 +4907,62 @@ Sets or unsets extra_spec for a volume type.
cinder type-list (v2) - usage: cinder --os-volume-api-version 2 type-list + usage: cinder --os-volume-api-version 2 type-list [--all] Lists available 'volume types'. - + + Optional arguments + + --all + + + Display all volume types (Admin only). + + + + +
+
+ cinder type-update (v2) + usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] <id> + +Updates volume type name and/or description. + + Positional arguments + + <id> + + + ID of the volume type. + + + + + + Optional arguments + + --name <name> + + + Name of the volume type. + + + + + --description <description> + + + Description of the volume type. + + + +
cinder unmanage (v2) usage: cinder --os-volume-api-version 2 unmanage <volume> +Stop managing a volume. Positional arguments diff --git a/doc/cli-reference/generated/ch_cli_glance_commands.xml b/doc/cli-reference/generated/ch_cli_glance_commands.xml index 5c51cd0f39..6285085b01 100644 --- a/doc/cli-reference/generated/ch_cli_glance_commands.xml +++ b/doc/cli-reference/generated/ch_cli_glance_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the OpenStack Image Service API and its extensions. This chapter documents glance version - 0.17.0. + 0.18.0. For help on a specific glance @@ -889,7 +889,8 @@ Update a specific image. example, if the image data is stored in swift, you could specify 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'. (Note: '%3A' is ':' URL - encoded.) + encoded.) This option only works for images in + 'queued' status. @@ -918,7 +919,8 @@ Update a specific image. Similar to '--location' in usage, but this indicates that the Glance server should immediately copy the - data and store it in its configured image store. + data and store it in its configured image store. This + option only works for images in 'queued' status. @@ -1300,7 +1302,8 @@ List images you can access.
glance image-show (v2) - usage: glance --os-image-api-version 2 image-show [--max-column-width <integer>] <IMAGE_ID> + usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>] + <IMAGE_ID> Describe a specific image. @@ -1316,6 +1319,14 @@ Describe a specific image. Optional arguments + + --human-readable + + + Print image size in a human-friendly format. + + + --max-column-width <integer> diff --git a/doc/cli-reference/generated/ch_cli_heat_commands.xml b/doc/cli-reference/generated/ch_cli_heat_commands.xml index 18f978fa49..73ec5647dc 100644 --- a/doc/cli-reference/generated/ch_cli_heat_commands.xml +++ b/doc/cli-reference/generated/ch_cli_heat_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Orchestration API and its extensions. This chapter documents heat version - 0.4.0. + 0.5.0. For help on a specific heat @@ -101,22 +101,6 @@ - - create - - - DEPRECATED! Use stack-create instead. - - - - - delete - - - DEPRECATED! Use stack-delete instead. - - - deployment-create @@ -157,14 +141,6 @@ - - describe - - - DEPRECATED! Use stack-show instead. - - - event @@ -189,14 +165,6 @@ - - gettemplate - - - DEPRECATED! Use template-show instead. - - - hook-clear @@ -205,14 +173,6 @@ - - list - - - DEPRECATED! Use stack-list instead. - - - output-list @@ -229,14 +189,6 @@ - - resource - - - DEPRECATED! Use resource-show instead. - - - resource-list @@ -437,22 +389,6 @@ - - update - - - DEPRECATED! Use stack-update instead. - - - - - validate - - - DEPRECATED! Use template-validate instead. - - - bash-completion diff --git a/doc/cli-reference/generated/ch_cli_ironic_commands.xml b/doc/cli-reference/generated/ch_cli_ironic_commands.xml index 9ca197d5de..a6e60ed52d 100644 --- a/doc/cli-reference/generated/ch_cli_ironic_commands.xml +++ b/doc/cli-reference/generated/ch_cli_ironic_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Bare metal and its extensions. This chapter documents ironic version - 0.5.1. + 0.6.0. For help on a specific ironic @@ -33,9 +33,10 @@ [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL] [--ironic-api-version IRONIC_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint OS_ENDPOINT] - [--os-endpoint-type OS_ENDPOINT_TYPE] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] + [--os-endpoint-type OS_ENDPOINT_TYPE] + [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] + [--insecure] [--os-cacert <ca-certificate>] + [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] @@ -466,6 +467,26 @@ + + --max-retries MAX_RETRIES + + + Maximum number of retries in case of conflict error + (HTTP 409). Defaults to env[IRONIC_MAX_RETRIES] or 5. + Use 0 to disable retrying. + + + + + --retry-interval RETRY_INTERVAL + + + Amount of time (in seconds) between retries in case of + conflict error (HTTP 409). Defaults to + env[IRONIC_RETRY_INTERVAL] or 2. + + + --insecure diff --git a/doc/cli-reference/generated/ch_cli_keystone_commands.xml b/doc/cli-reference/generated/ch_cli_keystone_commands.xml index ffb6bfed6c..cd303ea34f 100644 --- a/doc/cli-reference/generated/ch_cli_keystone_commands.xml +++ b/doc/cli-reference/generated/ch_cli_keystone_commands.xml @@ -21,7 +21,7 @@ interface (CLI) for the OpenStack Identity API and its extensions. This chapter documents keystone version - 1.3.0. + 1.4.0. For help on a specific keystone diff --git a/doc/cli-reference/generated/ch_cli_neutron_commands.xml b/doc/cli-reference/generated/ch_cli_neutron_commands.xml index 083f8f5148..d1a3801a2f 100644 --- a/doc/cli-reference/generated/ch_cli_neutron_commands.xml +++ b/doc/cli-reference/generated/ch_cli_neutron_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the OpenStack Networking API and its extensions. This chapter documents neutron version - 2.4.0. + 2.5.0. For help on a specific neutron diff --git a/doc/cli-reference/generated/ch_cli_nova_commands.xml b/doc/cli-reference/generated/ch_cli_nova_commands.xml index ceaa03471b..fa6f192c19 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.23.0. + 2.24.1. For help on a specific nova @@ -1460,11 +1460,60 @@ - host-servers-migrate + instance-action - Migrate all instances of the specified host to - other available hosts. + Show an action. + + + + + instance-action-list + + + List actions on a server. + + + + + host-meta + + + Set or Delete metadata on all instances of a + host. + + + + + host-evacuate-live + + + Live migrate all instances of the specified + host to other available hosts. + + + + + force-delete + + + Force delete a server. + + + + + restore + + + Restore a soft-deleted server. + + + + + migration-list + + + Print a list of migrations. @@ -1533,61 +1582,11 @@ - host-evacuate + list-extensions - Evacuate all instances from failed host. - - - - - cell-capacities - - - Get cell capacities for all cells or a given - cell. - - - - - cell-show - - - Show details of a given cell. - - - - - host-meta - - - Set or Delete metadata on all instances of a - host. - - - - - host-evacuate-live - - - Live migrate all instances of the specified - host to other available hosts. - - - - - instance-action - - - Show an action. - - - - - instance-action-list - - - List actions on a server. + List all the os-api extensions that are + available. @@ -1651,35 +1650,36 @@ - migration-list + cell-capacities - Print a list of migrations. + Get cell capacities for all cells or a given + cell. - force-delete + cell-show - Force delete a server. + Show details of a given cell. - restore + host-servers-migrate - Restore a soft-deleted server. + Migrate all instances of the specified host to + other available hosts. - list-extensions + host-evacuate - List all the os-api extensions that are - available. + Evacuate all instances from failed host. @@ -2791,15 +2791,15 @@ Boot a new server. (e.g. vda, xda, ...; if omitted, hypervisor driver chooses suitable device depending on selected bus), size=size of the block device - in GB (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). + 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). diff --git a/doc/cli-reference/generated/ch_cli_openstack_commands.xml b/doc/cli-reference/generated/ch_cli_openstack_commands.xml index e30697e34e..1fbe75d0cf 100644 --- a/doc/cli-reference/generated/ch_cli_openstack_commands.xml +++ b/doc/cli-reference/generated/ch_cli_openstack_commands.xml @@ -15,7 +15,7 @@ OpenStack command-line interface (CLI). This chapter documents openstack version - 1.0.3. + 1.1.0. For help on a specific openstack @@ -25,7 +25,8 @@
openstack usage - usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [--debug] + usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] + [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--timing] @@ -40,17 +41,18 @@ [--os-project-domain-id <auth-project-domain-id>] [--os-project-name <auth-project-name>] [--os-auth-url <auth-auth-url>] + [--os-identity-provider-url <auth-identity-provider-url>] [--os-trust-id <auth-trust-id>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-user-domain-id <auth-user-domain-id>] + [--os-url <auth-url>] [--os-token <auth-token>] [--os-domain-name <auth-domain-name>] - [--os-identity-provider-url <auth-identity-provider-url>] - [--os-token <auth-token>] [--os-domain-id <auth-domain-id>] - [--os-url <auth-url>] [--os-user-domain-name <auth-user-domain-name>] + [--os-domain-id <auth-domain-id>] [--os-user-id <auth-user-id>] [--os-password <auth-password>] + [--os-endpoint <auth-endpoint>] [--os-project-id <auth-project-id>] - [--os-object-api-version <object-api-version>] [-h] + [--os-object-api-version <object-api-version>]
openstack optional arguments @@ -103,6 +105,14 @@ + + --os-cloud <cloud-config-name> + + + Cloud name in clouds.yaml (Env: OS_CLOUD) + + + --os-region-name <auth-region-name> @@ -202,11 +212,10 @@ Select an auhentication type. Available types: - v2token, v2password, v3password, v3scopedsaml, - v3unscopedadfs, token, v3token, password, - v3unscopedsaml, osc_password, token_endpoint. Default: - selected based on --os-username/--os-token (Env: - OS_AUTH_TYPE) + osc_password, token_endpoint, v2token, v2password, + v3password, v3scopedsaml, v3unscopedadfs, token, + v3token, password, v3unscopedsaml. Default: selected + based on --os-username/--os-token (Env: OS_AUTH_TYPE) @@ -214,10 +223,10 @@ --os-username <auth-username> - With v2password: Username to login with With - v3password: Username With v3unscopedadfs: Username - With password: Username With v3unscopedsaml: Username - With osc_password: Username (Env: OS_USERNAME) + With osc_password: Username With v2password: Username + to login with With v3password: Username With + v3unscopedadfs: Username With password: Username With + v3unscopedsaml: Username (Env: OS_USERNAME) @@ -235,14 +244,14 @@ --os-project-domain-name <auth-project-domain-name> - With v3password: Domain name containing project With + With osc_password: Domain name containing project With + v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3unscopedadfs: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With password: Domain name containing project With v3unscopedsaml: Domain - name containing project With osc_password: Domain name - containing project (Env: OS_PROJECT_DOMAIN_NAME) + name containing project (Env: OS_PROJECT_DOMAIN_NAME) @@ -250,13 +259,13 @@ --os-project-domain-id <auth-project-domain-id> - With v3password: Domain ID containing project With + With osc_password: Domain ID containing project With + v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3unscopedadfs: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With password: Domain ID containing project With v3unscopedsaml: Domain ID - containing project With osc_password: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID) @@ -265,13 +274,13 @@ --os-project-name <auth-project-name> - With v3password: Project name to scope to With + With osc_password: Project name to scope to With + v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With password: Project name to scope to With - v3unscopedsaml: Project name to scope to With - osc_password: Project name to scope to (Env: + v3unscopedsaml: Project name to scope to (Env: OS_PROJECT_NAME) @@ -280,14 +289,24 @@ --os-auth-url <auth-auth-url> - With v2token: Authentication URL With v2password: - Authentication URL With v3password: Authentication URL - With v3scopedsaml: Authentication URL With - v3unscopedadfs: Authentication URL With token: - Authentication URL With v3token: Authentication URL - With password: Authentication URL With v3unscopedsaml: - Authentication URL With osc_password: Authentication - URL (Env: OS_AUTH_URL) + With osc_password: Authentication URL With v2token: + Authentication URL With v2password: Authentication URL + With v3password: Authentication URL With v3scopedsaml: + Authentication URL With v3unscopedadfs: Authentication + URL With token: Authentication URL With v3token: + Authentication URL With password: Authentication URL + With v3unscopedsaml: Authentication URL (Env: + OS_AUTH_URL) + + + + + --os-identity-provider-url <auth-identity-provider-url> + + + With v3unscopedadfs: Identity Provider's URL With + v3unscopedsaml: Identity Provider's URL (Env: + OS_IDENTITY_PROVIDER_URL) @@ -295,12 +314,12 @@ --os-trust-id <auth-trust-id> - With v2token: Trust ID With v2password: Trust ID With - v3password: Trust ID With v3scopedsaml: Trust ID With - v3unscopedadfs: Trust ID With token: Trust ID With - v3token: Trust ID With password: Trust ID With - v3unscopedsaml: Trust ID With osc_password: Trust ID - (Env: OS_TRUST_ID) + With osc_password: Trust ID With v2token: Trust ID + With v2password: Trust ID With v3password: Trust ID + With v3scopedsaml: Trust ID With v3unscopedadfs: Trust + ID With token: Trust ID With v3token: Trust ID With + password: Trust ID With v3unscopedsaml: Trust ID (Env: + OS_TRUST_ID) @@ -317,61 +336,9 @@ --os-user-domain-id <auth-user-domain-id> - With v3password: User's domain id With password: - User's domain id With osc_password: User's domain id - (Env: OS_USER_DOMAIN_ID) - - - - - --os-domain-name <auth-domain-name> - - - With v3password: Domain name to scope to With - v3scopedsaml: Domain name to scope to With - v3unscopedadfs: Domain name to scope to With token: - Domain name to scope to With v3token: Domain name to - scope to With password: Domain name to scope to With - v3unscopedsaml: Domain name to scope to With - osc_password: Domain name to scope to (Env: - OS_DOMAIN_NAME) - - - - - --os-identity-provider-url <auth-identity-provider-url> - - - With v3unscopedadfs: Identity Provider's URL With - v3unscopedsaml: Identity Provider's URL (Env: - OS_IDENTITY_PROVIDER_URL) - - - - - --os-token <auth-token> - - - With v2token: Token With v3scopedsaml: Token to - authenticate with With token: Token to authenticate - with With v3token: Token to authenticate with With - token_endpoint: Authentication token to use (Env: - OS_TOKEN) - - - - - --os-domain-id <auth-domain-id> - - - With v3password: Domain ID to scope to With - v3scopedsaml: Domain ID to scope to With - v3unscopedadfs: Domain ID to scope to With token: - Domain ID to scope to With v3token: Domain ID to scope - to With password: Domain ID to scope to With - v3unscopedsaml: Domain ID to scope to With - osc_password: Domain ID to scope to (Env: - OS_DOMAIN_ID) + With osc_password: User's domain id With v3password: + User's domain id With password: User's domain id (Env: + OS_USER_DOMAIN_ID) @@ -384,13 +351,54 @@ + + --os-token <auth-token> + + + With token_endpoint: The token that will always be + used With token_endpoint: Authentication token to use + With v2token: Token With v3scopedsaml: Token to + authenticate with With token: Token to authenticate + with With v3token: Token to authenticate with (Env: + OS_TOKEN) + + + + + --os-domain-name <auth-domain-name> + + + With osc_password: Domain name to scope to With + v3password: Domain name to scope to With v3scopedsaml: + Domain name to scope to With v3unscopedadfs: Domain + name to scope to With token: Domain name to scope to + With v3token: Domain name to scope to With password: + Domain name to scope to With v3unscopedsaml: Domain + name to scope to (Env: OS_DOMAIN_NAME) + + + --os-user-domain-name <auth-user-domain-name> - With v3password: User's domain name With password: - User's domain name With osc_password: User's domain - name (Env: OS_USER_DOMAIN_NAME) + With osc_password: User's domain name With v3password: + User's domain name With password: User's domain name + (Env: OS_USER_DOMAIN_NAME) + + + + + --os-domain-id <auth-domain-id> + + + With osc_password: Domain ID to scope to With + v3password: Domain ID to scope to With v3scopedsaml: + Domain ID to scope to With v3unscopedadfs: Domain ID + to scope to With token: Domain ID to scope to With + v3token: Domain ID to scope to With password: Domain + ID to scope to With v3unscopedsaml: Domain ID to scope + to (Env: OS_DOMAIN_ID) @@ -398,9 +406,9 @@ --os-user-id <auth-user-id> - With v2password: User ID to longin with With - v3password: User ID With password: User id With - osc_password: User id (Env: OS_USER_ID) + With osc_password: User id With v2password: User ID to + longin with With v3password: User ID With password: + User id (Env: OS_USER_ID) @@ -408,26 +416,34 @@ --os-password <auth-password> - With v2password: Password to use With v3password: - User's password With v3unscopedadfs: Password With - password: User's password With v3unscopedsaml: - Password With osc_password: User's password (Env: + With osc_password: User's password With v2password: + Password to use With v3password: User's password With + v3unscopedadfs: Password With password: User's + password With v3unscopedsaml: Password (Env: OS_PASSWORD) + + --os-endpoint <auth-endpoint> + + + With token_endpoint: The endpoint that will always be + used (Env: OS_ENDPOINT) + + + --os-project-id <auth-project-id> - With v3password: Project ID to scope to With - v3scopedsaml: Project ID to scope to With - v3unscopedadfs: Project ID to scope to With token: - Project ID to scope to With v3token: Project ID to - scope to With password: Project ID to scope to With - v3unscopedsaml: Project ID to scope to With - osc_password: Project ID to scope to (Env: - OS_PROJECT_ID) + With osc_password: Project ID to scope to With + v3password: Project ID to scope to With v3scopedsaml: + Project ID to scope to With v3unscopedadfs: Project ID + to scope to With token: Project ID to scope to With + v3token: Project ID to scope to With password: Project + ID to scope to With v3unscopedsaml: Project ID to + scope to (Env: OS_PROJECT_ID) @@ -440,14 +456,6 @@ - - -h, --help - - - Show this help message and exit - - -
@@ -2002,6 +2010,46 @@ List flavors + +
+
+ openstack flavor set + usage: openstack flavor set [-h] [-f {html,json,shell,table,value,yaml}] + [-c COLUMN] [--max-width <integer>] + [--prefix PREFIX] [--property <key=value>] + <flavor> + +Set flavor properties + + Positional arguments + + <flavor> + + + Flavor to modify (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key=value> + + + Property to add or modify for this flavor (repeat + option to set multiple properties) + + +
@@ -2033,6 +2081,46 @@ Display flavor details + +
+
+ openstack flavor unset + usage: openstack flavor unset [-h] [-f {html,json,shell,table,value,yaml}] + [-c COLUMN] [--max-width <integer>] + [--prefix PREFIX] [--property <key>] + <flavor> + +Unset flavor properties + + Positional arguments + + <flavor> + + + Flavor to modify (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property to remove from flavor (repeat option to unset + multiple properties) + + +
@@ -3007,7 +3095,8 @@ Display public key details usage: openstack limits show [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN] [--max-width <integer>] [--quote {all,minimal,none,nonnumeric}] - [--absolute | --rate] [--reserved] + [--absolute | --rate] [--reserved] + [--project <project>] [--domain <domain>] Show compute and volume limits @@ -3045,6 +3134,24 @@ Show compute and volume limits + + --project <project> + + + Show limits for a specific project (name or ID) [only + valid with --absolute] + + + + + --domain <domain> + + + Domain that owns --project (name or ID) [only valid + with --absolute] + + +
@@ -3079,7 +3186,8 @@ List module versions usage: openstack network create [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--prefix PREFIX] [--enable | --disable] - [--share | --no-share] + [--share | --no-share] [--project <project>] + [--domain <domain>] <name> Create new network @@ -3136,6 +3244,22 @@ Create new network + + --project <project> + + + Owner's project (name or ID) + + + + + --domain <domain> + + + Owner's domain (name or ID) + + +
@@ -3843,6 +3967,7 @@ List resource usage per project [--injected-path-size <injected-path-size>] [--gigabytes <gigabytes>] [--volumes <volumes>] [--snapshots <snapshots>] + [--volume-type <volume-type>] <project/class> Set quotas for project or class @@ -3995,6 +4120,14 @@ Set quotas for project or class + + --volume-type <volume-type> + + + Set quotas for a specific <volume-type> + + +
@@ -4689,7 +4822,7 @@ Add volume to server [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping>] - [--nic <nic-config-string>] + [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] @@ -4804,10 +4937,16 @@ Create a new server - --nic <nic-config-string> + --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> - Specify NIC configuration (optional extension) + Create a NIC on the server. Specify option multiple + times to create multiple NICs. Either net-id or port- + id must be provided, but not both. net-id: attach NIC + to network with this UUID, port-id: attach NIC to port + with this UUID, v4-fixed-ip: IPv4 fixed address for + NIC (optional), v6-fixed-ip: IPv6 fixed address for + NIC (optional). diff --git a/doc/cli-reference/generated/ch_cli_sahara_commands.xml b/doc/cli-reference/generated/ch_cli_sahara_commands.xml index f7a1a8db51..7acbba90af 100644 --- a/doc/cli-reference/generated/ch_cli_sahara_commands.xml +++ b/doc/cli-reference/generated/ch_cli_sahara_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Data processing API and its extensions. This chapter documents sahara version - 0.8.0. + 0.9.0. For help on a specific sahara @@ -25,7 +25,7 @@
sahara usage - usage: sahara [--version] [--debug] [--os-cache] + usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--sahara-api-version <sahara-api-ver>] @@ -145,14 +145,6 @@ - - event-list - - - Show events of a cluster. - - - image-add-tag @@ -323,6 +315,14 @@ + + job-type-list + + + Show supported job types. + + + node-group-template-create @@ -421,6 +421,14 @@ + + --region-name <region-name> + + + Defaults to env[OS_REGION_NAME]. + + + --service-type <service-type> @@ -687,7 +695,8 @@ Print a list of available clusters.
sahara cluster-show - usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--json] + usage: sahara cluster-show [--name NAME] [--id <cluster_id>] + [--show-progress SHOW_PROGRESS] [--json] Show details of a cluster. @@ -708,6 +717,14 @@ Show details of a cluster. + + --show-progress SHOW_PROGRESS + + + Show provision progress events of the cluster. + + + --json @@ -915,40 +932,6 @@ Show details of a data source. - -
-
- sahara event-list - usage: sahara event-list [--name <cluster_name>] [--id <cluster_id>] - [--step <step_id>] - -Show events of a cluster. - - Optional arguments - - --name <cluster_name> - - - Name of the cluster to show events. - - - - - --id <cluster_id> ID - - - of the cluster to show events. - - - - - --step <step_id> ID - - - of provision step to show events. - - -
@@ -1161,7 +1144,7 @@ Record a job binary.
sahara job-binary-data-create - usage: sahara job-binary-data-create [--file FILE] + usage: sahara job-binary-data-create [--file FILE] [--name NAME] Store data in the internal DB. Use 'swift upload' instead of this command. Use this command only if Swift is not available. @@ -1175,6 +1158,14 @@ this command only if Swift is not available. + + --name NAME + + + Name of the job binary internal. + + +
@@ -1472,6 +1463,41 @@ Show details of a job template. + +
+
+ sahara job-type-list + usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] + [--plugin-version <plugin_version>] + +Show supported job types. + + Optional arguments + + --type <job_type> + + + Report only on this job type + + + + + --plugin <plugin> + + + Report only job types supported by this plugin. + + + + + --plugin-version <plugin_version> + + + Report only on job types supported by this version of + a specified plugin. Only valid with --plugin. + + +
diff --git a/doc/cli-reference/generated/ch_cli_trove_commands.xml b/doc/cli-reference/generated/ch_cli_trove_commands.xml index 30c78ccc2b..197b2fb6fd 100644 --- a/doc/cli-reference/generated/ch_cli_trove_commands.xml +++ b/doc/cli-reference/generated/ch_cli_trove_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Database API and its extensions. This chapter documents trove version - 1.0.9. + 1.1.0. For help on a specific trove