diff --git a/doc/cli-reference/generated/ch_cli_ironic_commands.xml b/doc/cli-reference/generated/ch_cli_ironic_commands.xml index fe0c842c47..0c823ce0ee 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 API and its extensions. This chapter documents ironic version - 0.7.0. + 0.8.0. For help on a specific ironic @@ -25,24 +25,24 @@
ironic usage - usage: ironic [--version] [--debug] [-v] [--cert-file OS_CERT] - [--key-file OS_KEY] [--ca-file OS_CACERT] - [--os-username OS_USERNAME] [--os-password OS_PASSWORD] - [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] - [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] - [--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] - [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] - [--insecure] [--os-cacert <ca-certificate>] + usage: ironic [--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] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] - [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] + [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--version] + [--debug] [-v] [--cert-file OS_CERT] [--key-file OS_KEY] + [--ca-file OS_CACERT] [--os-username OS_USERNAME] + [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] + [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] + [--os-region-name OS_REGION_NAME] + [--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] + [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] <subcommand> ... Subcommands @@ -328,6 +328,103 @@
ironic optional arguments + + --insecure + + + 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. + + + + + --os-cacert <ca-certificate> + + + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + env[OS_CACERT]. + + + + + --os-cert <certificate> + + + Defaults to env[OS_CERT]. + + + + + --os-key <key> + + + Defaults to env[OS_KEY]. + + + + + --timeout <seconds> + + + Set request timeout (in seconds). + + + + + --os-user-domain-id OS_USER_DOMAIN_ID + + + Defaults to env[OS_USER_DOMAIN_ID]. + + + + + --os-user-domain-name OS_USER_DOMAIN_NAME + + + Defaults to env[OS_USER_DOMAIN_NAME]. + + + + + --os-project-id OS_PROJECT_ID + + + Another way to specify tenant ID. This option is + mutually exclusive with --os-tenant-id. Defaults to + env[OS_PROJECT_ID]. + + + + + --os-project-name OS_PROJECT_NAME + + + Another way to specify tenant name. This option is + mutually exclusive with --os-tenant-name. Defaults to + env[OS_PROJECT_NAME]. + + + + + --os-project-domain-id OS_PROJECT_DOMAIN_ID + + + Defaults to env[OS_PROJECT_DOMAIN_ID]. + + + + + --os-project-domain-name OS_PROJECT_DOMAIN_NAME + + + Defaults to env[OS_PROJECT_DOMAIN_NAME]. + + + --version @@ -495,103 +592,6 @@ - - --insecure - - - 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. - - - - - --os-cacert <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - Set request timeout (in seconds). - - - - - --os-user-domain-id OS_USER_DOMAIN_ID - - - Defaults to env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name OS_USER_DOMAIN_NAME - - - Defaults to env[OS_USER_DOMAIN_NAME]. - - - - - --os-project-id OS_PROJECT_ID - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-project-name OS_PROJECT_NAME - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-project-domain-id OS_PROJECT_DOMAIN_ID - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name OS_PROJECT_DOMAIN_NAME - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - -
@@ -640,7 +640,8 @@ Delete a chassis.
ironic chassis-list usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <chassis>] - [--sort-key <field>] [--sort-dir <direction>] + [--sort-key <field>] [--sort-dir <direction>] + [--fields <field> [<field> ...]] List the chassis. @@ -689,12 +690,23 @@ List the chassis. + + --fields <field> [<field> ...] + + + One or more chassis fields. Only these fields will be + fetched from the server. Can not be used when '-- + detail' is specified. + + +
ironic chassis-node-list usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] + [--fields <field> [<field> ...]] <chassis> List the nodes contained in a chassis. @@ -755,11 +767,21 @@ List the nodes contained in a chassis. + + --fields <field> [<field> ...] + + + One or more node fields. Only these fields will be + fetched from the server. Can not be used when '-- + detail' is specified. + + +
ironic chassis-show - usage: ironic chassis-show <chassis> + usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis> Show detailed information about a chassis. @@ -772,6 +794,18 @@ Show detailed information about a chassis. + + + Optional arguments + + --fields <field> [<field> ...] + + + One or more chassis fields. Only these fields will be + fetched from the server. + + +
@@ -1043,7 +1077,8 @@ Get the supported boot devices for a node. usage: ironic node-list [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] [--maintenance <boolean>] [--associated <boolean>] - [--detail] + [--provision-state <provision-state>] [--detail] + [--fields <field> [<field> ...]] List the nodes which are registered with the Ironic service. @@ -1100,6 +1135,14 @@ List the nodes which are registered with the Ironic service. + + --provision-state <provision-state> + + + List nodes in specified provision state. + + + --detail @@ -1108,12 +1151,23 @@ List the nodes which are registered with the Ironic service. + + --fields <field> [<field> ...] + + + One or more node fields. Only these fields will be + fetched from the server. Can not be used when '-- + detail' is specified. + + +
ironic node-port-list usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <port>] [--sort-key <field>] [--sort-dir <direction>] + [--fields <field> [<field> ...]] <node> List the ports associated with a node. @@ -1174,6 +1228,16 @@ List the ports associated with a node. + + --fields <field> [<field> ...] + + + One or more port fields. Only these fields will be + fetched from the server. Can not be used when '-- + detail' is specified. + + +
@@ -1345,7 +1409,7 @@ Provision, rebuild, delete, inspect, provide or manage an instance.
ironic node-show - usage: ironic node-show [--instance] <id> + usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id> Show detailed information about a node. @@ -1354,8 +1418,8 @@ Show detailed information about a node. <id> - Name or UUID of the node (or instance UUID if --instance is - specified). + Name or UUID of the node (or instance UUID if + --instance is specified). @@ -1370,6 +1434,15 @@ Show detailed information about a node. + + --fields <field> [<field> ...] + + + One or more node fields. Only these fields will be + fetched from the server. + + +
@@ -1544,7 +1617,8 @@ Delete a port. ironic port-list usage: ironic port-list [--detail] [--address <mac-address>] [--limit <limit>] [--marker <port>] [--sort-key <field>] - [--sort-dir <direction>] + [--sort-dir <direction>] + [--fields <field> [<field> ...]] List the ports. @@ -1602,11 +1676,21 @@ List the ports. + + --fields <field> [<field> ...] + + + One or more port fields. Only these fields will be + fetched from the server. Can not be used when '-- + detail' is specified. + + +
ironic port-show - usage: ironic port-show [--address] <id> + usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id> Show detailed information about a port. @@ -1615,7 +1699,8 @@ Show detailed information about a port. <id> - UUID of the port (or MAC address if --address is specified). + UUID of the port (or MAC address if --address is + specified). @@ -1626,7 +1711,17 @@ Show detailed information about a port. --address <id> - is the MAC address (instead of the UUID) of the port. + is the MAC address (instead of the UUID) of the + port. + + + + + --fields <field> [<field> ...] + + + One or more port fields. Only these fields will be + fetched from the server.