VCenter Connections Get Offboarding Summary

VCenter Connections Get Offboarding Summary
Summarize what removing a vCenter connection affects

Counts the hosts and agents tied to the connection and lists the recovery outcome per host. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/vcenter-connections/{id}/offboarding-summary
COPY
Path Parameters
string
id
Required  

vCenter connection id

id example
1

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The offboarding summary with the host and agent counts and the recovery outcome per host

Returns VCenterOffboardingSummaryDto of type(s) application/json
{
    "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)."
        }
    ]
}
string
vcenterConnectionId
Required  

Identifier of the connection, as given in the request

string
displayName
Optional

Display name of the connection

string
host
Optional

Address of the vCenter in the form host:port

integer As int64 As int64
totalDiscoveredHosts
Required  

Number of discovered host records linked to the connection

integer As int64 As int64
managedAgentsCount
Required  

Number of hosts that are not simulator records and have an Agent, either linked now or found by hardware UUID (currentlyLinkedAgentsCount plus historicalAgentsCount)

integer As int64 As int64
offlineAgentsCount
Required  

Number of hosts, other than simulator records, for which recovery is required

boolean
autoEnrollmentEnabled
Required  

Whether Auto Enrollment is switched on for the connection; false when no setting is stored

string
currentLifecycleStatus
Optional

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

integer As int64 As int64
currentlyLinkedAgentsCount
Required  

Number of hosts, other than simulator records, that have an Agent id above 0

integer As int64 As int64
historicalAgentsCount
Required  

Number of hosts, other than simulator records, that have no current Agent but share a hardware UUID with an earlier Agent

integer As int64 As int64
unresolvedIdentitiesCount
Required  

Number of hosts, other than simulator records, for which recovery is required (counted under the same condition as offlineAgentsCount)

integer As int64 As int64
simulatorRecordsCount
Required  

Number of hosts classed as simulator records: a loopback management IP, or a host name that looks like a test or simulator host

array of object
hostRecoveryOutcomes
Required  

One entry per discovered host of the connection, in the order the host records were read


400

400 Bad Request: INVALID_CONNECTION_ID

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

403 Forbidden: FORBIDDEN

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

404 Not Found: CONNECTION_NOT_FOUND

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/vcenter-connections/{id}/offboarding-summary