Update NS Group

Update NS Group

Updates the specified NSGroup. Modifiable parameters include the description, display_name and members.

Request
URI
PUT
https://nsxmanager.your.domain/api/v1/ns-groups/{ns-group-id}
COPY
Path Parameters
string
ns-group-id
Required

NSGroup Id

Request Body
NSGroup of type(s) application/json
Optional
This request body class requires all of the following: ManagedResource , InlineNSGroup1 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "member_count": 0,
    "members": [
        {
            "resource_type": "string",
            "target_resource": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            },
            "target_property": "string",
            "target_type": "string",
            "value": "string",
            "op": "string"
        }
    ],
    "membership_criteria": [
        {
            "resource_type": "string"
        }
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns NSGroup of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineNSGroup1 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "member_count": 0,
    "members": [
        {
            "resource_type": "string",
            "target_resource": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            },
            "target_property": "string",
            "target_type": "string",
            "value": "string",
            "op": "string"
        }
    ],
    "membership_criteria": [
        {
            "resource_type": "string"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Grouping Objects Operations
POST
Add MAC Address
POST
Add Or Remove NS Group Expression
POST
Create IP Set
POST
Create MAC Set
POST
Create NS Group
POST
Create NS Service
POST
Create NS Service Group
DELETE
Delete IP Set
DELETE
Delete MAC Set
DELETE
Delete NS Group
DELETE
Delete NS Service
DELETE
Delete NS Service Group
GET
Get Effective IP Address Members
GET
Get Effective Logical Port Members
GET
Get Effective Logical Switch Members
GET
Get MAC Addresses
GET
List IP Sets
GET
List MAC Sets
GET
List NS Groups
GET
List NS Service Groups
GET
List NS Services
GET
Read IP Set
GET
Read MAC Set
GET
Read NS Group
GET
Read NS Service
GET
Read NS Service Group
DELETE
Remove MAC Address
PUT
Update IP Set
PUT
Update MAC Set
PUT
Update NS Group
PUT
Update NS Service
PUT
Update NS Service Group