| object | snmp/ |
| Object representing SNMP server configuration | |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample CLI read command:
uom get snmp
⇒
Sample JS request write command:
request.put({url:"snmp/",body:<...>});
SNMP server enabled
| sum (boolean) | snmp/enabled/ |
| SNMP server enable status | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample uom library write command:
uom.snmp.enabled=true
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/snmp/enabled/',auth=auth,headers=headers).json())
⇒
False
Engine ID
| string | snmp/engine_id/ |
| The engine ID, in hexadecimal, to which all user authentication and privacy keys are localized | |
The value is subject to the following constraints: the value matches ^([0-9A-Fa-f]{2})*$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom library read command:
print(uom.dump(uom.snmp.engine_id))
⇒
"C7A2088A94F7EA306E"
Sample CLI write command:
uom set "snmp/engine_id" "\"003827CB\""
OID subtrees
| map | snmp/oid_subtrees/ |
| OID subtrees exposed by SNMP server | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map represents a value in persistent storage.
This map contains OID subtree elements.
Sample curl OID subtree creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"read_security_level\":\"noauth\",\"root\":\"1.3.6.1.2.1.229\",\"title\":\"energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)\",\"write_security_level\":\"noauth\"}" "http://192.168.0.100/restapi/snmp/oid_subtrees/energyObject/"
Sample requests write command:
requests.put('http://192.168.0.100/restapi/snmp/oid_subtrees/',auth=auth,headers=headers,json={'energyObject': {'read_security_level': 'noauth', 'root': '1.3.6.1.2.1.229', 'title': 'energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)', 'write_security_level': 'noauth'}})
See also OID subtrees: OID subtree
OID subtrees: OID subtree
| object | snmp/oid_subtrees/S/ |
| Properties of an OID subtree | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This object represents a value in persistent storage.
This object contains the following items:
| title | Title |
| root | Root mask |
| read_security_level | Read security level |
| write_security_level | Write security level |
Sample CLI read command (note that oid_subtree is a variable):
uom get "snmp/oid_subtrees/${oid_subtree}"
⇒
{"read_security_level":"noauth","root":"1.3.6.1.2.1.229","title":"energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)","write_security_level":"noauth"}
Sample requests read command (note that _oid_subtree is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/',auth=auth,headers=headers).json())
⇒
{'read_security_level': 'noauth', 'root': '1.3.6.1.2.1.229', 'title': 'energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)', 'write_security_level': 'noauth'}
Title
| string | snmp/oid_subtrees/S/title/ |
| The title of this subtree | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample curl write command (note that :oid_subtree is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)\"" "http://192.168.0.100/restapi/snmp/oid_subtrees/:oid_subtree/title/"
Sample requests write command (note that _oid_subtree is a variable):
requests.put('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/title/',auth=auth,headers=headers,json='energyObject MIB (RFC 7460, allows manipulating relays and power-related meters)')
Root mask
| string | snmp/oid_subtrees/S/root/ |
| The root OID mask of this subtree (for all but the first two arcs, '*' can be used for "don't care" parts, and inclusive ranges can be specified like '1,2,4-7') | |
The value is subject to the following constraints: the value matches ^(0|1|(01|2)(.(*|(0|[1-9][0-9]*)(-(0|[1-9][0-9]*))?(,(0|[1-9][0-9]*)(-(0|[1-9][0-9]*))?)*))*)$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample requests read command (note that _oid_subtree is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/root/',auth=auth,headers=headers).json())
⇒
'1.3.6.1.2.1.229'
Sample CLI write command (note that oid_subtree is a variable):
uom set "snmp/oid_subtrees/${oid_subtree}/root" "\"1.3.6.1.2.1.229\""
Read security level
| sum (enumerated string) | snmp/oid_subtrees/S/read_security_level/ |
| Required security level for reading from this subtree | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant "deny" | Forbidden | Nobody can read from this OID subtree | |
| constant "priv" | Authenticated and encrypted | SNMPv3 authentication and encryption must be used to read from this OID subtree | |
| constant "auth" | Authenticated | SNMPv3 authentication must be used to read from this OID subtree (encryption is optional) | |
| constant "noauth" | Minimal | Any protocol, including SNMPv1 and SNMPv2c, can be used to read from this OID subtree (authentication and encryption are optional) | |
Sample requests write command (note that _oid_subtree is a variable):
requests.put('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/read_security_level/',auth=auth,headers=headers,json='noauth')
Sample JS request write command (note that _oid_subtree is a variable):
request.put({url:"snmp/oid_subtrees/"+_oid_subtree+"/read_security_level/",body:"noauth"});
Write security level
| sum (enumerated string) | snmp/oid_subtrees/S/write_security_level/ |
| Required security level for writing to this subtree | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant "deny" | Forbidden | Nobody can write to this OID subtree | |
| constant "priv" | Authenticated and encrypted | SNMPv3 authentication and encryption must be used to write to this OID subtree | |
| constant "auth" | Authenticated | SNMPv3 authentication must be used to write to this OID subtree (encryption is optional) | |
| constant "noauth" | Minimal | Any protocol, including SNMPv1 and SNMPv2c, can be used to write to this OID subtree (authentication and encryption are optional) | |
Sample JS request read command (note that _oid_subtree is a variable):
request.get({url:"snmp/oid_subtrees/"+_oid_subtree+"/write_security_level/"},function(error,response,body) {console.log(body)});
⇒
"noauth"
Sample requests write command (note that _oid_subtree is a variable):
requests.put('http://192.168.0.100/restapi/snmp/oid_subtrees/'+_oid_subtree+'/write_security_level/',auth=auth,headers=headers,json='noauth')
Users
| map | snmp/users/ |
| SNMP user accounts | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map represents a value in persistent storage.
This map contains User elements.
Sample curl user creation command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"priv_password\":\"readerPrivPassword\",\"has_auth_password\":null,\"subtree_access\":{\"energyObject\":\"readonly\"},\"auth_password\":\"readerAuthPassword\",\"is_allowed\":false,\"priv_method\":\"aes\",\"auth_method\":\"sha1\"}" "http://192.168.0.100/restapi/snmp/users/powerReader/"
Sample uom library write command:
uom.snmp.users={powerAdmin={auth_method="md5",auth_password="adminAuthPassword",is_allowed=false,priv_method="aes",priv_password="adminPrivPassword",subtree_access={energyObject=true}},powerReader={auth_method="md5",auth_password="readerAuthPassword",is_allowed=true,priv_method="aes",priv_password="readerPrivPassword",subtree_access={energyObject="readonly"}}}
User
| object | snmp/users/S/ |
| Properties of an SNMP user | |
The value is subject to the following constraints: index of the value matches ^[a-zA-Z0-9]*$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This object represents a value in persistent storage.
This object contains the following items:
Sample JS request deletion command (note that _user is a variable):
request.delete({url:"snmp/users/"+_user+"/"});
Sample JS request read command (note that _user is a variable):
request.get({url:"snmp/users/"+_user+"/"},function(error,response,body) {console.log(body)});
⇒
{"priv_password":"adminPrivPassword","has_auth_password":true,"subtree_access":{"energyObject":true},"auth_password":"adminAuthPassword","is_allowed":true,"priv_method":"des","auth_method":"sha1","has_priv_password":true}
See also User: User allowed
See also User: Authentication method
See also User: Authentication password configured
See also User: Authentication password
See also User: Privacy method
See also User: Privacy password configured
See also User: Privacy password
See also User: Subtree access levels
User: User allowed
| sum (boolean) | snmp/users/S/is_allowed/ |
| Flag indicating whether user is allowed or denied | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Allowed | The user is allowed to log in | |
| constant false | Denied | The user is denied login | |
Sample uom library write command (note that _user is a variable):
uom.snmp.users[_user].is_allowed=false
Sample CLI write command (note that user is a variable):
uom set "snmp/users/${user}/is_allowed" "true"
User: Authentication method
| string | snmp/users/S/auth_method/ |
| User authentication method | |
The value is subject to the following constraints: known authentication methods[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom library write command (note that _user is a variable):
uom.snmp.users[_user].auth_method="sha1"
Sample JS request write command (note that _user is a variable):
request.put({url:"snmp/users/"+_user+"/auth_method/",body:"md5"});
User: Authentication password configured
| sum (boolean) | snmp/users/S/has_auth_password/ |
| Flag indicating if the authentication password has been configured for the user (cleared if engine ID or authentication method changes) | |
The value is unconditionally set to authentication password is not equal to "" on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
| constant true | Configured | The authentication password has been configured | |
| constant false | Not configured | The authentication password hasn't been configured, the user won't be able to log in | |
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/has_auth_password"
⇒
false
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/has_auth_password/',auth=auth,headers=headers).json())
⇒
True
User: Authentication password
| string | snmp/users/S/auth_password/ |
| User authentication password (cannot be read as it is stored localized to the engine ID), empty if not set | |
The value is subject to the following constraints: any of the following is true:
Retrieving the value is denied
Changing the value is denied if any of the following is true:
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
This string should be displayed in a secure manner.
Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return '{"$ref":""}' which means "the value of this resource".
Sample uom library write command (note that _user is a variable):
uom.snmp.users[_user].auth_password="readerAuthPassword"
Sample curl write command (note that :user is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"readerAuthPassword\"" "http://192.168.0.100/restapi/snmp/users/:user/auth_password/"
User: Privacy method
| string | snmp/users/S/priv_method/ |
| User privacy method | |
The value is subject to the following constraints: known privacy methods[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/priv_method"
⇒
"des"
Sample uom library read command (note that _user is a variable):
print(uom.dump(uom.snmp.users[_user].priv_method))
⇒
"des"
User: Privacy password configured
| sum (boolean) | snmp/users/S/has_priv_password/ |
| Flag indicating if the privacy password has been configured for the user (cleared if engine ID or authentication or privacy method changes) | |
The value is unconditionally set to privacy password is not equal to "" on creation and doesn't have to be supplied (if it is, it must match)
Retrieving the value is denied if not administrative user
This sum does not support direct modification.
This sum can change as if by itself or indirectly because of other actions.
Changes to this sum cannot be tracked.
This sum can assume the following values:
| constant true | Configured | The privacy password has been configured | |
| constant false | Not configured | The privacy password hasn't been configured, the user won't be able to log in | |
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/has_priv_password/',auth=auth,headers=headers).json())
⇒
False
Sample CLI read command (note that user is a variable):
uom get "snmp/users/${user}/has_priv_password"
⇒
false
User: Privacy password
| string | snmp/users/S/priv_password/ |
| User privacy password (cannot be read as it is stored localized to the engine ID), empty if not set | |
The value is subject to the following constraints: any of the following is true:
Retrieving the value is denied
Changing the value is denied if any of the following is true:
Using the string as a field for indexing into the grandparent collection is denied
This string represents a value in persistent storage.
This string can change as if by itself or indirectly because of other actions.
This string should be displayed in a secure manner.
Representation of the resource cannot be obtained. Attempts to do so via a JSON API will succeed but return '{"$ref":""}' which means "the value of this resource".
Sample curl write command (note that :user is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"adminPrivPassword\"" "http://192.168.0.100/restapi/snmp/users/:user/priv_password/"
Sample CLI write command (note that user is a variable):
uom set "snmp/users/${user}/priv_password" "\"readerPrivPassword\""
User: Subtree access levels
| map | snmp/users/S/subtree_access/ |
| OID subtree access levels | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This map is composite, i.e. is modified as a whole.
This map represents a value in persistent storage.
This map contains Subtree access elements.
Sample curl read command (note that :user is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/snmp/users/:user/subtree_access/"
⇒
{"energyObject":false}
Sample requests read command (note that _user is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/users/'+_user+'/subtree_access/',auth=auth,headers=headers).json())
⇒
{'energyObject': True}
Subtree access
| sum (optional variant) | snmp/users/S/subtree_access/S/ |
| OID subtree access level | |
The value is subject to the following constraints: OID subtrees[index of the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum is a part of a composite value which is modified as a whole.
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Full | OIDs can be read and written by the user | |
| constant "readonly" | Read-only | OIDs can only be read, not written, by the user | |
| constant false | None | OIDs can neither be read nor written by the user | |
| constant null | Default | No access rule present (permissions are determined by parent OID access levels, or denied) | |
Sample curl read command (note that :user and :subtree_access are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/snmp/users/:user/subtree_access/:subtree_access/"
⇒
"readonly"
Sample CLI deletion command (note that user and subtree_access are variables):
uom remove "snmp/users/${user}/subtree_access/${subtree_access}"
Community mappings
| array | snmp/community_mappings/ |
| Mappings of SNMP v1/v2c communities to user names | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Community mapping elements.
Sample CLI read command:
uom get "snmp/community_mappings"
⇒
Sample uom library write command:
uom.snmp.community_mappings={{community="private",ip_address="10.86.178.141",netmask="255.0.0.0",user="userDHCIkZ"},{community="private",ip_address="192.168.176.137",netmask="255.255.255.0",user="userlz55zp"},{community="private",ip_address="10.23.202.164",netmask="255.0.0.0",user="userIokTQ"}}
See also Community mappings: Community mapping
Community mappings: Community mapping
| object | snmp/community_mappings/N/ |
| Properties of a community mapping | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This object represents a value in persistent storage.
This object contains the following items:
| community | Community |
| user | User |
| ip_address | IP address |
| netmask | Network mask |
Sample JS request deletion command (note that _community_mapping_index is a variable):
request.delete({url:"snmp/community_mappings/"+_community_mapping_index.toString()+"/"});
Sample uom library read command (note that _community_mapping_index is a variable):
print(uom.dump(uom.snmp.community_mappings[_community_mapping_index]))
⇒
{community="private",ip_address="192.168.241.211",netmask="255.255.255.0",user="user7uxv1"}
Community
| string | snmp/community_mappings/N/community/ |
| The community identifier | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample curl write command (note that :community_mapping_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"private\"" "http://192.168.0.100/restapi/snmp/community_mappings/:community_mapping_index/community/"
Sample requests write command (note that _community_mapping_index is a variable):
requests.put('http://192.168.0.100/restapi/snmp/community_mappings/'+str(_community_mapping_index)+'/community/',auth=auth,headers=headers,json='DTGA1wWg5')
User
| string | snmp/community_mappings/N/user/ |
| The user identifier | |
The value is subject to the following constraints: users[the value]
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample curl write command (note that :community_mapping_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"user1Db7xt\"" "http://192.168.0.100/restapi/snmp/community_mappings/:community_mapping_index/user/"
Sample JS request write command (note that _community_mapping_index is a variable):
request.put({url:"snmp/community_mappings/"+_community_mapping_index.toString()+"/user/",body:"user6zJZ"});
IP address
| string | snmp/community_mappings/N/ip_address/ |
| IP address allowed to connect | |
The value is subject to the following constraints: the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom library read command (note that _community_mapping_index is a variable):
print(uom.dump(uom.snmp.community_mappings[_community_mapping_index].ip_address))
⇒
"10.57.78.124"
Sample requests read command (note that _community_mapping_index is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/community_mappings/'+str(_community_mapping_index)+'/ip_address/',auth=auth,headers=headers).json())
⇒
'192.168.4.150'
Network mask
| string | snmp/community_mappings/N/netmask/ |
| Network mask allowed to connect | |
The value is subject to the following constraints: the value matches ^((2(5[42]|4[80]|24)|192|128|0).0.0.0|255.(2(5[42]|4[80]|24)|192|128|0).0.0|255.255.(2(5[42]|4[80]|24)|192|128|0).0|255.255.255.(2(5[542]|4[80]|24)|192|128|0))$
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample CLI write command (note that community_mapping_index is a variable):
uom set "snmp/community_mappings/${community_mapping_index}/netmask" "\"255.255.255.0\""
Sample CLI read command (note that community_mapping_index is a variable):
uom get "snmp/community_mappings/${community_mapping_index}/netmask"
⇒
"255.0.0.0"
Known authentication methods
| map | snmp/known_auth_methods/ |
| Map of known authentication methods | |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map represents a value in persistent storage.
This map contains Authentication method elements.
Creating elements in this collection is not supported.
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/snmp/known_auth_methods/"
⇒
{"sha1":"SHA1","md5":"MD5"}
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/snmp/known_auth_methods/',auth=auth,headers=headers).json())
⇒
{'sha1': 'SHA1', 'md5': 'MD5'}
Authentication method
| string | snmp/known_auth_methods/S/ |
| Authentication method name | |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample uom library read command (note that _authentication_method is a variable):
print(uom.dump(uom.snmp.known_auth_methods[_authentication_method]))
⇒
"SHA1"
Sample curl read command (note that :authentication_method is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/snmp/known_auth_methods/:authentication_method/"
⇒
"MD5"
Known privacy methods
| map | snmp/known_priv_methods/ |
| Map of known privacy methods | |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map represents a value in persistent storage.
This map contains Privacy method elements.
Creating elements in this collection is not supported.
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/snmp/known_priv_methods/',auth=auth,headers=headers).json())
⇒
{'aes': 'AES', 'des': 'DES'}
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/snmp/known_priv_methods/"
⇒
{"aes":"AES","des":"DES"}
Privacy method
| string | snmp/known_priv_methods/S/ |
| Privacy method name | |
Retrieving the value is denied if not administrative user
This string does not support direct modification.
This string represents a value in persistent storage.
Sample JS request read command (note that _privacy_method is a variable):
request.get({url:"snmp/known_priv_methods/"+_privacy_method+"/"},function(error,response,body) {console.log(body)});
⇒
"DES"
Sample requests read command (note that _privacy_method is a variable):
print(requests.get('http://192.168.0.100/restapi/snmp/known_priv_methods/'+_privacy_method+'/',auth=auth,headers=headers).json())
⇒
'AES'
