com.vmware.vmc.orgs.sddcs

Interface Esxs

All Superinterfaces:

EsxsTypes, Service

All Known Implementing Classes:

EsxsStub

public interface Esxs
extends Service, EsxsTypes

Field Summary

Fields inherited from interface com.vmware.vmc.orgs.sddcs.EsxsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Task	create(java.lang.String org, java.lang.String sddc, EsxConfig esxConfig, java.lang.String action) Add/Remove one or more ESX hosts in the target cloud
void	create(java.lang.String org, java.lang.String sddc, EsxConfig esxConfig, java.lang.String action, AsyncCallback<Task> asyncCallback) Add/Remove one or more ESX hosts in the target cloud
void	create(java.lang.String org, java.lang.String sddc, EsxConfig esxConfig, java.lang.String action, AsyncCallback<Task> asyncCallback, InvocationConfig invocationConfig) Add/Remove one or more ESX hosts in the target cloud
Task	create(java.lang.String org, java.lang.String sddc, EsxConfig esxConfig, java.lang.String action, InvocationConfig invocationConfig) Add/Remove one or more ESX hosts in the target cloud

Method Detail

create

Task create(java.lang.String org,
            java.lang.String sddc,
            EsxConfig esxConfig,
            java.lang.String action)

Add/Remove one or more ESX hosts in the target cloud

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

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

esxConfig - esxConfig (required)

action - If = 'add', will add the esx. If = 'remove', will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = 'force-remove', will delete the esx even if it can lead to data loss (This is an privileged operation). If = 'addToAll', will add esxs to all clusters in the SDDC (This is an privileged operation). If = 'removeFromAll', will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = 'attach-diskgroup', will attach the provided diskgroups to a given host (privileged). If = 'detach-diskgroup', will detach the diskgroups of a given host (privileged). Default behaviour is 'add' (optional)

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - The sddc is not in a state that's valid for updates

Unauthorized - Access not allowed to the operation for the current user

NotFound - Cannot find the SDDC with the given identifier

create

Task create(java.lang.String org,
            java.lang.String sddc,
            EsxConfig esxConfig,
            java.lang.String action,
            InvocationConfig invocationConfig)

Add/Remove one or more ESX hosts in the target cloud

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:

org - Organization identifier (required)

sddc - Sddc identifier (required)

esxConfig - esxConfig (required)

action - If = 'add', will add the esx. If = 'remove', will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = 'force-remove', will delete the esx even if it can lead to data loss (This is an privileged operation). If = 'addToAll', will add esxs to all clusters in the SDDC (This is an privileged operation). If = 'removeFromAll', will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = 'attach-diskgroup', will attach the provided diskgroups to a given host (privileged). If = 'detach-diskgroup', will detach the diskgroups of a given host (privileged). Default behaviour is 'add' (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.vmc.model.Task

Throws:

Unauthenticated - Unauthorized

InvalidRequest - The sddc is not in a state that's valid for updates

Unauthorized - Access not allowed to the operation for the current user

NotFound - Cannot find the SDDC with the given identifier

create

void create(java.lang.String org,
            java.lang.String sddc,
            EsxConfig esxConfig,
            java.lang.String action,
            AsyncCallback<Task> asyncCallback)

Add/Remove one or more ESX hosts in the target cloud

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

Invocation Result:
com.vmware.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - The sddc is not in a state that's valid for updates
Unauthorized - Access not allowed to the operation for the current user
NotFound - Cannot find the SDDC with the given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

esxConfig - esxConfig (required)

action - If = 'add', will add the esx. If = 'remove', will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = 'force-remove', will delete the esx even if it can lead to data loss (This is an privileged operation). If = 'addToAll', will add esxs to all clusters in the SDDC (This is an privileged operation). If = 'removeFromAll', will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = 'attach-diskgroup', will attach the provided diskgroups to a given host (privileged). If = 'detach-diskgroup', will detach the diskgroups of a given host (privileged). Default behaviour is 'add' (optional)

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

create

void create(java.lang.String org,
            java.lang.String sddc,
            EsxConfig esxConfig,
            java.lang.String action,
            AsyncCallback<Task> asyncCallback,
            InvocationConfig invocationConfig)

Add/Remove one or more ESX hosts in the target cloud

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.vmc.model.Task

Operation Errors:
Unauthenticated - Unauthorized
InvalidRequest - The sddc is not in a state that's valid for updates
Unauthorized - Access not allowed to the operation for the current user
NotFound - Cannot find the SDDC with the given identifier

Parameters:

org - Organization identifier (required)

sddc - Sddc identifier (required)

esxConfig - esxConfig (required)

action - If = 'add', will add the esx. If = 'remove', will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = 'force-remove', will delete the esx even if it can lead to data loss (This is an privileged operation). If = 'addToAll', will add esxs to all clusters in the SDDC (This is an privileged operation). If = 'removeFromAll', will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = 'attach-diskgroup', will attach the provided diskgroups to a given host (privileged). If = 'detach-diskgroup', will detach the diskgroups of a given host (privileged). Default behaviour is 'add' (optional)

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

invocationConfig - Configuration for the method invocation.