VCenter Connections Abandon Local Removal
Exceptional, explicitly authorized local retirement. It removes the Console records only. Hosts without a confirmed outcome become LOCAL_ABANDONED, Agent ownership history, the unconfirmed-offboarding evidence and the suppression of automatic enrollment are kept, and no host is reported unenrolled. It never authorizes enrolling the host here or in another Console. Allowed only from ATTENTION_REQUIRED after at least one retry. Requires the ADMIN role.
vCenter connection id: its numeric primary key, with or without the db- prefix. The connection row may be gone; the operation record is looked up by the numeric key
1
The operation id and generation the administrator was shown, the typed confirmation phrase, a reason and the acknowledgement that Agents may still be enrolled.
Show optional properties
{
"operationId": 0,
"generation": 0,
"confirmationPhrase": "string",
"reasonCode": "string",
"acknowledgeAgentsMayStillBeEnrolled": false
}
{
"operationId": 7,
"generation": 3,
"confirmationPhrase": "ABANDON Primary vCenter",
"reasonCode": "PERMANENTLY_UNREACHABLE",
"reasonText": "vCenter was decommissioned",
"acknowledgeAgentsMayStillBeEnrolled": true
}
Removal operation the caller was shown, so another operation is never abandoned by mistake
Pass number the caller was shown; a newer pass answers 409 REMOVAL_STALE
The exact phrase ABANDON followed by a space and the connection's display name, typed by the administrator
Reason an administrator gives for abandoning the Console records of a vCenter that cannot be reached.
DECOMMISSIONED: The vCenter was taken out of service on purposePERMANENTLY_UNREACHABLE: The vCenter cannot be reached and will not come backREPLACED: A different vCenter replaced itOTHER: Any other reason, explained in the reason text
Optional explanation, at most 200 characters, kept in the audit record
Must be true: the administrator accepts that Agents of hosts without a confirmed outcome may still be enrolled to this Console
200 OK: the operation is LOCALLY_ABANDONED
{
"operationId": 7,
"connectionPk": 1,
"displayName": "Primary vCenter",
"host": "vcenter.example.com",
"port": 443,
"state": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"generation": 3,
"hostsTotal": 120,
"progress": {
"operationId": 7,
"operationState": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"hostsTotal": 120,
"hostsFinished": 119,
"hostsFailed": 1,
"hostsOutstanding": 0,
"remoteConfirmed": 117,
"noRemoteIdentity": 2,
"forcedUnconfirmed": 0,
"recoveryRequired": 1
},
"requestedBy": "alice.example",
"requestedAt": "2026-01-15T09:30:00Z",
"lastRetryBy": "alice.example",
"lastRetryAt": "2026-01-15T09:40:00Z",
"abandonedBy": null,
"abandonedAt": null,
"abandonReasonCode": null,
"finishedAt": null,
"connectionDeleted": false,
"canRetry": true,
"canAbandonLocal": true
}
Identifier of this removal operation
Primary key the connection had, kept after the row is deleted
Display name the connection had when the removal started
Address the connection had when the removal started
HTTPS port the connection had when the removal started
Where the operation stands: REQUESTED, RUNNING, ATTENTION_REQUIRED, COMPLETED or LOCALLY_ABANDONED
Why the operation stopped for the operator while ATTENTION_REQUIRED: HOST_FAILURES, INTERRUPTED, LATE_ENROLLMENT or FINALIZE_FAILED; null otherwise
Pass number, increased by every retry and by a restart interruption
Hosts the operation tracks, including hosts that appeared after it started
Where a vCenter removal stands while Agent unenrollment runs on the enrollment workers. Counts use the offboarding outcome vocabulary
Account that started the removal
Moment an administrator asked for the removal, in UTC
Account that last started a retry; null before the first retry
When the last retry started; null before the first retry
Account that abandoned the Console records; null unless LOCALLY_ABANDONED
When the Console records were abandoned; null unless LOCALLY_ABANDONED
Reason code given at abandonment: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED or OTHER; null unless LOCALLY_ABANDONED
When the operation reached COMPLETED or LOCALLY_ABANDONED; null while it is active
True once the connection row was deleted
Whether Retry Removal may be started now
Whether local abandonment may be requested now: ATTENTION_REQUIRED after at least one retry
202 Accepted: the forced local retirement of the hosts is still running; follow it with GET /api/v1/vcenter-connections/{id}/removal until the state is LOCALLY_ABANDONED
{
"operationId": 7,
"connectionPk": 1,
"displayName": "Primary vCenter",
"host": "vcenter.example.com",
"port": 443,
"state": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"generation": 3,
"hostsTotal": 120,
"progress": {
"operationId": 7,
"operationState": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"hostsTotal": 120,
"hostsFinished": 119,
"hostsFailed": 1,
"hostsOutstanding": 0,
"remoteConfirmed": 117,
"noRemoteIdentity": 2,
"forcedUnconfirmed": 0,
"recoveryRequired": 1
},
"requestedBy": "alice.example",
"requestedAt": "2026-01-15T09:30:00Z",
"lastRetryBy": "alice.example",
"lastRetryAt": "2026-01-15T09:40:00Z",
"abandonedBy": null,
"abandonedAt": null,
"abandonReasonCode": null,
"finishedAt": null,
"connectionDeleted": false,
"canRetry": true,
"canAbandonLocal": true
}
Identifier of this removal operation
Primary key the connection had, kept after the row is deleted
Display name the connection had when the removal started
Address the connection had when the removal started
HTTPS port the connection had when the removal started
Where the operation stands: REQUESTED, RUNNING, ATTENTION_REQUIRED, COMPLETED or LOCALLY_ABANDONED
Why the operation stopped for the operator while ATTENTION_REQUIRED: HOST_FAILURES, INTERRUPTED, LATE_ENROLLMENT or FINALIZE_FAILED; null otherwise
Pass number, increased by every retry and by a restart interruption
Hosts the operation tracks, including hosts that appeared after it started
Where a vCenter removal stands while Agent unenrollment runs on the enrollment workers. Counts use the offboarding outcome vocabulary
Account that started the removal
Moment an administrator asked for the removal, in UTC
Account that last started a retry; null before the first retry
When the last retry started; null before the first retry
Account that abandoned the Console records; null unless LOCALLY_ABANDONED
When the Console records were abandoned; null unless LOCALLY_ABANDONED
Reason code given at abandonment: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED or OTHER; null unless LOCALLY_ABANDONED
When the operation reached COMPLETED or LOCALLY_ABANDONED; null while it is active
True once the connection row was deleted
Whether Retry Removal may be started now
Whether local abandonment may be requested now: ATTENTION_REQUIRED after at least one retry
400 Bad Request: CONFIRMATION_MISMATCH, ACKNOWLEDGEMENT_REQUIRED or INVALID_ARGUMENT
{
"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 when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"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: REMOVAL_NOT_FOUND
{
"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.
409 Conflict: REMOVAL_NOT_ABANDONABLE, REMOVAL_STALE or REMOVAL_IN_PROGRESS
"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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"operationId":"integer","generation":"integer","confirmationPhrase":"string","reasonCode":"string","acknowledgeAgentsMayStillBeEnrolled":"boolean"}' https://{api_host}/api/v1/vcenter-connections/{id}/removal/abandon-local