System Administration >
Configuration
>
Fabric
>
Nodes
>
Services
>
SNMP
Read SNMP service properties
Read SNMP service properties.
Request:
Method:
GET
URI Path(s):
/api/v1/transport-nodes/{transport-node-id}/node/services/snmp
/api/v1/cluster/{cluster-node-id}/node/services/snmp
/api/v1/node/services/snmp
Request Headers:
n/a
Query Parameters:
GetSNMPParameters
+
GetSNMPParameters
(
schema
)
Name
Description
Type
Notes
show_sensitive_data
Show SNMP sensitive data or not
Whether to show SNMP service properties including community
strings if any applicable.
boolean
Default: "False"
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/node/services/snmp?show_sensitive_data=true
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSnmpServiceProperties
+
NodeSnmpServiceProperties
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
service_name
Service name
string
Required
service_properties
SNMP Service properties
SnmpServiceProperties
Required
Example Response:
{ "_schema": "NodeSnmpServiceProperties", "_self": { "href": "/node/services/snmp", "rel": "self" }, "service_name": "snmp", "service_properties": { "start_on_boot": false, "v2_configured": true, "communities": [ { "access": "READ_ONLY", "community_string": "snmpcommunity" } ], "v2_targets": [ { "server": "10.20.125.4", "port": 1162, "community_string": "snmpcommunity" } ], "v3_configured": false, "v3_auth_protocol": "SHA1", "v3_priv_protocol": "AES128", "v3_targets": [ { "server": "10.20.125.4", "port": 1162, "user_id": "user1", "security_level": "AUTH_PRIV" } ], "v3_users": [ { "user_id": "user1", "security_level": "AUTH_PRIV", "access": "READ_ONLY" } ] }
Required Permissions:
read
Feature:
system_administration
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable