Management::SNMPConfiguration

Introduced : BIG-IP_v9.0
The SNMPConfiguration interface allows users to manage the full configurations for UCD SNMP agent. Please read the manual pages for snmpd.conf for further information. TODO: Missing directives: - override

Methods

Method Description Introduced
get_access_info Gets a list of access maps from group/securitymodel/security level to a view. BIG-IP_v9.0
get_agent_group_id Gets the agent group id. BIG-IP_v9.0
get_agent_interface Gets the agent interface information. BIG-IP_v9.0
get_agent_listen_address Gets a list of agent listen addresses. BIG-IP_v9.0
get_agent_trap_state Gets the agent trap enabled state BIG-IP_v9.0
get_agent_user_id Gets the agent user id. BIG-IP_v9.0
get_agentx_information This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets the AgentX information. BIG-IP_v9.0
get_auth_trap_state Gets the authentication trap enabled state BIG-IP_v9.0
get_check_disk Gets a list of disk check instances. BIG-IP_v9.0
get_check_file Gets a list of available file checks. BIG-IP_v9.0
get_check_load Gets load check. BIG-IP_v9.0
get_check_process Gets a list of process checks. A process check is used to check to see if the process_name&aposd processes are running on the agent&aposs machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name&aposd program is not found on the process table as reported by PSCMD. BIG-IP_v9.0
get_client_access Gets a list of client access controls. BIG-IP_v9.0
get_community_to_security_info Gets a list of mappings from a source/community pair to security name. BIG-IP_v9.0
get_create_user Gets a list of SNMPv3 users. Since the authentication and private passphrases have already been munged by snmpd, this information will not be available in the response. Only the user_name, the auth_type, and priv_protocol fields in the UserInformation structure are available. BIG-IP_v9.0
get_dynamic_loadable_module This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets a list of dynamically loadable module instances. BIG-IP_v9.0
get_engine_id Gets the snmp engine identifier. BIG-IP_v9.0
get_exec Gets a list of program instances. BIG-IP_v9.0
get_exec_fix Gets a list of exec fix instances. BIG-IP_v9.0
get_generic_traps This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list of generic traps. BIG-IP_v9.0
get_generic_traps_v2 Gets a list of generic traps. BIG-IP_v9.2.0
get_group_info Gets a list of mappings from securitymodel/securityname to group. BIG-IP_v9.0
get_ignore_disk Return a list of disk devices currently ignored. BIG-IP_v9.0
get_pass_through Gets a list of pass through controls. BIG-IP_v9.0
get_pass_through_persist Gets a list of persist pass through controls. BIG-IP_v9.0
get_process_fix Retrieves a list of the current process fix instances. BIG-IP_v9.0
get_proxy Gets a list of snmp proxies. BIG-IP_v9.0
get_readonly_community Gets a list of read-only communities. BIG-IP_v9.0
get_readonly_user Gets a list of the SNMPv3 USM read-only users in the VACM access configuration tables. BIG-IP_v9.0
get_readwrite_community Gets a list of read-write communities. BIG-IP_v9.0
get_readwrite_user Gets a list of the SNMPv3 USM read-write users in the VACM access configuration tables. BIG-IP_v9.0
get_smux_subagent This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets a list of SMUX based sub-agents. BIG-IP_v9.0
get_storage_use_nfs This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &aposNetwork Disks&apos in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &aposFixed Disks&apos as it has been in previous versions of the ucd-snmp SNMP agent. BIG-IP_v9.0
get_system_information Gets the system location, system contact, and system name for the agent. This information is reported in the &apossystem&apos group in the mibII tree. BIG-IP_v9.0
get_trap_community Gets the trap community string. BIG-IP_v9.0
get_trap_sinks Returns a list of trap sinks. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.0
get_view_info Gets a list of named views. BIG-IP_v9.0
remove_access_info Removes access maps from group/securitymodel/security level to a view. BIG-IP_v9.0
remove_agent_group_id Removes the agent group id. BIG-IP_v9.0
remove_agent_interface Removes the agent interface information. BIG-IP_v9.0
remove_agent_listen_address Removes a list of agent listen addresses. Note: As of v9.4.2, this method actually sets the agent listen addresses back to the default. BIG-IP_v9.0
remove_agent_trap_state Removes the agent trap enabled state. Note: As of v9.4.2, this method actually sets the agent trap enabled state back to the default. BIG-IP_v9.0
remove_agent_user_id Removes the ugent ser id. BIG-IP_v9.0
remove_agentx_information This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes the AgentX information. BIG-IP_v9.0
remove_auth_trap_state Removes the authentication trap enabled state. Note: As of v9.4.2, this method actually sets the authentication trap enabled state back to the default. BIG-IP_v9.0
remove_check_disk Removes a disk check instance. BIG-IP_v9.0
remove_check_file Removes a file check. BIG-IP_v9.0
remove_check_load Removes a load check. BIG-IP_v9.0
remove_check_process Removes a process check. A process check is used to check to see if the process_name&aposs processes are running on the agent&aposs machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name&aposs program is not found on the process table as reported by PSCMD. BIG-IP_v9.0
remove_client_access Removes a list of client access controls. BIG-IP_v9.0
remove_community_to_security_info Removes mappings from a source/community pair to security names. BIG-IP_v9.0
remove_create_user Removes SNMPv3 users. BIG-IP_v9.0
remove_dynamic_loadable_module This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes a dynamically loadable module instance. BIG-IP_v9.0
remove_engine_id Removes the snmp engine identifier. BIG-IP_v9.0
remove_exec Removes a program instance. BIG-IP_v9.0
remove_exec_fix Removes an exec fix instance. BIG-IP_v9.0
remove_generic_traps This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes a list of generic traps. BIG-IP_v9.0
remove_generic_traps_v2 Removes a list of generic traps. BIG-IP_v9.2.0
remove_group_info Removes mappings from securitymodel/securityname to group. BIG-IP_v9.0
remove_ignore_disk Removes a disk device from the ignore list. BIG-IP_v9.0
remove_pass_through Removes a list of pass through controls. BIG-IP_v9.0
remove_pass_through_persist Removes a list of persist pass through controls. BIG-IP_v9.0
remove_process_fix Removes a process fix instance. BIG-IP_v9.0
remove_proxy Removes a list of snmp proxies. BIG-IP_v9.0
remove_readonly_community Removes read-only communities. BIG-IP_v9.0
remove_readonly_user Removes SNMPv3 USM read-only users from the VACM access configuration tables. BIG-IP_v9.0
remove_readwrite_community Removes read-write communities. BIG-IP_v9.0
remove_readwrite_user Removes SNMPv3 USM read-write users from the VACM access configuration tables. BIG-IP_v9.0
remove_smux_subagent This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes a SMUX based sub-agent. BIG-IP_v9.0
remove_storage_use_nfs This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &aposNetwork Disks&apos in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &aposFixed Disks&apos as it has been in previous versions of the ucd-snmp SNMP agent. BIG-IP_v9.0
remove_system_information Removes the system location, system contact, and system name for the agent. This information is reported in the &apossystem&apos group in the mibII tree. Note: As of v9.4.2, this method actually sets the system location and contact parameters and the system services parameter back to the default. As has always been the case, this method affects values only for the system information items you provide (non-empty/non-zero). BIG-IP_v9.0
remove_trap_community Removes the trap community string. Note: As of v9.4.2, this method actually sets the trap community string back to the default. BIG-IP_v9.0
remove_trap_sinks Removes a list of trap sinks. BIG-IP_v9.0
remove_view_info Removes a list of named views. BIG-IP_v9.0
set_access_info Creates access maps from group/securitymodel/security level to a view. BIG-IP_v9.0
set_agent_group_id Sets the agent group id. Change to this gid after opening port. The group id may refer to a group by name or a number if the group number starts with a #. BIG-IP_v9.0
set_agent_interface Sets the interface information for the agent. For interfaces where the agent fails to guess correctly on the type and speed, this directive can supply additional information. BIG-IP_v9.0
set_agent_listen_address Sets a list of agent listen addresses. This makes the agent listen on the specified list of sockets instead of the default port, which is 161. BIG-IP_v9.0
set_agent_trap_state Sets the agent trap enabled state. BIG-IP_v9.0
set_agent_user_id Sets the agent user id. Change to this uid after opening port. The userid may refer to a user by name or a number if the user number starts with &apos#&apos. BIG-IP_v9.0
set_agentx_information This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Sets the AgentX information. BIG-IP_v9.0
set_auth_trap_state Sets the authentication trap enabled state. Setting the trap state to Enabled, enables the generation of authentication failure traps. The default value is Disabled. BIG-IP_v9.0
set_check_disk Creates a disk check instance. This is used to check the named disks mounted on path for available disk space. If the disk space is less than minimum_space (kb or %), the associated entry in the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will be set to (1) and a descriptive error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG. BIG-IP_v9.0
set_check_file Adds a file check used to monitor file sizes and make sure they don&apost grow beyond a certain size (in kilobytes). BIG-IP_v9.0
set_check_load Adds a load check used to check the load average of the machine and returns an error flag (1), and a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute, or 15-minute averages exceed the associated maximum values. BIG-IP_v9.0
set_check_process Creates a process check. A process check is used to check to see if the process_name&aposs processes are running on the agent&aposs machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name&aposd program is not found on the process table as reported by PSCMD. BIG-IP_v9.0
set_client_access Creates a list of client access controls. These are stored in the /etc/hosts.allow file. BIG-IP_v9.0
set_community_to_security_info Creates mappings from a source/community pair to security names. The first source/community combination that matches the incoming packet is selected. BIG-IP_v9.0
set_create_user Creates SNMPv3 users. Note: as of v9.4.2, doing this method without having done set_readonly_user or set_readwrite_user first results in a valid (readonly) user rather than silently creating an incomplete but unusable user. However, such behavior is not guaranteed; please do one of the above methods before this method so as to define your new user fully. BIG-IP_v9.0
set_dynamic_loadable_module This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Creates a dynmically loadable module instance. If the agent is built with support for the UCD-DLMOD-MIB it is cabable of loading agent MIB modules dynamically at startup through the dlmod directive and during runtime through the use of the UCD-DLMOD-MIB. The directive loads the shared object module file path which uses the module name prefix. BIG-IP_v9.0
set_engine_id Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine id to be able to respond to SNMPv3 messages. BIG-IP_v9.0
set_exec Creates a program instance, used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG mib columns. The mib_num.ERRORMSG mib contains the entire STDOUT output, one mib table entry per line of output. BIG-IP_v9.0
set_exec_fix Sets an exec fix instance that registers a command that knows how to fix errors with the given program. BIG-IP_v9.0
set_generic_traps This method is now deprecated. Use method set_generic_traps_v2 instead. Creates generic traps that allows any type of trap destination to be specified with any version of SNMP. BIG-IP_v9.0
set_generic_traps_v2 Creates generic traps that allows any type of trap destination to be specified with any version of SNMP. BIG-IP_v9.2.0
set_group_info Creates mappings from securitymodel/securityname to group. BIG-IP_v9.0
set_ignore_disk Adds disk devices to the ignore list. When scanning for available disk devices the agent might block in trying to open all possible disk devices. This might lead to a timeout wheen walking the device tree. Sometimes it will timeout every time you try it. Adding a ignore disk directive will specify device names not to be checked (i.e. opened). BIG-IP_v9.0
set_pass_through Creates a list of pass through controls. This passes entire control of the mib oid to the executing program. BIG-IP_v9.0
set_pass_through_persist Creates a list of persist pass through controls. This passes entire control of the mib oid to the executing program. This is similar to set_path_through(), but the executing program continues to run after the initial request is answered. BIG-IP_v9.0
set_process_fix Sets a process fix instance that registers a command that knows how to fix errors with the given process. BIG-IP_v9.0
set_proxy Creates a list of snmp proxies. This specifies that any incoming request under oid should be proxied on to a remote host instead. BIG-IP_v9.0
set_readonly_community Creates read-only communities that can be used to access the agent. snmpd supports the View-Based Access Control Model (vacm) as defined in RFC 2275. BIG-IP_v9.0
set_readonly_user Creates SNMPv3 USM read-only users in the VACM access configuration tables. BIG-IP_v9.0
set_readwrite_community Creates read-write communities that can be used to access the agent. snmpd supports the View-Based Access Control Model (vacm) as defined in RFC 2275. BIG-IP_v9.0
set_readwrite_user Creates SNMPv3 USM read-write users in the VACM access configuration tables. BIG-IP_v9.0
set_smux_subagent This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Creates a SMUX based sub-agent, such as gated. BIG-IP_v9.0
set_storage_use_nfs This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Adds a directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &aposNetwork Disks&apos in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &aposFixed Disks&apos as it has been in previous versions of the ucd-snmp SNMP agent. BIG-IP_v9.0
set_system_information Sets the system location, system contact, and system name for the agent. This information is reported in the &apossystem&apos group in the mibII tree. As has always been the case, this method sets values only for the system information items you provide (non-empty/non-zero). BIG-IP_v9.0
set_trap_community Sets the trap community string. This defines the default community string to be used when sending traps. BIG-IP_v9.0
set_trap_sinks Creates a list of trap sinks. This method create definitions for hosts to receive traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps on authentication failures. BIG-IP_v9.0
set_view_info Creates named views. BIG-IP_v9.0

Structures

Structure

Description

AccessInformation

A struct that describes the mapping from group/securitymodel/security level to a view.

AgentInterface

For interfaces where the agent fails to correctly guess the type and speed, this directive can supply additional information.

AgentListenAddressPort

Makes the agent listen on the specified list of sockets instead of the default port, which is port 161.

AgentXInformation

This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. A struct that describes AgentX information.

ClientAccess

A struct that describes a client access definition consisting of an address and netmask.

DiskCheckInformation

This struct is used to check the named disks mounted at disk_path for available disk space. If the disk space is less than minimum_space (kb), the associated entry in the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will be set to (1) and a descriptive error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG.

DynamicLoadableModule

This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. If the agent is built with support for the UCD-DLMOD-MIB, it is cabable of loading agent MIB modules dynamically at startup through the dlmod directive and during runtime through the use of the UCD-DLMOD-MIB. The directive loads the shared object module file path which uses the module name prefix.

FileCheckInformation

Used to monitor file sizes and make sure they don&apost grow beyond a certain size (in kilobytes).

GenericSinkInformation

This structure is now deprecated. Use structure GenericSinkInformation2 instead. This is a more generic trap configuration that allows any type of trap destination to be specified with any version of SNMP. See the snmpcmd(1) manual page for further details on the arguments that can be passed with snmpcmd_args. In addition to the arguments listed there, the special argument -Ci specifies that you want inform notifications to be used instead of unacknowledged traps (this requires that you also specify a version number of v2c or v3 as well).

GenericSinkInformation2

This is a more generic trap configuration (trapsess directive) that allows any type of trap destination to be specified with any version of SNMP. See the snmpcmd(1) manual page for further details on the arguments that can be passed with snmpcmd_args. In addition to the arguments listed there, the special argument -Ci specifies that you want inform notifications to be used instead of unacknowledged traps (this requires that you also specify a version number of v2c or v3 as well).

GroupInformation

A struct that describes the mapping from securitymodel/securityname to a group.

LoadAverageInformation

Used to check the load average of the machine and returns an error flag (1), and a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute, or 15-minute averages exceed the associated maximum values.

MibnumNameProgArgs

Used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG mib columns. The mib_num.ERRORMSG mib contains the entire STDOUT output, one mib table entry per line of output.

NameProgArgs

Used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORMSG mib columns. All STDOUT output beyond the first line is silently truncated.

PassThroughInformation

A struct that describes the passing of entire control of mib_oid to the exec_name program.

ProcessInformation

Used to check to see if the process_name&aposd processes are running on the agent&aposs machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name&aposs program is not found on the process table as reported by PSCMD.

ProxyInformation

A struct that describes an snmp proxy. It specifies that any incoming requests under local_oid should be proxied on the remote_host instead.

SecurityInformation

A struct that describes the mapping from a source/community pair to a security name.

SinkInformation

A struct that describes a trap destination.

SmuxSubAgentInformation

This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. A struct that describes a smux sub agent.

SystemInformation

A struct that describes information about the given system.

UserInformation

A struct that describes a user&aposs security information.

ViewInformation

A struct that describes a named view.

WrapperSecurityInformation

A struct that describes a set of security information.

WrapperUserInformation

A struct that describes a SNMPv3 USM user in the VACM access configuration tables.


Enumerations

Enumeration Description
AuthType A list of snmp authentication types.
DiskCheckType The available disk check types.
LevelType A list of snmp level types.
ModelType A list of snmp model types.
PrefixType A list of snmp prefix types.
PrivacyProtocolType A list of snmp privacy protocol types.
SinkType These types define the hosts to receive traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps on authentication failures. Multiple trapsink, trap2sink, and informsink lines may be specified to specify mulitple destinations. Use trap2sink to send SNMPv2 traps and informsink to send inform notifications.
TransportType A list of snmp transport types.
ViewType A list of snmp view types.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
AccessInformationSequence AccessInformation [] A sequence of AccessInformation structures.
AgentListenAddressPortSequence AgentListenAddressPort [] A sequence of AgentListenAddressPort structures.
AgentXInformationSequence AgentXInformation [] This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system.
ClientAccessSequence ClientAccess [] A sequence of ClientAccess structures.
DiskCheckInformationSequence DiskCheckInformation [] A sequence of DiskCheckInformation structures.
DynamicLoadableModuleSequence DynamicLoadableModule [] This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system.
FileCheckInformationSequence FileCheckInformation [] A sequence of FileCheckInformation structures.
GenericSinkInformation2Sequence GenericSinkInformation2 [] A sequence of GenericSinkInformation2 structures.
GenericSinkInformationSequence GenericSinkInformation [] A sequence of GenericSinkInformation structures.
GroupInformationSequence GroupInformation [] A sequence of GroupInformation structures.
LoadAverageInformationSequence LoadAverageInformation [] A sequence of LoadAverageInformation structures.
MibnumNameProgArgsSequence MibnumNameProgArgs [] A sequence of MibnumNameProgArgs structures.
NameProgArgsSequence NameProgArgs [] A sequence of NameProgArgs structures.
PassThroughInformationSequence PassThroughInformation [] A sequence of PassThroughInformation structures.
ProcessInformationSequence ProcessInformation [] A sequence of ProcessInformation structures.
ProxyInformationSequence ProxyInformation [] A sequence of ProxyInformation structures.
SecurityInformationSequence SecurityInformation [] A sequence of SecurityInformation structures.
SinkInformationSequence SinkInformation [] A sequence of SinkInformation structures.
SmuxSubAgentInformationSequence SmuxSubAgentInformation [] This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system.
UserInformationSequence UserInformation [] A sequence of UserInformation structures.
ViewInformationSequence ViewInformation [] A sequence of ViewInformation structures.
WrapperSecurityInformationSequence WrapperSecurityInformation [] A sequence of WrapperSecurityInformation structures.
WrapperUserInformationSequence WrapperUserInformation [] A sequence of WrapperUserInformation structures.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


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.