com.vmware.vcenter.certificate_management.vcenter

Interface VmcaRoot

All Superinterfaces:

com.vmware.vapi.bindings.Service, VmcaRootTypes

All Known Implementing Classes:

VmcaRootStub

public interface VmcaRoot
extends com.vmware.vapi.bindings.Service, VmcaRootTypes

The VmcaRoot interface provides methods to replace VMware Certificate Authority (VMCA) root certificate. This interface was added in vSphere API 6.9.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.certificate_management.vcenter.VmcaRootTypes

VmcaRootTypes.CreateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.certificate_management.vcenter.VmcaRootTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(VmcaRootTypes.CreateSpec spec) Replace Root Certificate with VMCA signed one using the given Spec.
void	create(VmcaRootTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Replace Root Certificate with VMCA signed one using the given Spec.
void	create(VmcaRootTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Replace Root Certificate with VMCA signed one using the given Spec.
void	create(VmcaRootTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Replace Root Certificate with VMCA signed one using the given Spec.

Method Detail

create

void create(VmcaRootTypes.CreateSpec spec)

Replace Root Certificate with VMCA signed one using the given Spec.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - The information needed to generate VMCA signed Root Certificate. Default values will be set for all null parameters.

Throws:

Error - If the system failed to renew the TLS certificate.

Unsupported - If the operation is executed on a platform where it is not supported. This exception was added in vSphere API 8.0.2.0.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

create

void create(VmcaRootTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Replace Root Certificate with VMCA signed one using the given Spec.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - The information needed to generate VMCA signed Root Certificate. Default values will be set for all null parameters.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If the system failed to renew the TLS certificate.

Unsupported - If the operation is executed on a platform where it is not supported. This exception was added in vSphere API 8.0.2.0.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

create

void create(VmcaRootTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Replace Root Certificate with VMCA signed one using the given Spec.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - If the system failed to renew the TLS certificate.
Unsupported - If the operation is executed on a platform where it is not supported. This exception was added in vSphere API 8.0.2.0.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - The information needed to generate VMCA signed Root Certificate. Default values will be set for all null parameters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(VmcaRootTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Replace Root Certificate with VMCA signed one using the given Spec.

After this method completes, the services using the certificate will be restarted for the new certificate to take effect.

. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - If the system failed to renew the TLS certificate.
Unsupported - If the operation is executed on a platform where it is not supported. This exception was added in vSphere API 8.0.2.0.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - The information needed to generate VMCA signed Root Certificate. Default values will be set for all null parameters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.