{"id":18309,"date":"2017-04-17T17:23:43","date_gmt":"2017-04-17T22:23:43","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=18309"},"modified":"2019-05-16T12:28:54","modified_gmt":"2019-05-16T17:28:54","slug":"snmp","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/snmp\/","title":{"rendered":"snmp"},"content":{"rendered":"

Description: SNMP server and notifications configuration<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/span><\/td>\nType<\/strong><\/span><\/td>\nDescription<\/strong><\/span><\/td>\n<\/tr>\n
__v<\/td>\nUINT<\/td>\nVersion of model. Must be set to 2.<\/td>\n<\/tr>\n
server<\/td>\nOBJECT<\/td>\nSNMP server settings<\/td>\n<\/tr>\n
\u00a0 \u00a0 enabled<\/td>\nBOOL<\/td>\nEnable SNMP server<\/td>\n<\/tr>\n
\u00a0 \u00a0 allowedAddresses<\/td>\nARRAY<\/td>\nAllowed IP addresses array<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0address<\/td>\nSTRING<\/td>\nIP address (in the ###.###.###.### format)<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0<\/strong>prefix<\/td>\nSTRING<\/td>\nNetwork prefix, e.g. 16, 24 or 32<\/td>\n<\/tr>\n
users<\/td>\nOBJECT<\/td>\nSNMPv3 server settings<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0authProto<\/td>\nSTRING<\/td>\nAuthentication protocol (MD5, SHA1 or empty) used for authentication of SNMPv3 clients<\/td>\n<\/tr>\n
\u00a0 \u00a0 authPass<\/td>\nSTRING<\/td>\nAuthentication Password (SNMPv3)<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0community<\/td>\nSTRING<\/td>\nThe read-only community string used for authentication of SNMP v1\/v2c clients<\/td>\n<\/tr>\n
\u00a0 \u00a0 enabled<\/td>\nBOOL<\/td>\nEnable the SNMP server user<\/td>\n<\/tr>\n
\u00a0 \u00a0 label<\/td>\nSTRING<\/td>\nUnique configuration entry name<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0privProto<\/td>\n<\/td>\nEncryption protocol (DES, AES-128 or empty) used for encryption of SNMPv3 messages<\/td>\n<\/tr>\n
\u00a0 \u00a0\u00a0privPass<\/td>\n<\/td>\nEncryption password (SNMPv3)<\/td>\n<\/tr>\n
\u00a0 \u00a0 username<\/td>\nSTRING<\/td>\nSNMPv3 username<\/td>\n<\/tr>\n
\u00a0 \u00a0 version<\/td>\nSTRING<\/td>\nSNMP server user version (v1\/v2c or v3)<\/td>\n<\/tr>\n
traps<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
\u00a0 \u00a0 enabled<\/td>\nBOOL<\/td>\nEnable SNMP traps to allow sending<\/td>\n<\/tr>\n
\u00a0 \u00a0 engineId<\/td>\nSTRING<\/td>\nEngine ID is a unique identifier for the SNMP agent that receives SNMP traps (hex number between 5 and 32 octets long, e.g. 0x0102030405.)<\/td>\n<\/tr>\n
\u00a0 \u00a0 engineIdDefault<\/td>\nSTRING<\/td>\nDefault Engine ID value generated automatically<\/td>\n<\/tr>\n
\u00a0 \u00a0 receivers<\/td>\nARRAY<\/td>\nList of configured SNMP trap destinations<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 address<\/td>\nSTRING<\/td>\nIP address or remote SNMP Trap server (in the ###.###.###.### format)<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 authProto<\/td>\nSTRING<\/td>\nAuthentication protocol (MD5, SHA1 or empty) used for authentication of SNMPv3 traps<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 authPass<\/td>\nSTRING<\/td>\nAuthentication Password (SNMPv3)<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 community<\/td>\nSTRING<\/td>\nCommunity string used for authentication of SNMP v1\/v2c traps<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 enabled<\/td>\nBOOL<\/td>\nEnable the SNMP trap destination<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 label<\/td>\nSTRING<\/td>\nUnique configuration entry name<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 privPass<\/td>\nSTRING<\/td>\nEncryption password (SNMPv3)<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 privProto<\/td>\nSTRING<\/td>\nEncryption protocol (DES, AES-128 or empty) used for encryption of SNMPv3 traps<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 username<\/td>\nSTRING<\/td>\nUsername for authentication on remote SNMPv3 trap server<\/td>\n<\/tr>\n
\u00a0 \u00a0 \u00a0 \u00a0 version<\/td>\nSTRING<\/td>\nSNMP traps version (v1, v2c or v3)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Description: SNMP server and notifications configuration Element Type Description __v UINT Version of model. Must be set to 2. server OBJECT SNMP server settings \u00a0 \u00a0 enabled BOOL Enable SNMP server \u00a0 \u00a0 allowedAddresses ARRAY Allowed IP addresses array \u00a0 \u00a0 \u00a0 \u00a0 \u00a0address STRING IP address (in the ###.###.###.### format) \u00a0 \u00a0 \u00a0 \u00a0 […]<\/p>\n","protected":false},"author":1478,"featured_media":0,"parent":13129,"menu_order":59,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-18309","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18309","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1478"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=18309"}],"version-history":[{"count":6,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18309\/revisions"}],"predecessor-version":[{"id":26120,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/18309\/revisions\/26120"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=18309"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}