REST API - create

esx kms providers: create spec

The create_spec structure contains fields that describe the desired configuration for a new provider.

Representation:

JSON

{
    "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
    },
    "provider" : "obj-103",
    "master_key_id" : "string"
}

Attributes:

Name	Type	Description
Required
provider	string	Name of the provider. A unique string chosen by the client. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.kms.providers`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.kms.providers`.
master_key_id	string	Master key identifier created for the provider. A unique Key identifier.
key_server	key_server_create_spec	Key server associated with this provider.
key_server.type	string	Type of the key server. List the key server types. Value is one of: KMIP: Key Management Interoperability Protocol (KMIP) based key management server.
key_server.proxy_server.hostname	string	The IP address or the hostname.
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 of 5696 will be used.
Optional
key_server.description	string	Description of the key server. Optional. If unset, description will not be added.
key_server.proxy_server	network_address	Proxy server configuration. Optional. If unset, proxy server configuration will not be added.
key_server.proxy_server.port	long	The port for the connection. Optional. If unset, a default port depending on the server type will be used or 443 if it's not explicitly specified.
key_server.connection_timeout	long	Connection timeout in seconds. Optional. If unset, connection timeout will be unset.
key_server.kmip_server	kmip_server_create_spec	Key Server configuration detail for KMIP based KMS. 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.
key_server.kmip_server.username	string	Username for authentication. Optional. If unset, no username will be added.