com.vmware.nsx

Interface Cluster

All Superinterfaces:

ClusterTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ClusterStub

public interface Cluster
extends com.vmware.vapi.bindings.Service, ClusterTypes

Field Summary

Fields inherited from interface com.vmware.nsx.ClusterTypes

_VAPI_SERVICE_ID, BACKUPTOREMOTE_FRAME_TYPE_GLOBAL_MANAGER, BACKUPTOREMOTE_FRAME_TYPE_LOCAL_LOCAL_MANAGER, BACKUPTOREMOTE_FRAME_TYPE_LOCAL_MANAGER, BACKUPTOREMOTE_FRAME_TYPE_NSX_INTELLIGENCE, REMOVENODE_FORCE_FALSE, REMOVENODE_FORCE_TRUE, REMOVENODE_GRACEFUL_SHUTDOWN_FALSE, REMOVENODE_GRACEFUL_SHUTDOWN_TRUE, REMOVENODE_IGNORE_REPOSITORY_IP_CHECK_FALSE, REMOVENODE_IGNORE_REPOSITORY_IP_CHECK_TRUE

Method Summary

Modifier and Type	Method and Description
void	backuptoremote(java.lang.String frameType, java.lang.String siteId) Request one-time backup.
void	backuptoremote(java.lang.String frameType, java.lang.String siteId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Request one-time backup.
void	backuptoremote(java.lang.String frameType, java.lang.String siteId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Request one-time backup.
void	backuptoremote(java.lang.String frameType, java.lang.String siteId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Request one-time backup.
void	create(java.lang.String targetNodeId, java.lang.String targetUri) Invoke POST request on target cluster node
void	create(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Invoke POST request on target cluster node
void	create(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke POST request on target cluster node
void	create(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke POST request on target cluster node
void	delete(java.lang.String targetNodeId, java.lang.String targetUri) Invoke DELETE request on target cluster node
void	delete(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Invoke DELETE request on target cluster node
void	delete(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke DELETE request on target cluster node
void	delete(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke DELETE request on target cluster node
ClusterConfig	get() Returns information about the NSX cluster configuration.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfig> asyncCallback) Returns information about the NSX cluster configuration.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the NSX cluster configuration.
ClusterConfig	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the NSX cluster configuration.
ClusterNodeInfo	get0(java.lang.String nodeId) Returns information about the specified NSX cluster node.
void	get0(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeInfo> asyncCallback) Returns information about the specified NSX cluster node.
void	get0(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified NSX cluster node.
ClusterNodeInfo	get0(java.lang.String nodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified NSX cluster node.
void	get1(java.lang.String targetNodeId, java.lang.String targetUri) Invoke GET request on target cluster node
void	get1(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Invoke GET request on target cluster node
void	get1(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke GET request on target cluster node
void	get1(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke GET request on target cluster node
ClusterConfiguration	joincluster(JoinClusterParameters joinClusterParameters) Join this node to a NSX Cluster
void	joincluster(JoinClusterParameters joinClusterParameters, com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback) Join this node to a NSX Cluster
void	joincluster(JoinClusterParameters joinClusterParameters, com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Join this node to a NSX Cluster
ClusterConfiguration	joincluster(JoinClusterParameters joinClusterParameters, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Join this node to a NSX Cluster
ClusterConfiguration	removenode(java.lang.String nodeId, java.lang.String force, java.lang.String gracefulShutdown, java.lang.String ignoreRepositoryIpCheck) Detach a node from the Cluster
void	removenode(java.lang.String nodeId, java.lang.String force, java.lang.String gracefulShutdown, java.lang.String ignoreRepositoryIpCheck, com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback) Detach a node from the Cluster
void	removenode(java.lang.String nodeId, java.lang.String force, java.lang.String gracefulShutdown, java.lang.String ignoreRepositoryIpCheck, com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Detach a node from the Cluster
ClusterConfiguration	removenode(java.lang.String nodeId, java.lang.String force, java.lang.String gracefulShutdown, java.lang.String ignoreRepositoryIpCheck, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Detach a node from the Cluster
void	summarizeinventorytoremote() Request one-time inventory summary.
void	summarizeinventorytoremote(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Request one-time inventory summary.
void	summarizeinventorytoremote(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Request one-time inventory summary.
void	summarizeinventorytoremote(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Request one-time inventory summary.
void	update(java.lang.String targetNodeId, java.lang.String targetUri) Invoke PUT request on target cluster node
void	update(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Invoke PUT request on target cluster node
void	update(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke PUT request on target cluster node
void	update(java.lang.String targetNodeId, java.lang.String targetUri, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Invoke PUT request on target cluster node

Method Detail

backuptoremote

void backuptoremote(java.lang.String frameType,
                    java.lang.String siteId)

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

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

Parameters:

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

siteId - Site ID (optional, default to localhost)

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

backuptoremote

void backuptoremote(java.lang.String frameType,
                    java.lang.String siteId,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

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:

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

siteId - Site ID (optional, default to localhost)

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

backuptoremote

void backuptoremote(java.lang.String frameType,
                    java.lang.String siteId,
                    com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

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:

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

siteId - Site ID (optional, default to localhost)

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

backuptoremote

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

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

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:

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

siteId - Site ID (optional, default to localhost)

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

invocationConfig - Configuration for the method invocation.

create

void create(java.lang.String targetNodeId,
            java.lang.String targetUri)

Invoke POST request on target cluster node

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

create

void create(java.lang.String targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Invoke POST request on target cluster node

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:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

invocationConfig - Configuration for the method invocation.

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

create

void create(java.lang.String targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Invoke POST request on target cluster node

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

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

create

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

Invoke POST request on target cluster node

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
TimedOut - Gateway Timeout
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String targetNodeId,
            java.lang.String targetUri)

Invoke DELETE request on target cluster node

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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 targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Invoke DELETE request on target cluster node

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:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

invocationConfig - Configuration for the method invocation.

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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 targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Invoke DELETE request on target cluster node

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

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

delete

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

Invoke DELETE request on target cluster node

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
TimedOut - Gateway Timeout
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

invocationConfig - Configuration for the method invocation.

get

ClusterConfig get()

Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as \"roles.\" These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.

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

Returns:

com.vmware.nsx.model.ClusterConfig

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

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

Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as \"roles.\" These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.

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

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<ClusterConfig> asyncCallback)

Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as \"roles.\" These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.

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

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

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<ClusterConfig> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as \"roles.\" These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.

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

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.

get0

ClusterNodeInfo get0(java.lang.String nodeId)

Returns information about the specified NSX cluster node.

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

Parameters:

nodeId - (required)

Returns:

com.vmware.nsx.model.ClusterNodeInfo

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

get0

ClusterNodeInfo get0(java.lang.String nodeId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the specified NSX cluster node.

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:

nodeId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterNodeInfo

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

get0

void get0(java.lang.String nodeId,
          com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeInfo> asyncCallback)

Returns information about the specified NSX cluster node.

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

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

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

Parameters:

nodeId - (required)

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

get0

void get0(java.lang.String nodeId,
          com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeInfo> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the specified NSX cluster node.

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

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

Parameters:

nodeId - (required)

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

invocationConfig - Configuration for the method invocation.

get1

void get1(java.lang.String targetNodeId,
          java.lang.String targetUri)

Invoke GET request on target cluster node

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

get1

void get1(java.lang.String targetNodeId,
          java.lang.String targetUri,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Invoke GET request on target cluster node

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:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

invocationConfig - Configuration for the method invocation.

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

get1

void get1(java.lang.String targetNodeId,
          java.lang.String targetUri,
          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Invoke GET request on target cluster node

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

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

get1

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

Invoke GET request on target cluster node

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
TimedOut - Gateway Timeout
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

invocationConfig - Configuration for the method invocation.

joincluster

ClusterConfiguration joincluster(JoinClusterParameters joinClusterParameters)

Join this node to a NSX Cluster

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

Parameters:

joinClusterParameters - (required)

Returns:

com.vmware.nsx.model.ClusterConfiguration

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

joincluster

ClusterConfiguration joincluster(JoinClusterParameters joinClusterParameters,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Join this node to a NSX 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:

joinClusterParameters - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterConfiguration

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

joincluster

void joincluster(JoinClusterParameters joinClusterParameters,
                 com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback)

Join this node to a NSX Cluster

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

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

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

Parameters:

joinClusterParameters - (required)

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

joincluster

void joincluster(JoinClusterParameters joinClusterParameters,
                 com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Join this node to a NSX 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.ClusterConfiguration

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

Parameters:

joinClusterParameters - (required)

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

invocationConfig - Configuration for the method invocation.

removenode

ClusterConfiguration removenode(java.lang.String nodeId,
                                java.lang.String force,
                                java.lang.String gracefulShutdown,
                                java.lang.String ignoreRepositoryIpCheck)

Detach a node from the Cluster

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

Parameters:

nodeId - UUID of the node (required)

force - (optional)

gracefulShutdown - (optional, default to false)

ignoreRepositoryIpCheck - (optional, default to false)

Returns:

com.vmware.nsx.model.ClusterConfiguration

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

removenode

ClusterConfiguration removenode(java.lang.String nodeId,
                                java.lang.String force,
                                java.lang.String gracefulShutdown,
                                java.lang.String ignoreRepositoryIpCheck,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Detach a node from 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:

nodeId - UUID of the node (required)

force - (optional)

gracefulShutdown - (optional, default to false)

ignoreRepositoryIpCheck - (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterConfiguration

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

removenode

void removenode(java.lang.String nodeId,
                java.lang.String force,
                java.lang.String gracefulShutdown,
                java.lang.String ignoreRepositoryIpCheck,
                com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback)

Detach a node from the Cluster

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

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

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

Parameters:

nodeId - UUID of the node (required)

force - (optional)

gracefulShutdown - (optional, default to false)

ignoreRepositoryIpCheck - (optional, default to false)

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

removenode

void removenode(java.lang.String nodeId,
                java.lang.String force,
                java.lang.String gracefulShutdown,
                java.lang.String ignoreRepositoryIpCheck,
                com.vmware.vapi.bindings.client.AsyncCallback<ClusterConfiguration> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Detach a node from 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.ClusterConfiguration

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

Parameters:

nodeId - UUID of the node (required)

force - (optional)

gracefulShutdown - (optional, default to false)

ignoreRepositoryIpCheck - (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

summarizeinventorytoremote

void summarizeinventorytoremote()

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

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

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

summarizeinventorytoremote

void summarizeinventorytoremote(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

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.

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

summarizeinventorytoremote

void summarizeinventorytoremote(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

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:

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

summarizeinventorytoremote

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

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

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:

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String targetNodeId,
            java.lang.String targetUri)

Invoke PUT request on target cluster node

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

update

void update(java.lang.String targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Invoke PUT request on target cluster node

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:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

invocationConfig - Configuration for the method invocation.

Throws:

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

com.vmware.vapi.std.errors.TimedOut - Gateway Timeout

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

update

void update(java.lang.String targetNodeId,
            java.lang.String targetUri,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Invoke PUT request on target cluster node

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

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

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

update

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

Invoke PUT request on target cluster node

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
TimedOut - Gateway Timeout
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

targetNodeId - Target node UUID or keyword self (required)

targetUri - URI of API to invoke on target node (required)

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

invocationConfig - Configuration for the method invocation.