Skip to content

IPMI Scan Result

The IpmiScanResult is a RawModel plugin object provided by the Multi-API OOB/BMC Control content pack. It tracks the progress and results of an IPMI/BMC network discovery scan across a range of IP addresses. Each scan result object represents a single scan operation initiated through the scan-range plugin action.

When a scan is started, the plugin creates an IpmiScanResult object in the created state, then transitions it to running as it begins probing the address range defined by ScanStartAddress and ScanEndAddress. The scan iterates through each IP in the range, attempting to contact BMC interfaces using configured credentials and protocols. As machines are discovered, their UUIDs are recorded in the CreatedUuids list. The scan completes in finished state on success or canceled if interrupted.

The LowestScannedIndex and LowestScannedAddress fields track scan progress, enabling the scan to resume from where it left off if interrupted. The ScanSize field indicates the total number of IPs in the range. Any errors encountered during scanning are collected in ScanErrors without halting the overall scan.

For automation workflows, the ScanWaitForComplete flag causes the initiating API call to block until the scan finishes, with ScanWaitTimeoutMins setting an upper bound on wait time (defaulting to 5 minutes). This enables synchronous scan-then-act patterns in pipelines. Because IpmiScanResult is a plugin-provided RawModel, it does not support drpcli fieldinfo and has no auto-generated field table.

Fields

  • ScanStartAddress -- string, the first IP address in the scan range
  • ScanEndAddress -- string, the last IP address in the scan range
  • LowestScannedIndex -- int, the latest scanned address index, used for resuming interrupted scans
  • LowestScannedAddress -- string, the IP address at the lowest scanned index
  • ScanSize -- int, the total number of IPs being scanned
  • CreatedUuids -- list of strings, UUIDs of machines created during this scan
  • ScanErrors -- list of strings, any errors encountered during the range scan
  • State -- the state of the current scan: created, running, finished, or canceled
  • ScanActionJobId -- string, the job ID automatically associated with the scan action
  • ScanStartTime -- timestamp when the scan started running
  • ScanEndTime -- timestamp when the scan finished or failed
  • ScanUpdatedTime -- timestamp when the scan result object was last updated
  • ScanWaitForComplete -- boolean, if true the scan action blocks until completion
  • ScanWaitTimeoutMins -- duration, maximum wait time when ScanWaitForComplete is true (default 5 minutes)