com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package¶

Submodules¶

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module¶

The com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module provides the interfaces for configuring the Client Certificate used by the Key Provider Service to authenticate against the Key Servers.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client.Csr(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Csr interface provides methods to create a certificate signing request(CSR). This class was added in vSphere API 7.0.0.0.

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class Info(csr=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Csr.Info class contains the certificate signing request. This class was added in vSphere API 7.0.0.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: csr (str) – Certificate signing request. This attribute was added in vSphere API 7.0.0.0.

create_task(cluster, provider)¶

Generate a certificate signing request (CSR) for the client certificate. This overwrites any existing CSR.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

Calling the API repeatedly will result in a generating a new CSR each time.. This method was added in vSphere API 7.0.0.0.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
provider (str) – Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If cluster or provider id are empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the provider or cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error If any other error occurs.

get_task(cluster, provider)¶

Get existing certificate signing request (CSR) for the client certificate.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

. This method was added in vSphere API 7.0.0.0.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
provider (str) – Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If cluster or provider id are empty.

Raise

com.vmware.vapi.std.errors_client.NotFound If the provider or cluster is not found.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Error If any other error occurs.

class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance