Menu Close

Chapter 9. baremetal

This chapter describes the commands under the baremetal command.

9.1. baremetal chassis create

Create a new chassis.

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

Table 9.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.2. Output Formatters

ValueSummary

output formatter options-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

Table 9.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.4. Optional Arguments

ValueSummary

--uuid <uuid>

Unique uuid of the chassis

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

Table 9.5. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.2. baremetal chassis delete

Delete a chassis.

Usage:

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

Table 9.6. Positional Arguments

ValueSummary

<chassis>

Uuids of chassis to delete

Table 9.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.3. baremetal chassis list

List the chassis.

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

Table 9.8. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.9. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.10. Output Formatters

ValueSummary

output formatter options-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

Table 9.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.12. Optional Arguments

ValueSummary

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

--long

Show detailed information about the chassis

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

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

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

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

-h, --help

Show this help message and exit

9.4. baremetal chassis set

Set chassis properties.

Usage:

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>

Table 9.13. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

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)

9.5. baremetal chassis show

Show chassis details.

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>

Table 9.15. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.16. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 9.17. Output Formatters

ValueSummary

output formatter options-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

Table 9.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

Table 9.20. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.6. baremetal chassis unset

Unset chassis properties.

Usage:

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

Table 9.21. Positional Arguments

ValueSummary

<chassis>

Uuid of the chassis

Table 9.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

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

--description

Clear the chassis description

9.7. baremetal create

Create resources from files

Usage:

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

Table 9.23. Positional Arguments

ValueSummary

<file>

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

Table 9.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.8. baremetal driver list

List the enabled drivers.

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]

Table 9.25. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.26. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.27. Output Formatters

ValueSummary

output formatter options-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

Table 9.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.29. Optional Arguments

ValueSummary

--type <type>

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

-h, --help

Show this help message and exit

--long

Show detailed information about the drivers.

9.9. baremetal driver passthru call

Call a vendor passthru method for a driver.

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>

Table 9.30. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.31. Positional Arguments

ValueSummary

<method>

Vendor passthru method to be called.

<driver>

Name of the driver.

Table 9.32. Output Formatters

ValueSummary

output formatter options-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

Table 9.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--http-method <http-method>

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

--arg <key=value>

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

Table 9.35. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.10. baremetal driver passthru list

List available vendor passthru methods for a driver.

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>

Table 9.36. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.37. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.38. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.39. Output Formatters

ValueSummary

output formatter options-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

Table 9.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.11. baremetal driver property list

List the driver properties.

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>

Table 9.42. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.43. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.44. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.45. Output Formatters

ValueSummary

output formatter options-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

Table 9.46. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.12. baremetal driver raid property list

List a driver’s RAID logical disk properties.

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>

Table 9.48. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.49. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.50. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.51. Output Formatters

ValueSummary

output formatter options-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

Table 9.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.53. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.13. baremetal driver show

Show information about a driver.

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>

Table 9.54. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.55. Positional Arguments

ValueSummary

<driver>

Name of the driver.

Table 9.56. Output Formatters

ValueSummary

output formatter options-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

Table 9.57. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.59. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.14. baremetal introspection abort

Abort running introspection for node.

Usage:

openstack baremetal introspection abort [-h] node

Table 9.60. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.61. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.15. baremetal introspection data save

Save or display raw introspection data.

Usage:

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

Table 9.62. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.63. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded introspection data filename (default: stdout)

9.16. baremetal introspection interface list

List interface data including attached switch port information.

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

Table 9.64. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.65. Positional Arguments

ValueSummary

node_ident

Baremetal node uuid or name

Table 9.66. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.67. Output Formatters

ValueSummary

output formatter options-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

Table 9.68. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

9.17. baremetal introspection interface show

Show interface data including attached switch port information.

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

Table 9.70. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.71. Positional Arguments

ValueSummary

interface

Interface name

node_ident

Baremetal node uuid or name

Table 9.72. Output Formatters

ValueSummary

output formatter options-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

Table 9.73. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Display one or more fields.

Table 9.75. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.18. baremetal introspection list

List introspection statuses

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]

Table 9.76. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.77. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.78. Output Formatters

ValueSummary

output formatter options-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

Table 9.79. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.80. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT

The amount of items to return

--marker MARKER

Uuid of the last item on the previous page

9.19. baremetal introspection reprocess

Reprocess stored introspection data

Usage:

openstack baremetal introspection reprocess [-h] node

Table 9.81. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.82. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.20. baremetal introspection rule delete

Delete an introspection rule.

Usage:

openstack baremetal introspection rule delete [-h] uuid

Table 9.83. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 9.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.21. baremetal introspection rule import

Import one or several introspection rules from a json file.

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

Table 9.85. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.86. Positional Arguments

ValueSummary

file

Json file to import, may contain one or several rules

Table 9.87. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.88. Output Formatters

ValueSummary

output formatter options-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

Table 9.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.22. baremetal introspection rule list

List all introspection rules.

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]

Table 9.91. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.92. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.93. Output Formatters

ValueSummary

output formatter options-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

Table 9.94. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.23. baremetal introspection rule purge

Drop all introspection rules.

Usage:

openstack baremetal introspection rule purge [-h]

Table 9.96. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.24. baremetal introspection rule show

Show an introspection rule.

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

Table 9.97. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.98. Positional Arguments

ValueSummary

uuid

Rule uuid

Table 9.99. Output Formatters

ValueSummary

output formatter options-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

Table 9.100. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.101. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.102. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.25. baremetal introspection start

Start the introspection.

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

Table 9.103. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.104. Positional Arguments

ValueSummary

node

Baremetal node uuid(s) or name(s)

Table 9.105. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.106. Output Formatters

ValueSummary

output formatter options-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

Table 9.107. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

9.26. baremetal introspection status

Get 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

Table 9.109. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.110. Positional Arguments

ValueSummary

node

Baremetal node uuid or name

Table 9.111. Output Formatters

ValueSummary

output formatter options-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

Table 9.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.114. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.27. baremetal node abort

Set provision state of baremetal node to abort

Usage:

openstack baremetal node abort [-h] <node>

Table 9.115. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.28. baremetal node add trait

Add traits to a node.

Usage:

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

Table 9.117. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to add

Table 9.118. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.29. baremetal node adopt

Set provision state of baremetal node to adopt

Usage:

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

Table 9.119. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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.

9.30. baremetal node boot device set

Set the boot device for a node

Usage:

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

Table 9.121. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<device>

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

Table 9.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

9.31. baremetal node boot device show

Show the boot device information for a node

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>

Table 9.123. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.124. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.125. Output Formatters

ValueSummary

output formatter options-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

Table 9.126. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.127. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

Table 9.128. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.32. baremetal node clean

Set provision state of baremetal node to clean

Usage:

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

Table 9.129. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.33. baremetal node console disable

Disable console access for a node

Usage:

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

Table 9.131. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.132. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.34. baremetal node console enable

Enable console access for a node

Usage:

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

Table 9.133. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.35. baremetal node console show

Show console information for a node

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>

Table 9.135. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.136. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.137. Output Formatters

ValueSummary

output formatter options-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

Table 9.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 9.140. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.36. baremetal node create

Register a new node with the baremetal service

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>]
                                       [--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>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]

Table 9.141. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.142. Output Formatters

ValueSummary

output formatter options-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

Table 9.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.144. Optional Arguments

ValueSummary

--inspect-interface <inspect_interface>

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

--management-interface <management_interface>

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

--driver <driver>

Driver used to control the node [required].

--deploy-interface <deploy_interface>

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

--uuid <uuid>

Unique uuid for the node.

--console-interface <console_interface>

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

--chassis-uuid <chassis>

Uuid of the chassis that this node belongs to.

--network-interface <network_interface>

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

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

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

--raid-interface <raid_interface>

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

--power-interface <power_interface>

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

--name <name>

Unique name for the node.

--driver-info <key=value>

Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.

--extra <key=value>

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

-h, --help

Show this help message and exit

Table 9.145. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.37. baremetal node delete

Unregister baremetal node(s)

Usage:

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

Table 9.146. Positional Arguments

ValueSummary

<node>

Node(s) to delete (name or uuid)

Table 9.147. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.38. baremetal node deploy

Set provision state of baremetal node to deploy

Usage:

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

Table 9.148. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.39. baremetal node inject nmi

Inject NMI to baremetal node

Usage:

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

Table 9.150. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.151. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.40. baremetal node inspect

Set provision state of baremetal node to inspect

Usage:

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

Table 9.152. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.41. baremetal node list

List baremetal nodes

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]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--chassis <chassis UUID>]
                                     [--long | --fields <field> [<field> ...]]

Table 9.154. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.155. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.156. Output Formatters

ValueSummary

output formatter options-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

Table 9.157. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.158. Optional Arguments

ValueSummary

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

--chassis <chassis UUID>

Limit list to nodes of this chassis

--resource-class <resource class>

Limit list to nodes with resource class <resource class>

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

--long

Show detailed information about the nodes.

--provision-state <provision state>

List nodes in specified provision state.

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

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

--maintenance

Limit list to nodes in maintenance mode

--unassociated

List only nodes not associated with an instance.

-h, --help

Show this help message and exit

--associated

List only nodes associated with an instance.

--no-maintenance

Limit list to nodes not in maintenance mode

--driver <driver>

Limit list to nodes with driver <driver>

9.42. baremetal node maintenance set

Set baremetal node to maintenance mode

Usage:

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

Table 9.159. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.160. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

9.43. baremetal node maintenance unset

Unset baremetal node from maintenance mode

Usage:

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

Table 9.161. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.162. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.44. baremetal node manage

Set provision state of baremetal node to manage

Usage:

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

Table 9.163. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.45. baremetal node passthru call

Call a vendor passthu method for a node

Usage:

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

Table 9.165. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

Table 9.166. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--http-method <http-method>

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

--arg <key=value>

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

9.46. baremetal node passthru list

List vendor passthru methods for a node

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>

Table 9.167. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.168. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.169. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.170. Output Formatters

ValueSummary

output formatter options-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

Table 9.171. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.172. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.47. baremetal node power off

Power off a node

Usage:

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

Table 9.173. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.174. Optional Arguments

ValueSummary

--soft

Request graceful power-off.

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

9.48. baremetal node power on

Power on a node

Usage:

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>

Table 9.175. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.49. baremetal node provide

Set provision state of baremetal node to provide

Usage:

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

Table 9.177. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.178. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

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

9.50. baremetal node reboot

Reboot baremetal node

Usage:

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>

Table 9.179. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.180. Optional Arguments

ValueSummary

--soft

Request graceful reboot.

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

9.51. baremetal node rebuild

Set provision state of baremetal node to rebuild

Usage:

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

Table 9.181. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

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

9.52. baremetal node remove trait

Remove trait(s) from a node.

Usage:

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

Table 9.183. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<trait>

Trait(s) to remove

Table 9.184. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Remove all traits

9.53. baremetal node set

Set baremetal properties

Usage:

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--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>]
                                    [--storage-interface <storage_interface>]
                                    [--vendor-interface <vendor_interface>]
                                    [--resource-class <resource_class>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    <node>

Table 9.185. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.186. Optional Arguments

ValueSummary

--instance-uuid <uuid>

Set instance uuid of node to <uuid>

--inspect-interface <inspect_interface>

Set the inspect interface for the node

--boot-interface <boot_interface>

Set the boot interface for the node

--management-interface <management_interface>

Set the management interface for the node

--driver <driver>

Set the driver for the node

--extra <key=value>

Extra to set on this baremetal node (repeat option to set multiple extras)

--deploy-interface <deploy_interface>

Set the deploy interface for the node

--name <name>

Set the name of the node

--console-interface <console_interface>

Set the console interface for the node

--power-interface <power_interface>

Set the power interface for the node

--network-interface <network_interface>

Set the network interface for the node

--property <key=value>

Property to set on this baremetal node (repeat option to set multiple properties)

--vendor-interface <vendor_interface>

Set the vendor interface for the node

--resource-class <resource_class>

Set the resource class for the node

--chassis-uuid <chassis UUID>

Set the chassis for the node

--raid-interface <raid_interface>

Set the raid interface for the node

--storage-interface <storage_interface>

Set the storage interface for the node

--instance-info <key=value>

Instance information to set on this baremetal node (repeat option to set multiple instance infos)

--driver-info <key=value>

Driver information to set on this baremetal node (repeat option to set multiple driver infos)

-h, --help

Show this help message and exit

--target-raid-config <target_raid_config>

Set the target raid configuration (json) for the node. This can be one of: 1. a file containing JSON data of the RAID configuration; 2. "-" to read the contents from standard input; or 3. a valid JSON string.

9.54. baremetal node show

Show baremetal node details

Usage:

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

Table 9.187. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.188. Positional Arguments

ValueSummary

<node>

Name or uuid of the node (or instance uuid if --instance is specified)

Table 9.189. Output Formatters

ValueSummary

output formatter options-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

Table 9.190. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.191. Optional Arguments

ValueSummary

--instance

<node> is an instance uuid.

-h, --help

Show this help message and exit

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

One or more node fields. only these fields will be fetched from the server.

Table 9.192. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.55. baremetal node trait list

List a node’s traits.

Usage:

openstack baremetal node trait 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>

Table 9.193. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.194. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.195. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.196. Output Formatters

ValueSummary

output formatter options-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

Table 9.197. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.198. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.56. baremetal node undeploy

Set provision state of baremetal node to deleted

Usage:

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

Table 9.199. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.200. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--wait [<time-out>]

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

9.57. baremetal node unset

Unset baremetal properties

Usage:

openstack baremetal node unset [-h] [--instance-uuid] [--name]
                                      [--resource-class]
                                      [--target-raid-config]
                                      [--property <key>] [--extra <key>]
                                      [--driver-info <key>]
                                      [--instance-info <key>] [--chassis-uuid]
                                      [--boot-interface] [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--storage-interface]
                                      [--vendor-interface]
                                      <node>

Table 9.201. Positional Arguments

ValueSummary

<node>

Name or uuid of the node.

Table 9.202. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal node (repeat option to unset multiple properties)

--storage-interface

Unset storage interface on this baremetal node

--instance-uuid

Unset instance uuid on this baremetal node

--deploy-interface

Unset deploy interface on this baremetal node

--vendor-interface

Unset vendor interface on this baremetal node

--network-interface

Unset network interface on this baremetal node

--instance-info <key>

Instance information to unset on this baremetal node (repeat option to unset multiple instance informations)

--driver-info <key>

Driver information to unset on this baremetal node (repeat option to unset multiple driver informations)

--extra <key>

Extra to unset on this baremetal node (repeat option to unset multiple extras)

--resource-class

Unset the resource class of the node

--management-interface

Unset management interface on this baremetal node

--boot-interface

Unset boot interface on this baremetal node

--raid-interface

Unset raid interface on this baremetal node

--console-interface

Unset console interface on this baremetal node

--target-raid-config

Unset the target raid configuration of the node

--name

Unset the name of the node

-h, --help

Show this help message and exit

--inspect-interface

Unset inspect interface on this baremetal node

--chassis-uuid

Unset chassis uuid on this baremetal node

--power-interface

Unset power interface on this baremetal node

9.58. baremetal node validate

Validate a node’s driver interfaces

Usage:

openstack baremetal node validate [-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>

Table 9.203. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.204. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.205. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.206. Output Formatters

ValueSummary

output formatter options-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

Table 9.207. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.208. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.59. baremetal node vif attach

Attach VIF to a given node

Usage:

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

Table 9.209. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

Name or uuid of the vif to attach to a node.

Table 9.210. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--vif-info <key=value>

Record arbitrary key/value metadata. can be specified multiple times. The mandatory id parameter cannot be specified as a key.

9.60. baremetal node vif detach

Detach VIF from a given node

Usage:

openstack baremetal node vif detach [-h] <node> <vif-id>

Table 9.211. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

<vif-id>

Name or uuid of the vif to detach from a node.

Table 9.212. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.61. baremetal node vif list

Show attached VIFs for a node

Usage:

openstack baremetal node vif 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>

Table 9.213. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.214. Positional Arguments

ValueSummary

<node>

Name or uuid of the node

Table 9.215. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.216. Output Formatters

ValueSummary

output formatter options-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

Table 9.217. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.218. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.62. baremetal port create

Create a new port

Usage:

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX] --node
                                       <uuid> [--uuid <uuid>]
                                       [--extra <key=value>]
                                       [--local-link-connection <key=value>]
                                       [-l <key=value>]
                                       [--pxe-enabled <boolean>]
                                       [--port-group <uuid>]
                                       [--physical-network <physical network>]
                                       <address>

Table 9.219. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.220. Positional Arguments

ValueSummary

<address>

Mac address for this port.

Table 9.221. Output Formatters

ValueSummary

output formatter options-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

Table 9.222. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.223. Optional Arguments

ValueSummary

--extra <key=value>

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

--physical-network <physical network>

Name of the physical network to which this port is connected.

--uuid <uuid>

Uuid of the port.

--port-group <uuid>

Uuid of the port group that this port belongs to.

--local-link-connection <key=value>

Key/value metadata describing local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

--pxe-enabled <boolean>

Indicates whether this port should be used when pxe booting this Node.

-l <key=value>

Deprecated. please use --local-link-connection instead. Key/value metadata describing Local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this port belongs to.

Table 9.224. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.63. baremetal port delete

Delete port(s).

Usage:

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

Table 9.225. Positional Arguments

ValueSummary

<port>

Uuid(s) of the port(s) to delete.

Table 9.226. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.64. baremetal port group create

Create a new baremetal port group.

Usage:

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --node <uuid>
                                             [--address <mac-address>]
                                             [--name NAME] [--uuid UUID]
                                             [--extra <key=value>]
                                             [--mode MODE]
                                             [--property <key=value>]
                                             [--support-standalone-ports | --unsupport-standalone-ports]

Table 9.227. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.228. Output Formatters

ValueSummary

output formatter options-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

Table 9.229. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.230. Optional Arguments

ValueSummary

--support-standalone-ports

Ports that are members of this port group can be used as stand-alone ports. (default)

--extra <key=value>

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

--address <mac-address>

Mac address for this port group.

--unsupport-standalone-ports

Ports that are members of this port group cannot be used as stand-alone ports.

--property <key=value>

Key/value property related to this port group’s configuration. Can be specified multiple times.

--mode MODE

Mode of the port group. for possible values, refer to https://www.kernel.org/doc/Documentation/networking/bo nding.txt.

--name NAME

Name of the port group.

-h, --help

Show this help message and exit

--uuid UUID

Uuid of the port group.

--node <uuid>

Uuid of the node that this port group belongs to.

Table 9.231. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.65. baremetal port group delete

Unregister baremetal port group(s).

Usage:

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

Table 9.232. Positional Arguments

ValueSummary

<port group>

Port group(s) to delete (name or uuid).

Table 9.233. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.66. baremetal port group list

List baremetal port groups.

Usage:

openstack baremetal port group 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 <port group>]
                                           [--sort <key>[:<direction>]]
                                           [--address <mac-address>]
                                           [--node <node>]
                                           [--long | --fields <field> [<field> ...]]

Table 9.234. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.235. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.236. Output Formatters

ValueSummary

output formatter options-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

Table 9.237. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.238. Optional Arguments

ValueSummary

--node <node>

Only list port groups of this node (name or uuid).

--address <mac-address>

Only show information for the port group with this mac address.

--long

Show detailed information about the port groups.

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

One or more port group fields. only these fields will be fetched from the server. Can not be used when -- long is specified.

--limit <limit>

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

--marker <port group>

Port group uuid (for example, of the last port group in the list from a previous request). Returns the list of port groups after this UUID.

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

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

-h, --help

Show this help message and exit

9.67. baremetal port group set

Set baremetal port group properties.

Usage:

openstack baremetal port group set [-h] [--node <uuid>]
                                          [--address <mac-address>]
                                          [--name <name>]
                                          [--extra <key=value>] [--mode MODE]
                                          [--property <key=value>]
                                          [--support-standalone-ports | --unsupport-standalone-ports]
                                          <port group>

Table 9.239. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 9.240. Optional Arguments

ValueSummary

--support-standalone-ports

Ports that are members of this port group can be used as stand-alone ports.

--extra <key=value>

Extra to set on this baremetal port group (repeat option to set multiple extras).

--address <mac-address>

Mac address for this port group.

--unsupport-standalone-ports

Ports that are members of this port group cannot be used as stand-alone ports.

--property <key=value>

Key/value property related to this port group’s configuration (repeat option to set multiple properties).

--mode MODE

Mode of the port group. for possible values, refer to https://www.kernel.org/doc/Documentation/networking/bo nding.txt.

--name <name>

Name of the port group.

-h, --help

Show this help message and exit

--node <uuid>

Update uuid of the node that this port group belongs to.

9.68. baremetal port group show

Show baremetal port group details.

Usage:

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>

Table 9.241. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.242. Positional Arguments

ValueSummary

<id>

Uuid or name of the port group (or mac address if --address is specified).

Table 9.243. Output Formatters

ValueSummary

output formatter options-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

Table 9.244. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.245. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--address

<id> is the mac address (instead of uuid or name) of the port group.

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

One or more port group fields. only these fields will be fetched from the server.

Table 9.246. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.69. baremetal port group unset

Unset baremetal port group properties.

Usage:

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

Table 9.247. Positional Arguments

ValueSummary

<port group>

Name or uuid of the port group.

Table 9.248. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal port group (repeat option to unset multiple properties).

--name

Unset the name of the port group.

-h, --help

Show this help message and exit

--address

Unset the address of the port group.

--extra <key>

Extra to unset on this baremetal port group (repeat option to unset multiple extras).

9.70. baremetal port list

List baremetal ports.

Usage:

openstack baremetal port 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]
                                     [--address <mac-address>] [--node <node>]
                                     [--port-group <port group>]
                                     [--limit <limit>] [--marker <port>]
                                     [--sort <key>[:<direction>]]
                                     [--long | --fields <field> [<field> ...]]

Table 9.249. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.250. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.251. Output Formatters

ValueSummary

output formatter options-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

Table 9.252. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.253. Optional Arguments

ValueSummary

--node <node>

Only list ports of this node (name or uuid).

--address <mac-address>

Only show information for the port with this mac address.

--marker <port>

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

--long

Show detailed information about ports.

--port-group <port group>

Only list ports of this port group (name or uuid).

--limit <limit>

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

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

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

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

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

-h, --help

Show this help message and exit

9.71. baremetal port set

Set baremetal port properties.

Usage:

openstack baremetal port set [-h] [--node <uuid>] [--address <address>]
                                    [--extra <key=value>]
                                    [--port-group <uuid>]
                                    [--local-link-connection <key=value>]
                                    [--pxe-enabled | --pxe-disabled]
                                    [--physical-network <physical network>]
                                    <port>

Table 9.254. Positional Arguments

ValueSummary

<port>

Uuid of the port

Table 9.255. Optional Arguments

ValueSummary

--pxe-enabled

Indicates that this port should be used when pxe booting this node (default)

--extra <key=value>

Extra to set on this baremetal port (repeat option to set multiple extras)

--pxe-disabled

Indicates that this port should not be used when pxe booting this node

--port-group <uuid>

Set uuid of the port group that this port belongs to.

--local-link-connection <key=value>

Key/value metadata describing local link connection information. Valid keys are switch_info, switch_id, and port_id. The keys switch_id and port_id are required. Can be specified multiple times.

--physical-network <physical network>

Set the name of the physical network to which this port is connected.

-h, --help

Show this help message and exit

--node <uuid>

Set uuid of the node that this port belongs to

--address <address>

Set mac address for this port

9.72. baremetal port show

Show baremetal port details.

Usage:

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>

Table 9.256. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.257. Positional Arguments

ValueSummary

<id>

Uuid of the port (or mac address if --address is specified).

Table 9.258. Output Formatters

ValueSummary

output formatter options-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

Table 9.259. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.260. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--address

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

Table 9.261. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.73. baremetal port unset

Unset baremetal port properties.

Usage:

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network]
                                      <port>

Table 9.262. Positional Arguments

ValueSummary

<port>

Uuid of the port.

Table 9.263. Optional Arguments

ValueSummary

--port-group

Remove port from the port group

-h, --help

Show this help message and exit

--extra <key>

Extra to unset on this baremetal port (repeat option to unset multiple extras)

--physical-network

Unset the physical network on this baremetal port.

9.74. baremetal volume connector create

Create a new baremetal volume connector.

Usage:

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]

Table 9.264. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.265. Output Formatters

ValueSummary

output formatter options-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

Table 9.266. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.267. Optional Arguments

ValueSummary

--node <uuid>

Uuid of the node that this volume connector belongs to.

--uuid <uuid>

Uuid of the volume connector.

--type <type>

Type of the volume connector. can be iqn, ip, mac, wwnn, wwpn, port, portgroup.

--extra <key=value>

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

-h, --help

Show this help message and exit

--connector-id <connector id>

Id of the volume connector in the specified type. for example, the iSCSI initiator IQN for the node if the type is iqn.

Table 9.268. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.75. baremetal volume connector delete

Unregister baremetal volume connector(s).

Usage:

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

Table 9.269. Positional Arguments

ValueSummary

<volume connector>

Uuid(s) of the volume connector(s) to delete.

Table 9.270. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.76. baremetal volume connector list

List baremetal volume connectors.

Usage:

openstack baremetal volume connector 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 <node>]
                                                 [--limit <limit>]
                                                 [--marker <volume connector>]
                                                 [--sort <key>[:<direction>]]
                                                 [--long | --fields <field> [<field> ...]]

Table 9.271. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.272. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.273. Output Formatters

ValueSummary

output formatter options-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

Table 9.274. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.275. Optional Arguments

ValueSummary

--node <node>

Only list volume connectors of this node (name or UUID).

--long

Show detailed information about volume connectors.

--limit <limit>

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

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

One or more volume connector fields. only these fields will be fetched from the server. Can not be used when --long is specified.

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

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

-h, --help

Show this help message and exit

--marker <volume connector>

Volume connector uuid (for example, of the last volume connector in the list from a previous request). Returns the list of volume connectors after this UUID.

9.77. baremetal volume connector set

Set baremetal volume connector properties.

Usage:

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

Table 9.276. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

Table 9.277. Optional Arguments

ValueSummary

--extra <key=value>

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

--type <type>

Type of the volume connector. can be iqn, ip, mac, wwnn, wwpn, port, portgroup.

-h, --help

Show this help message and exit

--node <uuid>

Uuid of the node that this volume connector belongs to.

--connector-id <connector id>

Id of the volume connector in the specified type.

9.78. baremetal volume connector show

Show baremetal volume connector details.

Usage:

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--fields <field> [<field> ...]]
                                                 <id>

Table 9.278. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.279. Positional Arguments

ValueSummary

<id>

Uuid of the volume connector.

Table 9.280. Output Formatters

ValueSummary

output formatter options-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

Table 9.281. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.282. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

One or more volume connector fields. only these fields will be fetched from the server.

Table 9.283. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.79. baremetal volume connector unset

Unset baremetal volume connector properties.

Usage:

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

Table 9.284. Positional Arguments

ValueSummary

<volume connector>

Uuid of the volume connector.

Table 9.285. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

9.80. baremetal volume target create

Create a new baremetal volume target.

Usage:

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                --node <uuid> --type <volume
                                                type> [--property <key=value>]
                                                --boot-index <boot index>
                                                --volume-id <volume id>
                                                [--uuid <uuid>]
                                                [--extra <key=value>]

Table 9.286. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.287. Output Formatters

ValueSummary

output formatter options-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

Table 9.288. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.289. Optional Arguments

ValueSummary

--extra <key=value>

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

--uuid <uuid>

Uuid of the volume target.

--property <key=value>

Key/value property related to the type of this volume target. Can be specified multiple times.

--boot-index <boot index>

Boot index of the volume target.

--type <volume type>

Type of the volume target, e.g. iscsi, fibre_channel.

-h, --help

Show this help message and exit

--volume-id <volume id>

Id of the volume associated with this target.

--node <uuid>

Uuid of the node that this volume target belongs to.

Table 9.290. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.81. baremetal volume target delete

Unregister baremetal volume target(s).

Usage:

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

Table 9.291. Positional Arguments

ValueSummary

<volume target>

Uuid(s) of the volume target(s) to delete.

Table 9.292. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

9.82. baremetal volume target list

List baremetal volume targets.

Usage:

openstack baremetal volume target 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 <node>]
                                              [--limit <limit>]
                                              [--marker <volume target>]
                                              [--sort <key>[:<direction>]]
                                              [--long | --fields <field> [<field> ...]]

Table 9.293. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.294. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 9.295. Output Formatters

ValueSummary

output formatter options-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

Table 9.296. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.297. Optional Arguments

ValueSummary

--node <node>

Only list volume targets of this node (name or uuid).

--marker <volume target>

Volume target uuid (for example, of the last volume target in the list from a previous request). Returns the list of volume targets after this UUID.

--long

Show detailed information about volume targets.

--limit <limit>

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

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

One or more volume target fields. only these fields will be fetched from the server. Can not be used when --long is specified.

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

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

-h, --help

Show this help message and exit

9.83. baremetal volume target set

Set baremetal volume target properties.

Usage:

openstack baremetal volume target set [-h] [--node <uuid>]
                                             [--type <volume type>]
                                             [--property <key=value>]
                                             [--boot-index <boot index>]
                                             [--volume-id <volume id>]
                                             [--extra <key=value>]
                                             <volume target>

Table 9.298. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 9.299. Optional Arguments

ValueSummary

--extra <key=value>

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

--property <key=value>

Key/value property related to the type of this volume target. Can be specified multiple times.

--boot-index <boot index>

Boot index of the volume target.

--type <volume type>

Type of the volume target, e.g. iscsi, fibre_channel.

-h, --help

Show this help message and exit

--volume-id <volume id>

Id of the volume associated with this target.

--node <uuid>

Uuid of the node that this volume target belongs to.

9.84. baremetal volume target show

Show baremetal volume target details.

Usage:

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--fields <field> [<field> ...]]
                                              <id>

Table 9.300. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 9.301. Positional Arguments

ValueSummary

<id>

Uuid of the volume target.

Table 9.302. Output Formatters

ValueSummary

output formatter options-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

Table 9.303. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 9.304. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

One or more volume target fields. only these fields will be fetched from the server.

Table 9.305. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

9.85. baremetal volume target unset

Unset baremetal volume target properties.

Usage:

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

Table 9.306. Positional Arguments

ValueSummary

<volume target>

Uuid of the volume target.

Table 9.307. Optional Arguments

ValueSummary

--property <key>

Property to unset on this baremetal volume target (repeat option to unset multiple properties).

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)