OS Manuals

/opt/chainguard/openstack-cinder-2026.2/bin/baremetal

OpenStack Block Storage (Cinder) — 2026.2

From openstack-cinder-2026.2 29.0.1_git20261021-r4 (enterprise-packages), captured 2026-11-08 by running baremetal --help (exit 0). permalink

/opt/chainguard/openstack-cinder-2026.2/lib/python3.14/site-packages/jsonpath_rw_ext/_string.py:19: SyntaxWarning: "\(" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\("? A raw string is also an option.
  SUB = re.compile("sub\(/(.*)/,\s+(.*)\)")
/opt/chainguard/openstack-cinder-2026.2/lib/python3.14/site-packages/jsonpath_rw_ext/_string.py:20: SyntaxWarning: "\(" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\("? A raw string is also an option.
  SPLIT = re.compile("split\((.),\s+(\d+),\s+(\d+|-1)\)")
usage: baremetal [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--os-cloud <name>]
                 [--os-auth-type <name>] [--os-endpoint OS_ENDPOINT] [--insecure]
                 [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>]
                 [--timeout <seconds>] [--collect-timing] [--tls-ciphers <ciphers>]
                 [--tls-min-version {None,1.2,1.3}] [--os-service-type <name>]
                 [--os-service-name <name>] [--os-interface <name>] [--os-region-name <name>]
                 [--os-endpoint-override <name>] [--os-api-version <name>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--max-retries <max-retries-number>] [--retry-interval <retry-interval-seconds>]

Bare Metal service (ironic) client

options:
  --version             show program's version number and exit
  -v, --verbose         Increase verbosity of output. Can be repeated.
  -q, --quiet           Suppress output except warnings and errors.
  --log-file LOG_FILE   Specify a file to log output. Disabled by default.
  -h, --help            Show help message and exit.
  --debug               Show tracebacks on errors.
  --os-cloud <name>     Named cloud to connect to
  --os-auth-type, --os-auth-plugin <name>
                        Authentication type to use
  --os-baremetal-api-version <baremetal-api-version>
                        Bare metal API version, default="latest" (the maximum version supported by
                        both the client and the server). (Env: OS_BAREMETAL_API_VERSION)
  --max-retries <max-retries-number>
                        Maximum number of retries on connection problems and resource state
                        conflicts
  --retry-interval <retry-interval-seconds>
                        Interval in seconds between two retries

Authentication Options:
  Options specific to the none plugin.

  --os-endpoint OS_ENDPOINT
                        The endpoint that will always be used

API Connection Options:
  Options controlling the HTTP API Connections

  --insecure            Explicitly allow client to perform "insecure" TLS (https) requests. The
                        server's certificate will not be verified against any certificate
                        authorities. This option should be used with caution.
  --os-cacert <ca-certificate>
                        Specify a CA bundle file to use in verifying a TLS (https) server
                        certificate. Defaults to env[OS_CACERT].
  --os-cert <certificate>
                        The location for the keystore (PEM formatted) containing the public key of
                        this client. Defaults to env[OS_CERT].
  --os-key <key>        The location for the keystore (PEM formatted) containing the private key
                        of this client. Defaults to env[OS_KEY].
  --timeout <seconds>   Set request timeout (in seconds).
  --collect-timing      Collect per-API call timing information.
  --tls-ciphers <ciphers>
                        An OpenSSL cipher string to set the allowed ciphers for TLS connections.
                        If not specified, the default ciphers from the underlying OpenSSL library
                        are used. Defaults to env[OS_TLS_CIPHERS].
  --tls-min-version {None,1.2,1.3}
                        The minimum TLS version to require for TLS connections. When not
                        specified, the behavior is undefined and defers to the system
                        cryptographic policy. Defaults to env[OS_TLS_MIN_VERSION].

Service Options:
  Options controlling the specialization of the API Connection from information found in the
  catalog

  --os-service-type <name>
                        Service type to request from the catalog
  --os-service-name <name>
                        Service name to request from the catalog
  --os-interface <name>
                        API Interface to use [public, internal, admin]
  --os-region-name <name>
                        Region of the cloud to use
  --os-endpoint-override <name>
                        Endpoint to use instead of the endpoint in the catalog
  --os-api-version <name>
                        Which version of the service API to use

Commands:
  allocation create  Create a new baremetal allocation
  allocation delete  Unregister baremetal allocation(s)
  allocation list  List baremetal allocations
  allocation set  Set baremetal allocation properties
  allocation show  Show baremetal allocation details
  allocation unset  Unset baremetal allocation properties
  chassis create  Create a new chassis
  chassis delete  Delete a chassis
  chassis list   List the chassis
  chassis set    Set chassis properties
  chassis show   Show chassis details
  chassis unset  Unset chassis properties
  complete       print bash completion command (cliff)
  conductor list  List baremetal conductors
  conductor show  Show baremetal conductor details
  create         Create resources from files
  deploy template create  Create a new deploy template
  deploy template delete  Delete deploy template(s)
  deploy template list  List baremetal deploy templates
  deploy template set  Set baremetal deploy template properties
  deploy template show  Show baremetal deploy template details
  deploy template unset  Unset baremetal deploy template properties
  driver list    List the enabled drivers
  driver passthru call  Call a vendor passthru method for a driver
  driver passthru list  List available vendor passthru methods for a driver
  driver property list  List the driver properties
  driver raid property list  List a driver's RAID logical disk properties
  driver show    Show information about a driver
  help           print detailed help for another command (cliff)
  inspection rule create  Create a new rule
  inspection rule delete  Delete rule(s)
  inspection rule list  List baremetal rules
  inspection rule set  Set baremetal rule properties
  inspection rule show  Show baremetal rule details
  inspection rule unset  Unset baremetal rule properties
  node abort     Set provision state of baremetal node to 'abort'
  node add trait  Add traits to a node
  node adopt     Set provision state of baremetal node to 'adopt'
  node bios setting list  List a node's BIOS settings
  node bios setting show  Show a specific BIOS setting for a node
  node boot device set  Set the boot device for a node
  node boot device show  Show the boot device information for a node
  node boot mode set  Set the boot mode for the next baremetal node deployment
  node children list  Get a list of nodes associated as children
  node clean     Set provision state of baremetal node to 'clean'
  node console disable  Disable console access for a node
  node console enable  Enable console access for a node
  node console show  Show console information for a node
  node create    Register a new node with the baremetal service
  node delete    Unregister baremetal node(s)
  node deploy    Set provision state of baremetal node to 'deploy'
  node firmware list  List all Firmware Components of a node
  node history get  Get history event for a baremetal node
  node history list  Get history events for a baremetal node
  node inject nmi  Inject NMI to baremetal node
  node inspect   Set provision state of baremetal node to 'inspect'
  node inventory save  Get hardware inventory of a node (in JSON format) or save it to file
  node list      List baremetal nodes
  node maintenance set  Set baremetal node to maintenance mode
  node maintenance unset  Unset baremetal node from maintenance mode
  node manage    Set provision state of baremetal node to 'manage'
  node passthru call  Call a vendor passthru method for a node
  node passthru list  List vendor passthru methods for a node
  node power off  Power off a node
  node power on  Power on a node
  node provide   Set provision state of baremetal node to 'provide'
  node reboot    Reboot baremetal node
  node rebuild   Set provision state of baremetal node to 'rebuild'
  node remove trait  Remove trait(s) from a node
  node rescue    Set provision state of baremetal node to 'rescue'
  node secure boot off  Turn secure boot off
  node secure boot on  Turn secure boot on
  node service   Set provision state of baremetal node to 'service'
  node set       Set baremetal properties
  node show      Show baremetal node details
  node trait add  Add traits to a node
  node trait list  List a node's traits
  node trait remove  Remove trait(s) from a node
  node undeploy  Set provision state of baremetal node to 'deleted'
  node unhold    Set provision state of baremetal node to 'unhold'
  node unrescue  Set provision state of baremetal node to 'unrescue'
  node unset     Unset baremetal properties
  node validate  Validate a node's driver interfaces
  node vif attach  Attach VIF to a given node
  node vif detach  Detach VIF from a given node
  node vif list  Show attached VIFs for a node
  port create    Create a new port
  port delete    Delete port(s)
  port group create  Create a new baremetal port group
  port group delete  Unregister baremetal port group(s)
  port group list  List baremetal port groups
  port group set  Set baremetal port group properties
  port group show  Show baremetal port group details
  port group unset  Unset baremetal port group properties
  port list      List baremetal ports
  port set       Set baremetal port properties
  port show      Show baremetal port details
  port unset     Unset baremetal port properties
  runbook create  Create a new runbook
  runbook delete  Delete runbook(s)
  runbook list   List baremetal runbooks
  runbook set    Set baremetal runbook properties
  runbook show   Show baremetal runbook details
  runbook trait add  Add traits to a runbook
  runbook trait list  List a runbook's traits
  runbook trait remove  Remove trait(s) from a runbook
  runbook unset  Unset baremetal runbook properties
  shard list     List baremetal shards
  volume connector create  Create a new baremetal volume connector
  volume connector delete  Unregister baremetal volume connector(s)
  volume connector list  List baremetal volume connectors
  volume connector set  Set baremetal volume connector properties
  volume connector show  Show baremetal volume connector details
  volume connector unset  Unset baremetal volume connector properties
  volume target create  Create a new baremetal volume target
  volume target delete  Unregister baremetal volume target(s)
  volume target list  List baremetal volume targets
  volume target set  Set baremetal volume target properties
  volume target show  Show baremetal volume target details
  volume target unset  Unset baremetal volume target properties
Options (26)
OptionDescriptionSource
--versionshow program's version number and exithelp
-v, --verboseIncrease verbosity of output.help
-q, --quietSuppress output except warnings and errors.help
--log-file LOG_FILESpecify a file to log output.help
-h, --helpShow help message and exit.help
--debugShow tracebacks on errors.help
--os-cloud nameNamed cloud to connect tohelp
--os-auth-type, --os-auth-plugin nameAuthentication type to usehelp
--os-baremetal-api-version baremetal-api-versionBare metal API version, default="latest" (the maximum version supported by both the client and the server).help
--max-retries max-retries-numberMaximum number of retries on connection problems and resource state conflictshelp
--retry-interval retry-interval-secondsInterval in seconds between two retrieshelp
--os-endpoint OS_ENDPOINTThe endpoint that will always be usedhelp
--insecureExplicitly allow client to perform "insecure" TLS (https) requests.help
--os-cacert ca-certificateSpecify a CA bundle file to use in verifying a TLS (https) server certificate.help
--os-cert certificateThe location for the keystore (PEM formatted) containing the public key of this client.help
--os-key keyThe location for the keystore (PEM formatted) containing the private key of this client.help
--timeout secondsSet request timeout (in seconds).help
--collect-timingCollect per-API call timing information.help
--tls-ciphers ciphersAn OpenSSL cipher string to set the allowed ciphers for TLS connections.help
--tls-min-version NoneThe minimum TLS version to require for TLS connections.help
--os-service-type nameService type to request from the cataloghelp
--os-service-name nameService name to request from the cataloghelp
--os-interface nameAPI Interface to use [public, internal, admin]help
--os-region-name nameRegion of the cloud to usehelp
--os-endpoint-override nameEndpoint to use instead of the endpoint in the cataloghelp
--os-api-version nameWhich version of the service API to usehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.