bmctools is structured as a hierarchical CLI:
bmctools [global options] <protocol> <group> <command> [options]
Global Options
| Flag | Env Variable | Default | Description |
|---|
-i, --ip, --host | BMC_HOST | — | BMC IP address or hostname |
-u, --username | BMC_USERNAME | — | BMC username |
-p, --password | BMC_PASSWORD | — | BMC password |
-m, --manufacturer | BMC_MANUFACTURER | auto | Force vendor: asus dell supermicro gigabyte cisco |
-k, --insecure | BMC_INSECURE | enabled | Disable SSL certificate verification |
--secure | | | Enable SSL certificate verification |
-o, --output | | text | Output format: json json-pretty table text |
-v, --verbose | | off | Verbose output |
-d, --debug | | off | Debug mode (full stack traces) |
--no-color | NO_COLOR | off | Disable coloured output |
--version | | | Show version and exit |
redfish — Redfish API Commands
redfish boot — Boot Management
bmctools redfish boot <command> [options]
| Command | Description |
|---|
get-order | Get the current boot order |
get-order --staged | Show staged/pending boot order (ASUS) |
set-order -o ORDER | Set boot order (comma-separated string) |
set-order --order-file FILE | Set boot order from file (one entry per line) |
list-options | List all available boot options |
list-options --no-cache | Force fresh query, bypass cache |
find-by-mac -m MAC | Find boot option by MAC address |
find-by-mac -m MAC --type TYPE | Filter by type (e.g. PXE) |
find-by-alias -a ALIAS | Find boot option by display name |
get-pending | Get pending boot order (ASUS FutureState) |
get-override | Show current boot source override |
set-override -t TARGET | Set one-time boot override target |
set-override -t TARGET --mode MODE | Override mode: Once (default) Continuous Disabled |
Override targets: Pxe, Hdd, Cd, BiosSetup, Diags, None
bmctools redfish boot set-order -o "Boot0003,Boot0001,Boot0000,Boot0002"
bmctools redfish boot find-by-mac -m 04:32:01:D8:C0:B0 --type PXE
bmctools redfish boot set-override -t Pxe --mode Once
redfish firmware — Firmware Management
| Command | Description |
|---|
inventory | Get firmware inventory (BIOS, BMC, NIC versions) |
status | Get update service status |
update-bios -f FILE | Upload and apply a BIOS firmware image |
update-bmc -f FILE | Upload and apply a BMC firmware image (preserves config) |
update-bmc -f FILE --no-preserve-config | Update BMC without preserving config |
redfish system — System Management
| Command | Description |
|---|
info | Show system information |
reset | Graceful system reset |
reset --type TYPE | Reset with a specific type |
reset-types | List supported reset types for this system |
Common reset types: GracefulRestart, ForceRestart, ForceOff, On, GracefulShutdown
redfish tpm — TPM Management (ASUS)
| Command | Description |
|---|
set-state --state Enabled | Enable TPM |
set-state --state Disabled | Disable TPM |
redfish bios — BIOS Settings
Vendor-specific BIOS settings management.
redfish dell — Dell-Specific
| Command | Description |
|---|
get-nics | List NIC information (name, MAC, link status) |
pxe-boot -m MAC | Enable PXE on a NIC by MAC address and reboot |
redfish raw — Raw Endpoint Access
bmctools redfish raw <URI> [options]
bmctools redfish raw /redfish/v1 -o json-pretty
bmctools redfish raw /redfish/v1/Systems
bmctools redfish raw /redfish/v1/Managers/1
bmctools redfish raw /redfish/v1/Chassis/1
ipmi — IPMI Commands
ipmi power
| Command | Description |
|---|
status | Get current power status |
on | Power on |
off | Power off |
reset | Hard reset |
ipmi bmc
| Command | Description |
|---|
reset-warm | Warm reset the BMC |
reset-cold | Cold reset the BMC |
ipmi sel — System Event Log
| Command | Description |
|---|
list | List SEL entries |
list --elist | Extended list format |
list --raw | Show raw data |
list --age AGE | Filter by age (e.g. 7d, 24h) |
ipmi sol — Serial Over LAN
| Command | Description |
|---|
deactivate | Deactivate an active SOL session |
looptest [--loops N] | SOL loopback test (default: 10 loops) |
ipmi raw
bmctools ipmi raw "sdr type Temperature"
bmctools ipmi raw "chassis status"
racadm — RACADM Commands (Dell)
racadm get
bmctools racadm get BIOS.SysProfileSettings
bmctools racadm get iDRAC.Users --format
racadm set
bmctools racadm set <endpoint> [--args ARGS]
racadm storage
| Command | Description |
|---|
get <endpoint> | Get storage configuration |
check-vdisk [--format] | Check virtual disk status |
racadm job
| Command | Options | Description |
|---|
view | -j JOB_ID | View job details |
status | -j JOB_ID | Get job status |
wait | -j JOB_ID [--timeout SEC] | Wait for job completion (default: 300 s) |