com.vmware.nsx_policy.global_infra.tier_0s.groups.members

Interface VirtualMachines

All Superinterfaces:

com.vmware.vapi.bindings.Service, VirtualMachinesTypes

All Known Implementing Classes:

VirtualMachinesStub

public interface VirtualMachines
extends com.vmware.vapi.bindings.Service, VirtualMachinesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.tier_0s.groups.members.VirtualMachinesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
RealizedVirtualMachineListResult	list(java.lang.String tier0Id, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get Virtual machines that belong to this Tier-0 Group.
void	list(java.lang.String tier0Id, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RealizedVirtualMachineListResult> asyncCallback) Get Virtual machines that belong to this Tier-0 Group.
void	list(java.lang.String tier0Id, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RealizedVirtualMachineListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get Virtual machines that belong to this Tier-0 Group.
RealizedVirtualMachineListResult	list(java.lang.String tier0Id, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get Virtual machines that belong to this Tier-0 Group.

Method Detail

list

RealizedVirtualMachineListResult list(java.lang.String tier0Id,
                                      java.lang.String groupId,
                                      java.lang.String cursor,
                                      java.lang.String enforcementPointPath,
                                      java.lang.Boolean includeMarkForDeleteObjects,
                                      java.lang.String includedFields,
                                      java.lang.Long pageSize,
                                      java.lang.Boolean sortAscending,
                                      java.lang.String sortBy)

Get Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.

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

Parameters:

tier0Id - Tier-0 id (required)

groupId - Group Id (required)

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

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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_policy.model.RealizedVirtualMachineListResult

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

RealizedVirtualMachineListResult list(java.lang.String tier0Id,
                                      java.lang.String groupId,
                                      java.lang.String cursor,
                                      java.lang.String enforcementPointPath,
                                      java.lang.Boolean includeMarkForDeleteObjects,
                                      java.lang.String includedFields,
                                      java.lang.Long pageSize,
                                      java.lang.Boolean sortAscending,
                                      java.lang.String sortBy,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.

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:

tier0Id - Tier-0 id (required)

groupId - Group Id (required)

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

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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_policy.model.RealizedVirtualMachineListResult

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 tier0Id,
          java.lang.String groupId,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<RealizedVirtualMachineListResult> asyncCallback)

Get Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.

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

Invocation Result:
com.vmware.nsx_policy.model.RealizedVirtualMachineListResult

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

Parameters:

tier0Id - Tier-0 id (required)

groupId - Group Id (required)

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

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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 tier0Id,
          java.lang.String groupId,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<RealizedVirtualMachineListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.

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_policy.model.RealizedVirtualMachineListResult

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

Parameters:

tier0Id - Tier-0 id (required)

groupId - Group Id (required)

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

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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.