Policy > Inventory > Groups > Group Members

Associated URIs:

API Description	API Path
Get member types for a given Group It retrieves member types for a given group. In case of nested groups, it calculates member types of child groups as well. Considers member type for members added via static members and dynamic membership criteria.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/member-types GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/member-types
Get consolidated effective IPAddress translated from this group across site 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.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses
Get IP addresses that belong to this Group Get IP addresses that belong to this Group. This API is applicable for Groups containing either VirtualMachine, VIF, Segment ,Segment Port or IP Address member type.For Groups containing other member types,an empty list is returned	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/ip-addresses GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/ip-addresses
Get logical ports that belong to this Group Get logical ports that belong to this Group This API is applicable for Groups containing either VirtualMachine, VIF, Segment or Segment Port member type.For Groups containing other member types,an empty list is returned.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/logical-ports GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-ports
Get logical switches that belong to this Group Get logical switches that belong to this Group. This API is applicable for Groups containing Segment member type. For Groups containing other member types, an empty list is returned.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/logical-switches GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-switches
Get segment ports that belong to this Group Get segment ports that belong to this Group	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/segment-ports GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segment-ports
Get segments that belong to this Group Get segments that belong to this Group	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/segments GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segments
Get Virtual Network Interface instances that belong to this Group Get Virtual Network Interface instances that belong to this Group. This API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types. For Groups containing other member types,an empty list is returned.target_id in response is external_id of VirtualNetworkInterface or VirtualMachine.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/vifs GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/vifs
Get Virtual machines that belong to this Group Get Virtual machines that belong to this Group. This API is applicable for Groups containing VirtualMachine,member type. For Groups containing other member types,an empty list is returned.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/virtual-machines GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/virtual-machines
Get effective VMs for the Group Get the effective VM membership for the Group. This API also gives some VM details such as VM name, IDs and the current state of the VMs.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/statistics/virtual-machines (Deprecated)
Get tags used to define conditions inside a Group Get tags used to define conditions inside a Group. Also includes tags inside nested groups.	GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/tags GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/tags
Get groups for which the given object is a member Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list.	GET /policy/api/v1/infra/group-associations GET /policy/api/v1/global-infra/group-associations
Get groups for which the given IP address is a member Get policy groups for which the given IP address is a member.	GET /policy/api/v1/infra/ip-address-group-associations GET /policy/api/v1/global-infra/ip-address-group-associations
Get groups for which the given VM is a member Get policy groups for which the given VM is a member.	GET /policy/api/v1/infra/virtual-machine-group-associations GET /policy/api/v1/global-infra/virtual-machine-group-associations
Get groups for which the given VIF is a member Get policy groups for which the given VIF is a member.	GET /policy/api/v1/infra/virtual-network-interface-group-associations GET /policy/api/v1/global-infra/virtual-network-interface-group-associations