diff --git a/doc/cli-reference/generated/ch_cli_openstack_commands.xml b/doc/cli-reference/generated/ch_cli_openstack_commands.xml index dca23d214e..f942f8aba7 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.7.1. + 1.8.0. For help on a specific openstack @@ -58,7 +58,8 @@ [--os-password <auth-password>] [--os-endpoint <auth-endpoint>] [--os-url <auth-url>] [--os-token <auth-token>] [--os-project-id <auth-project-id>] - [--os-object-api-version <object-api-version>] + [--os-object-api-version <object-api-version>] + [--os-baremetal-api-version <baremetal-api-version>]
openstack optional arguments @@ -227,10 +228,10 @@ Select an authentication type. Available types: - osc_password, token_endpoint, v2token, admin_token, - v2password, v3password, v3scopedsaml, v3oidcpassword, - v3unscopedadfs, token, v3token, password, - v3unscopedsaml. Default: selected based on --os- + v2token, admin_token, v2password, v3password, + v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, + v3token, password, v3unscopedsaml, osc_password, + token_endpoint. Default: selected based on --os- username/--os-token (Env: OS_AUTH_TYPE) @@ -239,14 +240,14 @@ --os-project-domain-id <auth-project-domain-id> - With osc_password: Domain ID containing project With - v3password: Domain ID containing project With + With v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3oidcpassword: 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) @@ -267,14 +268,14 @@ --os-project-name <auth-project-name> - With osc_password: Project name to scope to With - v3password: Project name to scope to With + With v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: 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 (Env: + v3unscopedsaml: Project name to scope to With + osc_password: Project name to scope to (Env: OS_PROJECT_NAME) @@ -283,12 +284,12 @@ --os-trust-id <auth-trust-id> - With osc_password: Trust ID With v2token: Trust ID - With v2password: Trust ID With v3password: Trust ID - With v3scopedsaml: Trust ID With v3oidcpassword: 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) + With v2token: Trust ID With v2password: Trust ID With + v3password: Trust ID With v3scopedsaml: Trust ID With + v3oidcpassword: 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) @@ -305,14 +306,15 @@ --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 v3oidcpassword: 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) + With v3password: Domain name to scope to With + v3scopedsaml: Domain name to scope to With + v3oidcpassword: 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) @@ -320,9 +322,9 @@ --os-user-domain-id <auth-user-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) + With v3password: User's domain id With password: + User's domain id With osc_password: User's domain id + (Env: OS_USER_DOMAIN_ID) @@ -349,13 +351,14 @@ --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 v3oidcpassword: 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: + With v3password: Domain ID to scope to With + v3scopedsaml: Domain ID to scope to With + v3oidcpassword: 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) @@ -364,9 +367,9 @@ --os-user-domain-name <auth-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) + With v3password: User's domain name With password: + User's domain name With osc_password: User's domain + name (Env: OS_USER_DOMAIN_NAME) @@ -383,9 +386,9 @@ --os-user-id <auth-user-id> - With osc_password: User id With v2password: User ID to - login with With v3password: User ID With password: - User id (Env: OS_USER_ID) + With v2password: User ID to login with With + v3password: User ID With password: User id With + osc_password: User id (Env: OS_USER_ID) @@ -404,11 +407,11 @@ --os-username <auth-username> - With osc_password: Username With v2password: Username - to login with With v3password: Username With - v3oidcpassword: Username With v3unscopedadfs: Username - With password: Username With v3unscopedsaml: Username - (Env: OS_USERNAME) + With v2password: Username to login with With + v3password: Username With v3oidcpassword: Username + With v3unscopedadfs: Username With password: Username + With v3unscopedsaml: Username With osc_password: + Username (Env: OS_USERNAME) @@ -416,14 +419,15 @@ --os-auth-url <auth-auth-url> - With osc_password: Authentication URL With v2token: - Authentication URL With v2password: Authentication URL - With v3password: Authentication URL With v3scopedsaml: - Authentication URL With v3oidcpassword: 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) + With v2token: Authentication URL With v2password: + Authentication URL With v3password: Authentication URL + With v3scopedsaml: Authentication URL With + v3oidcpassword: 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) @@ -449,15 +453,15 @@ --os-project-domain-name <auth-project-domain-name> - With osc_password: Domain name containing project With - v3password: Domain name containing project With + With v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3oidcpassword: 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 (Env: OS_PROJECT_DOMAIN_NAME) + name containing project With osc_password: Domain name + containing project (Env: OS_PROJECT_DOMAIN_NAME) @@ -465,11 +469,11 @@ --os-password <auth-password> - With osc_password: User's password With v2password: - Password to use With v3password: User's password With - v3oidcpassword: Password With v3unscopedadfs: Password - With password: User's password With v3unscopedsaml: - Password (Env: OS_PASSWORD) + With v2password: Password to use With v3password: + User's password With v3oidcpassword: Password With + v3unscopedadfs: Password With password: User's + password With v3unscopedsaml: Password With + osc_password: User's password (Env: OS_PASSWORD) @@ -477,9 +481,9 @@ --os-endpoint <auth-endpoint> - With token_endpoint: The endpoint that will always be - used With admin_token: The endpoint that will always - be used (Env: OS_ENDPOINT) + With admin_token: The endpoint that will always be + used With token_endpoint: The endpoint that will + always be used (Env: OS_ENDPOINT) @@ -496,12 +500,12 @@ --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 admin_token: The token that will always be used With v3scopedsaml: Token to authenticate with With token: Token to authenticate - with With v3token: Token to authenticate with (Env: + with With v3token: Token to authenticate with With + token_endpoint: The token that will always be used + With token_endpoint: Authentication token to use (Env: OS_TOKEN) @@ -510,14 +514,15 @@ --os-project-id <auth-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 v3oidcpassword: 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) + With v3password: Project ID to scope to With + v3scopedsaml: Project ID to scope to With + v3oidcpassword: 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) @@ -530,6 +535,15 @@ + + --os-baremetal-api-version <baremetal-api-version> + + + Baremetal API version, default=1.6 (Env: + OS_BAREMETAL_API_VERSION) + + +
@@ -1025,6 +1039,321 @@ Display backup details + + +
+ openstack baremetal create + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal create [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width <integer>] + [--noindent] [--prefix PREFIX] + [--chassis-uuid <chassis>] --driver <driver> + [--driver-info <key=value>] + [--property <key=value>] + [--extra <key=value>] [--uuid <uuid>] + [--name <name>] + +Register a new node with the baremetal service + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --chassis-uuid <chassis> + + + UUID of the chassis that this node belongs to. + + + + + --driver <driver> + + + Driver used to control the node [REQUIRED]. + + + + + --driver-info <key=value> + + + Key/value pair used by the driver, such as out-of-band + management credentials. Can be specified multiple + times. + + + + + --property <key=value> + + + Key/value pair describing the physical characteristics + of the node. This is exported to Nova and used by the + scheduler. Can be specified multiple times. + + + + + --extra <key=value> + + + Record arbitrary key/value metadata. Can be specified + multiple times. + + + + + --uuid <uuid> + + + Unique UUID for the node. + + + + + --name <name> + + + Unique name for the node. + + + + +
+
+ openstack baremetal delete + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal delete [-h] <node> + +Unregister a baremetal node + + Positional arguments + + <node> + + + Node to delete (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack baremetal list + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal list [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width <integer>] + [--noindent] + [--quote {all,minimal,none,nonnumeric}] + [--limit <limit>] [--marker <node>] + [--sort <key>[:<direction>]] [--maintenance] + [--associated] [--long] + +List baremetal nodes + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --limit <limit> + + + Maximum number of nodes to return per request, 0 for + no limit. Default is the maximum number used by the + Baremetal API Service. + + + + + --marker <node> + + + Node UUID (for example, of the last node in the list + from a previous request). Returns the list of nodes + after this UUID. + + + + + --sort <key>[:<direction>] + + + Sort output by selected keys and directions(asc or + desc) (default: asc), multiple keys and directions can + be specified separated by comma + + + + + --maintenance + + + List nodes in maintenance mode. + + + + + --associated + + + List only nodes associated with an instance. + + + + + --long + + + Show detailed information about the nodes. + + + + +
+
+ openstack baremetal set + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal set [-h] [--property <path=value>] <node> + +Set baremetal properties + + Positional arguments + + <node> + + + Name or UUID of the node. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <path=value> + + + Property to add to this baremetal host (repeat option + to set multiple properties) + + + + +
+
+ openstack baremetal show + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal show [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width <integer>] + [--noindent] [--prefix PREFIX] [--instance] + [--long] + <node> + +Show baremetal node details + + Positional arguments + + <node> + + + Name or UUID of the node (or instance UUID if + --instance is specified) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --instance <node> + + + is an instance UUID. + + + + + --long + + + + + + +
+
+ openstack baremetal unset + usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal unset [-h] [--property <path>] <node> + +Unset baremetal properties + + Positional arguments + + <node> + + + Name or UUID of the node. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <path> + + + Property to unset on this baremetal host (repeat option + to unset multiple properties) + + +
@@ -1672,6 +2001,43 @@ Save container contents locally + +
+
+ openstack container set + usage: openstack --os-auth-type token --os-identity-api-version 2 container set [-h] --property <key=value> <container> + +Set container properties + + Positional arguments + + <container> + + + Container to modify + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key=value> + + + Set a property on this container (repeat option to set + multiple properties) + + +
@@ -1704,6 +2070,43 @@ Display container details + +
+
+ openstack container unset + usage: openstack --os-auth-type token --os-identity-api-version 2 container unset [-h] --property <key> <container> + +Unset container properties + + Positional arguments + + <container> + + + Container to modify + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property to remove from container (repeat option to remove + multiple properties) + + +
@@ -2891,19 +3294,17 @@ Save an image locally
openstack image set - usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--name <name>] - [--architecture <architecture>] - [--protected | --unprotected] [--public] - [--private] [--instance-uuid <instance_uuid>] - [--min-disk <disk-gb>] [--kernel-id <kernel-id>] - [--os-version <os-version>] - [--disk-format <disk-format>] - [--os-distro <os-distro>] [--owner <owner>] - [--ramdisk-id <ramdisk-id>] [--min-ram <ram-mb>] + usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] [--name <name>] [--owner <project>] + [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--container-format <container-format>] + [--disk-format <disk-format>] + [--protected | --unprotected] + [--public | --private] [--property <key=value>] + [--tag <tag>] [--architecture <architecture>] + [--instance-id <instance-id>] + [--kernel-id <kernel-id>] [--os-distro <os-distro>] + [--os-version <os-version>] + [--ramdisk-id <ramdisk-id>] <image> Set image properties @@ -2937,10 +3338,42 @@ Set image properties - --architecture <architecture> + --owner <project> - Operating system Architecture + New image owner project (name or ID) + + + + + --min-disk <disk-gb> + + + Minimum disk size needed to boot image, in gigabytes + + + + + --min-ram <ram-mb> + + + Minimum RAM size needed to boot image, in megabytes + + + + + --container-format <container-format> + + + Image container format (default: bare) + + + + + --disk-format <disk-format> + + + Image disk format (default: raw) @@ -2977,18 +3410,36 @@ Set image properties - --instance-uuid <instance_uuid> + --property <key=value> - ID of instance used to create this image + Set a property on this image (repeat option to set + multiple properties) - --min-disk <disk-gb> + --tag <tag> - Minimum disk size needed to boot image, in gigabytes + Set a tag on this image (repeat option to set multiple + tags) + + + + + --architecture <architecture> + + + Operating system architecture + + + + + --instance-id <instance-id> + + + ID of server instance used to create this image @@ -2996,27 +3447,7 @@ Set image properties --kernel-id <kernel-id> - ID of image in Glance that should be used as the - kernel when booting an AMI-style image - - - - - --os-version <os-version> - - - Operating system version as specified by the - distributor - - - - - --disk-format <disk-format> - - - Format of the disk. Valid values: ['None', 'ami', - 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', - 'iso'] + ID of kernel image used to boot this disk image @@ -3024,15 +3455,15 @@ Set image properties --os-distro <os-distro> - Common name of operating system distribution + Operating system distribution name - --owner <owner> + --os-version <os-version> - New Owner of the image + Operating system distribution version @@ -3040,25 +3471,7 @@ Set image properties --ramdisk-id <ramdisk-id> - ID of image stored in Glance that should be used as - the ramdisk when booting an AMI-style image - - - - - --min-ram <ram-mb> - - - Amount of RAM (in MB) required to boot image - - - - - --container-format <container-format> - - - Format of the container. Valid values: ['None', 'ami', - 'ari', 'aki', 'bare', 'ovf', 'ova'] + ID of ramdisk image used to boot this disk image @@ -4026,6 +4439,51 @@ Save object locally + +
+
+ openstack object set + usage: openstack --os-auth-type token --os-identity-api-version 2 object set [-h] --property <key=value> <container> <object> + +Set object properties + + Positional arguments + + <container> + + + Modify <object> from <container> + + + + + <object> + + + Object to modify + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key=value> + + + Set a property on this object (repeat option to set + multiple properties) + + +
@@ -4066,6 +4524,123 @@ Display object details + +
+
+ openstack object store account set + usage: openstack --os-auth-type token --os-identity-api-version 2 object store account set [-h] --property <key=value> + +Set account properties + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key=value> + + + Set a property on this account (repeat option to set + multiple properties) + + + + +
+
+ openstack object store account show + usage: openstack --os-auth-type token --os-identity-api-version 2 object store account show [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width <integer>] + [--noindent] [--prefix PREFIX] + +Display account details + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack object store account unset + usage: openstack --os-auth-type token --os-identity-api-version 2 object store account unset [-h] --property <key> + +Unset account properties + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property to remove from account (repeat option to remove + multiple properties) + + + + +
+
+ openstack object unset + usage: openstack --os-auth-type token --os-identity-api-version 2 object unset [-h] --property <key> <container> <object> + +Unset object properties + + Positional arguments + + <container> + + + Modify <object> from <container> + + + + + <object> + + + Object to modify + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property to remove from object (repeat option to remove + multiple properties) + + +
@@ -7393,7 +7968,7 @@ Delete volume(s) [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] - [--status <status>] [--name <name>] + [--name <name>] [--status <status>] [--all-projects] [--long] List volumes @@ -7408,18 +7983,18 @@ List volumes - --status <status> + --name <name> - Filter results by status + Filter results by volume name - --name <name> + --status <status> - Filter results by name + Filter results by status