vcenter trusted infrastructure trust authority hosts kms: summary

The summary structure contains all the stored information about a Key Provider Service. This structure was added in vSphere API 7.0.0.

Representation:

{
    "cluster""string",
    "trusted_CA"{
        "cert_chain"[
            "string",
            "string"
        ]
    },
    "address"{
        "hostname""string",
        "port"1
    },
    "host""obj-103",
    "summary_type""FULL",
    "group""string"
}

Attributes:

Name Type Description
Required
summary_type string Defines the verbosity of the summary. This attribute was added in vSphere API 7.0.0.

The connection information could include the certificates or be a shorter summary. This enumeration was added in vSphere API 7.0.0. Value is one of:
FULL: The full connection information, including certificates. This constant was added in vSphere API 7.0.0.
NORMAL: A summary containing only the hostname, port, and the group which determines the Attestation Services this Key Provider Service can communicate with. This constant was added in vSphere API 7.0.0.
BRIEF: A brief summary, containing only the hostname for the Key Provider Service. This constant was added in vSphere API 7.0.0.

address.hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

trusted_CA.cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 7.0.0.

Optional
host string The trusted ESX on which the service runs. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when summary_type has value [BRIEF, NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of BRIEF, NORMAL, or FULL.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

address network_address The service's address. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when summary_type has value [BRIEF, NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of BRIEF, NORMAL, or FULL.

address.port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

group string The group ID determines which Attestation Service instances this Key Provider Service can communicate with. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when summary_type has value [NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of NORMAL or FULL.

cluster string The opaque string identifier of the cluster in which the Key Provider Service is part of. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when summary_type has value [NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of NORMAL or FULL.

trusted_CA x509_cert_chain The service's TLS certificate chain. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when summary_type has value [FULL]. This field is optional and it is only relevant when the value of summary_type is FULL.