com.vmware.nsx_global_policy.global_infra.domains.groups.members

Interface ConsolidatedEffectiveIpAddresses

All Superinterfaces:

ConsolidatedEffectiveIpAddressesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ConsolidatedEffectiveIpAddressesStub

public interface ConsolidatedEffectiveIpAddresses
extends com.vmware.vapi.bindings.Service, ConsolidatedEffectiveIpAddressesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_global_policy.global_infra.domains.groups.members.ConsolidatedEffectiveIpAddressesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String domainId, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, 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 consolidated effective ip address members of the specified NSGroup.
void	list(java.lang.String domainId, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, 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 consolidated effective ip address members of the specified NSGroup.
void	list(java.lang.String domainId, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, 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 consolidated effective ip address members of the specified NSGroup.
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String domainId, java.lang.String groupId, java.lang.String cursor, java.lang.String enforcementPointPath, 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 consolidated effective ip address members of the specified NSGroup.

Method Detail

list

ConsolidatedEffectiveIPAddressMemberListResult list(java.lang.String domainId,
                                                    java.lang.String groupId,
                                                    java.lang.String cursor,
                                                    java.lang.String enforcementPointPath,
                                                    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 consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for Global Groups containing (directly or via nesting) either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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

Parameters:

domainId - Domain 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)

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_global_policy.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 domainId,
                                                    java.lang.String groupId,
                                                    java.lang.String cursor,
                                                    java.lang.String enforcementPointPath,
                                                    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 consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for Global Groups containing (directly or via nesting) either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the 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:

domainId - Domain 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)

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_global_policy.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 domainId,
          java.lang.String groupId,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          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 consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for Global Groups containing (directly or via nesting) either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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

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

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

Parameters:

domainId - Domain 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)

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 domainId,
          java.lang.String groupId,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          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 consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for Global Groups containing (directly or via nesting) either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the 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_global_policy.model.ConsolidatedEffectiveIPAddressMemberListResult

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

Parameters:

domainId - Domain 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)

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.