com.vmware.nsx.cluster.nodes

Interface Deployments

All Superinterfaces:

DeploymentsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

DeploymentsStub

public interface Deployments
extends com.vmware.vapi.bindings.Service, DeploymentsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.nodes.DeploymentsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ClusterNodeVMDeploymentRequestList	create(AddClusterNodeVMInfo addClusterNodeVMInfo) Deploys a cluster node VM as specified by the deployment config.
void	create(AddClusterNodeVMInfo addClusterNodeVMInfo, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback) Deploys a cluster node VM as specified by the deployment config.
void	create(AddClusterNodeVMInfo addClusterNodeVMInfo, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deploys a cluster node VM as specified by the deployment config.
ClusterNodeVMDeploymentRequestList	create(AddClusterNodeVMInfo addClusterNodeVMInfo, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deploys a cluster node VM as specified by the deployment config.
void	delete(java.lang.String nodeId, java.lang.Boolean forceDelete) Attempts to unregister and undeploy a specified auto-deployed cluster node VM.
void	delete(java.lang.String nodeId, java.lang.Boolean forceDelete, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Attempts to unregister and undeploy a specified auto-deployed cluster node VM.
void	delete(java.lang.String nodeId, java.lang.Boolean forceDelete, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempts to unregister and undeploy a specified auto-deployed cluster node VM.
void	delete(java.lang.String nodeId, java.lang.Boolean forceDelete, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Attempts to unregister and undeploy a specified auto-deployed cluster node VM.
ClusterNodeVMDeploymentRequest	get(java.lang.String nodeId) Returns deployment request information for a specific attempted deployment of a cluster node VM.
void	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequest> asyncCallback) Returns deployment request information for a specific attempted deployment of a cluster node VM.
void	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequest> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns deployment request information for a specific attempted deployment of a cluster node VM.
ClusterNodeVMDeploymentRequest	get(java.lang.String nodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns deployment request information for a specific attempted deployment of a cluster node VM.
ClusterNodeVMDeploymentRequestList	list() Returns request information for every attempted deployment of a cluster node VM.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback) Returns request information for every attempted deployment of a cluster node VM.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns request information for every attempted deployment of a cluster node VM.
ClusterNodeVMDeploymentRequestList	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns request information for every attempted deployment of a cluster node VM.

Method Detail

create

ClusterNodeVMDeploymentRequestList create(AddClusterNodeVMInfo addClusterNodeVMInfo)

Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed and powered on, it will automatically join the existing cluster.

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

Parameters:

addClusterNodeVMInfo - (required)

Returns:

com.vmware.nsx.model.ClusterNodeVMDeploymentRequestList

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

ClusterNodeVMDeploymentRequestList create(AddClusterNodeVMInfo addClusterNodeVMInfo,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed and powered on, it will automatically join the existing 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:

addClusterNodeVMInfo - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterNodeVMDeploymentRequestList

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

void create(AddClusterNodeVMInfo addClusterNodeVMInfo,
            com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback)

Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed and powered on, it will automatically join the existing cluster.

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

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

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

Parameters:

addClusterNodeVMInfo - (required)

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

create

void create(AddClusterNodeVMInfo addClusterNodeVMInfo,
            com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequestList> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed and powered on, it will automatically join the existing 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.ClusterNodeVMDeploymentRequestList

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

Parameters:

addClusterNodeVMInfo - (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 nodeId,
            java.lang.Boolean forceDelete)

Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully deleted.

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

Parameters:

nodeId - (required)

forceDelete - Delete by force (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

delete

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

Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully 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:

nodeId - (required)

forceDelete - Delete by force (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

delete

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

Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully 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:

nodeId - (required)

forceDelete - Delete by force (optional)

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

delete

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

Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully 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:

nodeId - (required)

forceDelete - Delete by force (optional)

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

invocationConfig - Configuration for the method invocation.

get

ClusterNodeVMDeploymentRequest get(java.lang.String nodeId)

Returns deployment request information for a specific attempted deployment of a cluster node VM.

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

Parameters:

nodeId - (required)

Returns:

com.vmware.nsx.model.ClusterNodeVMDeploymentRequest

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

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

Returns deployment request information for a specific attempted deployment of a cluster node VM.

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

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 nodeId,
         com.vmware.vapi.bindings.client.AsyncCallback<ClusterNodeVMDeploymentRequest> asyncCallback)

Returns deployment request information for a specific attempted deployment of a cluster node VM.

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

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

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

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

Returns deployment request information for a specific attempted deployment of a cluster node VM.

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

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

ClusterNodeVMDeploymentRequestList list()

Returns request information for every attempted deployment of a cluster node VM.

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

Returns:

com.vmware.nsx.model.ClusterNodeVMDeploymentRequestList

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

ClusterNodeVMDeploymentRequestList list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns request information for every attempted deployment of a cluster node VM.

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

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

Returns request information for every attempted deployment of a cluster node VM.

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

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

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.

list

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

Returns request information for every attempted deployment of a cluster node VM.

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

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.