NSX-T Data Center REST API

Invoke PUT request on target transport node

Request:

Method:
PUT
URI Path(s):
/api/v1/transport-nodes/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

PUT https://<nsx-mgr>/api/v1/transport-nodes/2b504b88-0655-11ea-8735-02004d51d475/node/services/snmp { "_schema": "NodeSnmpServiceProperties", "_self": { "href": "/transport-nodes/2b504b88-0655-11ea-8735-02004d51d475/node/services/snmp", "rel": "self" }, "service_name": "snmp", "service_properties": { "start_on_boot": false, "v2_configured": false, "v3_auth_protocol": "SHA1", "v3_configured": false, "v3_priv_protocol": "AES128", "v3_users": [{ "user_id": "testuser", "auth_password": "@uth_p@55w0rD", "priv_password": "pr!v_p@55w0rD" }] } }

Successful Response:

Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Example Response:

{ "_schema": "NodeSnmpServiceProperties", "_self": { "href": "/transport-nodes/2b504b88-0655-11ea-8735-02004d51d475/node/services/snmp", "rel": "self" }, "service_name": "snmp", "service_properties": { "start_on_boot": false, "v2_configured": false, "v3_auth_protocol": "SHA1", "v3_configured": true, "v3_priv_protocol": "AES128", "v3_users": [ { "user_id": "testuser" } ] } }

Required Permissions:

none

Feature:

system_administration Description:
Invoke any PUT /node* APIs on the target transport node. When invoking these APIs for edge nodes, internally Edge Node Refresh API call is made. This call will update realized edge node vSphere and node settings configuration to NSX-T Manager. Thus, this operation will update MP intent revision at Manager.

Additional Errors: