ipmi¶

IPMI module.

Todo

replace with pyghmi.

exception spicerack.ipmi.IpmiCheckError[source]¶

Custom exception class for check errors of the Ipmi class.

exception spicerack.ipmi.IpmiError[source]¶

Bases: spicerack.exceptions.SpicerackError

Custom exception class for errors of the Ipmi class.

class spicerack.ipmi.Ipmi(password: str, dry_run: bool = True)[source]¶

Class to manage remote IPMI via ipmitool.

Initialize the instance.

Parameters

check_bootparams(mgmt_hostname: str) → None [source]¶

Check if the BIOS boot parameters are back to normal values.

Parameters: mgmt_hostname (str) -- the FQDN of the management interface of the host to target.
Raises: spicerack.ipmi.IpmiCheckError -- if the BIOS boot parameters are incorrect.

check_connection(mgmt_hostname: str) → None [source]¶

Ensure that remote IPMI is working for the management console hostname.

Parameters: mgmt_hostname (str) -- the FQDN of the management interface of the host to target.
Raises: spicerack.ipmi.IpmiError -- if unable to connect or execute a test command.

command(mgmt_hostname: str, command_parts: List[str], is_safe: bool = False) → str [source]¶

Run an ipmitool command for a remote management console hostname.

Parameters

mgmt_hostname (str) -- the FQDN of the management interface of the host to target.
command_parts (list) -- a list of str with the IPMI command components to execute.
is_safe (bool, optional) -- if this is a safe command to run also in DRY RUN mode.

Returns

the output of the ipmitool command.

Return type

str

Raises

spicerack.ipmi.IpmiError -- on failure.

force_pxe(mgmt_hostname: str) → None [source]¶

Force PXE for the next boot and verify that the setting was applied.

Parameters: mgmt_hostname (str) -- the FQDN of the management interface of the host to target.
Raises: spicerack.ipmi.IpmiCheckError -- if unable to verify the PXE mode within the retries.