vcenter trusted infrastructure trust authority clusters kms providers: update spec

The update_spec structure contains fields that describe the new configuration for an existing provider. This structure was added in vSphere API 7.0.0.

Representation:

{
    "key_server"{
        "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
    },
    "master_key_id""string"
}

Attributes:

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

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

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

key_server.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
master_key_id string Master key identifier created for the provider.

A unique Key identifier.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, masterKeyId will remain unchanged.

key_server key_server_update_spec Key server associated with this provider.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, key server configuration will remain unchanged.

key_server.type string Type of the key server.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, key server type and configuration information will remain unchanged. In this case all key server configuration information fields (e.g KMIP) should be unset.

key_server.description string Description of the key server.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, description will remain unchanged.

key_server.proxy_server network_address Proxy server configuration.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, proxy server configuration will remain unchanged.

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

key_server.connection_timeout long Connection timeout in seconds.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, connection timeout will remain unchanged.

key_server.kmip_server kmip_server_update_spec 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. If unset, kmip server configuration will remain unchanged.

key_server.kmip_server.servers server[] List of 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.

Optional. If unset, server configuration will remain unchanged.

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

key_server.kmip_server.username string Username for authentication.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset, username will remain unchanged.