SnmpVersionSpecificData - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"type":"object","description":"SNMP configuration","oneOf":[{"required":["community","view"],"type":"object","properties":{"community":{"maxItems":2147483647,"minItems":1,"type":"array","description":"SNMPv2 community configuration","items":{"required":["name","tag","view"],"type":"object","properties":{"name":{"pattern":"^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$))[\\S]{1,})$","type":"string","description":"Set name of the SNMP community","example":"community_test"},"tag":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"Set alias name for SNMP community","example":"test"},"view":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP view name","example":"test"}},"description":"SNMPv2 community","$$ref":"#/components/schemas/Snmpv2Community"}},"trap":{"required":["group","target"],"type":"object","properties":{"group":{"maxItems":8,"minItems":0,"type":"array","description":"SNMPv2 trap groups","items":{"required":["enable","groupName"],"type":"object","properties":{"enable":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Trap module configuration","items":{"required":["level","module"],"type":"object","properties":{"level":{"maxItems":3,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"string","description":"Trap level","example":"critical","enum":["critical","major","minor"]}},"module":{"type":"string","description":"SNMP trap module name","example":"all","enum":["all","app-route","bfd","control","dhcp","hardware","omp","routing","security","system","vpn","bridge","policy","wwan"]}},"description":"Enable SNMP trap modules","$$ref":"#/components/schemas/SnmpTrapModule"}},"groupName":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"Trap group name","example":"trapGroup1"}},"description":"SNMPv3 trap groups","$$ref":"#/components/schemas/TrapGroup"}},"target":{"type":"array","description":"SNMPv2 target configuration","items":{"required":["communityTag","groupName","ip","port","vpnId"],"type":"object","properties":{"communityTag":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"Port number","example":"COMMUNITY_TEST"},"groupName":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMPv3 group name","example":"group1"},"ip":{"pattern":"(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))","type":"string","description":"IPv4 or IPv6 address","example":"1.1.1.3"},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Set UDP port number to connect to SNMP server","format":"int32","example":13212},"vpnId":{"type":"integer","description":"VPN ID","format":"int32","example":0,"enum":[0,512]}},"description":"SNMPv2 Target server configuration","$$ref":"#/components/schemas/Snmpv2Target"}}},"description":"SNMPv2 trap configuration","$$ref":"#/components/schemas/Snmpv2Trap"},"view":{"maxItems":2147483647,"minItems":1,"type":"array","description":"SNMPv2 view configuration","items":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP view name"},"oid":{"type":"array","description":"Configure SNMP object identifier","items":{"required":["id"],"type":"object","properties":{"exclude":{"type":"boolean","description":"Exclude the OID or not","example":false,"default":false},"id":{"pattern":"(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}","type":"string","description":"Configure identifier of subtree of MIB objects","example":"2.1.1.11.1"}},"description":"SNMP OID configuration","$$ref":"#/components/schemas/SnmpOID"}}},"description":"SNMP view configuration","$$ref":"#/components/schemas/SnmpView"}}},"description":"SNMPv2 configuration","$$ref":"#/components/schemas/SNMPv2Data"},{"required":["group","user","view"],"type":"object","properties":{"group":{"maxItems":2147483647,"minItems":1,"type":"array","description":"SNMPv3 group configuration","items":{"required":["name","securityLevel","view"],"type":"object","properties":{"name":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP group name","example":"group"},"securityLevel":{"type":"string","description":"Security Level","example":"auth-priv","enum":["no-auth-no-priv","auth-priv"]},"view":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"View name","example":"view1"}},"description":"SNMPv3 group configuration","$$ref":"#/components/schemas/Snmpv3Group"}},"trap":{"required":["group","target"],"type":"object","properties":{"group":{"maxItems":8,"minItems":0,"type":"array","description":"SNMPv3 trap groups","items":{"required":["enable","groupName"],"type":"object","properties":{"enable":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Trap module configuration","items":{"required":["level","module"],"type":"object","properties":{"level":{"maxItems":3,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"string","description":"Trap level","example":"critical","enum":["critical","major","minor"]}},"module":{"type":"string","description":"SNMP trap module name","example":"all","enum":["all","app-route","bfd","control","dhcp","hardware","omp","routing","security","system","vpn","bridge","policy","wwan"]}},"description":"Enable SNMP trap modules","$$ref":"#/components/schemas/SnmpTrapModule"}},"groupName":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"Trap group name","example":"trapGroup1"}},"description":"SNMPv3 trap groups","$$ref":"#/components/schemas/TrapGroup"}},"target":{"type":"array","description":"SNMPv3 target configuration","items":{"required":["groupName","ip","port","user","vpnId"],"type":"object","properties":{"groupName":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMPv3 group name","example":"group1"},"ip":{"pattern":"(^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))","type":"string","description":"IPv4 or IPv6 address","example":"1.1.1.3"},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Set UDP port number to connect to SNMP server","format":"int32","example":13212},"user":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMPv3 user name","example":"test1"},"vpnId":{"type":"integer","description":"VPN ID","format":"int32","example":0,"enum":[0,512],"default":0}},"description":"SNMPv3 target configuration","$$ref":"#/components/schemas/Snmpv3Target"}}},"description":"SNMPv3 trap configuration","$$ref":"#/components/schemas/Snmpv3Trap"},"user":{"maxItems":2147483647,"minItems":1,"type":"array","description":"SNMPv3 user configuration","items":{"required":["group","name"],"type":"object","properties":{"authPassword":{"pattern":"^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$","type":"string","description":"Authentication password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128","example":"authPassword"},"group":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP group name","example":"group1"},"name":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMPv3 User name","example":"user1"},"privPassword":{"pattern":"^(?:\\$CRYPT\\$.{17}|(?!(?:\\$CRYPT\\$)).{8,128})$","type":"string","description":"Privilege password, either a encrypt string starting with $CRYPT$, or a clear text string of length 8 to 128","example":"privPassword"}},"description":"SNMPv3 user","$$ref":"#/components/schemas/SNMPv3User"}},"view":{"maxItems":2147483647,"minItems":1,"type":"array","description":"SNMPv3 view configuration","items":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^(?=.{1,32}$)([^\u003c\u003e]*)$","type":"string","description":"SNMP view name"},"oid":{"type":"array","description":"Configure SNMP object identifier","items":{"required":["id"],"type":"object","properties":{"exclude":{"type":"boolean","description":"Exclude the OID or not","example":false,"default":false},"id":{"pattern":"(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}","type":"string","description":"Configure identifier of subtree of MIB objects","example":"2.1.1.11.1"}},"description":"SNMP OID configuration","$$ref":"#/components/schemas/SnmpOID"}}},"description":"SNMP view configuration","$$ref":"#/components/schemas/SnmpView"}}},"description":"SNMPv3 configuration","$$ref":"#/components/schemas/SNMPv3Data"}],"$$ref":"#/components/schemas/SnmpVersionSpecificData","title":"SnmpVersionSpecificData"}}