System Administration >
Configuration
>
NSX Managers
>
Clusters
>
Cluster Configuration
Invoke PUT request on target cluster node
Request:
Method:
PUT
URI Path(s):
/api/v1/cluster/<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/cluster/816a2c15-6f5a-4213-bc3a-46a5084a3f07/node/services/snmp { "_schema": "NodeSnmpServiceProperties", "_self": { "href": "/cluster/816a2c15-6f5a-4213-bc3a-46a5084a3f07/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": "/cluster/816a2c15-6f5a-4213-bc3a-46a5084a3f07/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 cluster node.
Additional Errors:
404 Not Found
504 Gateway Timeout
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable