com.vmware.nsx.trust_management

Interface Certificates

All Superinterfaces:

CertificatesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

CertificatesStub

public interface Certificates
extends com.vmware.vapi.bindings.Service, CertificatesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.trust_management.CertificatesTypes

_VAPI_SERVICE_ID, APPLYCERTIFICATE_SERVICE_TYPE_ANALYTICS_AGENT, APPLYCERTIFICATE_SERVICE_TYPE_ANALYTICS_KAFKA, APPLYCERTIFICATE_SERVICE_TYPE_APH, APPLYCERTIFICATE_SERVICE_TYPE_APH_TN, APPLYCERTIFICATE_SERVICE_TYPE_API, APPLYCERTIFICATE_SERVICE_TYPE_CBM_API, APPLYCERTIFICATE_SERVICE_TYPE_CBM_AR, APPLYCERTIFICATE_SERVICE_TYPE_CBM_CCP, APPLYCERTIFICATE_SERVICE_TYPE_CBM_CLUSTER_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_CBM_CM_INVENTORY, APPLYCERTIFICATE_SERVICE_TYPE_CBM_CORFU, APPLYCERTIFICATE_SERVICE_TYPE_CBM_CSM, APPLYCERTIFICATE_SERVICE_TYPE_CBM_GM, APPLYCERTIFICATE_SERVICE_TYPE_CBM_IDPS_REPORTING, APPLYCERTIFICATE_SERVICE_TYPE_CBM_MESSAGING_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_CBM_MONITORING, APPLYCERTIFICATE_SERVICE_TYPE_CBM_MP, APPLYCERTIFICATE_SERVICE_TYPE_CBM_SITE_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_CBM_SITE_PROXY_CLIENT, APPLYCERTIFICATE_SERVICE_TYPE_CBM_UPGRADE_COORDINATOR, APPLYCERTIFICATE_SERVICE_TYPE_CCP, APPLYCERTIFICATE_SERVICE_TYPE_CLIENT_AUTH, APPLYCERTIFICATE_SERVICE_TYPE_COMPUTE_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_GLOBAL_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_K8S_MSG_CLIENT, APPLYCERTIFICATE_SERVICE_TYPE_LOCAL_MANAGER, APPLYCERTIFICATE_SERVICE_TYPE_MGMT_CLUSTER, APPLYCERTIFICATE_SERVICE_TYPE_MGMT_PLANE, APPLYCERTIFICATE_SERVICE_TYPE_NOTIFICATION_COLLECTOR, APPLYCERTIFICATE_SERVICE_TYPE_RMQ, APPLYCERTIFICATE_SERVICE_TYPE_RSYSLOG_CLIENT, APPLYCERTIFICATE_SERVICE_TYPE_SYSLOG_SERVER, APPLYCERTIFICATE_SERVICE_TYPE_WEB_PROXY, LIST_TYPE_API_CERTIFICATE, LIST_TYPE_CLUSTER_API_CERTIFICATE, VALIDATE_USAGE_CLIENT, VALIDATE_USAGE_SERVER

Method Summary

Modifier and Type	Method and Description
void	applycertificate(java.lang.String certId, java.lang.String serviceType, java.lang.String nodeId) Look up the Certificate Profile matching the service-type and apply the certificate.
void	applycertificate(java.lang.String certId, java.lang.String serviceType, java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Look up the Certificate Profile matching the service-type and apply the certificate.
void	applycertificate(java.lang.String certId, java.lang.String serviceType, java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Look up the Certificate Profile matching the service-type and apply the certificate.
void	applycertificate(java.lang.String certId, java.lang.String serviceType, java.lang.String nodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Look up the Certificate Profile matching the service-type and apply the certificate.
void	delete(java.lang.String certId) Removes the specified certificate.
void	delete(java.lang.String certId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Removes the specified certificate.
void	delete(java.lang.String certId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes the specified certificate.
void	delete(java.lang.String certId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes the specified certificate.
PeerCertificateChain	fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint) Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.
void	fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint, com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback) Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.
void	fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint, com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.
PeerCertificateChain	fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.
Certificate	get(java.lang.String certId, java.lang.Boolean details) Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
void	get(java.lang.String certId, java.lang.Boolean details, com.vmware.vapi.bindings.client.AsyncCallback<Certificate> asyncCallback) Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
void	get(java.lang.String certId, java.lang.Boolean details, com.vmware.vapi.bindings.client.AsyncCallback<Certificate> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
Certificate	get(java.lang.String certId, java.lang.Boolean details, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
CertificateList	importcertificate(TrustObjectData trustObjectData) Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge).
void	importcertificate(TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback) Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge).
void	importcertificate(TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge).
CertificateList	importcertificate(TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge).
void	importtrustedca(java.lang.String alias, TrustObjectData trustObjectData) Add a CA certificate as a trust anchor
void	importtrustedca(java.lang.String alias, TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Add a CA certificate as a trust anchor
void	importtrustedca(java.lang.String alias, TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a CA certificate as a trust anchor
void	importtrustedca(java.lang.String alias, TrustObjectData trustObjectData, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a CA certificate as a trust anchor
CertificateList	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type) Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
void	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback) Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
void	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
CertificateList	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when).
void	setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest) Deprecated.
void	setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest) Deprecated.
void	setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
CertificateCheckingStatus	validate(java.lang.String certId, java.lang.String usage) Checks whether certificate is valid.
void	validate(java.lang.String certId, java.lang.String usage, com.vmware.vapi.bindings.client.AsyncCallback<CertificateCheckingStatus> asyncCallback) Checks whether certificate is valid.
void	validate(java.lang.String certId, java.lang.String usage, com.vmware.vapi.bindings.client.AsyncCallback<CertificateCheckingStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Checks whether certificate is valid.
CertificateCheckingStatus	validate(java.lang.String certId, java.lang.String usage, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Checks whether certificate is valid.

Method Detail

applycertificate

void applycertificate(java.lang.String certId,
                      java.lang.String serviceType,
                      java.lang.String nodeId)

Look up the Certificate Profile matching the service-type and apply the certificate. When the Certificate Profile has cluster_certificate=false, the node_id parameter is required to designate the node where the certificate needs to be applied.

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

Parameters:

certId - ID of certificate to apply (required)

serviceType - Supported service types, that are using certificates. (required)

nodeId - Node Id (optional)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

applycertificate

void applycertificate(java.lang.String certId,
                      java.lang.String serviceType,
                      java.lang.String nodeId,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Look up the Certificate Profile matching the service-type and apply the certificate. When the Certificate Profile has cluster_certificate=false, the node_id parameter is required to designate the node where the certificate needs to be applied.

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:

certId - ID of certificate to apply (required)

serviceType - Supported service types, that are using certificates. (required)

nodeId - Node Id (optional)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

applycertificate

void applycertificate(java.lang.String certId,
                      java.lang.String serviceType,
                      java.lang.String nodeId,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Look up the Certificate Profile matching the service-type and apply the certificate. When the Certificate Profile has cluster_certificate=false, the node_id parameter is required to designate the node where the certificate needs to be applied.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to apply (required)

serviceType - Supported service types, that are using certificates. (required)

nodeId - Node Id (optional)

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

applycertificate

void applycertificate(java.lang.String certId,
                      java.lang.String serviceType,
                      java.lang.String nodeId,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Look up the Certificate Profile matching the service-type and apply the certificate. When the Certificate Profile has cluster_certificate=false, the node_id parameter is required to designate the node where the certificate needs to be applied.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to apply (required)

serviceType - Supported service types, that are using certificates. (required)

nodeId - Node Id (optional)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String certId)

Removes the specified certificate. The private key associated with the certificate is also deleted.

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

Parameters:

certId - ID of certificate to delete (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String certId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes the specified certificate. The private key associated with the certificate is also deleted.

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:

certId - ID of certificate to delete (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String certId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Removes the specified certificate. The private key associated with the certificate is also deleted.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to delete (required)

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

delete

void delete(java.lang.String certId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes the specified certificate. The private key associated with the certificate is also deleted.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to delete (required)

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

invocationConfig - Configuration for the method invocation.

fetchpeercertificatechain

PeerCertificateChain fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint)

Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.

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

Parameters:

tlsServiceEndpoint - (required)

Returns:

com.vmware.nsx.model.PeerCertificateChain

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

fetchpeercertificatechain

PeerCertificateChain fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.

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:

tlsServiceEndpoint - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PeerCertificateChain

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

fetchpeercertificatechain

void fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint,
                               com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback)

Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.

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

Invocation Result:
com.vmware.nsx.model.PeerCertificateChain

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tlsServiceEndpoint - (required)

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

fetchpeercertificatechain

void fetchpeercertificatechain(TlsServiceEndpoint tlsServiceEndpoint,
                               com.vmware.vapi.bindings.client.AsyncCallback<PeerCertificateChain> asyncCallback,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Attempt to connect to an TLS service endpoint and retrieve the server certificate chain it presents.

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:
com.vmware.nsx.model.PeerCertificateChain

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tlsServiceEndpoint - (required)

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

invocationConfig - Configuration for the method invocation.

get

Certificate get(java.lang.String certId,
                java.lang.Boolean details)

Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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

Parameters:

certId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

Returns:

com.vmware.nsx.model.Certificate

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

Certificate get(java.lang.String certId,
                java.lang.Boolean details,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:

certId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.Certificate

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String certId,
         java.lang.Boolean details,
         com.vmware.vapi.bindings.client.AsyncCallback<Certificate> asyncCallback)

Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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

Invocation Result:
com.vmware.nsx.model.Certificate

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

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

get

void get(java.lang.String certId,
         java.lang.Boolean details,
         com.vmware.vapi.bindings.client.AsyncCallback<Certificate> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information for the specified certificate ID, including the certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:
com.vmware.nsx.model.Certificate

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

importcertificate

CertificateList importcertificate(TrustObjectData trustObjectData)

Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A private key can be uploaded for a CA certificate only if the \"purpose\" parameter is set to \"signing-ca\".

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

Parameters:

trustObjectData - (required)

Returns:

com.vmware.nsx.model.CertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

importcertificate

CertificateList importcertificate(TrustObjectData trustObjectData,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A private key can be uploaded for a CA certificate only if the \"purpose\" parameter is set to \"signing-ca\".

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:

trustObjectData - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.CertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

importcertificate

void importcertificate(TrustObjectData trustObjectData,
                       com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback)

Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A private key can be uploaded for a CA certificate only if the \"purpose\" parameter is set to \"signing-ca\".

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

Invocation Result:
com.vmware.nsx.model.CertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

trustObjectData - (required)

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

importcertificate

void importcertificate(TrustObjectData trustObjectData,
                       com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A private key can be uploaded for a CA certificate only if the \"purpose\" parameter is set to \"signing-ca\".

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:
com.vmware.nsx.model.CertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

trustObjectData - (required)

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

invocationConfig - Configuration for the method invocation.

importtrustedca

void importtrustedca(java.lang.String alias,
                     TrustObjectData trustObjectData)

Add a CA certificate as a trust anchor

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

Parameters:

alias - Alias under which to store the trusted CA in the trust-store (required)

trustObjectData - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

importtrustedca

void importtrustedca(java.lang.String alias,
                     TrustObjectData trustObjectData,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add a CA certificate as a trust anchor

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:

alias - Alias under which to store the trusted CA in the trust-store (required)

trustObjectData - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

importtrustedca

void importtrustedca(java.lang.String alias,
                     TrustObjectData trustObjectData,
                     com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Add a CA certificate as a trust anchor

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

alias - Alias under which to store the trusted CA in the trust-store (required)

trustObjectData - (required)

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

importtrustedca

void importtrustedca(java.lang.String alias,
                     TrustObjectData trustObjectData,
                     com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add a CA certificate as a trust anchor

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

alias - Alias under which to store the trusted CA in the trust-store (required)

trustObjectData - (required)

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

invocationConfig - Configuration for the method invocation.

list

CertificateList list(java.lang.String cursor,
                     java.lang.Boolean details,
                     java.lang.String includedFields,
                     java.lang.String nodeId,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy,
                     java.lang.String type)

Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

Returns:

com.vmware.nsx.model.CertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

CertificateList list(java.lang.String cursor,
                     java.lang.Boolean details,
                     java.lang.String includedFields,
                     java.lang.String nodeId,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy,
                     java.lang.String type,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.CertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String cursor,
          java.lang.Boolean details,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback)

Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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

Invocation Result:
com.vmware.nsx.model.CertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

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

list

void list(java.lang.String cursor,
          java.lang.Boolean details,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<CertificateList> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all certificate information viewable by the user, including each certificate's UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:
com.vmware.nsx.model.CertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

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

invocationConfig - Configuration for the method invocation.

setapplianceproxycertificateforintersitecommunication

@Deprecated
void setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest)

Deprecated.

Set a certificate that has been imported to be the Appliance Proxy certificate used for communicating with Appliance Proxies on other sites.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=APH

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

Parameters:

setInterSiteAphCertificateRequest - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

setapplianceproxycertificateforintersitecommunication

@Deprecated
void setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest,
                                                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Set a certificate that has been imported to be the Appliance Proxy certificate used for communicating with Appliance Proxies on other sites.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=APH

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:

setInterSiteAphCertificateRequest - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

setapplianceproxycertificateforintersitecommunication

@Deprecated
void setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest,
                                                                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Set a certificate that has been imported to be the Appliance Proxy certificate used for communicating with Appliance Proxies on other sites.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=APH

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

setInterSiteAphCertificateRequest - (required)

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

setapplianceproxycertificateforintersitecommunication

@Deprecated
void setapplianceproxycertificateforintersitecommunication(SetInterSiteAphCertificateRequest setInterSiteAphCertificateRequest,
                                                                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                                                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Set a certificate that has been imported to be the Appliance Proxy certificate used for communicating with Appliance Proxies on other sites.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=APH

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

setInterSiteAphCertificateRequest - (required)

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

invocationConfig - Configuration for the method invocation.

setpicertificateforfederation

@Deprecated
void setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest)

Deprecated.

Set a certificate that has been imported to be either the principal identity certificate for the local cluster with either GM or LM service type. Currently, the service type specified must match the current service type of the local cluster.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=LOCAL_MANAGER
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=GLOBAL_MANAGER

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

Parameters:

setPrincipalIdentityCertificateForFederationRequest - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

setpicertificateforfederation

@Deprecated
void setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Set a certificate that has been imported to be either the principal identity certificate for the local cluster with either GM or LM service type. Currently, the service type specified must match the current service type of the local cluster.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=LOCAL_MANAGER
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=GLOBAL_MANAGER

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:

setPrincipalIdentityCertificateForFederationRequest - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

setpicertificateforfederation

@Deprecated
void setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest,
                                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Set a certificate that has been imported to be either the principal identity certificate for the local cluster with either GM or LM service type. Currently, the service type specified must match the current service type of the local cluster.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=LOCAL_MANAGER
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=GLOBAL_MANAGER

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

setPrincipalIdentityCertificateForFederationRequest - (required)

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

setpicertificateforfederation

@Deprecated
void setpicertificateforfederation(SetPrincipalIdentityCertificateForFederationRequest setPrincipalIdentityCertificateForFederationRequest,
                                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Set a certificate that has been imported to be either the principal identity certificate for the local cluster with either GM or LM service type. Currently, the service type specified must match the current service type of the local cluster.

Please use below APIs.
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=LOCAL_MANAGER
POST https:///api/v1/trust-management/certificates/?action=apply_certificate&service_type=GLOBAL_MANAGER

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

setPrincipalIdentityCertificateForFederationRequest - (required)

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

invocationConfig - Configuration for the method invocation.

validate

CertificateCheckingStatus validate(java.lang.String certId,
                                   java.lang.String usage)

Checks whether certificate is valid. When the certificate contains a chain, the full chain is validated. The usage parameter can be SERVER (default) or CLIENT. This indicates whether the certificate needs to be validated as a server-auth or a client-auth certificate.

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

Parameters:

certId - ID of certificate to validate (required)

usage - Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER (optional)

Returns:

com.vmware.nsx.model.CertificateCheckingStatus

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

validate

CertificateCheckingStatus validate(java.lang.String certId,
                                   java.lang.String usage,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Checks whether certificate is valid. When the certificate contains a chain, the full chain is validated. The usage parameter can be SERVER (default) or CLIENT. This indicates whether the certificate needs to be validated as a server-auth or a client-auth certificate.

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:

certId - ID of certificate to validate (required)

usage - Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.CertificateCheckingStatus

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

validate

void validate(java.lang.String certId,
              java.lang.String usage,
              com.vmware.vapi.bindings.client.AsyncCallback<CertificateCheckingStatus> asyncCallback)

Checks whether certificate is valid. When the certificate contains a chain, the full chain is validated. The usage parameter can be SERVER (default) or CLIENT. This indicates whether the certificate needs to be validated as a server-auth or a client-auth certificate.

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

Invocation Result:
com.vmware.nsx.model.CertificateCheckingStatus

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to validate (required)

usage - Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER (optional)

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

validate

void validate(java.lang.String certId,
              java.lang.String usage,
              com.vmware.vapi.bindings.client.AsyncCallback<CertificateCheckingStatus> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Checks whether certificate is valid. When the certificate contains a chain, the full chain is validated. The usage parameter can be SERVER (default) or CLIENT. This indicates whether the certificate needs to be validated as a server-auth or a client-auth certificate.

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:
com.vmware.nsx.model.CertificateCheckingStatus

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certId - ID of certificate to validate (required)

usage - Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER (optional)

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

invocationConfig - Configuration for the method invocation.