Chapter 12. Bare Metal Service Command-line Client


The ironic client is the command-line interface (CLI) for the Bare Metal API and its extensions. This chapter documents ironic version 1.7.1.
For help on a specific ironic command, enter:
$ ironic help COMMAND
Copy to Clipboard Toggle word wrap

12.1. ironic Usage

usage: ironic [--insecure] [--os-cacert <ca-certificate>]
              [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
              [--version] [--debug] [--json] [-v] [--cert-file OS_CERT]
              [--key-file OS_KEY] [--ca-file OS_CACERT]
              [--os-username OS_USERNAME] [--os-password OS_PASSWORD]
              [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
              [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
              [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL]
              [--ironic-api-version IRONIC_API_VERSION]
              [--os-service-type OS_SERVICE_TYPE] [--os-endpoint IRONIC_URL]
              [--os-endpoint-type OS_ENDPOINT_TYPE]
              [--os-user-domain-id OS_USER_DOMAIN_ID]
              [--os-user-domain-name OS_USER_DOMAIN_NAME]
              [--os-project-id OS_PROJECT_ID]
              [--os-project-name OS_PROJECT_NAME]
              [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
              [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
              [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL]
              <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

chassis-create


        Create a new chassis.

chassis-delete


        Delete a chassis.

chassis-list


        List the chassis.

chassis-node-list


        List the nodes contained in a chassis.

chassis-show


        Show detailed information about a chassis.

chassis-update


        Update information about a chassis.

node-create


        Register a new node with the Ironic service.

node-delete


        Unregister node(s) from the Ironic service.

node-get-boot-device


      Get the current boot device for a node.

node-get-console


        Get the connection information for a node's console,
      if enabled.

node-get-supported-boot-devices


      Get the supported boot devices for a node.

node-get-vendor-passthru-methods


      Get the vendor passthru methods for a node.

node-list


        List the nodes which are registered with the Ironic
      service.

node-port-list


        List the ports associated with a node.

node-set-boot-device


      Set the boot device for a node.

node-set-console-mode


      Enable or disable serial console access for a node.

node-set-maintenance


      Enable or disable maintenance mode for a node.

node-set-power-state


      Power a node on or off or reboot.

node-set-provision-state


      Initiate a provisioning state change for a node.

node-set-target-raid-config


      Set target RAID config on a node.

node-show


        Show detailed information about a node.

node-show-states


        Show information about the node's states.

node-update


        Update information about a registered node.

node-validate


        Validate a node's driver interfaces.

node-vendor-passthru


      Call a vendor-passthru extension for a node.

port-create


        Create a new port.

port-delete


        Delete a port.

port-list


        List the ports.

port-show


        Show detailed information about a port.

port-update


        Update information about a port.

driver-get-vendor-passthru-methods


      Get the vendor passthru methods for a driver.

driver-list


        List the enabled drivers.

driver-properties


        Get properties of a driver.

driver-raid-logical-disk-properties


      Get RAID logical disk properties for a driver.

driver-show


        Show information about a driver.

driver-vendor-passthru


      Call a vendor-passthru extension for a driver.

create


        Create baremetal resources (chassis, nodes, and
      ports).

bash-completion


        Prints all of the commands and options for bash-
      completion.

help


        Display help about this program or one of its
      subcommands.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat