Skip to main content
Hitachi Vantara Knowledge

Set SNMP access config

Configure SNMP management access. SNMP provides read only access to various system resources.

NoteIt’s not possible to enable SNMPv3 while SNMPv1 or SNMPv2 are enabled. It’s currently not possible to fully configure SNMPv3 via the REST API.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/file-devices/management-access/snmp
Name Type Required Values Description
isEnabledBODYNbooleanControls whether SNMP access is enabled or not.
restrictedHostsBODYNbooleanRestrict access to only those hosts in the allowedHosts list.
portBODYNintegerPort that the specific management interface listens on.
sendAuthFailureTrapsBODYNbooleanDetermines whether authentication failure traps are sent or not.
allowedHostsBODYNlist of stringsSpecifies a list of hosts allowed to access the specific management interface. The host values can be either IP address or valid DNS names.
allowedCommunitiesBODYNlist of stringsA list of allowed community string values.
allowSnmpV1BODYNbooleanAllow SNMPv1 requests
allowSnmpV2BODYNbooleanAllow SNMPv2 requests
allowSnmpV3BODYNbooleanAllow SNMPv3 requests
Return codes
Code Data Description
204 No DataSNMP access successfully updated.
400 Error Message Missing or invalid request contents.
403Error MessageOperation forbidden by access level.
500 Error message Error associated with the storage system.

Any HTTP status code other than 204 indicates that the API did not complete successfully.

Request example: Enable SNMPv1 and SNMPv2, and set a community string
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" -X PATCH -d '{"allowSnmpV1":true, "allowSnmpV2":true, "allowedCommunities":["public"]}'
Response example
HTTP/1.1 204 No Content


  • Was this article helpful?