TestVCenterConnectionResult

TestVCenterConnectionResult
TestVCenterConnectionResult

Result of a diagnostic test or trust acceptance

JSON Example
{
    "status": "string",
    "message": "string",
    "vcenterVersion": "string",
    "apiVersion": "string",
    "instanceUuid": "string",
    "trustChallengeId": "string",
    "tlsFailureReason": "string",
    "certificate": {
        "subject": "string",
        "issuer": "string",
        "validFrom": "string",
        "validTo": "string",
        "sha256Fingerprint": "string",
        "isExpired": false,
        "subjectAlternativeNames": [
            "string"
        ]
    },
    "verifiedConnectionToken": "string"
}
status
Required  

Status of a vCenter diagnostic test or trust evaluation

  • SUCCESS: The probe signed in and read the vCenter version, API version and instance UUID; a verified connection token is returned
  • TLS_TRUST_REQUIRED: Strict certificate validation failed with a condition an administrator can approve (untrusted CA, host name mismatch, or both); a trust challenge, the failure reason and the certificate details are returned
  • CONNECTIVITY_FAILURE: The vCenter host and port could not be reached
  • TLS_FAILURE: The certificate is expired, not yet valid or failed the handshake for another reason, which administrator trust cannot bypass, or the server certificate could not be inspected
  • AUTHENTICATION_FAILURE: The vCenter rejected the user name or password
  • INSUFFICIENT_PRIVILEGE: The sign-in worked, but the account lacks the privilege to enumerate the vCenter inventory
  • VCENTER_IDENTITY_MISMATCH: No behaviour is documented for this value. No producing site in the current server code
  • PINNED_CERTIFICATE_EXPIRED: No behaviour is documented for this value. No producing site in the current server code
  • UNKNOWN_FAILURE: Any other failure of the probe; the message carries the cause
Enumeration: SUCCESS, TLS_TRUST_REQUIRED, CONNECTIVITY_FAILURE, TLS_FAILURE, AUTHENTICATION_FAILURE, INSUFFICIENT_PRIVILEGE, VCENTER_IDENTITY_MISMATCH, PINNED_CERTIFICATE_EXPIRED, UNKNOWN_FAILURE
string
message
Required  

User-facing diagnostic or error message (contains no credentials)

string
vcenterVersion
Optional

Detected vCenter product version if available

string
apiVersion
Optional

Detected vCenter API version if available

string
instanceUuid
Optional

Authoritative vCenter instance UUID if successfully authenticated

string
trustChallengeId
Optional

Single-use server-issued inspection challenge ID when status is TLS_TRUST_REQUIRED

tlsFailureReason
Optional

Specific cryptographic reason for TLS handshake or trust verification failure

  • UNTRUSTED_CA: The certificate is within its validity period and matches the host, but its issuer is not trusted
  • HOSTNAME_MISMATCH: The issuer is trusted, but the certificate does not match the host name used
  • UNTRUSTED_CA_AND_HOSTNAME_MISMATCH: The issuer is not trusted and the certificate does not match the host name used
  • CERTIFICATE_EXPIRED: The certificate end date has passed; no trust challenge is created for it
  • CERTIFICATE_NOT_YET_VALID: The certificate start date is in the future; no trust challenge is created for it
  • TLS_HANDSHAKE_FAILURE: The certificate is within its validity period, trusted and matches the host, yet the secure connection failed; no trust challenge is created for it
Enumeration: UNTRUSTED_CA, HOSTNAME_MISMATCH, UNTRUSTED_CA_AND_HOSTNAME_MISMATCH, CERTIFICATE_EXPIRED, CERTIFICATE_NOT_YET_VALID, TLS_HANDSHAKE_FAILURE
certificate
Optional

Presented X.509 certificate presentation and health details

string
verifiedConnectionToken
Optional

Single-use server-issued verification token required for Save