vcenter trusted infrastructure trust authority clusters kms providers: key server info

The key_server_info structure contains fields that describe the current configuration of a key server. This structure was added in vSphere API 7.0.0.

Representation:

{
    "proxy_server"{
        "hostname""string",
        "port"1
    },
    "description""string",
    "kmip_server"{
        "servers"[
            {
                "address"{
                    "hostname""string",
                    "port"1
                },
                "name""string"
            },
            {
                "address"{
                    "hostname""string",
                    "port"1
                },
                "name""string"
            }
        ],
        "username""string"
    },
    "type""KMIP",
    "connection_timeout"1
}

Attributes:

Name Type Description
Required
type string Type of the key server. This attribute was added in vSphere API 7.0.0.

List the key server types. This enumeration was added in vSphere API 7.0.0. Value is one of:
KMIP: Key Management Interoperability Protocol (KMIP) based key management server. This constant was added in vSphere API 7.0.0.

description string Description of the key server. This attribute was added in vSphere API 7.0.0.

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

kmip_server.servers server[] List of KMIP compliant key servers. This attribute was added in vSphere API 7.0.0.

kmip_server.servers[].name string Name of the server.

A unique string chosen by the client.

. This attribute was added in vSphere API 7.0.0.

kmip_server.servers[].address network_address The server's address. This attribute was added in vSphere API 7.0.0.

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

Optional
proxy_server network_address Proxy server configuration.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, proxy server configuration will not be set.

proxy_server.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.

connection_timeout long Connection timeout in seconds.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, connection timeout will be unset.

kmip_server kmip_server_info Configuration information for KMIP based key server. This attribute was added in vSphere API 7.0.0.

Optional. It is only relevant when type has value KMIP. This field is optional and it is only relevant when the value of type is KMIP.

kmip_server.servers[].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.

kmip_server.username string Username for authentication.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, username will not be set.