SNMP Management

SNMP Management Endpoints

Master/sub-agent services

• Enable/disable SNMP master/sub-agent service : PUT /api2/system/snmp/config admin
  • Json structure
• Get SNMP master/sub-agent master service set status : GET /api2/system/snmp/config admin
  • Json structure
• Get SNMP master/sub-agent master service real status : GET /api2/system/snmp/state admin
  • Json structure

Read-only users

• Get users : GET /api2/system/snmp/users admin
  • Json structure
• Get a user : GET /api2/system/snmp/users/$ admin
  • Json structure
• Add a rouser : POST /api2/system/snmp/users admin
  • Json structure
• Change a rouser : PUT /api2/system/snmp/users/$ admin
  • Json structure
• Delete a rouser : DELETE /api2/system/snmp/users/$ admin

Informsinks

• Get informsinks : GET /api2/system/snmp/informsinks admin
  • Json structure
• Add an informsink : POST /api2/system/snmp/informsinks admin
  • Json structure
• Change an informsink : PUT /api2/system/snmp/informsinks/$ admin
  • Json structure
• Delete an informsink : DELETE /api2/system/snmp/informsinks/$ admin

Communities

• Get Community : GET /api2/system/snmp/communities admin
  • Json structure
• Add an community : POST /api2/system/snmp/communities admin
  • Json structure
• Change an community : PUT /api2/system/snmp/communities/$ admin
  • Json structure
• Delete an community : DELETE /api2/system/snmp/communities/$ admin

Enable/disable SNMP/sub-agent master service JSON

{
    "enable": true
}

Read-only users JSON

[
    {
        "id":1,
        "username": "John",
        "active": true,
        "security": "noauth" / "auth" / "priv",
        "auth": "md5" / "sha",
        "auth-passphrase":"Qwerty123",
        "priv": "des" / "aes",
        "priv-passphrase":"Qwerty123"
    }
]

Informsinks JSON

[
    {
        "id":1,
        "host": "192.168.1.170",
        "protocol": "udp",
        "port":1212,
        "active": true,
        "community":"communitystring",
        "version": "v3"
    }
]

Communities JSON

[
    {
        "id":1,
        "name": "community",
        "active": true,
        "type":"rocommunity"
    }
]

Back to X2-SERIES API Home