Create Trust Authority Clusters KMS Providers Task
Add a new Key Provider.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers?vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec of mimetype application/json
Required
Provider information.
{
"key_server": {
"type": "KMIP"
},
"master_key_id": "string",
"provider": "string"
}
key_server
Required
Key server associated with this Provider.
string
master_key_id
Required
Master key ID created for the provider. A unique Key ID.
string
provider
Required
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.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
Errors
400
com.vmware.vapi.std.errors.already_exists : If the provider already exists. | com.vmware.vapi.std.errors.invalid_argument : If the spec is invalid or cluster id is empty.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec -Type "KMIP"
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec -Provider "MyProvider" -MasterKeyId "MyMasterKeyId" -KeyServer $TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec
Invoke-CreateClusterKmsProvidersAsync -Cluster "MyCluster" -TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec $TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec
PowerCLI Client SDK All Parameters Example
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname" -Port 0
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer -Name "MyName" -Address $TrustedInfrastructureNetworkAddress
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerCreateSpec -Servers $TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer -Username "MyUsername"
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec -Type "KMIP" -Description "MyDescription" -ProxyServer $TrustedInfrastructureNetworkAddress -ConnectionTimeout 0 -KmipServer $TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerCreateSpec
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec -Provider "MyProvider" -MasterKeyId "MyMasterKeyId" -KeyServer $TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerCreateSpec
Invoke-CreateClusterKmsProvidersAsync -Cluster "MyCluster" -TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec $TrustedInfrastructureTrustAuthorityClustersKmsProvidersCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"key_server":{"connection_timeout":0,"description":"string","kmip_server":{"servers":[{"address":{"hostname":"string","port":0},"name":"string"}],"username":"string"},"proxy_server":{"hostname":"string","port":0},"type":"KMIP"},"master_key_id":"string","provider":"string"}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
Availability
Added in 7.0.0.0
