VCenterConnectionSummary

VCenterConnectionSummary
VCenterConnectionSummary

Summary of a registered vCenter connection

JSON Example
{
    "id": "string",
    "displayName": "string",
    "host": "string",
    "port": 0,
    "username": "string",
    "enabled": false,
    "vcenterInstanceUuid": "string",
    "trustProvenance": "string",
    "certSha256": "string",
    "certSubject": "string",
    "certNotAfter": "string",
    "lastConnectionStatus": "string",
    "lastConnectionSecurityCode": "string",
    "createdAt": "string",
    "discoveredHostCount": 0,
    "discoveredHostCountStatus": "string",
    "lastVerifiedSyncAt": "string",
    "inventoryHoldReason": "string",
    "inventoryHoldObservedHosts": 0,
    "inventoryHoldCurrentHosts": 0,
    "inventoryHoldId": "string",
    "inventoryHoldExcludedProductHosts": 0,
    "removalProgress": {
        "operationId": 0,
        "operationState": "string",
        "attentionReason": "string",
        "hostsTotal": 0,
        "hostsFinished": 0,
        "hostsFailed": 0,
        "hostsOutstanding": 0,
        "remoteConfirmed": 0,
        "noRemoteIdentity": 0,
        "forcedUnconfirmed": 0,
        "recoveryRequired": 0
    }
}
string
id
Required  

Unique database identifier for the connection

string
displayName
Required  

Operator-chosen name of the connection, trimmed of surrounding spaces when the connection is added; unique ignoring case

string
host
Required  

Host address

integer As int32 As int32
port
Required  

HTTPS port

string
username
Required  

Account the Console signs in to vCenter with, trimmed of surrounding spaces when the connection is added; the password is never returned

boolean
enabled
Required  

Whether discovery is currently enabled for this connection

string
vcenterInstanceUuid
Required  

Authoritative vCenter instance UUID

trustProvenance
Required  

Provenance of trust for the active vCenter certificate

  • CA_SAN_VERIFIED: The certificate passed strict CA and subject alternative name validation; also the value when none is given
  • USER_APPROVED: An administrator approved the certificate through a trust challenge, and the connection is pinned to it
Enumeration: CA_SAN_VERIFIED, USER_APPROVED
string
certSha256
Optional

SHA-256 fingerprint of the trusted leaf certificate

string
certSubject
Optional

Subject of the trusted leaf certificate

string As date-time As date-time
certNotAfter
Optional

Expiration timestamp of the trusted leaf certificate

lastConnectionStatus
Required  

Operational lifecycle state of a vCenter discovery connection. The server code also declares WAITING_FOR_AGENTS (the code found no place that sets it); it is not in the enum list

  • DISCONNECTED: Not connected: the state after STOPPING, and the state reported when none is stored
  • CONNECTING: The initial state of a newly added connection, and the state of each connect attempt
  • BASELINING: The connection is made and the security code is cleared; the inventory baseline is being loaded
  • WATCHING: The baseline is loaded and the worker follows inventory changes
  • DEGRADED_RETRYING: A transient transport failure occurred (security code CONNECTIVITY_FAILURE); the worker retries
  • REBUILDING: The session or its change lineage was invalidated; the worker reconnects through CONNECTING and BASELINING
  • STOPPING: Shutdown is in progress; DISCONNECTED follows
  • OPERATOR_ACTION_REQUIRED: The worker stopped retrying until an operator acts; the security code names the reason (trust required, pinned certificate expired, identity mismatch, authentication failure or insufficient privilege)
  • REMOVING: Removal was requested; discovery is fenced and the Agents of the connection's hosts are being offboarded, so the connection is not removed yet
  • ATTENTION_REQUIRED: A removal pass finished with at least one host that could not be offboarded; the connection is kept so the operator can retry or force the removal
  • REMOVED: Every host has an outcome and the connection row was deleted; returned by the removal call only
Enumeration: DISCONNECTED, CONNECTING, BASELINING, WATCHING, DEGRADED_RETRYING, REBUILDING, STOPPING, OPERATOR_ACTION_REQUIRED, REMOVING, ATTENTION_REQUIRED, REMOVED
lastConnectionSecurityCode
Optional

Security or error reason code for an operator-action or degraded vCenter connection

  • NONE: No security or error condition; the value stored when a connection is added and whenever the worker reaches CONNECTING or BASELINING cleanly
  • TLS_TRUST_REQUIRED: Certificate verification failed on connect, or the pinned certificate is not yet valid (set with OPERATOR_ACTION_REQUIRED)
  • VCENTER_IDENTITY_MISMATCH: The live vCenter instance UUID differs from the one recorded for the connection (set with OPERATOR_ACTION_REQUIRED)
  • PINNED_CERTIFICATE_EXPIRED: The pinned certificate has expired and the expired-pin policy does not allow continuing (set with OPERATOR_ACTION_REQUIRED)
  • AUTHENTICATION_FAILURE: The vCenter rejected the stored credentials (set with OPERATOR_ACTION_REQUIRED)
  • INSUFFICIENT_PRIVILEGE: The account lacks the privilege to enumerate the inventory (set with OPERATOR_ACTION_REQUIRED)
  • CONNECTIVITY_FAILURE: The vCenter could not be reached or a transient transport failure occurred (set with DEGRADED_RETRYING)
Enumeration: NONE, TLS_TRUST_REQUIRED, VCENTER_IDENTITY_MISMATCH, PINNED_CERTIFICATE_EXPIRED, AUTHENTICATION_FAILURE, INSUFFICIENT_PRIVILEGE, CONNECTIVITY_FAILURE
string As date-time As date-time
createdAt
Required  

Creation timestamp

integer As int64 As int64
discoveredHostCount
Optional

Number of ACTIVE vCenter-managed hypervisor rows stored for this connection, the same rows Hypervisors, Discover lists by default; STALE and standalone rows are excluded. Read from the stored inventory, never from vCenter. Present on the list response only

string
discoveredHostCountStatus
Optional

Present on the list response only; null elsewhere

string As date-time As date-time
lastVerifiedSyncAt
Optional

Time of the last successful baseline or WaitForUpdatesEx reply of the running discovery worker, null until the first one after a Console start. Not stored. Present on the list response only

string
inventoryHoldReason
Optional

Why removal of hosts missing from a complete vCenter snapshot is held: EMPTY_SNAPSHOT (no hosts although some are known) or MASS_REDUCTION (at least the configured number of hosts, and more than the configured percentage, would leave); null when no removal is held. Present on the list response only

Enumeration: EMPTY_SNAPSHOT, MASS_REDUCTION
integer As int32 As int32
inventoryHoldObservedHosts
Optional

Hosts the held snapshot listed; null without a hold. Present on the list response only

integer As int32 As int32
inventoryHoldCurrentHosts
Optional

Hosts currently known for the connection when the removal was held; null without a hold. Present on the list response only

string
inventoryHoldId
Optional

Identifier of the current hold, new for every hold; the confirmation must echo it so a confirmation made for one hold cannot apply to a later one. Null without a hold. Present on the list response only

integer As int32 As int32
inventoryHoldExcludedProductHosts
Optional

How many of the hosts whose removal is held are identified as unsupported mobility agent hosts, already hidden from Discover pending removal; 0 or null without a hold. Present on the list response only

object
removalProgress
Optional

Progress of Agent unenrollment while the connection is REMOVING, and the last pass's counts while it is ATTENTION_REQUIRED after a failed removal; null otherwise, and after a Console restart