com.vmware.nsx.fabric

Interface ComputeManagers

All Superinterfaces:

ComputeManagersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ComputeManagersStub

public interface ComputeManagers
extends com.vmware.vapi.bindings.Service, ComputeManagersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.fabric.ComputeManagersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ComputeManager	create(ComputeManager computeManager) Registers compute manager with NSX.
void	create(ComputeManager computeManager, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback) Registers compute manager with NSX.
void	create(ComputeManager computeManager, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Registers compute manager with NSX.
ComputeManager	create(ComputeManager computeManager, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Registers compute manager with NSX.
void	delete(java.lang.String computeManagerId) Unregisters a specified compute manager
void	delete(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Unregisters a specified compute manager
void	delete(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Unregisters a specified compute manager
void	delete(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Unregisters a specified compute manager
ComputeManager	get(java.lang.String computeManagerId) Returns information about a specific compute manager
void	get(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback) Returns information about a specific compute manager
void	get(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific compute manager
ComputeManager	get(java.lang.String computeManagerId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific compute manager
ComputeManagerListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String originType, java.lang.Long pageSize, java.lang.String server, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all compute managers.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String originType, java.lang.Long pageSize, java.lang.String server, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManagerListResult> asyncCallback) Returns information about all compute managers.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String originType, java.lang.Long pageSize, java.lang.String server, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManagerListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all compute managers.
ComputeManagerListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.String originType, java.lang.Long pageSize, java.lang.String server, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all compute managers.
ComputeManager	update(java.lang.String computeManagerId, ComputeManager computeManager) Updates a specified compute manager
void	update(java.lang.String computeManagerId, ComputeManager computeManager, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback) Updates a specified compute manager
void	update(java.lang.String computeManagerId, ComputeManager computeManager, com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates a specified compute manager
ComputeManager	update(java.lang.String computeManagerId, ComputeManager computeManager, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates a specified compute manager

Method Detail

create

ComputeManager create(ComputeManager computeManager)

Registers compute manager with NSX. Inventory service will collect data from the registered compute manager

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

Parameters:

computeManager - (required)

Returns:

com.vmware.nsx.model.ComputeManager

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

ComputeManager create(ComputeManager computeManager,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Registers compute manager with NSX. Inventory service will collect data from the registered compute manager

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:

computeManager - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ComputeManager

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

Registers compute manager with NSX. Inventory service will collect data from the registered compute manager

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

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

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

Parameters:

computeManager - (required)

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

create

void create(ComputeManager computeManager,
            com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Registers compute manager with NSX. Inventory service will collect data from the registered compute manager

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

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

Parameters:

computeManager - (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 computeManagerId)

Unregisters a specified compute manager

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

Parameters:

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

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

Unregisters a specified compute manager

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:

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

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

Unregisters a specified compute manager

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:

computeManagerId - (required)

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

delete

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

Unregisters a specified compute manager

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:

computeManagerId - (required)

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

invocationConfig - Configuration for the method invocation.

get

ComputeManager get(java.lang.String computeManagerId)

Returns information about a specific compute manager

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

Parameters:

computeManagerId - (required)

Returns:

com.vmware.nsx.model.ComputeManager

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

ComputeManager get(java.lang.String computeManagerId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific compute manager

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:

computeManagerId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ComputeManager

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

Returns information about a specific compute manager

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

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

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

Parameters:

computeManagerId - (required)

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

get

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

Returns information about a specific compute manager

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

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

Parameters:

computeManagerId - (required)

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

invocationConfig - Configuration for the method invocation.

list

ComputeManagerListResult list(java.lang.String cursor,
                              java.lang.String includedFields,
                              java.lang.String originType,
                              java.lang.Long pageSize,
                              java.lang.String server,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Returns information about all compute managers.

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)

originType - Compute manager type like vCenter (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

server - IP address or hostname of compute manager (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ComputeManagerListResult

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

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

Returns information about all compute managers.

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)

originType - Compute manager type like vCenter (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

server - IP address or hostname of compute manager (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ComputeManagerListResult

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

Returns information about all compute managers.

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

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

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)

originType - Compute manager type like vCenter (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

server - IP address or hostname of compute manager (optional)

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.String originType,
          java.lang.Long pageSize,
          java.lang.String server,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ComputeManagerListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all compute managers.

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

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)

originType - Compute manager type like vCenter (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

server - IP address or hostname of compute manager (optional)

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.

update

ComputeManager update(java.lang.String computeManagerId,
                      ComputeManager computeManager)

Updates a specified compute manager

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

Parameters:

computeManagerId - (required)

computeManager - (required)

Returns:

com.vmware.nsx.model.ComputeManager

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

update

ComputeManager update(java.lang.String computeManagerId,
                      ComputeManager computeManager,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Updates a specified compute manager

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:

computeManagerId - (required)

computeManager - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ComputeManager

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

update

void update(java.lang.String computeManagerId,
            ComputeManager computeManager,
            com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback)

Updates a specified compute manager

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

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

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

Parameters:

computeManagerId - (required)

computeManager - (required)

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

update

void update(java.lang.String computeManagerId,
            ComputeManager computeManager,
            com.vmware.vapi.bindings.client.AsyncCallback<ComputeManager> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Updates a specified compute manager

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

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

Parameters:

computeManagerId - (required)

computeManager - (required)

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

invocationConfig - Configuration for the method invocation.