此内容没有您所选择的语言版本。

Chapter 9. baremetal


This chapter describes the commands under the baremetal command.

9.1. baremetal chassis create

Usage:

openstack baremetal chassis create [-h]

                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--description <description>]
                                        [--extra <key=value>]
                                        [--uuid <uuid>]

Create a new chassis.

Expand
Table 9.1. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description for the chassis

--extra <key=value>

Record arbitrary key/value metadata. can be specified multiple times.

--uuid <uuid>

Unique uuid of the chassis

Expand
Table 9.2. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.3. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.5. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.2. baremetal chassis delete

Usage:

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]

Delete a chassis.

Expand
Table 9.6. Positional Arguments
ValueSummary

<chassis>

Uuids of chassis to delete

Expand
Table 9.7. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.3. baremetal chassis list

Usage:

openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--fields <field> [<field> ...]]
                                      [--limit <limit>] [--long]
                                      [--marker <chassis>]
                                      [--sort <key>[:<direction>]]

List the chassis.

Expand
Table 9.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--fields <field> [<field> …​]

One or more chassis fields. Only these fields will be fetched from the server. Cannot be used when '--long' is specified.

--limit <limit>

Maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.

--long

Show detailed information about the chassis

--marker <chassis>

Chassis uuid (for example, of the last chassis in the list from a previous request). Returns the list of chassis after this UUID.

--sort <key>[:<direction>]

Sort output by specified chassis fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.

Expand
Table 9.9. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.10. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.12. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.4. baremetal chassis set

Usage:

openstack baremetal chassis set [-h] [--description <description>]

                                     [--extra <key=value>]
                                     <chassis>

Set chassis properties.

Expand
Table 9.13. Positional Arguments
ValueSummary

<chassis>

Uuid of the chassis

Expand
Table 9.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set the description of the chassis

--extra <key=value>

Extra to set on this chassis (repeat option to set multiple extras)

This command is provided by the python-ironicclient plugin.

9.5. baremetal chassis show

Usage:

openstack baremetal chassis show [-h]

                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--fields <field> [<field> ...]]
                                      <chassis>

Show chassis details.

Expand
Table 9.15. Positional Arguments
ValueSummary

<chassis>

Uuid of the chassis

Expand
Table 9.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--fields <field> [<field> …​]

One or more chassis fields. Only these fields will be fetched from the server.

Expand
Table 9.17. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.18. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.20. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.6. baremetal chassis unset

Usage:

openstack baremetal chassis unset [-h] [--description] [--extra <key>]

                                       <chassis>

Unset chassis properties.

Expand
Table 9.21. Positional Arguments
ValueSummary

<chassis>

Uuid of the chassis

Expand
Table 9.22. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description

Clear the chassis description

--extra <key>

Extra to unset on this chassis (repeat option to unset multiple extras)

This command is provided by the python-ironicclient plugin.

9.7. baremetal create

Usage:

openstack baremetal create [-h] <file> [<file> ...]

Create resources from files

Expand
Table 9.23. Positional Arguments
ValueSummary

<file>

File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times.

Expand
Table 9.24. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.8. baremetal driver list

Usage:

openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--type <type>] [--long]

List the enabled drivers.

Expand
Table 9.25. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--type <type>

Type of driver ("classic" or "dynamic"). the default is to list all of them.

--long

Show detailed information about the drivers.

Expand
Table 9.26. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.27. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.28. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.29. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.9. baremetal driver passthru call

Usage:

openstack baremetal driver passthru call [-h]

                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <driver> <method>

Call a vendor passthru method for a driver.

Expand
Table 9.30. Positional Arguments
ValueSummary

<driver>

Name of the driver.

<method>

Vendor passthru method to be called.

Expand
Table 9.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--arg <key=value>

Argument to pass to the passthru method (repeat option to specify multiple arguments).

--http-method <http-method>

The HTTP method to use in the passthru request. One of DELETE, GET, PATCH, POST, PUT. Defaults to 'POST'.

Expand
Table 9.32. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.33. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.34. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.35. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.10. baremetal driver passthru list

Usage:

openstack baremetal driver passthru list [-h]

                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              <driver>

List available vendor passthru methods for a driver.

Expand
Table 9.36. Positional Arguments
ValueSummary

<driver>

Name of the driver.

Expand
Table 9.37. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.38. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.39. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.40. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.41. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.11. baremetal driver property list

Usage:

openstack baremetal driver property list [-h]

                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              <driver>

List the driver properties.

Expand
Table 9.42. Positional Arguments
ValueSummary

<driver>

Name of the driver.

Expand
Table 9.43. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.44. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.45. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.46. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.47. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.12. baremetal driver raid property list

Usage:

openstack baremetal driver raid property list [-h]

                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--sort-column SORT_COLUMN]
                                                   <driver>

List a driver’s RAID logical disk properties.

Expand
Table 9.48. Positional Arguments
ValueSummary

<driver>

Name of the driver.

Expand
Table 9.49. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.50. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.51. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.52. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.53. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.13. baremetal driver show

Usage:

openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <driver>

Show information about a driver.

Expand
Table 9.54. Positional Arguments
ValueSummary

<driver>

Name of the driver.

Expand
Table 9.55. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.56. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.57. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.58. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.59. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.14. baremetal introspection abort

Usage:

openstack baremetal introspection abort [-h] node

Abort running introspection for node.

Expand
Table 9.60. Positional Arguments
ValueSummary

node

Baremetal node uuid or name

Expand
Table 9.61. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

9.15. baremetal introspection data save

Usage:

openstack baremetal introspection data save [-h] [--file <filename>]

                                                 node

Save or display raw introspection data.

Expand
Table 9.62. Positional Arguments
ValueSummary

node

Baremetal node uuid or name

Expand
Table 9.63. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded introspection data filename (default: stdout)

This command is provided by the python-ironic-inspector-client plugin.

9.16. baremetal introspection interface list

Usage:

openstack baremetal introspection interface list [-h]

                                                      [-f {csv,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      [--sort-column SORT_COLUMN]
                                                      [--vlan VLAN]
                                                      [--long | --fields <field> [<field> ...]]
                                                      node_ident

List interface data including attached switch port information.

Expand
Table 9.64. Positional Arguments
ValueSummary

node_ident

Baremetal node uuid or name

Expand
Table 9.65. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--vlan VLAN

List only interfaces configured for this vlan id, can be repeated

--long

Show detailed information about interfaces.

--fields <field> [<field> …​]

Display one or more fields. Can not be used when '-- long' is specified

Expand
Table 9.66. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.67. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.68. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.69. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironic-inspector-client plugin.

9.17. baremetal introspection interface show

Usage:

openstack baremetal introspection interface show [-h]

                                                      [-f {json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [--fields <field> [<field> ...]]
                                                      node_ident interface

Show interface data including attached switch port information.

Expand
Table 9.70. Positional Arguments
ValueSummary

node_ident

Baremetal node uuid or name

interface

Interface name

Expand
Table 9.71. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--fields <field> [<field> …​]

Display one or more fields.

Expand
Table 9.72. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.73. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.74. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.75. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironic-inspector-client plugin.

9.18. baremetal introspection list

Usage:

openstack baremetal introspection list [-h]

                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--marker MARKER]
                                            [--limit LIMIT]

List introspection statuses

Expand
Table 9.76. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--marker MARKER

Uuid of the last item on the previous page

--limit LIMIT

The amount of items to return

Expand
Table 9.77. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.78. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.79. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.80. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironic-inspector-client plugin.

9.19. baremetal introspection reprocess

Usage:

openstack baremetal introspection reprocess [-h] node

Reprocess stored introspection data

Expand
Table 9.81. Positional Arguments
ValueSummary

node

Baremetal node uuid or name

Expand
Table 9.82. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

9.20. baremetal introspection rule delete

Usage:

openstack baremetal introspection rule delete [-h] uuid

Delete an introspection rule.

Expand
Table 9.83. Positional Arguments
ValueSummary

uuid

Rule uuid

Expand
Table 9.84. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

9.21. baremetal introspection rule import

Usage:

openstack baremetal introspection rule import [-h]

                                                   [-f {csv,json,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--quote {all,minimal,none,nonnumeric}]
                                                   [--sort-column SORT_COLUMN]
                                                   file

Import one or several introspection rules from a json file.

Expand
Table 9.85. Positional Arguments
ValueSummary

file

Json file to import, may contain one or several rules

Expand
Table 9.86. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.87. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.88. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.89. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.90. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironic-inspector-client plugin.

9.22. baremetal introspection rule list

Usage:

openstack baremetal introspection rule list [-h]

                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width]
                                                 [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]

List all introspection rules.

Expand
Table 9.91. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.92. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.93. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.94. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.95. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironic-inspector-client plugin.

9.23. baremetal introspection rule purge

Usage:

openstack baremetal introspection rule purge [-h]

Drop all introspection rules.

Expand
Table 9.96. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironic-inspector-client plugin.

9.24. baremetal introspection rule show

Usage:

openstack baremetal introspection rule show [-h]

                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width]
                                                 [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 uuid

Show an introspection rule.

Expand
Table 9.97. Positional Arguments
ValueSummary

uuid

Rule uuid

Expand
Table 9.98. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.99. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.100. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.101. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.102. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironic-inspector-client plugin.

9.25. baremetal introspection start

Usage:

openstack baremetal introspection start [-h]

                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
                                             [--wait]
                                             node [node ...]

Start the introspection.

Expand
Table 9.103. Positional Arguments
ValueSummary

node

Baremetal node uuid(s) or name(s)

Expand
Table 9.104. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for introspection to finish; the result will be displayed in the end

Expand
Table 9.105. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.106. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.107. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.108. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironic-inspector-client plugin.

9.26. baremetal introspection status

Usage:

openstack baremetal introspection status [-h]

                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              node

Get introspection status.

Expand
Table 9.109. Positional Arguments
ValueSummary

node

Baremetal node uuid or name

Expand
Table 9.110. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.111. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.112. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.113. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.114. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironic-inspector-client plugin.

9.27. baremetal node abort

Usage:

openstack baremetal node abort [-h] <node>

Set provision state of baremetal node to 'abort'

Expand
Table 9.115. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.116. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.28. baremetal node add trait

Usage:

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

Add traits to a node.

Expand
Table 9.117. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to add

Expand
Table 9.118. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.29. baremetal node adopt

Usage:

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

Set provision state of baremetal node to 'adopt'

Expand
Table 9.119. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.120. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

This command is provided by the python-ironicclient plugin.

9.30. baremetal node bios setting list

Usage:

openstack baremetal node bios setting list [-h]

                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                <node>

List a node’s BIOS settings.

Expand
Table 9.121. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.122. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.123. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.124. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.125. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.126. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.31. baremetal node bios setting show

Usage:

openstack baremetal node bios setting show [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                <node> <setting name>

Show a specific BIOS setting for a node.

Expand
Table 9.127. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

<setting name>

Setting name to show

Expand
Table 9.128. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.129. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.130. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.131. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.132. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.32. baremetal node boot device set

Usage:

openstack baremetal node boot device set [-h] [--persistent]

                                              <node> <device>

Set the boot device for a node

Expand
Table 9.133. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

<device>

One of bios, cdrom, disk, pxe, safe, wanboot

Expand
Table 9.134. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

This command is provided by the python-ironicclient plugin.

9.33. baremetal node boot device show

Usage:

openstack baremetal node boot device show [-h]

                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--prefix PREFIX]
                                               [--supported]
                                               <node>

Show the boot device information for a node

Expand
Table 9.135. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.136. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

Expand
Table 9.137. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.138. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.139. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.140. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.34. baremetal node clean

Usage:

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps

                                    <clean-steps>
                                    <node>

Set provision state of baremetal node to 'clean'

Expand
Table 9.141. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.142. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

--clean-steps <clean-steps>

The clean steps in JSON format. May be the path to a file containing the clean steps; OR '-', with the clean steps being read from standard input; OR a string. The value should be a list of clean-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'.

This command is provided by the python-ironicclient plugin.

9.35. baremetal node console disable

Usage:

openstack baremetal node console disable [-h] <node>

Disable console access for a node

Expand
Table 9.143. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.144. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.36. baremetal node console enable

Usage:

openstack baremetal node console enable [-h] <node>

Enable console access for a node

Expand
Table 9.145. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.146. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.37. baremetal node console show

Usage:

openstack baremetal node console show [-h]

                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <node>

Show console information for a node

Expand
Table 9.147. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.148. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.149. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.150. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.151. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.152. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.38. baremetal node create

Usage:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--chassis-uuid <chassis>] --driver
                                     <driver> [--driver-info <key=value>]
                                     [--property <key=value>]
                                     [--extra <key=value>] [--uuid <uuid>]
                                     [--name <name>]
                                     [--bios-interface <bios_interface>]
                                     [--boot-interface <boot_interface>]
                                     [--console-interface <console_interface>]
                                     [--deploy-interface <deploy_interface>]
                                     [--inspect-interface <inspect_interface>]
                                     [--management-interface <management_interface>]
                                     [--network-interface <network_interface>]
                                     [--power-interface <power_interface>]
                                     [--raid-interface <raid_interface>]
                                     [--rescue-interface <rescue_interface>]
                                     [--storage-interface <storage_interface>]
                                     [--vendor-interface <vendor_interface>]
                                     [--resource-class <resource_class>]
                                     [--conductor-group <conductor_group>]

Register a new node with the baremetal service

Expand
Table 9.153. Optional Arguments
ValueSummary

-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.

--bios-interface <bios_interface>

BIOS interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--boot-interface <boot_interface>

Boot interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--console-interface <console_interface>

Console interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--deploy-interface <deploy_interface>

Deploy interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--inspect-interface <inspect_interface>

Inspect interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--management-interface <management_interface>

Management interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--network-interface <network_interface>

Network interface used for switching node to cleaning/provisioning networks.

--power-interface <power_interface>

Power interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--raid-interface <raid_interface>

RAID interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--rescue-interface <rescue_interface>

Rescue interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--storage-interface <storage_interface>

Storage interface used by the node’s driver.

--vendor-interface <vendor_interface>

Vendor interface used by the node’s driver. This is only applicable when the specified --driver is a hardware type.

--resource-class <resource_class>

Resource class for mapping nodes to Nova flavors

--conductor-group <conductor_group>

Conductor group the node will belong to

Expand
Table 9.154. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 9.155. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.156. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.157. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-ironicclient plugin.

9.39. baremetal node delete

Usage:

openstack baremetal node delete [-h] <node> [<node> ...]

Unregister baremetal node(s)

Expand
Table 9.158. Positional Arguments
ValueSummary

<node>

Node(s) to delete (name or uuid)

Expand
Table 9.159. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.40. baremetal node deploy

Usage:

openstack baremetal node deploy [-h] [--wait [<time-out>]]

                                     [--config-drive <config-drive>]
                                     <node>

Set provision state of baremetal node to 'deploy'

Expand
Table 9.160. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.161. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, active. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

--config-drive <config-drive>

A gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files. In case it’s a directory, a config drive will be generated from it.

This command is provided by the python-ironicclient plugin.

9.41. baremetal node inject nmi

Usage:

openstack baremetal node inject nmi [-h] <node>

Inject NMI to baremetal node

Expand
Table 9.162. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.163. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.42. baremetal node inspect

Usage:

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

Set provision state of baremetal node to 'inspect'

Expand
Table 9.164. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.165. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

This command is provided by the python-ironicclient plugin.

9.43. baremetal node list

Usage:

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--limit <limit>] [--marker <node>]
                                   [--sort <key>[:<direction>]]
                                   [--maintenance | --no-maintenance]
                                   [--fault <fault>]
                                   [--associated | --unassociated]
                                   [--provision-state <provision state>]
                                   [--driver <driver>]
                                   [--resource-class <resource class>]
                                   [--conductor-group <conductor_group>]
                                   [--chassis <chassis UUID>]
                                   [--long | --fields <field> [<field> ...]]

List baremetal nodes

Expand
Table 9.166. Optional Arguments
ValueSummary

-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 specified node fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma.

--maintenance

Limit list to nodes in maintenance mode

--no-maintenance

Limit list to nodes not in maintenance mode

--fault <fault>

List nodes in specified fault.

--associated

List only nodes associated with an instance.

--unassociated

List only nodes not associated with an instance.

--provision-state <provision state>

List nodes in specified provision state.

--driver <driver>

Limit list to nodes with driver <driver>

--resource-class <resource class>

Limit list to nodes with resource class <resource class>

--conductor-group <conductor_group>

Limit list to nodes with conductor group <conductor group>

--chassis <chassis UUID>

Limit list to nodes of this chassis

--long

Show detailed information about the nodes.

--fields <field> [<field> …​]

One or more node fields. Only these fields will be fetched from the server. Can not be used when '--long' is specified.

Expand
Table 9.167. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.168. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.169. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.170. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.44. baremetal node maintenance set

Usage:

openstack baremetal node maintenance set [-h] [--reason <reason>]

                                              <node>

Set baremetal node to maintenance mode

Expand
Table 9.171. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.172. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

This command is provided by the python-ironicclient plugin.

9.45. baremetal node maintenance unset

Usage:

openstack baremetal node maintenance unset [-h] <node>

Unset baremetal node from maintenance mode

Expand
Table 9.173. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.174. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-ironicclient plugin.

9.46. baremetal node manage

Usage:

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

Set provision state of baremetal node to 'manage'

Expand
Table 9.175. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.176. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

Wait for a node to reach the desired state, manageable. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely.

This command is provided by the python-ironicclient plugin.

9.47. baremetal node passthru call

Usage:

openstack baremetal node passthru call [-h] [--arg <key=value>]

                                            [--http-method <http-method>]
                                            <node> <method>

Call a vendor passthu method for a node

Expand
Table 9.177. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

Expand
Table 9.178. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--arg <key=value>

Argument to pass to the passthru method (repeat option to specify multiple arguments)

--http-method <http-method>

The HTTP method to use in the passthru request. One of DELETE, GET, PATCH, POST, PUT. Defaults to POST.

This command is provided by the python-ironicclient plugin.

9.48. baremetal node passthru list

Usage:

openstack baremetal node passthru list [-h]

                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            <node>

List vendor passthru methods for a node

Expand
Table 9.179. Positional Arguments
ValueSummary

<node>

Name or uuid of the node

Expand
Table 9.180. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 9.181. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 9.182. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 9.183. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 9.184. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-ironicclient plugin.

9.49. baremetal node power off

Usage:

openstack baremetal node power off [-h]

                                        [--power-timeout <power-timeout>]
                                        [--soft]
                                        <node>

Power off a node

Expand
Table 9.185. Positional Arguments
ValueSummary

<node>

Name or uuid of the node.

Expand
Table 9.186. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--power-timeout <power-timeout>

Timeout (in seconds, positive integer) to wait for the target power state before erroring out.

--soft

Request graceful power-off.

This command is provided by the python-ironicclient plugin.

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat
返回顶部