com.vmware.nsx.ns_groups

Interface ConsolidatedEffectiveIpAddressMembers

All Superinterfaces:

ConsolidatedEffectiveIpAddressMembersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ConsolidatedEffectiveIpAddressMembersStub

public interface ConsolidatedEffectiveIpAddressMembers
extends com.vmware.vapi.bindings.Service, ConsolidatedEffectiveIpAddressMembersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.ns_groups.ConsolidatedEffectiveIpAddressMembersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns the consolidated effective IP address members of the specified NSGroup.
void	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback) Returns the consolidated effective IP address members of the specified NSGroup.
void	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the consolidated effective IP address members of the specified NSGroup.
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the consolidated effective IP address members of the specified NSGroup.

Method Detail

list

ConsolidatedEffectiveIPAddressMemberListResult list(java.lang.String nsGroupId,
                                                    java.lang.String cursor,
                                                    java.lang.String includedFields,
                                                    java.lang.String ipFilter,
                                                    java.lang.Long pageSize,
                                                    java.lang.String siteId,
                                                    java.lang.Boolean sortAscending,
                                                    java.lang.String sortBy)

Returns the consolidated effective IP address members of the specified NSGroup. This is applicable in the case of a federated/NSX+ environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the ns-group evaluation on a site is empty, the response will contain the site-id with empty list. If an ns-group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs from other sites, and the response will contain an empty list of IPs for the sites where is it a reference group. This API is applicable only for Global and NSX+ Groups that contain (either directly or via nesting) VirtualMachine, VIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page. If there is no cursor value in the response, it indicates that it is the last page of results for the query.

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

Parameters:

nsGroupId - NSGroup Id (required)

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)

ipFilter - IP address, range, or subnet (optional)

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

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ConsolidatedEffectiveIPAddressMemberListResult

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

ConsolidatedEffectiveIPAddressMemberListResult list(java.lang.String nsGroupId,
                                                    java.lang.String cursor,
                                                    java.lang.String includedFields,
                                                    java.lang.String ipFilter,
                                                    java.lang.Long pageSize,
                                                    java.lang.String siteId,
                                                    java.lang.Boolean sortAscending,
                                                    java.lang.String sortBy,
                                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the consolidated effective IP address members of the specified NSGroup. This is applicable in the case of a federated/NSX+ environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the ns-group evaluation on a site is empty, the response will contain the site-id with empty list. If an ns-group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs from other sites, and the response will contain an empty list of IPs for the sites where is it a reference group. This API is applicable only for Global and NSX+ Groups that contain (either directly or via nesting) VirtualMachine, VIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page. If there is no cursor value in the response, it indicates that it is the last page of results for the query.

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:

nsGroupId - NSGroup Id (required)

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)

ipFilter - IP address, range, or subnet (optional)

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

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ConsolidatedEffectiveIPAddressMemberListResult

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 nsGroupId,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.String ipFilter,
          java.lang.Long pageSize,
          java.lang.String siteId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback)

Returns the consolidated effective IP address members of the specified NSGroup. This is applicable in the case of a federated/NSX+ environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the ns-group evaluation on a site is empty, the response will contain the site-id with empty list. If an ns-group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs from other sites, and the response will contain an empty list of IPs for the sites where is it a reference group. This API is applicable only for Global and NSX+ Groups that contain (either directly or via nesting) VirtualMachine, VIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page. If there is no cursor value in the response, it indicates that it is the last page of results for the query.

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

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

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

Parameters:

nsGroupId - NSGroup Id (required)

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)

ipFilter - IP address, range, or subnet (optional)

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

siteId - UUID of the site from which the effective IP addresses are to be fetched (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 nsGroupId,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.String ipFilter,
          java.lang.Long pageSize,
          java.lang.String siteId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the consolidated effective IP address members of the specified NSGroup. This is applicable in the case of a federated/NSX+ environment. The response includes a site-wise list of static and dynamically translated effective IP address members. If the ns-group evaluation on a site is empty, the response will contain the site-id with empty list. If an ns-group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs from other sites, and the response will contain an empty list of IPs for the sites where is it a reference group. This API is applicable only for Global and NSX+ Groups that contain (either directly or via nesting) VirtualMachine, VIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page. If there is no cursor value in the response, it indicates that it is the last page of results for the query.

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

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

Parameters:

nsGroupId - NSGroup Id (required)

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)

ipFilter - IP address, range, or subnet (optional)

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

siteId - UUID of the site from which the effective IP addresses are to be fetched (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.