Chapter 11. baremetal

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

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<allocation>

Allocations(s) to delete (name or uuid).

-h, --help

Show this help message and exit

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<allocation>

Name or uuid of the allocation

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

<id>

Uuid or name of the allocation

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<allocation>

Name or uuid of the allocation

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

-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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<chassis>

Uuids of chassis to delete

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

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

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

--limit <limit>

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

--long

Show detailed information about the chassis

--marker <chassis>

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

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<chassis>

Uuid of the chassis

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

<chassis>

Uuid of the chassis

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<chassis>

Uuid of the chassis

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<conductor>

Hostname of the conductor

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<file>

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

-h, --help

Show this help message and exit

<name>

Unique name for this deploy template. must be a valid trait name

-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 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, args and priority.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<template>

Name(s) or uuid(s) of the deploy template(s) to delete.

-h, --help

Show this help message and exit

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<template>

Name or uuid of the deploy template

-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 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, args and priority.

--extra <key=value>

Extra to set on this baremetal deploy template (repeat option to set multiple extras).

<template>

Name or uuid of the deploy template.

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<template>

Name or uuid of the deploy template

-h, --help

Show this help message and exit

--extra <key>

Extra to unset on this baremetal deploy template (repeat option to unset multiple extras).

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<driver>

Name of the driver.

<method>

Vendor passthru method to be called.

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<driver>

Name of the driver.

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<driver>

Name of the driver.

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<driver>

Name of the driver.

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<driver>

Name of the driver.

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

node

Baremetal node uuid or name

-h, --help

Show this help message and exit

node

Baremetal node uuid or name

-h, --help

Show this help message and exit

--file <filename>

Downloaded introspection data filename (default: stdout)

node_ident

Baremetal node uuid or name

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

node_ident

Baremetal node uuid or name

interface

Interface name

-h, --help

Show this help message and exit

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

Display one or more fields.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

-h, --help

Show this help message and exit

--marker MARKER

Uuid of the last item on the previous page

--limit LIMIT

The amount of items to return

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

node

Baremetal node uuid or name

-h, --help

Show this help message and exit

uuid

Rule uuid

-h, --help

Show this help message and exit

file

Json or yaml file to import, may contain one or several rules

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

-h, --help

Show this help message and exit

uuid

Rule uuid

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

node

Baremetal node uuid(s) or name(s)

-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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

node

Baremetal node uuid or name

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<node>

Name or uuid of the node.

-h, --help

Show this help message and exit

<node>

Name or uuid of the node

<trait>

Trait(s) to add

-h, --help

Show this help message and exit

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<node>

Name or uuid of the node

<setting name>

Setting name to show

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<node>

Name or uuid of the node

<device>

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

-h, --help

Show this help message and exit

--persistent

Make changes persistent for all future boots

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

--supported

Show the supported boot devices

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<node>

Name or uuid of the node.

-h, --help

Show this help message and exit

--wait [<time-out>]

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

--clean-steps <clean-steps>

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

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

-h, --help

Show this help message and exit

--chassis-uuid <chassis>

Uuid of the chassis that this node belongs to.

--driver <driver>

Driver used to control the node [required].

--driver-info <key=value>

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

--property <key=value>

Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.

--extra <key=value>

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

--uuid <uuid>

Unique uuid for the node.

--name <name>

Unique name for the node.

--bios-interface <bios_interface>

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

--boot-interface <boot_interface>

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

--console-interface <console_interface>

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

--deploy-interface <deploy_interface>

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

--inspect-interface <inspect_interface>

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

--management-interface <management_interface>

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

--network-interface <network_interface>

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

--power-interface <power_interface>

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

--raid-interface <raid_interface>

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

--rescue-interface <rescue_interface>

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

--storage-interface <storage_interface>

Storage interface used by the node’s driver.

--vendor-interface <vendor_interface>

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

--resource-class <resource_class>

Resource class for mapping nodes to nova flavors

--conductor-group <conductor_group>

Conductor group the node will belong to

--automated-clean

Enable automated cleaning for the node

--owner <owner>

Owner of the node.

--description <description>

Description for the node.

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<node>

Node(s) to delete (name or uuid)

-h, --help

Show this help message and exit

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

-h, --help

Show this help message and exit

<node>

Name or uuid of the node.

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

-h, --help

Show this help message and exit

--limit <limit>

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

--marker <node>

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

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

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

--maintenance

Limit list to nodes in maintenance mode

--no-maintenance

Limit list to nodes not in maintenance mode

--fault <fault>

List nodes in specified fault.

--associated

List only nodes associated with an instance.

--unassociated

List only nodes not associated with an instance.

--provision-state <provision state>

List nodes in specified provision state.

--driver <driver>

Limit list to nodes with driver <driver>

--resource-class <resource class>

Limit list to nodes with resource class <resource class>

--conductor-group <conductor_group>

Limit list to nodes with conductor group <conductor group>

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

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

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<node>

Name or uuid of the node.

-h, --help

Show this help message and exit

--reason <reason>

Reason for setting maintenance mode.

<node>

Name or uuid of the node.

-h, --help

Show this help message and exit

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node

<method>

Vendor passthru method to be executed

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

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node

<trait>

Trait(s) to remove

-h, --help

Show this help message and exit

--all

Remove all traits

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

-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

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

--protected

Mark the node as protected

--protected-reason <protected_reason>

Set the reason of marking the node as protected

--target-raid-config <target_raid_config>

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

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

--description <description>

Set the description for the node

<node>

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

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

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

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

<node>

Name or uuid of the node.

-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

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

--owner

Unset the owner field of the node

--description

Unset the description field of the node

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<node>

Name or uuid of the node

<vif-id>

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

-h, --help

Show this help message and exit

--vif-info <key=value>

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

<node>

Name or uuid of the node

<vif-id>

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

-h, --help

Show this help message and exit

<node>

Name or uuid of the node

-h, --help

Show this help message and exit

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

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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