For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • DSX Exchange
    • Architecture
    • Pre-Deployment
    • Deployment
    • Integrator Quickstart
    • Operations
    • Authentication
    • BMS Integration
    • Validated Capabilities
  • Schema
      • Overview
      • Messages
      • Schemas
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • ManagedHostState
  • dpudiscoveringstate
  • dpuinit
  • hostinit
  • validation
  • ready
  • assigned
  • waitingforcleanup
  • forcedeletion
  • created
  • failed
  • dpureprovision
  • hostreprovision
  • measuring
  • postassignedmeasuring
  • bomvalidating
  • BmcFirmwareUpgradeSubstate
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • Variant 7
  • BomValidating
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • BomValidatingContext
  • CleanupState
  • init
  • secureeraseboss
  • hostcleanup
  • createbossvolume
  • disablebiosbmclockdown
  • CreateBossVolumeContext
  • CreateBossVolumeState
  • createbossvolume
  • waitforjobscheduled
  • reboothost
  • waitforjobcompletion
  • handlejobfailure
  • lockhost
  • DpuDiscoveringState
  • Dpu discovery via redfish states
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • Variant 7
  • DpuDiscoveringStates
  • DpuInitState
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • Variant 7
  • DpuInitStates
  • DpuReprovisionStates
  • FailureCause
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • Variant 7
  • Variant 8
  • Variant 9
  • Variant 10
  • FailureDetails
  • FailureSource
  • Variant 1
  • Variant 2
  • FirmwareComponentType
  • HostPlatformConfigurationState
  • powercycle
  • checkhostconfig
  • unlockhost
  • configurebios
  • pollingbiossetup
  • setbootorder
  • lockhost
  • HostReprovisionState
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • Variant 6
  • Variant 7
  • Variant 8
  • InitialResetPhase
  • InstallDpuOsState
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • InstanceState
  • init
  • waitingfornetworksegmenttobeready
  • waitingfornetworkconfig
  • waitingforstorageconfig
  • dpaprovisioning
  • waitingfordpatobeready
  • waitingforextensionservicesconfig
  • waitingforreboottoready
  • ready
  • hostplatformconfiguration
  • waitingfordpustoup
  • bootingwithdiscoveryimage
  • switchtoadminnetwork
  • waitingfornetworkreconfig
  • dpureprovision
  • failed
  • hostreprovision
  • networkconfigupdate
  • LockdownInfo
  • LockdownMode
  • LockdownState
  • MachineId
  • MachineState
  • init
  • enableipmioverlan
  • waitingforplatformconfiguration
  • pollingbiossetup
  • setbootorder
  • uefisetup
  • measuring
  • waitingfordiscovery
  • discovered
  • waitingforlockdown
  • MachineValidatingState
  • Variant 1
  • Variant 2
  • MeasuringState
  • WaitingForMeasurements is reported when the machine has reached a state where…
  • PendingBundle is reported when the API has received measurements from the mac…
  • NetworkConfigUpdateState
  • PerformPowerOperation
  • off
  • on
  • PowerDrainState
  • ReprovisionState
  • Variant 1
  • Variant 2
  • Variant 3
  • RetryInfo
  • SecureEraseBossContext
  • SecureEraseBossState
  • unlockhost
  • secureeraseboss
  • waitforjobcompletion
  • handlejobfailure
  • SetBootOrderInfo
  • SetBootOrderState
  • setbootorder
  • waitforsetbootorderjobscheduled
  • reboothost
  • waitforsetbootorderjobcompletion
  • SetSecureBootState
  • Variant 1
  • Variant 2
  • Variant 3
  • Variant 4
  • Variant 5
  • StateMachineArea
  • UefiSetupInfo
  • UefiSetupState
  • unlockhost
  • setuefipassword
  • waitforpasswordjobscheduled
  • powercyclehost
  • waitforpasswordjobcompletion
  • lockdownhost
  • ValidationState
  • Host machine validation placeholder for DPU machine validation TODO: add DPU …
SchemaNICo Host State

Schemas

||View as Markdown|
Previous

Messages

Next

Overview

ManagedHostState

Possible Machine state-machine implementation Possible ManagedHost state-machine implementation Only DPU machine field in DB will contain state. Host will be empty. DPU state field will be used to derive state for DPU and Host both.

Possible Machine state-machine implementation Possible ManagedHost state-machine implementation Only DPU machine field in DB will contain state. Host will be empty. DPU state field will be used to derive state for DPU and Host both.

dpudiscoveringstate

Dpu was discovered by a site-explorer and is being configuring via redfish.

NameTypeRequiredDescription
dpu_statesDpuDiscoveringStatesYes
dpu_states.statesmap<string, DpuDiscoveringState>Yes
statestringYesValues: dpudiscoveringstate

dpuinit

DPU is not yet ready.

NameTypeRequiredDescription
dpu_statesDpuInitStatesYes
dpu_states.statesmap<string, DpuInitState>Yes
statestringYesValues: dpuinit

hostinit

DPU is ready, Host is not yet Ready.

NameTypeRequiredDescription
machine_stateMachineStateYes
statestringYesValues: hostinit

validation

Host validation state for machine and DPU validation

NameTypeRequiredDescription
statestringYesValues: validation
validation_stateValidationStateYes

ready

Host is Ready for instance creation.

NameTypeRequiredDescription
statestringYesValues: ready

assigned

Host is assigned to an Instance.

NameTypeRequiredDescription
instance_stateInstanceStateYesPossible Instance state-machine implementation, for when the machine host is assigned to a tenant
statestringYesValues: assigned

waitingforcleanup

Some cleanup is going on.

NameTypeRequiredDescription
cleanup_stateCleanupStateYes
statestringYesValues: waitingforcleanup

forcedeletion

A forced deletion process has been triggered by the admin CLI State controller will no longer manage the Machine

NameTypeRequiredDescription
statestringYesValues: forcedeletion

created

A dummy state used to create DPU in beginning. State will sync to Init when host will be created.

NameTypeRequiredDescription
statestringYesValues: created

failed

Machine moved to failed state. Recovery will be based on FailedCause

NameTypeRequiredDescription
detailsFailureDetailsYes
details.causeFailureCauseYes
details.failed_atstring (date-time)Yes
details.sourceFailureSourceYes
machine_idMachineIdYes
retry_countinteger (uint32)No
statestringYesValues: failed

dpureprovision

State used to indicate that DPU reprovisioning is going on.

NameTypeRequiredDescription
dpu_statesDpuReprovisionStatesYes
dpu_states.statesmap<string, ReprovisionState>Yes
statestringYesValues: dpureprovision

hostreprovision

State used to indicate that host reprovisioning is going on

NameTypeRequiredDescription
reprovision_stateHostReprovisionStateYes
retry_countinteger (uint32)No
statestringYesValues: hostreprovision

measuring

State used to indicate the API is currently waiting on the machine to send attestation measurements, or waiting for measurements to match a valid/approved measurement bundle, before continuing on towards a Ready state.

NameTypeRequiredDescription
measuring_stateMeasuringStateYesMeasuringState contains states used for host attestion (or measured boot).
statestringYesValues: measuring

postassignedmeasuring

NameTypeRequiredDescription
measuring_stateMeasuringStateYesMeasuringState contains states used for host attestion (or measured boot).
statestringYesValues: postassignedmeasuring

bomvalidating

NameTypeRequiredDescription
bom_validating_stateBomValidatingYes
statestringYesValues: bomvalidating

BmcFirmwareUpgradeSubstate

Variant 1

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: checkfwversion

Variant 2

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: waitforupdatecompletion
firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
task_idstringYes

Variant 3

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: reboot
countinteger (uint32)Yes

Variant 4

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: waitforerotbackgroundcopytocomplete

Variant 5

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: hostpowercycle

Variant 6

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: failed
failure_detailsstringYes

Variant 7

NameTypeRequiredDescription
bmcfirmwareupdatesubstatestringYesValues: fwupdatecompleted

BomValidating

Variant 1

NameTypeRequiredDescription
MatchingSkuBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
MatchingSku.machine_validation_contextstring or nullNo
MatchingSku.reboot_retry_countinteger or nullNo

Variant 2

NameTypeRequiredDescription
UpdatingInventoryBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
UpdatingInventory.machine_validation_contextstring or nullNo
UpdatingInventory.reboot_retry_countinteger or nullNo

Variant 3

NameTypeRequiredDescription
VerifyingSkuBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
VerifyingSku.machine_validation_contextstring or nullNo
VerifyingSku.reboot_retry_countinteger or nullNo

Variant 4

NameTypeRequiredDescription
SkuVerificationFailedBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
SkuVerificationFailed.machine_validation_contextstring or nullNo
SkuVerificationFailed.reboot_retry_countinteger or nullNo

Variant 5

NameTypeRequiredDescription
WaitingForSkuAssignmentBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
WaitingForSkuAssignment.machine_validation_contextstring or nullNo
WaitingForSkuAssignment.reboot_retry_countinteger or nullNo

Variant 6

NameTypeRequiredDescription
SkuMissingBomValidatingContextYesA context for passing information between states thoughout the BOM validation process.
SkuMissing.machine_validation_contextstring or nullNo
SkuMissing.reboot_retry_countinteger or nullNo

BomValidatingContext

A context for passing information between states thoughout the BOM validation process.

NameTypeRequiredDescription
machine_validation_contextstring or nullNo
reboot_retry_countinteger or nullNo

CleanupState

init

NameTypeRequiredDescription
statestringYesValues: init

secureeraseboss

NameTypeRequiredDescription
secure_erase_boss_contextSecureEraseBossContextYes
secure_erase_boss_context.boss_controller_idstringYes
secure_erase_boss_context.iterationinteger or nullNo
secure_erase_boss_context.secure_erase_boss_stateSecureEraseBossStateYes
secure_erase_boss_context.secure_erase_jidstring or nullNo
statestringYesValues: secureeraseboss

hostcleanup

NameTypeRequiredDescription
boss_controller_idstring or nullNo
statestringYesValues: hostcleanup

createbossvolume

NameTypeRequiredDescription
create_boss_volume_contextCreateBossVolumeContextYes
create_boss_volume_context.boss_controller_idstringYes
create_boss_volume_context.create_boss_volume_jidstring or nullNo
create_boss_volume_context.create_boss_volume_stateCreateBossVolumeStateYes
create_boss_volume_context.iterationinteger or nullNo
statestringYesValues: createbossvolume

disablebiosbmclockdown

NameTypeRequiredDescription
statestringYesValues: disablebiosbmclockdown

CreateBossVolumeContext

NameTypeRequiredDescription
boss_controller_idstringYes
create_boss_volume_jidstring or nullNo
create_boss_volume_stateCreateBossVolumeStateYes
iterationinteger or nullNo

CreateBossVolumeState

createbossvolume

NameTypeRequiredDescription
statestringYesValues: createbossvolume

waitforjobscheduled

NameTypeRequiredDescription
statestringYesValues: waitforjobscheduled

reboothost

NameTypeRequiredDescription
statestringYesValues: reboothost

waitforjobcompletion

NameTypeRequiredDescription
statestringYesValues: waitforjobcompletion

handlejobfailure

NameTypeRequiredDescription
failurestringYes
power_statestringYes
statestringYesValues: handlejobfailure

lockhost

NameTypeRequiredDescription
statestringYesValues: lockhost

DpuDiscoveringState

Dpu discovery via redfish states

NameTypeRequiredDescription
dpudiscoverystatestringYesValues: initializing

Variant 2

NameTypeRequiredDescription
dpudiscoverystatestringYesValues: configuring

Variant 3

NameTypeRequiredDescription
dpudiscoverystatestringYesValues: rebootalldpus

Variant 4

NameTypeRequiredDescription
countinteger (uint32)Yes
dpudiscoverystatestringYesValues: enablesecureboot
enable_secure_boot_stateSetSecureBootStateYes

Variant 5

NameTypeRequiredDescription
countinteger (uint32)Yes
disable_secure_boot_stateanyNo
dpudiscoverystatestringYesValues: disablesecureboot

Variant 6

NameTypeRequiredDescription
dpudiscoverystatestringYesValues: setuefihttpboot

Variant 7

NameTypeRequiredDescription
dpudiscoverystatestringYesValues: enablershim

DpuDiscoveringStates

NameTypeRequiredDescription
statesmap<string, DpuDiscoveringState>Yes

DpuInitState

Variant 1

NameTypeRequiredDescription
dpustatestringYesValues: installdpuos
substateInstallDpuOsStateYes

Variant 2

NameTypeRequiredDescription
dpustatestringYesValues: init

Variant 3

NameTypeRequiredDescription
dpustatestringYesValues: waitingforplatformpowercycle
substatePerformPowerOperationYes

Variant 4

NameTypeRequiredDescription
dpustatestringYesValues: waitingforplatformconfiguration

Variant 5

NameTypeRequiredDescription
dpustatestringYesValues: pollingbiossetup

Variant 6

NameTypeRequiredDescription
dpustatestringYesValues: waitingfornetworkconfig

Variant 7

NameTypeRequiredDescription
dpustatestringYesValues: waitingfornetworkinstall

DpuInitStates

NameTypeRequiredDescription
statesmap<string, DpuInitState>Yes

DpuReprovisionStates

NameTypeRequiredDescription
statesmap<string, ReprovisionState>Yes

FailureCause

Variant 1

Allowed values: noerror

Variant 2

NameTypeRequiredDescription
nvmecleanfailedobjectYes
nvmecleanfailed.errstringYes

Variant 3

NameTypeRequiredDescription
discoveryobjectYes
discovery.errstringYes

Variant 4

NameTypeRequiredDescription
reprovisioningobjectYes
reprovisioning.errstringYes

Variant 5

NameTypeRequiredDescription
machinevalidationobjectYes
machinevalidation.errstringYes

Variant 6

NameTypeRequiredDescription
unhandledstateobjectYes
unhandledstate.errstringYes

Variant 7

NameTypeRequiredDescription
measurementsfailedsignaturecheckobjectYes
measurementsfailedsignaturecheck.errstringYes

Variant 8

NameTypeRequiredDescription
measurementsretiredobjectYes
measurementsretired.errstringYes

Variant 9

NameTypeRequiredDescription
measurementsrevokedobjectYes
measurementsrevoked.errstringYes

Variant 10

NameTypeRequiredDescription
measurementscavalidationfailedobjectYes
measurementscavalidationfailed.errstringYes

FailureDetails

NameTypeRequiredDescription
causeFailureCauseYes
failed_atstring (date-time)Yes
sourceFailureSourceYes

FailureSource

Variant 1

Allowed values: noerror, scout, statemachine

Variant 2

NameTypeRequiredDescription
statemachineareaStateMachineAreaYesValues: default, hostinit, mainflow, assignedinstance

FirmwareComponentType

Allowed values: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, gpu, unknown


HostPlatformConfigurationState

powercycle

NameTypeRequiredDescription
power_onbooleanYes
statestringYesValues: powercycle

checkhostconfig

NameTypeRequiredDescription
statestringYesValues: checkhostconfig

unlockhost

NameTypeRequiredDescription
statestringYesValues: unlockhost

configurebios

NameTypeRequiredDescription
statestringYesValues: configurebios

pollingbiossetup

NameTypeRequiredDescription
statestringYesValues: pollingbiossetup

setbootorder

NameTypeRequiredDescription
set_boot_order_infoSetBootOrderInfoYes
set_boot_order_info.set_boot_order_jidstring or nullNo
set_boot_order_info.set_boot_order_stateSetBootOrderStateYes
statestringYesValues: setbootorder

lockhost

NameTypeRequiredDescription
statestringYesValues: lockhost

HostReprovisionState

Variant 1

Allowed values: checkingfirmware, checkingfirmwarerepeat

Variant 2

NameTypeRequiredDescription
initialresetobjectYes
initialreset.last_timestring (date-time)Yes
initialreset.phaseInitialResetPhaseYesValues: start, bmcwasreset, waithostboot

Variant 3

NameTypeRequiredDescription
waitingforscriptobjectYes

Variant 4

NameTypeRequiredDescription
waitingforuploadobjectYes
waitingforupload.final_versionstringYes
waitingforupload.firmware_numberinteger or nullNo
waitingforupload.firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
waitingforupload.power_drains_neededinteger or nullNo

Variant 5

NameTypeRequiredDescription
waitingforfirmwareupgradeobjectYes
waitingforfirmwareupgrade.final_versionstringYes
waitingforfirmwareupgrade.firmware_numberinteger or nullNo
waitingforfirmwareupgrade.firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
waitingforfirmwareupgrade.power_drains_neededinteger or nullNo
waitingforfirmwareupgrade.started_waitingstring or nullNo
waitingforfirmwareupgrade.task_idstringYes

Variant 6

NameTypeRequiredDescription
resetfornewfirmwareobjectYes
resetfornewfirmware.delay_untilinteger or nullNo
resetfornewfirmware.final_versionstringYes
resetfornewfirmware.firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
resetfornewfirmware.last_power_drain_operationanyNo
resetfornewfirmware.power_drains_neededinteger or nullNo

Variant 7

NameTypeRequiredDescription
newfirmwarereportedwaitobjectYes
newfirmwarereportedwait.final_versionstringYes
newfirmwarereportedwait.firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
newfirmwarereportedwait.previous_reset_timeinteger or nullNo

Variant 8

NameTypeRequiredDescription
failedfirmwareupgradeobjectYes
failedfirmwareupgrade.firmware_typeFirmwareComponentTypeYesValues: bmc, cec, uefi, nic, cpldmb, cpldpdb, hgxbmc, combinedbmcuefi, … (10 total)
failedfirmwareupgrade.reasonstring or nullNo
failedfirmwareupgrade.report_timestring or nullNo

InitialResetPhase

Allowed values: start, bmcwasreset, waithostboot


InstallDpuOsState

Variant 1

NameTypeRequiredDescription
installdpuosstatestringYesValues: installingbfb

Variant 2

NameTypeRequiredDescription
installdpuosstatestringYesValues: waitforinstallcomplete
progressstringYes
task_idstringYes

Variant 3

NameTypeRequiredDescription
installdpuosstatestringYesValues: completed

Variant 4

NameTypeRequiredDescription
installdpuosstatestringYesValues: installationerror
msgstringYes

InstanceState

Possible Instance state-machine implementation, for when the machine host is assigned to a tenant

Possible Instance state-machine implementation, for when the machine host is assigned to a tenant

init

NameTypeRequiredDescription
statestringYesValues: init

waitingfornetworksegmenttobeready

NameTypeRequiredDescription
statestringYesValues: waitingfornetworksegmenttobeready

waitingfornetworkconfig

NameTypeRequiredDescription
statestringYesValues: waitingfornetworkconfig

waitingforstorageconfig

NameTypeRequiredDescription
statestringYesValues: waitingforstorageconfig

dpaprovisioning

NameTypeRequiredDescription
statestringYesValues: dpaprovisioning

waitingfordpatobeready

NameTypeRequiredDescription
statestringYesValues: waitingfordpatobeready

waitingforextensionservicesconfig

NameTypeRequiredDescription
statestringYesValues: waitingforextensionservicesconfig

waitingforreboottoready

NameTypeRequiredDescription
statestringYesValues: waitingforreboottoready

ready

NameTypeRequiredDescription
statestringYesValues: ready

hostplatformconfiguration

NameTypeRequiredDescription
platform_config_stateHostPlatformConfigurationStateYes
statestringYesValues: hostplatformconfiguration

waitingfordpustoup

NameTypeRequiredDescription
statestringYesValues: waitingfordpustoup

bootingwithdiscoveryimage

NameTypeRequiredDescription
retryobjectNo
retry.countinteger (uint64)Yes
statestringYesValues: bootingwithdiscoveryimage

switchtoadminnetwork

NameTypeRequiredDescription
statestringYesValues: switchtoadminnetwork

waitingfornetworkreconfig

NameTypeRequiredDescription
statestringYesValues: waitingfornetworkreconfig

dpureprovision

NameTypeRequiredDescription
dpu_statesDpuReprovisionStatesYes
dpu_states.statesmap<string, ReprovisionState>Yes
statestringYesValues: dpureprovision

failed

NameTypeRequiredDescription
detailsFailureDetailsYes
details.causeFailureCauseYes
details.failed_atstring (date-time)Yes
details.sourceFailureSourceYes
machine_idMachineIdYes
statestringYesValues: failed

hostreprovision

NameTypeRequiredDescription
reprovision_stateHostReprovisionStateYes
statestringYesValues: hostreprovision

networkconfigupdate

NameTypeRequiredDescription
network_config_update_stateNetworkConfigUpdateStateYesTenant has requested network config update for the existing instance. At this point, instance config, instance network config version are already increased. Values: `waitingfornetworksegmenttoberea…
statestringYesValues: networkconfigupdate

LockdownInfo

NameTypeRequiredDescription
modeLockdownModeYesWhether lockdown should be enabled or disabled in an operation Values: enable, disable
stateLockdownStateYesValues: setlockdown, timewaitfordpudown, waitfordpuup, pollinglockdownstatus

LockdownMode

Whether lockdown should be enabled or disabled in an operation

Allowed values: enable, disable


LockdownState

Allowed values: setlockdown, timewaitfordpudown, waitfordpuup, pollinglockdownstatus


MachineId

Type: string


MachineState

init

NameTypeRequiredDescription
statestringYesValues: init

enableipmioverlan

NameTypeRequiredDescription
statestringYesValues: enableipmioverlan

waitingforplatformconfiguration

NameTypeRequiredDescription
statestringYesValues: waitingforplatformconfiguration

pollingbiossetup

NameTypeRequiredDescription
statestringYesValues: pollingbiossetup

setbootorder

NameTypeRequiredDescription
set_boot_order_infoanyNo
statestringYesValues: setbootorder

uefisetup

NameTypeRequiredDescription
statestringYesValues: uefisetup
uefi_setup_infoUefiSetupInfoYes
uefi_setup_info.uefi_password_jidstring or nullNo
uefi_setup_info.uefi_setup_stateUefiSetupStateYesSubstates of enabling/disabling lockdown

measuring

NameTypeRequiredDescription
measuring_stateMeasuringStateYesMeasuringState contains states used for host attestion (or measured boot).
statestringYesValues: measuring

waitingfordiscovery

NameTypeRequiredDescription
statestringYesValues: waitingfordiscovery

discovered

NameTypeRequiredDescription
skip_reboot_waitbooleanNo
statestringYesValues: discovered

waitingforlockdown

Lockdown handling.

NameTypeRequiredDescription
lockdown_infoLockdownInfoYes
lockdown_info.modeLockdownModeYesWhether lockdown should be enabled or disabled in an operation Values: enable, disable
lockdown_info.stateLockdownStateYesValues: setlockdown, timewaitfordpudown, waitfordpuup, pollinglockdownstatus
statestringYesValues: waitingforlockdown

MachineValidatingState

Variant 1

NameTypeRequiredDescription
reboothostobjectYes
reboothost.validation_idstring (uuid)Yes

Variant 2

NameTypeRequiredDescription
machinevalidatingobjectYes
machinevalidating.completedinteger (uint)Yes
machinevalidating.contextstringYes
machinevalidating.idstring (uuid)Yes
machinevalidating.is_enabledbooleanNo
machinevalidating.totalinteger (uint)Yes

MeasuringState

MeasuringState contains states used for host attestion (or measured boot).

MeasuringState contains states used for host attestion (or measured boot).

WaitingForMeasurements is reported when the machine has reached a state where…

Allowed values: waitingformeasurements

PendingBundle is reported when the API has received measurements from the mac…

Allowed values: pendingbundle


NetworkConfigUpdateState

Tenant has requested network config update for the existing instance. At this point, instance config, instance network config version are already increased.

Allowed values: waitingfornetworksegmenttobeready, waitingforconfigsynced, releaseoldresources


PerformPowerOperation

off

NameTypeRequiredDescription
statestringYesValues: off

on

NameTypeRequiredDescription
statestringYesValues: on

PowerDrainState

Allowed values: off, powercycle, on


ReprovisionState

Variant 1

Allowed values: firmwareupgrade, waitingfornetworkinstall, poweringoffhost, powerdown, buffertime, verifyfirmareversions, waitingfornetworkconfig, reboothostbmc, reboothost, notunderreprovision

Variant 2

NameTypeRequiredDescription
bmcfirmwareupgradeobjectYes
bmcfirmwareupgrade.substateBmcFirmwareUpgradeSubstateYes

Variant 3

NameTypeRequiredDescription
installdpuosobjectYes
installdpuos.substateInstallDpuOsStateYes

RetryInfo

NameTypeRequiredDescription
countinteger (uint64)Yes

SecureEraseBossContext

NameTypeRequiredDescription
boss_controller_idstringYes
iterationinteger or nullNo
secure_erase_boss_stateSecureEraseBossStateYes
secure_erase_jidstring or nullNo

SecureEraseBossState

unlockhost

NameTypeRequiredDescription
statestringYesValues: unlockhost

secureeraseboss

NameTypeRequiredDescription
statestringYesValues: secureeraseboss

waitforjobcompletion

NameTypeRequiredDescription
statestringYesValues: waitforjobcompletion

handlejobfailure

NameTypeRequiredDescription
failurestringYes
power_statestringYes
statestringYesValues: handlejobfailure

SetBootOrderInfo

NameTypeRequiredDescription
set_boot_order_jidstring or nullNo
set_boot_order_stateSetBootOrderStateYes

SetBootOrderState

setbootorder

NameTypeRequiredDescription
statestringYesValues: setbootorder

waitforsetbootorderjobscheduled

NameTypeRequiredDescription
statestringYesValues: waitforsetbootorderjobscheduled

reboothost

NameTypeRequiredDescription
statestringYesValues: reboothost

waitforsetbootorderjobcompletion

NameTypeRequiredDescription
statestringYesValues: waitforsetbootorderjobcompletion

SetSecureBootState

Variant 1

NameTypeRequiredDescription
disablesecurebootstatestringYesValues: checksecurebootstatus

Variant 2

NameTypeRequiredDescription
disablesecurebootstatestringYesValues: disablesecureboot

Variant 3

NameTypeRequiredDescription
disablesecurebootstatestringYesValues: setsecureboot

Variant 4

NameTypeRequiredDescription
disablesecurebootstatestringYesValues: rebootdpu
reboot_countinteger (uint32)Yes

Variant 5

NameTypeRequiredDescription
disablesecurebootstatestringYesValues: waitcertificateupload
task_idstringYes

StateMachineArea

Allowed values: default, hostinit, mainflow, assignedinstance


UefiSetupInfo

NameTypeRequiredDescription
uefi_password_jidstring or nullNo
uefi_setup_stateUefiSetupStateYesSubstates of enabling/disabling lockdown

UefiSetupState

Substates of enabling/disabling lockdown

Substates of enabling/disabling lockdown

unlockhost

NameTypeRequiredDescription
statestringYesValues: unlockhost

setuefipassword

NameTypeRequiredDescription
statestringYesValues: setuefipassword

waitforpasswordjobscheduled

NameTypeRequiredDescription
statestringYesValues: waitforpasswordjobscheduled

powercyclehost

NameTypeRequiredDescription
statestringYesValues: powercyclehost

waitforpasswordjobcompletion

NameTypeRequiredDescription
statestringYesValues: waitforpasswordjobcompletion

lockdownhost

NameTypeRequiredDescription
statestringYesValues: lockdownhost

ValidationState

Host machine validation placeholder for DPU machine validation TODO: add DPU …

NameTypeRequiredDescription
machine_validationMachineValidatingStateYes
validation_typestringYesValues: machinevalidation