com.vmware.vcenter.certificate_management.vcenter

Interface SigningCertificate

All Superinterfaces:

Service, SigningCertificateTypes

All Known Implementing Classes:

SigningCertificateStub

public interface SigningCertificate
extends Service, SigningCertificateTypes

The SigningCertificate interface provides methods to view and manage vCenter signing certificates which are used to sign and verify tokens issued by vCenter token service. Versioning is the same as for the com.vmware.vcenter package. 1.23 - vSphere 7.0 U3. This interface was added in vSphere API 7.0.3.0.

Nested Class Summary

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

SigningCertificateTypes.Info, SigningCertificateTypes.SetSpec

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SigningCertificateTypes.Info	get() Retrieve the signing certificate chains for validating vCenter-issued tokens.
void	get(AsyncCallback<SigningCertificateTypes.Info> asyncCallback) Retrieve the signing certificate chains for validating vCenter-issued tokens.
void	get(AsyncCallback<SigningCertificateTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieve the signing certificate chains for validating vCenter-issued tokens.
SigningCertificateTypes.Info	get(InvocationConfig invocationConfig) Retrieve the signing certificate chains for validating vCenter-issued tokens.
X509CertChain	refresh(java.lang.Boolean force) Refresh the vCenter signing certificate chain.
void	refresh(java.lang.Boolean force, AsyncCallback<X509CertChain> asyncCallback) Refresh the vCenter signing certificate chain.
void	refresh(java.lang.Boolean force, AsyncCallback<X509CertChain> asyncCallback, InvocationConfig invocationConfig) Refresh the vCenter signing certificate chain.
X509CertChain	refresh(java.lang.Boolean force, InvocationConfig invocationConfig) Refresh the vCenter signing certificate chain.
void	set(SigningCertificateTypes.SetSpec spec) Set the active signing certificate for vCenter.
void	set(SigningCertificateTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set the active signing certificate for vCenter.
void	set(SigningCertificateTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set the active signing certificate for vCenter.
void	set(SigningCertificateTypes.SetSpec spec, InvocationConfig invocationConfig) Set the active signing certificate for vCenter.

Method Detail

get

SigningCertificateTypes.Info get()

Retrieve the signing certificate chains for validating vCenter-issued tokens. This method was added in vSphere API 7.0.3.0.

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

Returns:

The active certificate chain and signing certificate chains for validating tokens.

Throws:

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

• Method execution requires System.Read.

get

SigningCertificateTypes.Info get(InvocationConfig invocationConfig)

Retrieve the signing certificate chains for validating vCenter-issued tokens. This method was added in vSphere API 7.0.3.0.

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:

The active certificate chain and signing certificate chains for validating tokens.

Throws:

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

• Method execution requires System.Read.

get

void get(AsyncCallback<SigningCertificateTypes.Info> asyncCallback)

Retrieve the signing certificate chains for validating vCenter-issued tokens. This method was added in vSphere API 7.0.3.0.

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

Invocation Result:
The active certificate chain and signing certificate chains for validating tokens.

Operation Errors:
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<SigningCertificateTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Retrieve the signing certificate chains for validating vCenter-issued tokens. This method was added in vSphere API 7.0.3.0.

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:
The active certificate chain and signing certificate chains for validating tokens.

Operation Errors:
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.

set

void set(SigningCertificateTypes.SetSpec spec)

Set the active signing certificate for vCenter. The certificate will immediately be used to sign tokens issued by vCenter token service. This method was added in vSphere API 7.0.3.0.

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

Parameters:

spec - Signing certificate chain and private key which the vCenter token service will actively use to sign tokens.

Throws:

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

• Method execution requires CertificateManagement.Administer.

set

void set(SigningCertificateTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Set the active signing certificate for vCenter. The certificate will immediately be used to sign tokens issued by vCenter token service. This method was added in vSphere API 7.0.3.0.

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 - Signing certificate chain and private key which the vCenter token service will actively use to sign tokens.

invocationConfig - Configuration for the method invocation.

Throws:

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

• Method execution requires CertificateManagement.Administer.

set

void set(SigningCertificateTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Set the active signing certificate for vCenter. The certificate will immediately be used to sign tokens issued by vCenter token service. This method was added in vSphere API 7.0.3.0.

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

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

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - Signing certificate chain and private key which the vCenter token service will actively use to sign tokens.

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

set

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

Set the active signing certificate for vCenter. The certificate will immediately be used to sign tokens issued by vCenter token service. This method was added in vSphere API 7.0.3.0.

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:
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires CertificateManagement.Administer.

Parameters:

spec - Signing certificate chain and private key which the vCenter token service will actively use to sign tokens.

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

invocationConfig - Configuration for the method invocation.

refresh

X509CertChain refresh(java.lang.Boolean force)

Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance. This method was added in vSphere API 7.0.3.0.

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

Parameters:

force - Will force refresh in environments that would otherwise prevent refresh from occurring, such as a mixed-version environment. Force refresh may leave systems in the local vCenter domain in a non-functional state until they are restarted. If null, then refresh will not be forced.

Returns:

The signing certificate chain created during the refresh.

Throws:

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

• Method execution requires CertificateManagement.Administer.

refresh

X509CertChain refresh(java.lang.Boolean force,
                      InvocationConfig invocationConfig)

Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance. This method was added in vSphere API 7.0.3.0.

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:

force - Will force refresh in environments that would otherwise prevent refresh from occurring, such as a mixed-version environment. Force refresh may leave systems in the local vCenter domain in a non-functional state until they are restarted. If null, then refresh will not be forced.

invocationConfig - Configuration for the method invocation.

Returns:

The signing certificate chain created during the refresh.

Throws:

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

• Method execution requires CertificateManagement.Administer.

refresh

void refresh(java.lang.Boolean force,
             AsyncCallback<X509CertChain> asyncCallback)

Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance. This method was added in vSphere API 7.0.3.0.

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

Invocation Result:
The signing certificate chain created during the refresh.

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

• Method execution requires CertificateManagement.Administer.

Parameters:

force - Will force refresh in environments that would otherwise prevent refresh from occurring, such as a mixed-version environment. Force refresh may leave systems in the local vCenter domain in a non-functional state until they are restarted. If null, then refresh will not be forced.

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

refresh

void refresh(java.lang.Boolean force,
             AsyncCallback<X509CertChain> asyncCallback,
             InvocationConfig invocationConfig)

Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance. This method was added in vSphere API 7.0.3.0.

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:
The signing certificate chain created during the refresh.

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

• Method execution requires CertificateManagement.Administer.

Parameters:

force - Will force refresh in environments that would otherwise prevent refresh from occurring, such as a mixed-version environment. Force refresh may leave systems in the local vCenter domain in a non-functional state until they are restarted. If null, then refresh will not be forced.

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

invocationConfig - Configuration for the method invocation.