com.vmware.nsx.cluster

Interface ApiCertificate

All Superinterfaces:

ApiCertificateTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ApiCertificateStub

public interface ApiCertificate
extends com.vmware.vapi.bindings.Service, ApiCertificateTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.ApiCertificateTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ClusterCertificateId	clearclustercertificate(java.lang.String certificateId) Deprecated.
void	clearclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback) Deprecated.
void	clearclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterCertificateId	clearclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterCertificateId	get() Returns the ID of the certificate that is used as the cluster certificate for MP
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback) Returns the ID of the certificate that is used as the cluster certificate for MP
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the ID of the certificate that is used as the cluster certificate for MP
ClusterCertificateId	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the ID of the certificate that is used as the cluster certificate for MP
ClusterCertificateId	setclustercertificate(java.lang.String certificateId) Deprecated.
void	setclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback) Deprecated.
void	setclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterCertificateId	setclustercertificate(java.lang.String certificateId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

clearclustercertificate

@Deprecated
ClusterCertificateId clearclustercertificate(java.lang.String certificateId)

Deprecated.

Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to set the cluster certificate to a different one. It just means that from now on, individual certificates will be used on each MP node. This affects all nodes in the cluster.

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

Parameters:

certificateId - Certificate ID (required)

Returns:

com.vmware.nsx.model.ClusterCertificateId

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

clearclustercertificate

@Deprecated
ClusterCertificateId clearclustercertificate(java.lang.String certificateId,
                                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to set the cluster certificate to a different one. It just means that from now on, individual certificates will be used on each MP node. This affects all nodes in the cluster.

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:

certificateId - Certificate ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterCertificateId

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

clearclustercertificate

@Deprecated
void clearclustercertificate(java.lang.String certificateId,
                                         com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback)

Deprecated.

Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to set the cluster certificate to a different one. It just means that from now on, individual certificates will be used on each MP node. This affects all nodes in the cluster.

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

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

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

Parameters:

certificateId - Certificate ID (required)

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

clearclustercertificate

@Deprecated
void clearclustercertificate(java.lang.String certificateId,
                                         com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to set the cluster certificate to a different one. It just means that from now on, individual certificates will be used on each MP node. This affects all nodes in the cluster.

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

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

Parameters:

certificateId - Certificate ID (required)

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

invocationConfig - Configuration for the method invocation.

get

ClusterCertificateId get()

Returns the ID of the certificate that is used as the cluster certificate for MP

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

Returns:

com.vmware.nsx.model.ClusterCertificateId

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

ClusterCertificateId get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the ID of the certificate that is used as the cluster certificate for MP

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:

com.vmware.nsx.model.ClusterCertificateId

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(com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback)

Returns the ID of the certificate that is used as the cluster certificate for MP

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

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

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

Parameters:

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

get

void get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the ID of the certificate that is used as the cluster certificate for MP

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

setclustercertificate

@Deprecated
ClusterCertificateId setclustercertificate(java.lang.String certificateId)

Deprecated.

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

Parameters:

certificateId - Certificate ID (required)

Returns:

com.vmware.nsx.model.ClusterCertificateId

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

setclustercertificate

@Deprecated
ClusterCertificateId setclustercertificate(java.lang.String certificateId,
                                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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:

certificateId - Certificate ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterCertificateId

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

setclustercertificate

@Deprecated
void setclustercertificate(java.lang.String certificateId,
                                       com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback)

Deprecated.

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

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

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

Parameters:

certificateId - Certificate ID (required)

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

setclustercertificate

@Deprecated
void setclustercertificate(java.lang.String certificateId,
                                       com.vmware.vapi.bindings.client.AsyncCallback<ClusterCertificateId> asyncCallback,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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

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

Parameters:

certificateId - Certificate ID (required)

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

invocationConfig - Configuration for the method invocation.