Create KMS Services
Registers a Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/kms/services
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
TrustedInfrastructureKmsServicesCreateSpec of mimetype application/json
Required
The CreateSpec for the new service.
{
"address": {
"hostname": "string"
},
"group": "string",
"trust_authority_cluster": "string",
"trusted_CA": {
"cert_chain": [
"string"
]
}
}
string
group
Required
The group determines the Attestation Service instances this Key Provider service can accept reports from.
string
trust_authority_cluster
Required
The cluster specifies the Trust Authority Cluster this Key Provider Service belongs to.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string of type application/json
ID of the newly registered Key Provider Service instance. The result will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.
Code Samples
PowerCLI Client SDK Example
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname"
$TrustedInfrastructureX509CertChain = Initialize-TrustedInfrastructureX509CertChain -CertChain "MyCertChain"
$TrustedInfrastructureKmsServicesCreateSpec = Initialize-TrustedInfrastructureKmsServicesCreateSpec -Address $TrustedInfrastructureNetworkAddress -TrustedCA $TrustedInfrastructureX509CertChain -Group "MyGroup" -TrustAuthorityCluster "MyTrustAuthorityCluster"
Invoke-CreateTrustedInfrastructureKmsServices -TrustedInfrastructureKmsServicesCreateSpec $TrustedInfrastructureKmsServicesCreateSpec
PowerCLI Client SDK All Parameters Example
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname" -Port 0
$TrustedInfrastructureX509CertChain = Initialize-TrustedInfrastructureX509CertChain -CertChain "MyCertChain"
$TrustedInfrastructureKmsServicesCreateSpec = Initialize-TrustedInfrastructureKmsServicesCreateSpec -Address $TrustedInfrastructureNetworkAddress -TrustedCA $TrustedInfrastructureX509CertChain -Group "MyGroup" -TrustAuthorityCluster "MyTrustAuthorityCluster"
Invoke-CreateTrustedInfrastructureKmsServices -TrustedInfrastructureKmsServicesCreateSpec $TrustedInfrastructureKmsServicesCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"address":{"hostname":"string","port":0},"group":"string","trust_authority_cluster":"string","trusted_CA":{"cert_chain":["string"]}}' https://{api_host}/api/vcenter/trusted-infrastructure/kms/services
Errors
400
com.vmware.vapi.std.errors.already_exists : if there is already a Key Provider Service instance with the same Address. | com.vmware.vapi.std.errors.invalid_argument : if the CreateSpec contains invalid data.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.0
