APIRef_tm_sys_snmp_trapsΒΆ

mgmt/tm/sys/snmp/traps

/tm/sys

Generic interface for configuring SNMP traps.

REST Endpoints

Collection URI
/mgmt/tm/sys/snmp/traps
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/sys/snmp/traps/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name

Properties

Name Type Default Value Required Access Description
authPassword string   optional read/write The clear text password used to authenticate the user. This field will not be displayed.
authPasswordEncrypted string   optional read/write The encrypted password used to authenticate the user.
authProtocol string   optional read/write Specifies the protocol used to authenticate the user.
community string   optional read/write Specifies the community string used for this trap.
description string   optional read/write User defined description.
engineId string   optional read/write Specifies the authoritative security engine for SNMPv3.
host string   required read/write The host name or IP address that the trap will be sent to.
network string   optional read/write Destination network for trap mgmt or other.
port integer   optional read/write The port that the trap will be sent to.
privacyPassword string   optional read/write Specifies the clear text password used to encrypt traffic. This field will not be displayed.
privacyPasswordEncrypted string   optional read/write Specifies the encrypted password used to encrypt traffic.
privacyProtocol string   optional read/write Specifies the protocol used to encrypt traffic.
securityLevel string   optional read/write Specifies whether or not traffic is encrypted and whether or not authentication is required.
securityName string   optional read/write Security name used in conjunction with SNMPv3.
version string   optional read/write SNMP version used for sending the trap.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.