Get SNMP Trap on Element (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/snmptraps

List all the configured SNMP traps on an element.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

ID of the site.

element_id stringrequired

ID of the element.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items SNMPTrap[]
Array [
description
The description of the SNMP trap. Max - 256. Max characters = 256.
enabled boolean
The SNMP Trap option is enabled. For this, the Disabled option must be unchecked.
id string
The ID of the SNMP trap configuration.
server_ip stringrequired
The SNMP server or manager’s IP address.
source_interface string
The source interface for the SNMP server.
tags string[]
A information field that can be added to identify the SNMP trap configuration.
v2_config SNMPTrapV2Config
Indicates if SNMP v2 is enabled.
community string
Community
v3_config SNMPTrapV3Config
Indicates if SNMP v3 is enabled.
user_access SNMPTrapUserAccess
User Access
auth_phrase string
Auth Phrase
auth_type string
Possible values: [NONE, MD5, SHA]
Auth Type
enc_phrase string
Enc Phrase
enc_type string
Possible values: [NONE, AES, DES]
Enc Type
engine_id string
Engine Id
security_level string
Possible values: [NOAUTH, AUTH, PRIVATE]
Security Level
user_name string
User Name
version stringrequired
Possible values: [V2, V3]
The version of the SNMP configuration.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "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"
    }
  ]
}

Loading...