HostRecoveryOutcomeDto

HostRecoveryOutcomeDto
HostRecoveryOutcomeDto

The recovery state of one host of a vCenter connection.

JSON Example
{
    "hypervisorPk": 0,
    "hostname": "string",
    "managementIp": "string",
    "hardwareUuid": "string",
    "agentId": "string",
    "enrollmentStatus": "string",
    "enrollmentStage": "string",
    "recoveryRequired": false,
    "identityType": "string",
    "offboardOutcome": "string",
    "error": "string"
}
integer As int64 As int64
hypervisorPk
Required  

Database identifier of the discovered host record

string
hostname
Optional

Host name recorded on the discovered host

string
managementIp
Optional

Management IP address recorded on the discovered host

string
hardwareUuid
Optional

Hardware UUID recorded on the discovered host; it is the key used to look for an earlier Agent of the host

string As ^[0-9]+$
agentId
Optional

Identifier of the Agent linked to the host, as a decimal string (a 64-bit value, sent as a string because browsers cannot hold it exactly as a number); for identityType HISTORICAL_AGENT, the identifier of the earlier Agent found by hardware UUID; otherwise the value on the host record, which is null when no Agent was linked

string
enrollmentStatus
Optional

Enrollment status recorded on the host: NOT_ENROLLED, ENROLLING, ENROLLED, FAILED or UNENROLLED; the text UNKNOWN when the host has none

string
enrollmentStage
Optional

Enrollment stage recorded on the host: NONE, AUTHORIZING, CSR_REQUESTED, CSR_RECEIVED, CERT_SIGNED, CERT_DELIVERED, AWAITING_HEARTBEAT, ENROLLED, RECOVERY_REQUIRED or FAILED; the text NONE when the host has none

boolean
recoveryRequired
Required  

True when the enrollment status is FAILED or the stage is RECOVERY_REQUIRED

string
identityType
Optional

How the host relates to an Agent, decided in this order: SIMULATOR (loopback management IP, or a host name that looks like a test or simulator host), CURRENT_LINK (the host has an Agent id above 0), HISTORICAL_AGENT (no current Agent, but an Agent with the same hardware UUID exists), UNRESOLVED_REMOTE (neither, and recovery is required), NOT_ENROLLED (none of the above). The set is closed by these five values

string
offboardOutcome
Optional

Outcome expected if the connection is removed now: RECOVERY_REQUIRED when recoveryRequired is true, REMOTE_CONFIRMED when the host has a current or earlier Agent, otherwise NO_REMOTE_IDENTITY. FORCED_UNCONFIRMED, the fourth outcome of an offboard, is never reported here

string
error
Optional

Enrollment error text recorded on the host; null when none is recorded