com.vmware.nsx.fabric

Interface VirtualSwitches

All Superinterfaces:

com.vmware.vapi.bindings.Service, VirtualSwitchesTypes

All Known Implementing Classes:

VirtualSwitchesStub

public interface VirtualSwitches
extends com.vmware.vapi.bindings.Service, VirtualSwitchesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
VirtualSwitchListResult	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String originId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uuid) Returns information about all virtual switches based on the request parameters.
void	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String originId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uuid, com.vmware.vapi.bindings.client.AsyncCallback<VirtualSwitchListResult> asyncCallback) Returns information about all virtual switches based on the request parameters.
void	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String originId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uuid, com.vmware.vapi.bindings.client.AsyncCallback<VirtualSwitchListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all virtual switches based on the request parameters.
VirtualSwitchListResult	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String originId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uuid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all virtual switches based on the request parameters.

Method Detail

list

VirtualSwitchListResult list(java.lang.String cmLocalId,
                             java.lang.String cursor,
                             java.lang.String discoveredNodeId,
                             java.lang.String displayName,
                             java.lang.String externalId,
                             java.lang.String includedFields,
                             java.lang.String originId,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             java.lang.String uuid)

Returns information about all virtual switches based on the request parameters.

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

Parameters:

cmLocalId - Local Id of the virtual switch (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

discoveredNodeId - Discovered node ID (optional)

displayName - Display name of the virtual switch (optional)

externalId - External id of the virtual switch (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

originId - ID of the compute manager (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)

uuid - UUID of the switch (optional)

Returns:

com.vmware.nsx.model.VirtualSwitchListResult

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

VirtualSwitchListResult list(java.lang.String cmLocalId,
                             java.lang.String cursor,
                             java.lang.String discoveredNodeId,
                             java.lang.String displayName,
                             java.lang.String externalId,
                             java.lang.String includedFields,
                             java.lang.String originId,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             java.lang.String uuid,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all virtual switches based on the request parameters.

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:

cmLocalId - Local Id of the virtual switch (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

discoveredNodeId - Discovered node ID (optional)

displayName - Display name of the virtual switch (optional)

externalId - External id of the virtual switch (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

originId - ID of the compute manager (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)

uuid - UUID of the switch (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VirtualSwitchListResult

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 cmLocalId,
          java.lang.String cursor,
          java.lang.String discoveredNodeId,
          java.lang.String displayName,
          java.lang.String externalId,
          java.lang.String includedFields,
          java.lang.String originId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String uuid,
          com.vmware.vapi.bindings.client.AsyncCallback<VirtualSwitchListResult> asyncCallback)

Returns information about all virtual switches based on the request parameters.

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

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

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

Parameters:

cmLocalId - Local Id of the virtual switch (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

discoveredNodeId - Discovered node ID (optional)

displayName - Display name of the virtual switch (optional)

externalId - External id of the virtual switch (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

originId - ID of the compute manager (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)

uuid - UUID of the switch (optional)

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

list

void list(java.lang.String cmLocalId,
          java.lang.String cursor,
          java.lang.String discoveredNodeId,
          java.lang.String displayName,
          java.lang.String externalId,
          java.lang.String includedFields,
          java.lang.String originId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String uuid,
          com.vmware.vapi.bindings.client.AsyncCallback<VirtualSwitchListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all virtual switches based on the request parameters.

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

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

Parameters:

cmLocalId - Local Id of the virtual switch (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

discoveredNodeId - Discovered node ID (optional)

displayName - Display name of the virtual switch (optional)

externalId - External id of the virtual switch (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

originId - ID of the compute manager (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)

uuid - UUID of the switch (optional)

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

invocationConfig - Configuration for the method invocation.