SNMP Admin API

There are two parts of the SNMP admin api:

Get SNMP Profiles

The “/api/admin/switches/snmpprofiles/” GET endpoint returns a list of all SNMP Profiles.

Here is an example call:

http http://localhost:8000/api/admin/switches/snmpprofiles/ 'Authorization: Token ***34b'

The returned data will look similar to this:

HTTP/1.1 200 OK
...
[
    {
        "auth_protocol": 2,
        "community": "public",
        "context_engine_id": null,
        "context_name": null,
        "description": "",
        "id": 1,
        "name": "v2-read-only",
        "passphrase": null,
        "priv_passphrase": null,
        "priv_protocol": 3,
        "sec_level": 2,
        "udp_port": 161,
        "username": null,
        "version": 2
    },
    ...
    more snmp profiles
    ...
]

Note this is a V2 snmp profile, so passphrases, priv_protocol and sec_level are don’t cares.

Attributes

There are several parameters that need explanation to create v2 or v3 SNMP Profiles.

SNMP v2 is straight forward, you just need community

For SNMP v3, you will need to set the following values.

For auth_protocol:

MD5 = 1
SHA = 2

For priv_protocol:

DES = 1
AES = 3

and for sec_level:

NOAUTH_NOPRIV = 0
AUTH_NOPRIV = 1
AUTH_PRIV = 2

NOTE: these values can be found in the source at openl2m/switches/constants.py

Add SNMP Profile

The “/api/admin/switches/snmpprofiles/” POST endpoint allows you to create a new SNMP Profile. The new object will be returned if the call succeeds. Valid field names are as shown in the above output example.

Here is an example call to create a new SNMP v2 profile:

http --form POST http://localhost:8000/api/admin/switches/snmpprofiles/ 'Authorization: Token ***34b' name="Departmental SNMP" community="private" version="2"

and the example output:

HTTP/1.1 201 Created
...
{
    "auth_protocol": 2,
    "community": "private",
    "context_engine_id": null,
    "context_name": null,
    "description": "",
    "id": 5,
    "name": "Departmental SNMP",
    "priv_protocol": 3,
    "sec_level": 2,
    "udp_port": 161,
    "username": null,
    "version": 2
}

Note

You will need the returned SNMP Profile id for future update calls.

Other values may be supported in the future, please see the source code for more details at https://github.com/openl2m/openl2m/blob/main/openl2m/switches/constants.py

Get SNMP Details

The “/api/admin/switches/snmpprofiles/<id>/” GET endpoint returns the details about a specific SNMP Profile object.

The returned data is identical to the “create” data in the above example.

Example:

http http://localhost:8000/api/admin/switches/snmpprofiles/5/ 'Authorization: Token ***34b'

Set SNMP Profile Attributes

The “/api/admin/switches/snmpprofiles/<id>/” POST (or PATCH) endpoint allows you to change attributes of a specific Profile object. You can change one or more at the same time.

The returned data is identical to the “create” data in the above example.

The below example changes the above created SNMP v2 to a SNMP v3 AuthNoPriv configuration:

http --form POST http://localhost:8000/api/admin/switches/snmpprofiles/5/ 'Authorization: Token ***34b' version=3 sec_level=1 auth_protocol=2 username="snmp_user" passphrase="auth_secret"

and the returned data:

HTTP/1.1 200 OK
...
{
    "auth_protocol": 2,
    "community": "private",
    "context_engine_id": null,
    "context_name": null,
    "description": "",
    "id": 5,
    "name": "Departmental SNMP",
    "passphrase": "auth_secret",
    "priv_passphrase": null,
    "priv_protocol": 3,
    "sec_level": 1,
    "udp_port": 161,
    "username": "snmp_user",
    "version": 3
}