com.vmware.vcenter.certificate_management.vcenter

Interface Tls

All Superinterfaces:

Service, TlsTypes

All Known Implementing Classes:

TlsStub

public interface Tls
extends Service, TlsTypes

The Tls interface provides methods to replace Tls certificate. This interface was added in vSphere API 6.7.2.

Nested Class Summary

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

TlsTypes.Info, TlsTypes.ReplaceSpec, TlsTypes.Spec

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TlsTypes.Info	get() Returns the rhttpproxy TLS certificate.
void	get(AsyncCallback<TlsTypes.Info> asyncCallback) Returns the rhttpproxy TLS certificate.
void	get(AsyncCallback<TlsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the rhttpproxy TLS certificate.
TlsTypes.Info	get(InvocationConfig invocationConfig) Returns the rhttpproxy TLS certificate.
void	renew(java.lang.Long duration) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, AsyncCallback<java.lang.Void> asyncCallback) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Renews the TLS certificate for the given duration period.
void	renew(java.lang.Long duration, InvocationConfig invocationConfig) Renews the TLS certificate for the given duration period.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	replaceVmcaSigned(TlsTypes.ReplaceSpec spec, InvocationConfig invocationConfig) Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	set(TlsTypes.Spec spec) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Replaces the rhttpproxy TLS certificate with the specified certificate.
void	set(TlsTypes.Spec spec, InvocationConfig invocationConfig) Replaces the rhttpproxy TLS certificate with the specified certificate.

Method Detail

set

void set(TlsTypes.Spec spec)

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

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

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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

Parameters:

spec - The information needed to replace the TLS certificate.

Throws:

NotFound - If the private key is not present in the VECS store.

AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.

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

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

• Method execution requires CertificateManagement.Administer.

set

void set(TlsTypes.Spec spec,
         InvocationConfig invocationConfig)

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

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

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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 replace the TLS certificate.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If the private key is not present in the VECS store.

AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.

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

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

• Method execution requires CertificateManagement.Administer.

set

void set(TlsTypes.Spec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

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

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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

Operation Errors:
NotFound - If the private key is not present in the VECS store.
AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
Error - If the system failed to replace the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - The information needed to replace the TLS certificate.

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

set

void set(TlsTypes.Spec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Replaces the rhttpproxy TLS certificate with the specified certificate. This method can be used in three scenarios :

1. When the CSR is created and the private key is already stored, this method can replace the certificate. The certificate but not the private key and root certificate must be provided as input.
2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this method can replace the certificate and private key. The certificate and the private key but not the root certificate must be provided as input.
3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this method can replace the certificate, private key and root CA certificate. The certificate, private key and root certificate must be provided as input.

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

The above three scenarios are only supported from vsphere 7.0 onwards.

. This method was added in vSphere API 6.7.2.

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:
NotFound - If the private key is not present in the VECS store.
AlreadyExists - If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
Error - If the system failed to replace the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - The information needed to replace the TLS certificate.

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

invocationConfig - Configuration for the method invocation.

get

TlsTypes.Info get()

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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

Returns:

TLS certificate.

Throws:

NotFound - if the rhttpproxy certificate is not present in VECS store.

Error - if failed due to generic exception.

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

• Method execution requires System.Read.

get

TlsTypes.Info get(InvocationConfig invocationConfig)

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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:

invocationConfig - Configuration for the method invocation.

Returns:

TLS certificate.

Throws:

NotFound - if the rhttpproxy certificate is not present in VECS store.

Error - if failed due to generic exception.

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

• Method execution requires System.Read.

get

void get(AsyncCallback<TlsTypes.Info> asyncCallback)

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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

Invocation Result:
TLS certificate.

Operation Errors:
NotFound - if the rhttpproxy certificate is not present in VECS store.
Error - if failed due to generic exception.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

get

void get(AsyncCallback<TlsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the rhttpproxy TLS certificate. This method was added in vSphere API 6.7.2.

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

Invocation Result:
TLS certificate.

Operation Errors:
NotFound - if the rhttpproxy certificate is not present in VECS store.
Error - if failed due to generic exception.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

renew

void renew(java.lang.Long duration)

Renews the TLS certificate for the given duration period.

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.7.2.

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

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

Throws:

Unsupported - If the TLS certificate is not VMCA generated.

InvalidArgument - If the duration period specified is invalid.

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

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

• Method execution requires CertificateManagement.Administer.

renew

void renew(java.lang.Long duration,
           InvocationConfig invocationConfig)

Renews the TLS certificate for the given duration period.

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.7.2.

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:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

invocationConfig - Configuration for the method invocation.

Throws:

Unsupported - If the TLS certificate is not VMCA generated.

InvalidArgument - If the duration period specified is invalid.

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

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

• Method execution requires CertificateManagement.Administer.

renew

void renew(java.lang.Long duration,
           AsyncCallback<java.lang.Void> asyncCallback)

Renews the TLS certificate for the given duration period.

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.7.2.

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

Operation Errors:
Unsupported - If the TLS certificate is not VMCA generated.
InvalidArgument - If the duration period specified is invalid.
Error - If the system failed to renew the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

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

renew

void renew(java.lang.Long duration,
           AsyncCallback<java.lang.Void> asyncCallback,
           InvocationConfig invocationConfig)

Renews the TLS certificate for the given duration period.

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.7.2.

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:
Unsupported - If the TLS certificate is not VMCA generated.
InvalidArgument - If the duration period specified is invalid.
Error - If the system failed to renew the TLS certificate.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

duration - The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If null, the duration will be 730 days (two years).

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

invocationConfig - Configuration for the method invocation.

replaceVmcaSigned

void replaceVmcaSigned(TlsTypes.ReplaceSpec spec)

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

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 Machine SSL

Throws:

InvalidArgument - If the Spec given is not complete or invalid

Error - If the system failed to replace the machine ssl certificate

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

• Method execution requires CertificateManagement.Administer.

replaceVmcaSigned

void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                       InvocationConfig invocationConfig)

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

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 Machine SSL

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - If the Spec given is not complete or invalid

Error - If the system failed to replace the machine ssl certificate

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

• Method execution requires CertificateManagement.Administer.

replaceVmcaSigned

void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                       AsyncCallback<java.lang.Void> asyncCallback)

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

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:
InvalidArgument - If the Spec given is not complete or invalid
Error - If the system failed to replace the machine ssl certificate
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 Machine SSL

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

replaceVmcaSigned

void replaceVmcaSigned(TlsTypes.ReplaceSpec spec,
                       AsyncCallback<java.lang.Void> asyncCallback,
                       InvocationConfig invocationConfig)

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

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:
InvalidArgument - If the Spec given is not complete or invalid
Error - If the system failed to replace the machine ssl certificate
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 Machine SSL

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

invocationConfig - Configuration for the method invocation.