com.vmware.nsx.cluster

Interface Nodes

All Superinterfaces:

NodesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NodesStub

public interface Nodes
extends com.vmware.vapi.bindings.Service, NodesTypes

Field Summary

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

_VAPI_SERVICE_ID, CREATE_ACTION_NODE

Method Summary

Modifier and Type	Method and Description
ClusterNodeConfig	create(AddClusterNodeSpec addClusterNodeSpec, java.lang.String action) Deprecated.
void	create(AddClusterNodeSpec addClusterNodeSpec, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback) Deprecated.
void	create(AddClusterNodeSpec addClusterNodeSpec, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterNodeConfig	create(AddClusterNodeSpec addClusterNodeSpec, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String nodeId) Deprecated.
void	delete(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String nodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterNodeConfig	get(java.lang.String nodeId) Deprecated.
void	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback) Deprecated.
void	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterNodeConfig	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ClusterNodeConfigListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all NSX cluster nodes.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfigListResult> asyncCallback) Returns information about all NSX cluster nodes.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfigListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all NSX cluster nodes.
ClusterNodeConfigListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all NSX cluster nodes.

Method Detail

create

@Deprecated
ClusterNodeConfig create(AddClusterNodeSpec addClusterNodeSpec,
                                     java.lang.String action)

Deprecated.

Add a new controller to the NSX cluster. The controller comes with the new node.
Deprecated. Use POST /cluster?action=join_cluster to join a node to cluster.

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

Parameters:

addClusterNodeSpec - (required)

action - (required)

Returns:

com.vmware.nsx.model.ClusterNodeConfig

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

create

@Deprecated
ClusterNodeConfig create(AddClusterNodeSpec addClusterNodeSpec,
                                     java.lang.String action,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a new controller to the NSX cluster. The controller comes with the new node.
Deprecated. Use POST /cluster?action=join_cluster to join a node to 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:

addClusterNodeSpec - (required)

action - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterNodeConfig

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

create

@Deprecated
void create(AddClusterNodeSpec addClusterNodeSpec,
                        java.lang.String action,
                        com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback)

Deprecated.

Add a new controller to the NSX cluster. The controller comes with the new node.
Deprecated. Use POST /cluster?action=join_cluster to join a node to cluster.

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

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

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

Parameters:

addClusterNodeSpec - (required)

action - (required)

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

create

@Deprecated
void create(AddClusterNodeSpec addClusterNodeSpec,
                        java.lang.String action,
                        com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a new controller to the NSX cluster. The controller comes with the new node.
Deprecated. Use POST /cluster?action=join_cluster to join a node to 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.ClusterNodeConfig

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

Parameters:

addClusterNodeSpec - (required)

action - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String nodeId)

Deprecated.

Removes the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the \"stop service controller\" command.
Use POST /cluster/?action=remove_node to detach a node from cluster. The controller is removed with the node.

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

Parameters:

nodeId - (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

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

Deprecated.

Removes the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the \"stop service controller\" command.
Use POST /cluster/?action=remove_node to detach a node from cluster. The controller is removed with the 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.

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

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

Deprecated.

Removes the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the \"stop service controller\" command.
Use POST /cluster/?action=remove_node to detach a node from cluster. The controller is removed with the node.

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:

nodeId - (required)

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

delete

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

Deprecated.

Removes the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the \"stop service controller\" command.
Use POST /cluster/?action=remove_node to detach a node from cluster. The controller is removed with the 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
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.

get

@Deprecated
ClusterNodeConfig get(java.lang.String nodeId)

Deprecated.

Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.

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

Parameters:

nodeId - (required)

Returns:

com.vmware.nsx.model.ClusterNodeConfig

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

@Deprecated
ClusterNodeConfig get(java.lang.String nodeId,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.

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

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

@Deprecated
void get(java.lang.String nodeId,
                     com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback)

Deprecated.

Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.

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

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

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.

get

@Deprecated
void get(java.lang.String nodeId,
                     com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfig> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.

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

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.

list

ClusterNodeConfigListResult list(java.lang.String cursor,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy)

Returns information about all NSX cluster nodes.

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)

includedFields - Comma separated list of fields that should be included in query result (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)

Returns:

com.vmware.nsx.model.ClusterNodeConfigListResult

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

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

Returns information about all NSX cluster nodes.

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)

includedFields - Comma separated list of fields that should be included in query result (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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterNodeConfigListResult

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.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeConfigListResult> asyncCallback)

Returns information about all NSX cluster nodes.

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

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

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)

includedFields - Comma separated list of fields that should be included in query result (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)

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

list

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

Returns information about all NSX cluster nodes.

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

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)

includedFields - Comma separated list of fields that should be included in query result (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)

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

invocationConfig - Configuration for the method invocation.