Chapter 11. baremetal This chapter describes the commands under the baremetal command. 11.1. baremetal allocation create Create a new baremetal allocation. Usage: Table 11.1. Command arguments Value Summary -h, --help Show this help message and exit --resource-class RESOURCE_CLASS Resource class to request. --trait TRAITS A trait to request. can be specified multiple times. --candidate-node CANDIDATE_NODES A candidate node for this allocation. can be specified multiple times. If at least one is specified, only the provided candidate nodes are considered for the allocation. --name NAME Unique name of the allocation. --uuid UUID Uuid of the allocation. --owner OWNER Owner of the allocation. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. --wait [<time-out>] Wait for the new allocation to become active. an error is returned if allocation fails and --wait is used. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely. --node NODE Backfill this allocation from the provided node that has already been deployed. Bypasses the normal allocation process. Table 11.2. Output formatter options Value Summary -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 to show multiple columns Table 11.3. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.4. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.5. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.2. baremetal allocation delete Unregister baremetal allocation(s). Usage: Table 11.6. Positional arguments Value Summary <allocation> Allocations(s) to delete (name or uuid). Table 11.7. Command arguments Value Summary -h, --help Show this help message and exit 11.3. baremetal allocation list List baremetal allocations. Usage: Table 11.8. Command arguments Value Summary -h, --help Show this help message and exit --limit <limit> Maximum number of allocations to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service. --marker <allocation> Allocation uuid (for example, of the last allocation in the list from a request). Returns the list of allocations after this UUID. --sort <key>[:<direction>] Sort output by specified allocation fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. --node <node> Only list allocations of this node (name or uuid). --resource-class <resource_class> Only list allocations with this resource class. --state <state> Only list allocations in this state. --owner <owner> Only list allocations with this owner. --long Show detailed information about the allocations. --fields <field> [<field> ... ] One or more allocation fields. only these fields will be fetched from the server. Can not be used when -- long is specified. Table 11.9. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.10. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.11. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.12. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.4. baremetal allocation set Set baremetal allocation properties. Usage: Table 11.13. Positional arguments Value Summary <allocation> Name or uuid of the allocation Table 11.14. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Set the name of the allocation --extra <key=value> Extra property to set on this allocation (repeat option to set multiple extra properties) 11.5. baremetal allocation show Show baremetal allocation details. Usage: Table 11.15. Positional arguments Value Summary <id> Uuid or name of the allocation Table 11.16. Command arguments Value Summary -h, --help Show this help message and exit --fields <field> [<field> ... ] One or more allocation fields. only these fields will be fetched from the server. Table 11.17. Output formatter options Value Summary -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 to show multiple columns Table 11.18. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.19. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.20. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.6. baremetal allocation unset Unset baremetal allocation properties. Usage: Table 11.21. Positional arguments Value Summary <allocation> Name or uuid of the allocation Table 11.22. Command arguments Value Summary -h, --help Show this help message and exit --name Unset the name of the allocation --extra <key> Extra property to unset on this baremetal allocation (repeat option to unset multiple extra property). 11.7. baremetal chassis create Create a new chassis. Usage: Table 11.23. Command arguments Value Summary -h, --help Show this help message and exit --description <description> Description for the chassis --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. --uuid <uuid> Unique uuid of the chassis Table 11.24. Output formatter options Value Summary -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 to show multiple columns Table 11.25. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.26. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.27. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.8. baremetal chassis delete Delete a chassis. Usage: Table 11.28. Positional arguments Value Summary <chassis> Uuids of chassis to delete Table 11.29. Command arguments Value Summary -h, --help Show this help message and exit 11.9. baremetal chassis list List the chassis. Usage: Table 11.30. Command arguments Value Summary -h, --help Show this help message and exit --fields <field> [<field> ... ] One or more chassis fields. only these fields will be fetched from the server. Cannot be used when --long is specified. --limit <limit> Maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service. --long Show detailed information about the chassis --marker <chassis> Chassis uuid (for example, of the last chassis in the list from a request). Returns the list of chassis after this UUID. --sort <key>[:<direction>] Sort output by specified chassis fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. Table 11.31. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.32. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.33. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.34. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.10. baremetal chassis set Set chassis properties. Usage: Table 11.35. Positional arguments Value Summary <chassis> Uuid of the chassis Table 11.36. Command arguments Value Summary -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) 11.11. baremetal chassis show Show chassis details. Usage: Table 11.37. Positional arguments Value Summary <chassis> Uuid of the chassis Table 11.38. Command arguments Value Summary -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 11.39. Output formatter options Value Summary -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 to show multiple columns Table 11.40. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.41. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.42. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.12. baremetal chassis unset Unset chassis properties. Usage: Table 11.43. Positional arguments Value Summary <chassis> Uuid of the chassis Table 11.44. Command arguments Value Summary -h, --help Show this help message and exit --description Clear the chassis description --extra <key> Extra to unset on this chassis (repeat option to unset multiple extras) 11.13. baremetal conductor list List baremetal conductors Usage: Table 11.45. Command arguments Value Summary -h, --help Show this help message and exit --limit <limit> Maximum number of conductors to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service. --marker <conductor> Hostname of the conductor (for example, of the last conductor in the list from a request). Returns the list of conductors after this conductor. --sort <key>[:<direction>] Sort output by specified conductor fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. --long Show detailed information about the conductors. --fields <field> [<field> ... ] One or more conductor fields. only these fields will be fetched from the server. Can not be used when -- long is specified. Table 11.46. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.47. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.48. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.49. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.14. baremetal conductor show Show baremetal conductor details Usage: Table 11.50. Positional arguments Value Summary <conductor> Hostname of the conductor Table 11.51. Command arguments Value Summary -h, --help Show this help message and exit --fields <field> [<field> ... ] One or more conductor fields. only these fields will be fetched from the server. Table 11.52. Output formatter options Value Summary -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 to show multiple columns Table 11.53. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.54. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.55. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.15. baremetal create Create resources from files Usage: Table 11.56. Positional arguments Value Summary <file> File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times. Table 11.57. Command arguments Value Summary -h, --help Show this help message and exit 11.16. baremetal deploy template create Create a new deploy template Usage: Table 11.58. Positional arguments Value Summary <name> Unique name for this deploy template. must be a valid trait name Table 11.59. Command arguments Value Summary -h, --help Show this help message and exit --uuid <uuid> Uuid of the deploy template. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. --steps <steps> The deploy steps. may be the path to a yaml file containing the deploy steps; OR - , with the deploy steps being read from standard input; OR a JSON string. The value should be a list of deploy-step dictionaries; each dictionary should have keys interface , step , args and priority . Table 11.60. Output formatter options Value Summary -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 to show multiple columns Table 11.61. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.62. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.63. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.17. baremetal deploy template delete Delete deploy template(s). Usage: Table 11.64. Positional arguments Value Summary <template> Name(s) or uuid(s) of the deploy template(s) to delete. Table 11.65. Command arguments Value Summary -h, --help Show this help message and exit 11.18. baremetal deploy template list List baremetal deploy templates. Usage: Table 11.66. Command arguments Value Summary -h, --help Show this help message and exit --limit <limit> Maximum number of deploy templates to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service. --marker <template> Deploytemplate uuid (for example, of the last deploy template in the list from a request). Returns the list of deploy templates after this UUID. --sort <key>[:<direction>] Sort output by specified deploy template fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. --long Show detailed information about deploy templates. --fields <field> [<field> ... ] One or more deploy template fields. only these fields will be fetched from the server. Can not be used when --long is specified. Table 11.67. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.68. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.69. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.70. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.19. baremetal deploy template set Set baremetal deploy template properties. Usage: Table 11.71. Positional arguments Value Summary <template> Name or uuid of the deploy template Table 11.72. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Set unique name of the deploy template. must be a valid trait name. --steps <steps> The deploy steps. may be the path to a yaml file containing the deploy steps; OR - , with the deploy steps being read from standard input; OR a JSON string. The value should be a list of deploy-step dictionaries; each dictionary should have keys interface , step , args and priority . --extra <key=value> Extra to set on this baremetal deploy template (repeat option to set multiple extras). 11.20. baremetal deploy template show Show baremetal deploy template details. Usage: Table 11.73. Positional arguments Value Summary <template> Name or uuid of the deploy template. Table 11.74. Command arguments Value Summary -h, --help Show this help message and exit --fields <field> [<field> ... ] One or more deploy template fields. only these fields will be fetched from the server. Table 11.75. Output formatter options Value Summary -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 to show multiple columns Table 11.76. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.77. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.78. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.21. baremetal deploy template unset Unset baremetal deploy template properties. Usage: Table 11.79. Positional arguments Value Summary <template> Name or uuid of the deploy template Table 11.80. Command arguments Value Summary -h, --help Show this help message and exit --extra <key> Extra to unset on this baremetal deploy template (repeat option to unset multiple extras). 11.22. baremetal driver list List the enabled drivers. Usage: Table 11.81. Command arguments Value Summary -h, --help Show this help message and exit --type <type> Type of driver ("classic" or "dynamic"). the default is to list all of them. --long Show detailed information about the drivers. Table 11.82. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.83. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.84. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.85. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.23. baremetal driver passthru call Call a vendor passthru method for a driver. Usage: Table 11.86. Positional arguments Value Summary <driver> Name of the driver. <method> Vendor passthru method to be called. Table 11.87. Command arguments Value Summary -h, --help Show this help message and exit --arg <key=value> Argument to pass to the passthru method (repeat option to specify multiple arguments). --http-method <http-method> The http method to use in the passthru request. one of DELETE, GET, PATCH, POST, PUT. Defaults to POST . Table 11.88. Output formatter options Value Summary -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 to show multiple columns Table 11.89. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.90. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.91. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.24. baremetal driver passthru list List available vendor passthru methods for a driver. Usage: Table 11.92. Positional arguments Value Summary <driver> Name of the driver. Table 11.93. Command arguments Value Summary -h, --help Show this help message and exit Table 11.94. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.95. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.96. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.97. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.25. baremetal driver property list List the driver properties. Usage: Table 11.98. Positional arguments Value Summary <driver> Name of the driver. Table 11.99. Command arguments Value Summary -h, --help Show this help message and exit Table 11.100. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.101. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.102. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.103. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.26. baremetal driver raid property list List a driver's RAID logical disk properties. Usage: Table 11.104. Positional arguments Value Summary <driver> Name of the driver. Table 11.105. Command arguments Value Summary -h, --help Show this help message and exit Table 11.106. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.107. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.108. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.109. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.27. baremetal driver show Show information about a driver. Usage: Table 11.110. Positional arguments Value Summary <driver> Name of the driver. Table 11.111. Command arguments Value Summary -h, --help Show this help message and exit Table 11.112. Output formatter options Value Summary -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 to show multiple columns Table 11.113. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.114. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.115. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.28. baremetal introspection abort Abort running introspection for node. Usage: Table 11.116. Positional arguments Value Summary node Baremetal node uuid or name Table 11.117. Command arguments Value Summary -h, --help Show this help message and exit 11.29. baremetal introspection data save Save or display raw introspection data. Usage: Table 11.118. Positional arguments Value Summary node Baremetal node uuid or name Table 11.119. Command arguments Value Summary -h, --help Show this help message and exit --file <filename> Downloaded introspection data filename (default: stdout) --unprocessed Download the unprocessed data 11.30. baremetal introspection interface list List interface data including attached switch port information. Usage: Table 11.120. Positional arguments Value Summary node_ident Baremetal node uuid or name Table 11.121. Command arguments Value Summary -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 Table 11.122. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.123. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.124. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.125. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.31. baremetal introspection interface show Show interface data including attached switch port information. Usage: Table 11.126. Positional arguments Value Summary node_ident Baremetal node uuid or name interface Interface name Table 11.127. Command arguments Value Summary -h, --help Show this help message and exit --fields <field> [<field> ... ] Display one or more fields. Table 11.128. Output formatter options Value Summary -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 to show multiple columns Table 11.129. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.130. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.131. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.32. baremetal introspection list List introspection statuses Usage: Table 11.132. Command arguments Value Summary -h, --help Show this help message and exit --marker MARKER Uuid of the last item on the page --limit LIMIT The amount of items to return Table 11.133. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.134. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.135. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.136. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.33. baremetal introspection reprocess Reprocess stored introspection data Usage: Table 11.137. Positional arguments Value Summary node Baremetal node uuid or name Table 11.138. Command arguments Value Summary -h, --help Show this help message and exit 11.34. baremetal introspection rule delete Delete an introspection rule. Usage: Table 11.139. Positional arguments Value Summary uuid Rule uuid Table 11.140. Command arguments Value Summary -h, --help Show this help message and exit 11.35. baremetal introspection rule import Import one or several introspection rules from a JSON/YAML file. Usage: Table 11.141. Positional arguments Value Summary file Json or yaml file to import, may contain one or several rules Table 11.142. Command arguments Value Summary -h, --help Show this help message and exit Table 11.143. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.144. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.145. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.146. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.36. baremetal introspection rule list List all introspection rules. Usage: Table 11.147. Command arguments Value Summary -h, --help Show this help message and exit Table 11.148. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.149. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.150. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.151. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.37. baremetal introspection rule purge Drop all introspection rules. Usage: Table 11.152. Command arguments Value Summary -h, --help Show this help message and exit 11.38. baremetal introspection rule show Show an introspection rule. Usage: Table 11.153. Positional arguments Value Summary uuid Rule uuid Table 11.154. Command arguments Value Summary -h, --help Show this help message and exit Table 11.155. Output formatter options Value Summary -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 to show multiple columns Table 11.156. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.157. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.158. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.39. baremetal introspection start Start the introspection. Usage: Table 11.159. Positional arguments Value Summary node Baremetal node uuid(s) or name(s) Table 11.160. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for introspection to finish; the result will be displayed in the end --check-errors Check if errors occurred during the introspection; if any error occurs only the errors are displayed; can only be used with --wait Table 11.161. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.162. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.163. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.164. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.40. baremetal introspection status Get introspection status. Usage: Table 11.165. Positional arguments Value Summary node Baremetal node uuid or name Table 11.166. Command arguments Value Summary -h, --help Show this help message and exit Table 11.167. Output formatter options Value Summary -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 to show multiple columns Table 11.168. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.169. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.170. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.41. baremetal node abort Set provision state of baremetal node to abort Usage: Table 11.171. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.172. Command arguments Value Summary -h, --help Show this help message and exit 11.42. baremetal node add trait Add traits to a node. Usage: Table 11.173. Positional arguments Value Summary <node> Name or uuid of the node <trait> Trait(s) to add Table 11.174. Command arguments Value Summary -h, --help Show this help message and exit 11.43. baremetal node adopt Set provision state of baremetal node to adopt Usage: Table 11.175. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.176. Command arguments Value Summary -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. 11.44. baremetal node bios setting list List a node's BIOS settings. Usage: Table 11.177. Positional arguments Value Summary <node> Name or uuid of the node Table 11.178. Command arguments Value Summary -h, --help Show this help message and exit Table 11.179. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.180. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.181. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.182. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.45. baremetal node bios setting show Show a specific BIOS setting for a node. Usage: Table 11.183. Positional arguments Value Summary <node> Name or uuid of the node <setting name> Setting name to show Table 11.184. Command arguments Value Summary -h, --help Show this help message and exit Table 11.185. Output formatter options Value Summary -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 to show multiple columns Table 11.186. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.187. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.188. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.46. baremetal node boot device set Set the boot device for a node Usage: Table 11.189. Positional arguments Value Summary <node> Name or uuid of the node <device> One of bios, cdrom, disk, pxe, safe, wanboot Table 11.190. Command arguments Value Summary -h, --help Show this help message and exit --persistent Make changes persistent for all future boots 11.47. baremetal node boot device show Show the boot device information for a node Usage: Table 11.191. Positional arguments Value Summary <node> Name or uuid of the node Table 11.192. Command arguments Value Summary -h, --help Show this help message and exit --supported Show the supported boot devices Table 11.193. Output formatter options Value Summary -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 to show multiple columns Table 11.194. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.195. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.196. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.48. baremetal node clean Set provision state of baremetal node to clean Usage: Table 11.197. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.198. Command arguments Value Summary -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. may be the path to a yaml file containing the clean steps; OR - , with the clean steps being read from standard input; OR a JSON string. The value should be a list of clean-step dictionaries; each dictionary should have keys interface and step , and optional key args . 11.49. baremetal node console disable Disable console access for a node Usage: Table 11.199. Positional arguments Value Summary <node> Name or uuid of the node Table 11.200. Command arguments Value Summary -h, --help Show this help message and exit 11.50. baremetal node console enable Enable console access for a node Usage: Table 11.201. Positional arguments Value Summary <node> Name or uuid of the node Table 11.202. Command arguments Value Summary -h, --help Show this help message and exit 11.51. baremetal node console show Show console information for a node Usage: Table 11.203. Positional arguments Value Summary <node> Name or uuid of the node Table 11.204. Command arguments Value Summary -h, --help Show this help message and exit Table 11.205. Output formatter options Value Summary -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 to show multiple columns Table 11.206. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.207. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.208. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.52. baremetal node create Register a new node with the baremetal service Usage: Table 11.209. Command arguments Value Summary -h, --help Show this help message and exit --chassis-uuid <chassis> Uuid of the chassis that this node belongs to. --driver <driver> Driver used to control the node [required]. --driver-info <key=value> Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times. --property <key=value> Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. --uuid <uuid> Unique uuid for the node. --name <name> Unique name for the node. --bios-interface <bios_interface> Bios interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --boot-interface <boot_interface> Boot interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --console-interface <console_interface> Console interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --deploy-interface <deploy_interface> Deploy interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --inspect-interface <inspect_interface> Inspect interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --management-interface <management_interface> Management interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --network-data <network data> Json string or a yaml file or - for stdin to read static network configuration for the baremetal node associated with this ironic node. Format of this file should comply with Nova network data metadata (network_data.json). Depending on ironic boot interface capabilities being used, network configuration may or may not been served to the node for offline network configuration. --network-interface <network_interface> Network interface used for switching node to cleaning/provisioning networks. --power-interface <power_interface> Power interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --raid-interface <raid_interface> Raid interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --rescue-interface <rescue_interface> Rescue interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --storage-interface <storage_interface> Storage interface used by the node's driver. --vendor-interface <vendor_interface> Vendor interface used by the node's driver. this is only applicable when the specified --driver is a hardware type. --resource-class <resource_class> Resource class for mapping nodes to nova flavors --conductor-group <conductor_group> Conductor group the node will belong to --automated-clean Enable automated cleaning for the node --no-automated-clean Explicitly disable automated cleaning for the node --owner <owner> Owner of the node. --lessee <lessee> Lessee of the node. --description <description> Description for the node. Table 11.210. Output formatter options Value Summary -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 to show multiple columns Table 11.211. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.212. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.213. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.53. baremetal node delete Unregister baremetal node(s) Usage: Table 11.214. Positional arguments Value Summary <node> Node(s) to delete (name or uuid) Table 11.215. Command arguments Value Summary -h, --help Show this help message and exit 11.54. baremetal node deploy Set provision state of baremetal node to deploy Usage: Table 11.216. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.217. Command arguments Value Summary -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 OR a JSON object to build config drive from. In case it's a directory, a config drive will be generated from it. In case it's a JSON object with optional keys meta_data , user_data and network_data , a config drive will be generated on the server side (see the bare metal API reference for more details). --deploy-steps <deploy-steps> The deploy steps. may be the path to a yaml file containing the deploy steps; OR - , with the deploy steps being read from standard input; OR a JSON string. The value should be a list of deploy-step dictionaries; each dictionary should have keys interface and step , and optional key args . 11.55. baremetal node inject nmi Inject NMI to baremetal node Usage: Table 11.218. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.219. Command arguments Value Summary -h, --help Show this help message and exit 11.56. baremetal node inspect Set provision state of baremetal node to inspect Usage: Table 11.220. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.221. Command arguments Value Summary -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. 11.57. baremetal node list List baremetal nodes Usage: Table 11.222. Command arguments Value Summary -h, --help Show this help message and exit --limit <limit> Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service. --marker <node> Node uuid (for example, of the last node in the list from a request). Returns the list of nodes after this UUID. --sort <key>[:<direction>] Sort output by specified node fields and directions (asc or desc) (default: asc). Multiple fields and directions can be specified, separated by comma. --maintenance Limit list to nodes in maintenance mode --no-maintenance Limit list to nodes not in maintenance mode --retired Limit list to retired nodes. --no-retired Limit list to not retired nodes. --fault <fault> List nodes in specified fault. --associated List only nodes associated with an instance. --unassociated List only nodes not associated with an instance. --provision-state <provision state> List nodes in specified provision state. --driver <driver> Limit list to nodes with driver <driver> --resource-class <resource class> Limit list to nodes with resource class <resource class> --conductor-group <conductor_group> Limit list to nodes with conductor group <conductor group> --conductor <conductor> Limit list to nodes with conductor <conductor> --chassis <chassis UUID> Limit list to nodes of this chassis --owner <owner> Limit list to nodes with owner <owner> --lessee <lessee> Limit list to nodes with lessee <lessee> --description-contains <description_contains> Limit list to nodes with description contains <description_contains> --long Show detailed information about the nodes. --fields <field> [<field> ... ] One or more node fields. only these fields will be fetched from the server. Can not be used when --long is specified. Table 11.223. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.224. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.225. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.226. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.58. baremetal node maintenance set Set baremetal node to maintenance mode Usage: Table 11.227. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.228. Command arguments Value Summary -h, --help Show this help message and exit --reason <reason> Reason for setting maintenance mode. 11.59. baremetal node maintenance unset Unset baremetal node from maintenance mode Usage: Table 11.229. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.230. Command arguments Value Summary -h, --help Show this help message and exit 11.60. baremetal node manage Set provision state of baremetal node to manage Usage: Table 11.231. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.232. Command arguments Value Summary -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. 11.61. baremetal node passthru call Call a vendor passthu method for a node Usage: Table 11.233. Positional arguments Value Summary <node> Name or uuid of the node <method> Vendor passthru method to be executed Table 11.234. Command arguments Value Summary -h, --help Show this help message and exit --arg <key=value> Argument to pass to the passthru method (repeat option to specify multiple arguments) --http-method <http-method> The http method to use in the passthru request. one of DELETE, GET, PATCH, POST, PUT. Defaults to POST. 11.62. baremetal node passthru list List vendor passthru methods for a node Usage: Table 11.235. Positional arguments Value Summary <node> Name or uuid of the node Table 11.236. Command arguments Value Summary -h, --help Show this help message and exit Table 11.237. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.238. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.239. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.240. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.63. baremetal node power off Power off a node Usage: Table 11.241. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.242. Command arguments Value Summary -h, --help Show this help message and exit --power-timeout <power-timeout> Timeout (in seconds, positive integer) to wait for the target power state before erroring out. --soft Request graceful power-off. 11.64. baremetal node power on Power on a node Usage: Table 11.243. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.244. Command arguments Value Summary -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. 11.65. baremetal node provide Set provision state of baremetal node to provide Usage: Table 11.245. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.246. Command arguments Value Summary -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. 11.66. baremetal node reboot Reboot baremetal node Usage: Table 11.247. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.248. Command arguments Value Summary -h, --help Show this help message and exit --soft Request graceful reboot. --power-timeout <power-timeout> Timeout (in seconds, positive integer) to wait for the target power state before erroring out. 11.67. baremetal node rebuild Set provision state of baremetal node to rebuild Usage: Table 11.249. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.250. Command arguments Value Summary -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 OR a JSON object to build config drive from. In case it's a directory, a config drive will be generated from it. In case it's a JSON object with optional keys meta_data , user_data and network_data , a config drive will be generated on the server side (see the bare metal API reference for more details). --deploy-steps <deploy-steps> The deploy steps in json format. may be the path to a file containing the deploy steps; OR - , with the deploy steps being read from standard input; OR a string. The value should be a list of deploy-step dictionaries; each dictionary should have keys interface , step , priority and optional key args . 11.68. baremetal node remove trait Remove trait(s) from a node. Usage: Table 11.251. Positional arguments Value Summary <node> Name or uuid of the node <trait> Trait(s) to remove Table 11.252. Command arguments Value Summary -h, --help Show this help message and exit --all Remove all traits 11.69. baremetal node rescue Set provision state of baremetal node to rescue Usage: Table 11.253. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.254. Command arguments Value Summary -h, --help Show this help message and exit --wait [<time-out>] Wait for a node to reach the desired state, rescue. Optionally takes a timeout value (in seconds). The default value is 0, meaning it will wait indefinitely. --rescue-password <rescue-password> The password that will be used to login to the rescue ramdisk. The value should be a non-empty string. 11.70. baremetal node set Set baremetal properties Usage: Table 11.255. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.256. Command arguments Value Summary -h, --help Show this help message and exit --instance-uuid <uuid> Set instance uuid of node to <uuid> --name <name> Set the name of the node --chassis-uuid <chassis UUID> Set the chassis for the node --driver <driver> Set the driver for the node --bios-interface <bios_interface> Set the bios interface for the node --reset-bios-interface Reset the bios interface to its hardware type default --boot-interface <boot_interface> Set the boot interface for the node --reset-boot-interface Reset the boot interface to its hardware type default --console-interface <console_interface> Set the console interface for the node --reset-console-interface Reset the console interface to its hardware type default --deploy-interface <deploy_interface> Set the deploy interface for the node --reset-deploy-interface Reset the deploy interface to its hardware type default --inspect-interface <inspect_interface> Set the inspect interface for the node --reset-inspect-interface Reset the inspect interface to its hardware type default --management-interface <management_interface> Set the management interface for the node --reset-management-interface Reset the management interface to its hardware type default --network-interface <network_interface> Set the network interface for the node --reset-network-interface Reset the network interface to its hardware type default --network-data <network data> Json string or a yaml file or - for stdin to read static network configuration for the baremetal node associated with this ironic node. Format of this file should comply with Nova network data metadata (network_data.json). Depending on ironic boot interface capabilities being used, network configuration may or may not been served to the node for offline network configuration. --power-interface <power_interface> Set the power interface for the node --reset-power-interface Reset the power interface to its hardware type default --raid-interface <raid_interface> Set the raid interface for the node --reset-raid-interface Reset the raid interface to its hardware type default --rescue-interface <rescue_interface> Set the rescue interface for the node --reset-rescue-interface Reset the rescue interface to its hardware type default --storage-interface <storage_interface> Set the storage interface for the node --reset-storage-interface Reset the storage interface to its hardware type default --vendor-interface <vendor_interface> Set the vendor interface for the node --reset-vendor-interface Reset the vendor interface to its hardware type default --reset-interfaces Reset all interfaces not specified explicitly to their default implementations. Only valid with --driver. --resource-class <resource_class> Set the resource class for the node --conductor-group <conductor_group> Set the conductor group for the node --automated-clean Enable automated cleaning for the node --no-automated-clean Explicitly disable automated cleaning for the node --protected Mark the node as protected --protected-reason <protected_reason> Set the reason of marking the node as protected --retired Mark the node as retired --retired-reason <retired_reason> Set the reason of marking the node as retired --target-raid-config <target_raid_config> Set the target raid configuration (json) for the node. This can be one of: 1. a file containing YAML data of the RAID configuration; 2. "-" to read the contents from standard input; or 3. a valid JSON string. --property <key=value> Property to set on this baremetal node (repeat option to set multiple properties) --extra <key=value> Extra to set on this baremetal node (repeat option to set multiple extras) --driver-info <key=value> Driver information to set on this baremetal node (repeat option to set multiple driver infos) --instance-info <key=value> Instance information to set on this baremetal node (repeat option to set multiple instance infos) --owner <owner> Set the owner for the node --lessee <lessee> Set the lessee for the node --description <description> Set the description for the node 11.71. baremetal node show Show baremetal node details Usage: Table 11.257. Positional arguments Value Summary <node> Name or uuid of the node (or instance uuid if --instance is specified) Table 11.258. Command arguments Value Summary -h, --help Show this help message and exit --instance <node> is an instance uuid. --fields <field> [<field> ... ] One or more node fields. only these fields will be fetched from the server. Table 11.259. Output formatter options Value Summary -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 to show multiple columns Table 11.260. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.261. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.262. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.72. baremetal node trait list List a node's traits. Usage: Table 11.263. Positional arguments Value Summary <node> Name or uuid of the node Table 11.264. Command arguments Value Summary -h, --help Show this help message and exit Table 11.265. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.266. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.267. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.268. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.73. baremetal node undeploy Set provision state of baremetal node to deleted Usage: Table 11.269. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.270. Command arguments Value Summary -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. 11.74. baremetal node unrescue Set provision state of baremetal node to unrescue Usage: Table 11.271. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.272. Command arguments Value Summary -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. 11.75. baremetal node unset Unset baremetal properties Usage: Table 11.273. Positional arguments Value Summary <node> Name or uuid of the node. Table 11.274. Command arguments Value Summary -h, --help Show this help message and exit --instance-uuid Unset instance uuid on this baremetal node --name Unset the name of the node --resource-class Unset the resource class of the node --target-raid-config Unset the target raid configuration of the node --property <key> Property to unset on this baremetal node (repeat option to unset multiple properties) --extra <key> Extra to unset on this baremetal node (repeat option to unset multiple extras) --driver-info <key> Driver information to unset on this baremetal node (repeat option to unset multiple driver informations) --instance-info <key> Instance information to unset on this baremetal node (repeat option to unset multiple instance informations) --chassis-uuid Unset chassis uuid on this baremetal node --bios-interface Unset bios interface on this baremetal node --boot-interface Unset boot interface on this baremetal node --console-interface Unset console interface on this baremetal node --deploy-interface Unset deploy interface on this baremetal node --inspect-interface Unset inspect interface on this baremetal node --network-data Unset network data on this baremetal port. --management-interface Unset management interface on this baremetal node --network-interface Unset network interface on this baremetal node --power-interface Unset power interface on this baremetal node --raid-interface Unset raid interface on this baremetal node --rescue-interface Unset rescue interface on this baremetal node --storage-interface Unset storage interface on this baremetal node --vendor-interface Unset vendor interface on this baremetal node --conductor-group Unset conductor group for this baremetal node (the default group will be used) --automated-clean Unset automated clean option on this baremetal node (the value from configuration will be used) --protected Unset the protected flag on the node --protected-reason Unset the protected reason (gets unset automatically when protected is unset) --retired Unset the retired flag on the node --retired-reason Unset the retired reason (gets unset automatically when retired is unset) --owner Unset the owner field of the node --lessee Unset the lessee field of the node --description Unset the description field of the node 11.76. baremetal node validate Validate a node's driver interfaces Usage: Table 11.275. Positional arguments Value Summary <node> Name or uuid of the node Table 11.276. Command arguments Value Summary -h, --help Show this help message and exit Table 11.277. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.278. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.279. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.280. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.77. baremetal node vif attach Attach VIF to a given node Usage: Table 11.281. Positional arguments Value Summary <node> Name or uuid of the node <vif-id> Name or uuid of the vif to attach to a node. Table 11.282. Command arguments Value Summary -h, --help Show this help message and exit --port-uuid <port-uuid> Uuid of the baremetal port to attach the vif to. --vif-info <key=value> Record arbitrary key/value metadata. can be specified multiple times. The mandatory id parameter cannot be specified as a key. 11.78. baremetal node vif detach Detach VIF from a given node Usage: Table 11.283. Positional arguments Value Summary <node> Name or uuid of the node <vif-id> Name or uuid of the vif to detach from a node. Table 11.284. Command arguments Value Summary -h, --help Show this help message and exit 11.79. baremetal node vif list Show attached VIFs for a node Usage: Table 11.285. Positional arguments Value Summary <node> Name or uuid of the node Table 11.286. Command arguments Value Summary -h, --help Show this help message and exit Table 11.287. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.288. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.289. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.290. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.80. baremetal port create Create a new port Usage: Table 11.291. Positional arguments Value Summary <address> Mac address for this port. Table 11.292. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this port belongs to. --uuid <uuid> Uuid of the port. --extra <key=value> Record arbitrary key/value metadata. argument can be specified multiple times. --local-link-connection <key=value> Key/value metadata describing local link connection information. Valid keys are switch_info , switch_id , port_id and hostname . The keys switch_id and port_id are required. In case of a Smart NIC port, the required keys are port_id and hostname . Argument can be specified multiple times. -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. --pxe-enabled <boolean> Indicates whether this port should be used when pxe booting this Node. --port-group <uuid> Uuid of the port group that this port belongs to. --physical-network <physical network> Name of the physical network to which this port is connected. --is-smartnic Indicates whether this port is a smart nic port Table 11.293. Output formatter options Value Summary -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 to show multiple columns Table 11.294. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.295. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.296. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.81. baremetal port delete Delete port(s). Usage: Table 11.297. Positional arguments Value Summary <port> Uuid(s) of the port(s) to delete. Table 11.298. Command arguments Value Summary -h, --help Show this help message and exit 11.82. baremetal port group create Create a new baremetal port group. Usage: Table 11.299. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this port group belongs to. --address <mac-address> Mac address for this port group. --name NAME Name of the port group. --uuid UUID Uuid of the port group. --extra <key=value> Record arbitrary key/value metadata. 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. --property <key=value> Key/value property related to this port group's configuration. Can be specified multiple times. --support-standalone-ports Ports that are members of this port group can be used as stand-alone ports. (default) --unsupport-standalone-ports Ports that are members of this port group cannot be used as stand-alone ports. Table 11.300. Output formatter options Value Summary -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 to show multiple columns Table 11.301. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.302. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.303. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.83. baremetal port group delete Unregister baremetal port group(s). Usage: Table 11.304. Positional arguments Value Summary <port group> Port group(s) to delete (name or uuid). Table 11.305. Command arguments Value Summary -h, --help Show this help message and exit 11.84. baremetal port group list List baremetal port groups. Usage: Table 11.306. Command arguments Value Summary -h, --help Show this help message and exit --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 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. --address <mac-address> Only show information for the port group with this mac address. --node <node> Only list port groups of this node (name or uuid). --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. Table 11.307. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.308. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.309. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.310. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.85. baremetal port group set Set baremetal port group properties. Usage: Table 11.311. Positional arguments Value Summary <port group> Name or uuid of the port group. Table 11.312. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Update uuid of the node that this port group belongs to. --address <mac-address> Mac address for this port group. --name <name> Name of the port group. --extra <key=value> Extra to set on this baremetal port group (repeat option to set multiple extras). --mode MODE Mode of the port group. for possible values, refer to https://www.kernel.org/doc/Documentation/networking/bo nding.txt. --property <key=value> Key/value property related to this port group's configuration (repeat option to set multiple properties). --support-standalone-ports Ports that are members of this port group can be used as stand-alone ports. --unsupport-standalone-ports Ports that are members of this port group cannot be used as stand-alone ports. 11.86. baremetal port group show Show baremetal port group details. Usage: Table 11.313. Positional arguments Value Summary <id> Uuid or name of the port group (or mac address if --address is specified). Table 11.314. Command arguments Value Summary -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 11.315. Output formatter options Value Summary -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 to show multiple columns Table 11.316. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.317. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.318. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.87. baremetal port group unset Unset baremetal port group properties. Usage: Table 11.319. Positional arguments Value Summary <port group> Name or uuid of the port group. Table 11.320. Command arguments Value Summary -h, --help Show this help message and exit --name Unset the name of the port group. --address Unset the address of the port group. --extra <key> Extra to unset on this baremetal port group (repeat option to unset multiple extras). --property <key> Property to unset on this baremetal port group (repeat option to unset multiple properties). 11.88. baremetal port list List baremetal ports. Usage: Table 11.321. Command arguments Value Summary -h, --help Show this help message and exit --address <mac-address> Only show information for the port with this mac address. --node <node> Only list ports of this node (name or uuid). --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 Baremetal API Service. --marker <port> Port uuid (for example, of the last port in the list from a request). Returns the list of ports after this UUID. --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. --long Show detailed information about ports. --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. Table 11.322. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.323. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.324. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.325. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.89. baremetal port set Set baremetal port properties. Usage: Table 11.326. Positional arguments Value Summary <port> Uuid of the port Table 11.327. Command arguments Value Summary -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 --extra <key=value> Extra to set on this baremetal port (repeat option to set multiple extras) --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 , port_id and hostname . The keys switch_id and port_id are required. In case of a Smart NIC port, the required keys are port_id and hostname . Argument can be specified multiple times. --pxe-enabled Indicates that this port should be used when pxe booting this node (default) --pxe-disabled Indicates that this port should not be used when pxe booting this node --physical-network <physical network> Set the name of the physical network to which this port is connected. --is-smartnic Set port to be smart nic port 11.90. baremetal port show Show baremetal port details. Usage: Table 11.328. Positional arguments Value Summary <id> Uuid of the port (or mac address if --address is specified). Table 11.329. Command arguments Value Summary -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 11.330. Output formatter options Value Summary -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 to show multiple columns Table 11.331. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.332. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.333. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.91. baremetal port unset Unset baremetal port properties. Usage: Table 11.334. Positional arguments Value Summary <port> Uuid of the port. Table 11.335. Command arguments Value Summary -h, --help Show this help message and exit --extra <key> Extra to unset on this baremetal port (repeat option to unset multiple extras) --port-group Remove port from the port group --physical-network Unset the physical network on this baremetal port. --is-smartnic Set port as not smart nic port 11.92. baremetal volume connector create Create a new baremetal volume connector. Usage: Table 11.336. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this volume connector belongs to. --type <type> Type of the volume connector. can be iqn , ip , mac , wwnn , wwpn , port , portgroup . --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 . --uuid <uuid> Uuid of the volume connector. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. Table 11.337. Output formatter options Value Summary -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 to show multiple columns Table 11.338. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.339. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.340. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.93. baremetal volume connector delete Unregister baremetal volume connector(s). Usage: Table 11.341. Positional arguments Value Summary <volume connector> Uuid(s) of the volume connector(s) to delete. Table 11.342. Command arguments Value Summary -h, --help Show this help message and exit 11.94. baremetal volume connector list List baremetal volume connectors. Usage: Table 11.343. Command arguments Value Summary -h, --help Show this help message and exit --node <node> Only list volume connectors of this node (name or UUID). --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. --marker <volume connector> Volume connector uuid (for example, of the last volume connector in the list from a request). Returns the list of volume connectors after this UUID. --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. --long Show detailed information about volume connectors. --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. Table 11.344. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.345. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.346. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.347. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.95. baremetal volume connector set Set baremetal volume connector properties. Usage: Table 11.348. Positional arguments Value Summary <volume connector> Uuid of the volume connector. Table 11.349. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this volume connector belongs to. --type <type> Type of the volume connector. can be iqn , ip , mac , wwnn , wwpn , port , portgroup . --connector-id <connector id> Id of the volume connector in the specified type. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. 11.96. baremetal volume connector show Show baremetal volume connector details. Usage: Table 11.350. Positional arguments Value Summary <id> Uuid of the volume connector. Table 11.351. Command arguments Value Summary -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 11.352. Output formatter options Value Summary -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 to show multiple columns Table 11.353. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.354. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.355. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.97. baremetal volume connector unset Unset baremetal volume connector properties. Usage: Table 11.356. Positional arguments Value Summary <volume connector> Uuid of the volume connector. Table 11.357. Command arguments Value Summary -h, --help Show this help message and exit --extra <key> Extra to unset (repeat option to unset multiple extras) 11.98. baremetal volume target create Create a new baremetal volume target. Usage: Table 11.358. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this volume target belongs to. --type <volume type> Type of the volume target, e.g. iscsi , fibre_channel . --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. --volume-id <volume id> Id of the volume associated with this target. --uuid <uuid> Uuid of the volume target. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. Table 11.359. Output formatter options Value Summary -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 to show multiple columns Table 11.360. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.361. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.362. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.99. baremetal volume target delete Unregister baremetal volume target(s). Usage: Table 11.363. Positional arguments Value Summary <volume target> Uuid(s) of the volume target(s) to delete. Table 11.364. Command arguments Value Summary -h, --help Show this help message and exit 11.100. baremetal volume target list List baremetal volume targets. Usage: Table 11.365. Command arguments Value Summary -h, --help Show this help message and exit --node <node> Only list volume targets of this node (name or uuid). --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. --marker <volume target> Volume target uuid (for example, of the last volume target in the list from a request). Returns the list of volume targets after this UUID. --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. --long Show detailed information about volume targets. --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. Table 11.366. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 11.367. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 11.368. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.369. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.101. baremetal volume target set Set baremetal volume target properties. Usage: Table 11.370. Positional arguments Value Summary <volume target> Uuid of the volume target. Table 11.371. Command arguments Value Summary -h, --help Show this help message and exit --node <uuid> Uuid of the node that this volume target belongs to. --type <volume type> Type of the volume target, e.g. iscsi , fibre_channel . --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. --volume-id <volume id> Id of the volume associated with this target. --extra <key=value> Record arbitrary key/value metadata. can be specified multiple times. 11.102. baremetal volume target show Show baremetal volume target details. Usage: Table 11.372. Positional arguments Value Summary <id> Uuid of the volume target. Table 11.373. Command arguments Value Summary -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 11.374. Output formatter options Value Summary -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 to show multiple columns Table 11.375. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 11.376. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 11.377. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 11.103. baremetal volume target unset Unset baremetal volume target properties. Usage: Table 11.378. Positional arguments Value Summary <volume target> Uuid of the volume target. Table 11.379. Command arguments Value Summary -h, --help Show this help message and exit --extra <key> Extra to unset (repeat option to unset multiple extras) --property <key> Property to unset on this baremetal volume target (repeat option to unset multiple properties).

Commands:
openstack baremetal allocation create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--resource-class RESOURCE_CLASS] [--trait TRAITS] [--candidate-node CANDIDATE_NODES] [--name NAME] [--uuid UUID] [--owner OWNER] [--extra <key=value>] [--wait [<time-out>]] [--node NODE]
openstack baremetal allocation delete [-h] <allocation> [<allocation> ...]
openstack baremetal allocation list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--limit <limit>] [--marker <allocation>] [--sort <key>[:<direction>]] [--node <node>] [--resource-class <resource_class>] [--state <state>] [--owner <owner>] [--long | --fields <field> [<field> ...]]
openstack baremetal allocation set [-h] [--name <name>] [--extra <key=value>] <allocation>
openstack baremetal allocation show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <id>
openstack baremetal allocation unset [-h] [--name] [--extra <key>] <allocation>
openstack baremetal chassis create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--extra <key=value>] [--uuid <uuid>]
openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]
openstack baremetal chassis list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--fields <field> [<field> ...]] [--limit <limit>] [--long] [--marker <chassis>] [--sort <key>[:<direction>]]
openstack baremetal chassis set [-h] [--description <description>] [--extra <key=value>] <chassis>
openstack baremetal chassis show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <chassis>
openstack baremetal chassis unset [-h] [--description] [--extra <key>] <chassis>
openstack baremetal conductor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--limit <limit>] [--marker <conductor>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
openstack baremetal conductor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <conductor>
openstack baremetal create [-h] <file> [<file> ...]
openstack baremetal deploy template create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--uuid <uuid>] [--extra <key=value>] --steps <steps> <name>
openstack baremetal deploy template delete [-h] <template> [<template> ...]
openstack baremetal deploy template list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--limit <limit>] [--marker <template>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
openstack baremetal deploy template set [-h] [--name <name>] [--steps <steps>] [--extra <key=value>] <template>
openstack baremetal deploy template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <template>
openstack baremetal deploy template unset [-h] [--extra <key>] <template>
openstack baremetal driver list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--type <type>] [--long]
openstack baremetal driver passthru call [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--arg <key=value>] [--http-method <http-method>] <driver> <method>
openstack baremetal driver passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <driver>
openstack baremetal driver property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <driver>
openstack baremetal driver raid property list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <driver>
openstack baremetal driver show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <driver>
openstack baremetal introspection abort [-h] node
openstack baremetal introspection data save [-h] [--file <filename>] [--unprocessed] node
openstack baremetal introspection interface list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--vlan VLAN] [--long | --fields <field> [<field> ...]] node_ident
openstack baremetal introspection interface show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] node_ident interface
openstack baremetal introspection list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--marker MARKER] [--limit LIMIT]
openstack baremetal introspection reprocess [-h] node
openstack baremetal introspection rule delete [-h] uuid
openstack baremetal introspection rule import [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] file
openstack baremetal introspection rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending]
openstack baremetal introspection rule purge [-h]
openstack baremetal introspection rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] uuid
openstack baremetal introspection start [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--wait] [--check-errors] node [node ...]
openstack baremetal introspection status [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] node
openstack baremetal node abort [-h] <node>
openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
openstack baremetal node bios setting list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <node>
openstack baremetal node bios setting show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <node> <setting name>
openstack baremetal node boot device set [-h] [--persistent] <node> <device>
openstack baremetal node boot device show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--supported] <node>
openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps <clean-steps> <node>
openstack baremetal node console disable [-h] <node>
openstack baremetal node console enable [-h] <node>
openstack baremetal node console show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <node>
openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--chassis-uuid <chassis>] --driver <driver> [--driver-info <key=value>] [--property <key=value>] [--extra <key=value>] [--uuid <uuid>] [--name <name>] [--bios-interface <bios_interface>] [--boot-interface <boot_interface>] [--console-interface <console_interface>] [--deploy-interface <deploy_interface>] [--inspect-interface <inspect_interface>] [--management-interface <management_interface>] [--network-data <network data>] [--network-interface <network_interface>] [--power-interface <power_interface>] [--raid-interface <raid_interface>] [--rescue-interface <rescue_interface>] [--storage-interface <storage_interface>] [--vendor-interface <vendor_interface>] [--resource-class <resource_class>] [--conductor-group <conductor_group>] [--automated-clean | --no-automated-clean] [--owner <owner>] [--lessee <lessee>] [--description <description>]
openstack baremetal node delete [-h] <node> [<node> ...]
openstack baremetal node deploy [-h] [--wait [<time-out>]] [--config-drive <config-drive>] [--deploy-steps <deploy-steps>] <node>
openstack baremetal node inject nmi [-h] <node>
openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>
openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--limit <limit>] [--marker <node>] [--sort <key>[:<direction>]] [--maintenance | --no-maintenance] [--retired | --no-retired] [--fault <fault>] [--associated | --unassociated] [--provision-state <provision state>] [--driver <driver>] [--resource-class <resource class>] [--conductor-group <conductor_group>] [--conductor <conductor>] [--chassis <chassis UUID>] [--owner <owner>] [--lessee <lessee>] [--description-contains <description_contains>] [--long | --fields <field> [<field> ...]]
openstack baremetal node maintenance set [-h] [--reason <reason>] <node>
openstack baremetal node maintenance unset [-h] <node>
openstack baremetal node manage [-h] [--wait [<time-out>]] <node>
openstack baremetal node passthru call [-h] [--arg <key=value>] [--http-method <http-method>] <node> <method>
openstack baremetal node passthru list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <node>
openstack baremetal node power off [-h] [--power-timeout <power-timeout>] [--soft] <node>
openstack baremetal node power on [-h] [--power-timeout <power-timeout>] <node>
openstack baremetal node provide [-h] [--wait [<time-out>]] <node>
openstack baremetal node reboot [-h] [--soft] [--power-timeout <power-timeout>] <node>
openstack baremetal node rebuild [-h] [--wait [<time-out>]] [--config-drive <config-drive>] [--deploy-steps <deploy-steps>] <node>
openstack baremetal node remove trait [-h] [--all] <node> [<trait> ...]
openstack baremetal node rescue [-h] [--wait [<time-out>]] --rescue-password <rescue-password> <node>
openstack baremetal node set [-h] [--instance-uuid <uuid>] [--name <name>] [--chassis-uuid <chassis UUID>] [--driver <driver>] [--bios-interface <bios_interface> | --reset-bios-interface] [--boot-interface <boot_interface> | --reset-boot-interface] [--console-interface <console_interface> | --reset-console-interface] [--deploy-interface <deploy_interface> | --reset-deploy-interface] [--inspect-interface <inspect_interface> | --reset-inspect-interface] [--management-interface <management_interface> | --reset-management-interface] [--network-interface <network_interface> | --reset-network-interface] [--network-data <network data>] [--power-interface <power_interface> | --reset-power-interface] [--raid-interface <raid_interface> | --reset-raid-interface] [--rescue-interface <rescue_interface> | --reset-rescue-interface] [--storage-interface <storage_interface> | --reset-storage-interface] [--vendor-interface <vendor_interface> | --reset-vendor-interface] [--reset-interfaces] [--resource-class <resource_class>] [--conductor-group <conductor_group>] [--automated-clean | --no-automated-clean] [--protected] [--protected-reason <protected_reason>] [--retired] [--retired-reason <retired_reason>] [--target-raid-config <target_raid_config>] [--property <key=value>] [--extra <key=value>] [--driver-info <key=value>] [--instance-info <key=value>] [--owner <owner>] [--lessee <lessee>] [--description <description>] <node>
openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--instance] [--fields <field> [<field> ...]] <node>
openstack baremetal node trait list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <node>
openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>
openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>
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] [--bios-interface] [--boot-interface] [--console-interface] [--deploy-interface] [--inspect-interface] [--network-data] [--management-interface] [--network-interface] [--power-interface] [--raid-interface] [--rescue-interface] [--storage-interface] [--vendor-interface] [--conductor-group] [--automated-clean] [--protected] [--protected-reason] [--retired] [--retired-reason] [--owner] [--lessee] [--description] <node>
openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <node>
openstack baremetal node vif attach [-h] [--port-uuid <port-uuid>] [--vif-info <key=value>] <node> <vif-id>
openstack baremetal node vif detach [-h] <node> <vif-id>
openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <node>
openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --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>] [--is-smartnic] <address>
openstack baremetal port delete [-h] <port> [<port> ...]
openstack baremetal port group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> [--address <mac-address>] [--name NAME] [--uuid UUID] [--extra <key=value>] [--mode MODE] [--property <key=value>] [--support-standalone-ports | --unsupport-standalone-ports]
openstack baremetal port group delete [-h] <port group> [<port group> ...]
openstack baremetal port group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--limit <limit>] [--marker <port group>] [--sort <key>[:<direction>]] [--address <mac-address>] [--node <node>] [--long | --fields <field> [<field> ...]]
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>
openstack baremetal port group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--address] [--fields <field> [<field> ...]] <id>
openstack baremetal port group unset [-h] [--name] [--address] [--extra <key>] [--property <key>] <port group>
openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--address <mac-address>] [--node <node>] [--port-group <port group>] [--limit <limit>] [--marker <port>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
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>] [--is-smartnic] <port>
openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--address] [--fields <field> [<field> ...]] <id>
openstack baremetal port unset [-h] [--extra <key>] [--port-group] [--physical-network] [--is-smartnic] <port>
openstack baremetal volume connector create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> --type <type> --connector-id <connector id> [--uuid <uuid>] [--extra <key=value>]
openstack baremetal volume connector delete [-h] <volume connector> [<volume connector> ...]
openstack baremetal volume connector list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--node <node>] [--limit <limit>] [--marker <volume connector>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
openstack baremetal volume connector set [-h] [--node <uuid>] [--type <type>] [--connector-id <connector id>] [--extra <key=value>] <volume connector>
openstack baremetal volume connector show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <id>
openstack baremetal volume connector unset [-h] [--extra <key>] <volume connector>
openstack baremetal volume target create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --node <uuid> --type <volume type> [--property <key=value>] --boot-index <boot index> --volume-id <volume id> [--uuid <uuid>] [--extra <key=value>]
openstack baremetal volume target delete [-h] <volume target> [<volume target> ...]
openstack baremetal volume target list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--node <node>] [--limit <limit>] [--marker <volume target>] [--sort <key>[:<direction>]] [--long | --fields <field> [<field> ...]]
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>
openstack baremetal volume target show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--fields <field> [<field> ...]] <id>
openstack baremetal volume target unset [-h] [--extra <key>] [--property <key>] <volume target>