VCenter Connections Get Offboarding Summary
Counts the hosts and agents tied to the connection and lists the recovery outcome per host. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
vCenter connection id
1
200 OK successful response envelope. The offboarding summary with the host and agent counts and the recovery outcome per host
{
"vcenterConnectionId": "1",
"displayName": "Primary vCenter",
"host": "vcenter.example.com:443",
"totalDiscoveredHosts": 1,
"managedAgentsCount": 1,
"offlineAgentsCount": 1,
"autoEnrollmentEnabled": false,
"currentLifecycleStatus": "WATCHING",
"currentlyLinkedAgentsCount": 1,
"historicalAgentsCount": 0,
"unresolvedIdentitiesCount": 1,
"simulatorRecordsCount": 0,
"hostRecoveryOutcomes": [
{
"hypervisorPk": 104,
"hostname": "esx04.example.com",
"managementIp": "192.0.2.14",
"hardwareUuid": "00000000-0000-4000-8000-000000000023",
"agentId": "4",
"enrollmentStatus": "FAILED",
"enrollmentStage": "RECOVERY_REQUIRED",
"recoveryRequired": true,
"identityType": "CURRENT_LINK",
"offboardOutcome": "RECOVERY_REQUIRED",
"error": "Remote agent unenrollment failed: the Agent did not respond. Operator override required (force=true)."
}
]
}
Identifier of the connection, as given in the request
Display name of the connection
Address of the vCenter in the form host:port
Number of discovered host records linked to the connection
Number of hosts that are not simulator records and have an Agent, either linked now or found by hardware UUID (currentlyLinkedAgentsCount plus historicalAgentsCount)
Number of hosts, other than simulator records, for which recovery is required
Whether Auto Enrollment is switched on for the connection; false when no setting is stored
Lifecycle state of the vCenter connection: one of the VCenterLifecycleState values (DISCONNECTED, CONNECTING, BASELINING, WATCHING, DEGRADED_RETRYING, REBUILDING, STOPPING, OPERATOR_ACTION_REQUIRED, REMOVING, WAITING_FOR_AGENTS, ATTENTION_REQUIRED, REMOVED); DISCONNECTED when none was recorded. Returned as a plain string
Number of hosts, other than simulator records, that have an Agent id above 0
Number of hosts, other than simulator records, that have no current Agent but share a hardware UUID with an earlier Agent
Number of hosts, other than simulator records, for which recovery is required (counted under the same condition as offlineAgentsCount)
Number of hosts classed as simulator records: a loopback management IP, or a host name that looks like a test or simulator host
One entry per discovered host of the connection, in the order the host records were read
400 Bad Request: INVALID_CONNECTION_ID
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: CONNECTION_NOT_FOUND
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/vcenter-connections/{id}/offboarding-summary