vcenter trusted infrastructure trust authority clusters kms providers: key server create spec

The key_server_create_spec structure contains fields that describe the desired configuration for the 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.

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

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 Key Management Interoperability Protocol (KMIP) compliant key servers.

Key servers must be configured for active-active replication. If the server port is unset, a default value for KMIP's port will be used.

. 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
description string Description of the key server. This attribute was added in vSphere API 7.0.0.

Optional. If unset, description will not be added.

proxy_server network_address Proxy server configuration. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the key server will not use a proxy server.

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 not be set.

kmip_server kmip_server_create_spec Configuration information for Key Management Interoperability Protocol (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, no username will be added.