Get SNMP Trap on Element (v2.0)
GET/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/snmptraps/:snmptrap_id
List the configured SNMP trap on an element.
Request
Path Parameters
ID of the tenant.
ID of the site.
ID of the element.
The SNMP trap configuration ID.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The description of the SNMP trap. Max - 256. Max characters = 256.
The SNMP Trap option is enabled. For this, the Disabled option must be unchecked.
The ID of the SNMP trap configuration.
The SNMP server or manager’s IP address.
The source interface for the SNMP server.
A information field that can be added to identify the SNMP trap configuration.
v2_config SNMPV2Config
Indicates if SNMP v2 is enabled.
If V2 is enabled, community is configured. If community is not configured, then public will be set as the default community. White spaces not allowed in community name. Max characters = 32.
v3_config SNMPV3Config
Indicates if SNMP v3 is enabled.
user_access SNMPUserAccessrequired
The SNMP configuration user access.
The authentication phrase of 8 to 25 characters if auth type is selected.
Possible values: [NONE
, MD5
, SHA
]
The authentication type. Auth Type may be MD5, SHA, or None.
The encryption phrase of 8 to 25 characters if encryption type is selected.
Possible values: [NONE
, AES
, DES
]
The encrption type.
The SNMP configuration supported engine ID. Hexadecimal value should be in pairs (multiple of two) with minimum length 10 and maximum length 256.
Possible values: [NOAUTH
, AUTH
, PRIVATE
]
The security level of the SNMP configuration.
The user name to identify the device. User name length should be between 4 and 256.
Possible values: [V2
, V3
]
The version of the SNMP configuration.
{
"enabled": true,
"id": "string",
"server_ip": "string",
"source_interface": "string",
"tags": [
"string"
],
"v2_config": {
"community": "string"
},
"v3_config": {
"user_access": {
"auth_phrase": "string",
"auth_type": "NONE",
"enc_phrase": "string",
"enc_type": "NONE",
"engine_id": "string",
"security_level": "NOAUTH",
"user_name": "string"
}
},
"version": "V2"
}