bmc_host

Execution module for the bmc resource type.

Exposes per-host BMC operations as bmc_host.* functions so they can be invoked against individual BMC resources. Targeting can use any of:

# By resource ID alone — Salt's registry resolves the managing minion.
salt  bmc-host-01            bmc_host.power_status
salt  bmc-host-01            bmc_host.set_boot_device device=http persistent=False
salt  bmc-host-01            bmc_host.power_cycle

# By full SRN (resource type + ID).
salt -C 'T@bmc:bmc-host-01'  bmc_host.power_status

# All resources of type 'bmc' across the fleet.
salt -C 'T@bmc'              bmc_host.power_status

All functions delegate to the per-resource operations defined in saltext.bmc.resources.bmc via __resource_funcs__.

saltext.bmc.resources.bmc.modules.bmc_host.power_status()[source]

Return 'on', 'off', or 'unknown' for this host.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.power_status
saltext.bmc.resources.bmc.modules.bmc_host.power_on()[source]

Power on this host.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.power_on
saltext.bmc.resources.bmc.modules.bmc_host.power_off(force=False)[source]

Power off this host. force=True issues ForceOff (hard cut).

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.power_off
salt -C 'T@bmc:bmc-host-01' bmc_host.power_off force=True
saltext.bmc.resources.bmc.modules.bmc_host.power_cycle()[source]

Power-cycle this host.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.power_cycle
saltext.bmc.resources.bmc.modules.bmc_host.power_reset(force=False)[source]

Reset this host. Prefers GracefulRestart; force=True for ForceRestart.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.power_reset
saltext.bmc.resources.bmc.modules.bmc_host.get_boot_device()[source]

Return the current boot override.

Return type:

dict — keys device (friendly name), redfish_target, enabled (Once/Continuous/Disabled).

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.get_boot_device
saltext.bmc.resources.bmc.modules.bmc_host.set_boot_device(device='none', persistent=False)[source]

Set the boot override.

Parameters:

  • device (str) – One of disk, pxe, http, bios, cd, usb, none.

  • persistent (bool) – True for Continuous, False for Once.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.set_boot_device device=http
salt -C 'T@bmc:bmc-host-01' bmc_host.set_boot_device device=pxe persistent=True
saltext.bmc.resources.bmc.modules.bmc_host.get_system_info()[source]

Return a normalised inventory dict for this host.

Return type:

dict — keys manufacturer, model, serial_number, uuid, sku, host_name, bios_version, firmware_version, power_state.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.get_system_info
saltext.bmc.resources.bmc.modules.bmc_host.get_sensor_data()[source]

Return temperatures/fans/voltages for this host.

Return type:

dict — {"temperatures": [...], "fans": [...], "voltages": [...]}.

CLI Example:

salt -C 'T@bmc:bmc-host-01' bmc_host.get_sensor_data