SNMP Configuration
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
JSON Table
Attribute | Data Type | Description |
---|---|---|
policyCreatedAtLocId | application/json | ID of the location where policy is created. The value is of the type Location ID JSON. |
policyType | String | A read-only field for internal use. |
snmpIntegrationEnabled | boolean | A true or false value indicating whether to enable the integration with SNMP servers or not. When SNMP integration is enabled , the system sends SNMP traps to the configured SNMP servers. |
snmpSettings | application/json | |
snmpSettings/versionOneTwoSettings | ||
snmpSettings/versionOneTwoSettings/enableGets | ||
snmpSettings/versionOneTwoSettings/communityString | String | |
snmpSettings/versionThreeSettings | application/json | |
snmpSettings/versionThreeSettings/enableGets | ||
snmpSettings/versionThreeSettings/userName | String | Name of the SNMPv3 user. |
snmpSettings/versionThreeSettings/authenticationPassword | String | The password used to generate the key for authentication. |
snmpSettings/versionThreeSettings/privacyPassword | String | The password used to generate the key for encryption. |
snmpSettings/versionThreeSettings/authenticationProtocol | enum | |
snmpSettings/versionThreeSettings/privacyProtocol | enum | |
snmpSettings/versionThreeSettings/engineId | String | The Engine ID is only used by SNMPv3 entities to uniquely identify them. |
snmpSettings/getEnabled | boolean | A true or false value indicating whether to allow SNMP managers to query server-operatng parameters enlisted in IF-MIB, MIB-|| and Host Resources MIB or not. If set to false it blocks queries related to all MIBs. |
snmpSettings/trapEnabled | boolean | A true or false value indicating whether to allow SNMP traps to be sent to configured SNMP server. |
snmpMib | application/json | |
snmpMib/snmpMibII | application/json | |
snmpMib/snmpMibII/systemName | String | |
snmpMib/snmpMibII/systemContact | String | |
snmpMib/snmpMibII/systemLocation | String | |
snmpMib/hostResourcesMibEnabled | boolean | |
snmpMib/interfaceMibEnabled | boolean | |
snmpMib/vendorEnabled | boolean | A true or false value indicating whether to enable the external SNMP Trap receivers to receive traps or not. |
snmpMib/mibIIEnabled | boolean | |
snmpServerlist | ||
snmpServerlist/enableTraps | boolean | A true or false value indicating whether the SNMP server is enabled to receive SNMP traps or not. |
snmpServerlist/trapPort | int | Specifies the port number on the receiving system to which the SNMP trap is sent. |
snmpServerlist/protocolVersion | enum | Specifies the SNMP protocol version for the SNMP agent. |
snmpServerlist/userName | String | SNMP version three user name. |
snmpServerlist/authenticationPassword | String | SNMP version three authentication password. |
snmpServerlist/privacyPassword | String | SNMP version three privacy password. |
snmpServerlist/authenticationType | enum | SNMP version three authentication protocol. |
snmpServerlist/privacyProtocol | enum | SNMP version three privacy protocol. |
snmpServerlist/destIpAddress |
Copy Sample JSON
Sample JSON
Response body: { "policyCreatedAtLocId": { "type": "locallocationid", "id": 0 }, "policyType": "SNMP_POLICY", "snmpIntegrationEnabled": true, "snmpSettings": { "versionOneTwoSettings": { "enableGets": false, "communityString": "public" }, "versionThreeSettings": { "enableGets": false, "userName": "admin", "authenticationPassword": "password", "privacyPassword": "password", "authenticationProtocol": "MD5", "privacyProtocol": "DES", "engineId": "0x80001F8804776966692D73656375726974792D736572766572" }, "getEnabled": false, "trapEnabled": false }, "snmpMib": { "snmpMibII": { "systemName": "Wifi Security Server", "systemContact": "", "systemLocation": "" }, "hostResourcesMibEnabled": true, "interfaceMibEnabled": true, "vendorEnabled": true, "mibIIEnabled": true }, "snmpServerlist": [ { "enableTraps": true, "trapPort": 162, "protocolVersion": "V3", "userName": "admin", "authenticationPassword": "password", "privacyPassword": "password", "authenticationType": "MD5", "privacyProtocol": "DES", "destIpAddress": "10.1.1.1" } ] }
API Calls
/V5/configuration/global/snmp
/V5/configuration/global/snmp