POST /api/lunasa/snmp/users/{userid}/notifications

POST /api/lunasa/snmp/users/{userid}/notifications

This resource creates an SNMP user notification.

Parameters

userid

Specifies the user to create the notification for.

Use: Required

JSON Schema:

    Object
    type:string

address

Specifies the IPv4 or IPv6 address that receives notifications.

Use: Required

JSON Schema:

    Object
    type:string

port

Specifies the UDP port (0-65535).

Use: Required

JSON Schema:

    Object
    type:integer

authenticationPassword

Specifies and confirms the password used to authenticate SNMPv3 notification messages. Note: This password must contain between 8 and 128 characters and is case-sensitive.

Use: Required

JSON Schema:

    Object
    type:string

authenticationProtocol

Specifies the HMAC (hash-based message authentication code) algorithm used to authenticate SNMPv3 notification messages. Note: Restricted to SHA.

Use: Not Required

JSON Schema:

    Object
    type:string

privacyPassword

Specifies and confirms the password used to encrypt SNMPv3 notification messages. Note: This password must contain between 8 and 128 characters and is case-sensitive.

Use: Required

JSON Schema:

    Object
    type:string

privacyProtocol

Specifies the algorithm used to encrypt SNMPv3 notification messages. Note: Restricted to AES.

Use: Not Required

JSON Schema:

    Object
    type:string

type

Specifies the type of notification (trap, inform).

Use: Required

JSON Schema:

    Object
    type:string

engineId

Specifies the engine that receives notifications and that has the authority to control the flow of information. Note: This value represents a hexadecimal value with a length of 10, 12, 14 or 16 (excluding the prepended 0x value), if the notification type specified is of type inform this parameter will not be required.

Use: Not Required (conditional)

JSON Schema:

    Object
    type:string

Responses

204

SNMP notification created.

Location

"Location" is the URL to the newly created SNMP notification.

see GET /api/lunasa/snmp/users/{userid}/notifications/{notificationid}

400

Invalid parameters.

404

Invalid user.

Example Request

    POST
    https://1.2.3.4:8443/api/lunasa/snmp/users/myUser/notifications
    {
        "address": "1.2.3.4",
        "port" : 1504,
        "authenticationPassword" : "password",
        "authenticationProtocol" : "SHA",
        "privacyPassword" : "password2",
        "privacyProtocol" : "AES",
        "type" : "trap",
        "engineId" : "000FFFFFFFA9"
    }

Example Response

{
}