APIRef_tm_sys_snmp

mgmt/tm/sys/snmp

/tm/sys

SNMP agent config

REST Endpoints

Collection URI
/mgmt/tm/sys/snmp
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/sys/snmp/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH

Properties

Name Type Default Value Required Access Description
agentAddresses string   optional read/write A list of protocol/address combinations that the agent listens for traffic on.
agentTrap string   optional read/write Enables or disables traps about the agent status.
allowedAddresses string   optional read/write Configures hosts or networks from which snmpd can accept traffic. Entries go directly into hosts.allow.
authTrap string   optional read/write Enable or disable generating traps on authentication failures
bigipTraps string   optional read/write Enables or disables traps about device warnings.
description string   optional read/write User defined description.
include string   optional read/write Adds information to the snmpd.conf file. Use with extreme caution or under the guidance of F5 support.
l2forwardVlan string   optional read/write Enables l2forwarding statistics for specified VLANs.
loadMax1 integer   optional read/write One minute load threshold before SNMPd sends a trap.
loadMax15 integer   optional read/write Fifteen minute load threshold before SNMPd sends a trap.
loadMax5 integer   optional read/write Five minute load threshold before SNMPd sends a trap.
snmpv1 string   optional read/write Enables the snmp agent to respond to the SNMPv1 protocol.
snmpv2c string   optional read/write Enables the snmp agent to respond to the SNMPv2c protocol.
sysContact string   optional read/write Specifies the contact information for the system administrator.
sysLocation string   optional read/write Describes the system’s physical location.
sysServices integer   optional read/write Sets the value of the system.sysServices.0 object.
trapCommunity string   optional read/write Default community name used when sending traps.
trapSource string   optional read/write Source used for sending traps.

Subcollections

Name Type Default Value Required Access Description
communities array_structure   optional read/write Specifies SNMP community strings and limits them to specific oid subsets.
traps array_structure   optional read/write Generic interface for configuring SNMP traps.
users array_structure   optional read/write Specifies user account information for use with SNMPv3.

Array Structures

Name Type Default Value Required Access Description
/disk-monitors array_structure   optional read/write Specifies disk locations to monitor and conditions for sending traps.
/disk-monitors/description string   optional read/write User defined description.
/disk-monitors/minspace integer   optional read/write If the available disk space goes below this threshold a trap is sent.
/disk-monitors/minspace-type string   optional read/write Specifies how the ‘minspace’ property is interpreted - as a percent or a size (in kB).
/disk-monitors/path string   required read/write The path on the system’s disk to monitor.
/process-monitors array_structure   optional read/write Specifies processes to monitor and conditions for sending traps.
/process-monitors/description string   optional read/write User defined description.
/process-monitors/max-processes string   optional read/write Maximum number of instances of the process that can exist before a trap is sent.
/process-monitors/min-processes integer   optional read/write Minimum number of instances of the process that must exist before a trap is sent.
/process-monitors/process string   required read/write Name of the process to monitor.
/v1-traps array_structure   optional read/write Simple interface for configuring SNMPv1 traps
/v1-traps/community string   required read/write Specifies the community string used for this trap.
/v1-traps/description string   optional read/write User defined description.
/v1-traps/host string   required read/write The host the trap will be sent to.
/v1-traps/port integer   optional read/write The port that the trap will be sent to.
/v2-traps array_structure   optional read/write Simple interface for configuring SNMPv2 traps
/v2-traps/community string   required read/write Specifies the community string used for this trap.
/v2-traps/description string   optional read/write User defined description.
/v2-traps/host string   required read/write The host the trap will be sent to.
/v2-traps/port integer   optional read/write The port that the trap will be sent to.
iControl Reference Index
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.