Chapter 11. baremetal

<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. In case it’s a directory, a config drive will be generated from it.

<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

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

<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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

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

<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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<address>

Mac address for this port.

-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. 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', and 'port_id'. The keys 'switch_id' and 'port_id' are required. 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.

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<port>

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

-h, --help

Show this help message and exit

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<port group>

Port group(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 port groups to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.

--marker <port group>

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

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

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

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<port group>

Name or uuid of the port group.

-h, --help

Show this help message and exit

--node <uuid>

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

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

<id>

Uuid or name of the port group (or mac address if

--address is specified).

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<port group>

Name or uuid of the port group.

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

-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 Ironic API Service.

--marker <port>

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

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<port>

Uuid of the port

-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', and 'port_id'. The keys 'switch_id' and 'port_id' are required. 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.

<id>

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

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<port>

Uuid of the port.

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

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<volume connector>

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

-h, --help

Show this help message and exit

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<volume connector>

Uuid of the volume connector.

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

<id>

Uuid of the volume connector.

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<volume connector>

Uuid of the volume connector.

-h, --help

Show this help message and exit

--extra <key>

Extra to unset (repeat option to unset multiple extras)

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<volume target>

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

-h, --help

Show this help message and exit

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<volume target>

Uuid of the volume target.

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

<id>

Uuid of the volume target.

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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<volume target>

Uuid of the volume target.

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