PATCH /api/lunasa/snmp/trap

This resource configures specified SNMP trap parameters.

Parameters

address

This parameter specifies the ip address or hostname that receives traps.

Use: Not Required

JSON Schema:

    Object
    type:string

securityName

This parameter specifies the SNMP user to associate traps with. Note: This is user that is created with POST /api/lunasa/snmp/users

Use: Not Required

JSON Schema:

    Object
    type:string

engineId

Specifies the engine that receives traps 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).

Use: Not Required

JSON Schema:

    Object
    type:string

authenticationPassword

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

Use: Not Required

JSON Schema:

    Object
    type:string

authenticationProtocol

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

Use: Not Required

JSON Schema:

    Object
    type:string

privacyPassword

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

Use: Not Required

JSON Schema:

    Object
    type:string

privacyProtocol

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

Use: Not Required

JSON Schema:

    Object
    type:string

Responses

204

Success.

400

Unexpected failure.

404

Security name does not exist.

Example Request

    PATCH
    https://1.2.3.4:8443/api/lunasa/snmp/trap
    {
        "address": "1.2.3.5",
        "securityName" : "myUser"
    }

Example Response

{
}

Notes

This resource is only to modify the current configuration of the trap. In order to do the initial trap configuration see PUT /api/lunasa/snmp/trap