Create NS Group

Create NS Group

Creates a new NSGroup that can group NSX resources - VIFs, Lports and LSwitches as well as the grouping objects - IPSet, MACSet and other NSGroups. For NSGroups containing VM criteria(both static and dynamic), system VMs will not be included as members. This filter applies at VM level only. Exceptions are as follows:

  1. LogicalPorts and VNI of System VMs will be included in NSGroup if the criteria is based on LogicalPort, LogicalSwitch or VNI directly.

This API is deprecated. Please use below policy API /infra/domains//groups/ to create Group.
Request
URI
POST
https://nsxmanager.your.domain/api/v1/ns-groups
COPY
Request Body
NSGroup of type(s) application/json
Optional
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "_revision": 0,
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_protection": "string",
    "_system_owned": false,
    "description": "string",
    "display_name": "string",
    "id": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "member_count": 0,
    "members": [
        {
            "resource_type": "string",
            "op": "string",
            "target_property": "string",
            "target_resource": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "target_type": "string",
            "value": "string"
        }
    ],
    "membership_criteria": [
        {
            "resource_type": "string"
        }
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns NSGroup of type(s) application/json
This response body class contains all of the following: InlineNSGroup1
"NSGroup Object"

400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404
Returns NotFound of type(s) application/json
Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v1/ns-groups
                
Deprecated
Management Plane Api Operations
GET
List IP Sets
Deprecated
POST
Create IP Set
Deprecated
DELETE
Delete IP Set
Deprecated
GET
Read IP Set
Deprecated
POST
Add Remove IP Address
Deprecated
PUT
Update IP Set
Deprecated
GET
Get IP Addresses
Deprecated
GET
List MAC Sets
Deprecated
POST
Create MAC Set
Deprecated
DELETE
Delete MAC Set
Deprecated
GET
Read MAC Set
Deprecated
PUT
Update MAC Set
Deprecated
GET
Get MAC Addresses
Deprecated
POST
Add MAC Address
Deprecated
DELETE
Remove MAC Address
Deprecated
GET
List NS Groups
Deprecated
POST
Create NS Group
Deprecated
GET
Get Unassociated Virtual Machines
Deprecated
DELETE
Delete NS Group
Deprecated
GET
Read NS Group
Deprecated
POST
Add Or Remove NS Group Expression
Deprecated
PUT
Update NS Group
Deprecated
GET
Get Consolidated Effective IP Address Members
Deprecated
GET
Get Effective Cloud Native Service Instances
Deprecated
GET
Get Effective Active Directory Groups
Deprecated
GET
Get Effective IP Address Members
Deprecated
GET
Get Effective IP Set Members
Deprecated
GET
Get Effective Logical Port Members
Deprecated
GET
Get Effective Logical Switch Members
Deprecated
GET
Get Effective Physical Server Members
Deprecated
GET
Get Effective Transport Node Members
Deprecated
GET
Get Effective VIF Members
Deprecated
GET
Get Effective Virtual Machine Members
Deprecated
GET
Get Member Types
Deprecated
GET
Get Service Associations
Deprecated
GET
List NS Profiles
Deprecated
POST
Create NS Profile
Deprecated
GET
List NS Supported Attributes Types
Deprecated
GET
List NS Supported Attributes
Deprecated
DELETE
Delete NS Profile
Deprecated
GET
Read NS Profile
Deprecated
PUT
Update NS Profile
Deprecated
GET
List NS Service Groups
Deprecated
POST
Create NS Service Group
Deprecated
DELETE
Delete NS Service Group
Deprecated
GET
Read NS Service Group
Deprecated
PUT
Update NS Service Group
Deprecated
GET
List NS Services
Deprecated
POST
Create NS Service
Deprecated
DELETE
Delete NS Service
Deprecated
GET
Read NS Service
Deprecated
PUT
Update NS Service
Deprecated