vmware::vcenter::certificate_management::vcenter::Tls Interface Reference

The Tls interface provides methods to replace Tls certificate. More...

Inherited by vmware::vcenter::certificate_management::vcenter::TlsStub.

List of all members.

Public Member Functions
void	Set (vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec spec)
	Replaces the rhttpproxy TLS certificate with the specified certificate.
void	Set (vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Replaces the rhttpproxy TLS certificate with the specified certificate.
global::System.Threading.Tasks.Task	SetAsync (vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec spec)
	Replaces the rhttpproxy TLS certificate with the specified certificate.
global::System.Threading.Tasks.Task	SetAsync (vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Replaces the rhttpproxy TLS certificate with the specified certificate.
vmware.vcenter.certificate_management.vcenter.TlsTypes.Info	Get ()
	Returns the rhttpproxy TLS certificate.
vmware.vcenter.certificate_management.vcenter.TlsTypes.Info	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the rhttpproxy TLS certificate.
global::System.Threading.Tasks.Task < vmware.vcenter.certificate_management.vcenter.TlsTypes.Info >	GetAsync ()
	Returns the rhttpproxy TLS certificate.
global::System.Threading.Tasks.Task < vmware.vcenter.certificate_management.vcenter.TlsTypes.Info >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the rhttpproxy TLS certificate.
void	Renew (long?duration)
	Renews the TLS certificate for the given duration period.
void	Renew (long?duration, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Renews the TLS certificate for the given duration period.
global::System.Threading.Tasks.Task	RenewAsync (long?duration)
	Renews the TLS certificate for the given duration period.
global::System.Threading.Tasks.Task	RenewAsync (long?duration, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Renews the TLS certificate for the given duration period.
void	ReplaceVmcaSigned (vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec spec)
	Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
void	ReplaceVmcaSigned (vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
global::System.Threading.Tasks.Task	ReplaceVmcaSignedAsync (vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec spec)
	Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.
global::System.Threading.Tasks.Task	ReplaceVmcaSignedAsync (vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

---

Detailed Description

The Tls interface provides methods to replace Tls certificate.

This interface was added in vSphere API 6.7.2.

---

Member Function Documentation

vmware.vcenter.certificate_management.vcenter.TlsTypes.Info vmware::vcenter::certificate_management::vcenter::Tls::Get

(

)

Returns the rhttpproxy TLS certificate.

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.NotFound	if the rhttpproxy certificate is not present in VECS store.
vmware.vapi.std.errors.Error	if failed due to generic exception.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Returns:

TLS certificate.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

vmware.vcenter.certificate_management.vcenter.TlsTypes.Info vmware::vcenter::certificate_management::vcenter::Tls::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the rhttpproxy TLS certificate.

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.NotFound	if the rhttpproxy certificate is not present in VECS store.
vmware.vapi.std.errors.Error	if failed due to generic exception.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Returns:

TLS certificate.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.certificate_management.vcenter.TlsTypes.Info> vmware::vcenter::certificate_management::vcenter::Tls::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the rhttpproxy TLS certificate.

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.NotFound	if the rhttpproxy certificate is not present in VECS store.
vmware.vapi.std.errors.Error	if failed due to generic exception.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Returns:

TLS certificate.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.certificate_management.vcenter.TlsTypes.Info> vmware::vcenter::certificate_management::vcenter::Tls::GetAsync

(

)

Returns the rhttpproxy TLS certificate.

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.NotFound	if the rhttpproxy certificate is not present in VECS store.
vmware.vapi.std.errors.Error	if failed due to generic exception.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Returns:

TLS certificate.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::Renew

(

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.

Exceptions:

vmware.vapi.std.errors.Unsupported	If the TLS certificate is not VMCA generated.
vmware.vapi.std.errors.InvalidArgument	If the duration period specified is invalid.
vmware.vapi.std.errors.Error	If the system failed to renew the TLS certificate.
vmware.vapi.std.errors.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).

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::Renew	(	long?	duration,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.Unsupported	If the TLS certificate is not VMCA generated.
vmware.vapi.std.errors.InvalidArgument	If the duration period specified is invalid.
vmware.vapi.std.errors.Error	If the system failed to renew the TLS certificate.
vmware.vapi.std.errors.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).
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::RenewAsync

(

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.

Exceptions:

vmware.vapi.std.errors.Unsupported	If the TLS certificate is not VMCA generated.
vmware.vapi.std.errors.InvalidArgument	If the duration period specified is invalid.
vmware.vapi.std.errors.Error	If the system failed to renew the TLS certificate.
vmware.vapi.std.errors.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).

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::RenewAsync	(	long?	duration,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.Unsupported	If the TLS certificate is not VMCA generated.
vmware.vapi.std.errors.InvalidArgument	If the duration period specified is invalid.
vmware.vapi.std.errors.Error	If the system failed to renew the TLS certificate.
vmware.vapi.std.errors.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).
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::ReplaceVmcaSigned

(

vmware.vcenter.certificate_management.vcenter.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the Spec given is not complete or invalid
vmware.vapi.std.errors.Error	If the system failed to replace the machine ssl certificate
vmware.vapi.std.errors.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

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::ReplaceVmcaSigned	(	vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the Spec given is not complete or invalid
vmware.vapi.std.errors.Error	If the system failed to replace the machine ssl certificate
vmware.vapi.std.errors.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
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::ReplaceVmcaSignedAsync

(

vmware.vcenter.certificate_management.vcenter.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the Spec given is not complete or invalid
vmware.vapi.std.errors.Error	If the system failed to replace the machine ssl certificate
vmware.vapi.std.errors.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

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::ReplaceVmcaSignedAsync	(	vmware.vcenter.certificate_management.vcenter.TlsTypes.ReplaceSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If the Spec given is not complete or invalid
vmware.vapi.std.errors.Error	If the system failed to replace the machine ssl certificate
vmware.vapi.std.errors.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
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::Set	(	vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.NotFound	If the private key is not present in the VECS store.
vmware.vapi.std.errors.AlreadyExists	If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
vmware.vapi.std.errors.Error	If the system failed to replace the TLS certificate.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

void vmware::vcenter::certificate_management::vcenter::Tls::Set

(

vmware.vcenter.certificate_management.vcenter.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.

Exceptions:

vmware.vapi.std.errors.NotFound	If the private key is not present in the VECS store.
vmware.vapi.std.errors.AlreadyExists	If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
vmware.vapi.std.errors.Error	If the system failed to replace the TLS certificate.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::SetAsync	(	vmware.vcenter.certificate_management.vcenter.TlsTypes.Spec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.NotFound	If the private key is not present in the VECS store.
vmware.vapi.std.errors.AlreadyExists	If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
vmware.vapi.std.errors.Error	If the system failed to replace the TLS certificate.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

global::System.Threading.Tasks.Task vmware::vcenter::certificate_management::vcenter::Tls::SetAsync

(

vmware.vcenter.certificate_management.vcenter.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.

Exceptions:

vmware.vapi.std.errors.NotFound	If the private key is not present in the VECS store.
vmware.vapi.std.errors.AlreadyExists	If the specified certificate thumbprint is the same as the existing TLS certificate thumbprint.
vmware.vapi.std.errors.Error	If the system failed to replace the TLS certificate.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::certificate_management::vcenter::TlsStub.

---

The documentation for this interface was generated from the following file:

• Tls.cs