NSX-T Data Center Global Manager REST API
Associated URIs:
API Description | API Path |
---|---|
List Groups for a domainList Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types. |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups
|
Delete GroupDelete the group with group_id under domain domain_id. The force query parameter supported on the API is deprecated. Usage of the force query parameter does not alter the behaviour of the API. The API just ignores the force parameter. |
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}
|
Read groupRead group |
GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}
|
Patch a groupIf a group with the group-id is not already present, create a new group. If it already exists, patch the group. Group created with Kubernetes membership criteria includes only Antrea reported inventory as its members. Once created, Groups with Identity (Directory) Group members should be updated with the new Distinguished Name in case it is changed on AD Server. Maximum of 500 malicious IP Groups (i.e Group with criteria having IPAddress equals All MALICIOUS_IP) should be created. |
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}
|
Create or update a groupIf a group with the group-id is not already present, create a new group. If it already exists, update the group. Avoid creating groups with multiple MACAddressExpression and IPAddressExpression. In future releases, group will be restricted to contain a single MACAddressExpression and IPAddressExpression along with other expressions. To group IPAddresses or MACAddresses, use nested groups instead of multiple IPAddressExpressions/MACAddressExpression. Group created with Kubernetes membership criteria includes only Antrea reported inventory as its members. Once created, Groups with Identity (Directory) Group members should be updated with the new Distinguished Name in case it is changed on AD Server. Maximum of 500 malicious IP Groups (i.e Group with criteria having IPAddress equals All MALICIOUS_IP) should be created. |
PUT /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}
|
Delete Group External ID ExpressionDelete Group External ID Expression |
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/external-id-expressions/{expression-id}
|
Patch a group external ID expressionIf a group ExternalIDexpression with the expression-id is not already present, create a new ExternalIDexpresison. If it already exists, replace the existing ExternalIDexpression. |
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/external-id-expressions/{expression-id}
|
Add or Remove external id based members from/to a GroupIt will add or remove the specified members having external ID for a given expression of a group. |
POST /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/external-id-expressions/{expression-id}
|
Delete Group IPAddressExpressionDelete Group IPAddressExpression |
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/ip-address-expressions/{expression-id}
|
Patch a group IP Address expressionIf a group IPAddressExpression with the expression-id is not already present, create a new IPAddressExpression. If it already exists, replace the existing IPAddressExpression. |
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/ip-address-expressions/{expression-id}
|
Add or Remove IP Addresses from/to a GroupIt will add or remove the specified IP Addresses from a given expression of a group. |
POST /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/ip-address-expressions/{expression-id}
|
Delete Group MACAddressExpressionDelete Group MACAddressExpression |
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/mac-address-expressions/{expression-id}
|
Patch a group MAC Address expressionIf a group MACAddressExpression with the expression-id is not already present, create a new MACAddressExpression. If it already exists, replace the existing MACAddressExpression. |
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/mac-address-expressions/{expression-id}
|
Add or Remove MAC Addresses from/to a GroupIt will add or remove the specified MAC Addresses from a given expression of a group. |
POST /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/mac-address-expressions/{expression-id}
|
Delete Group Path ExpressionDelete Group Path Expression |
DELETE /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/path-expressions/{expression-id}
|
Patch a group path expressionIf a group path_expression with the expression-id is not already present, create a new pathexpresison. If it already exists, replace the existing pathexpression. |
PATCH /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/path-expressions/{expression-id}
|
Add or Remove path based members from/to a GroupIt will add or remove the specified members having path for a given expression of a group. |
POST /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/path-expressions/{expression-id}
|