STATE_DISABLED STATE_ENABLED PRIV_PROTOCOL_DES PRIV_PROTOCOL_NONE PRIV_PROTOCOL_AES PREFIX_EXACT PREFIX_PREFIX DISKCHECK_SIZE DISKCHECK_PERCENT LEVEL_NOAUTH LEVEL_AUTH LEVEL_PRIV SINK_TRAPSINK SINK_TRAP2SINK SINK_INFORMSINK AUTH_MD5 AUTH_SHA AUTH_NONE MODEL_ANY MODEL_V1 MODEL_V2C MODEL_USM VIEW_INCLUDED VIEW_EXCLUDED TRANSPORT_UDP TRANSPORT_TCP TRANSPORT_UDP6 TRANSPORT_TCP6 Creates a process check. A process check is used to check to see if the process_name's processes are running on the agent's 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'd program is not found on the process table as reported by PSCMD.

Gets a list of process checks. A process check is used to check to see if the process_name'd processes are running on the agent's 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'd program is not found on the process table as reported by PSCMD.

Removes a process check. A process check is used to check to see if the process_name's processes are running on the agent's 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's program is not found on the process table as reported by PSCMD.

Sets a process fix instance that registers a command that knows how to fix errors with the given process.

Retrieves a list of the current process fix instances.

Removes a process fix instance.

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.

Gets a list of program instances.

Removes a program instance.

Sets an exec fix instance that registers a command that knows how to fix errors with the given program.

Gets a list of exec fix instances.

Removes an exec fix instance.

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.

Gets a list of disk check instances.

Removes a disk check instance.

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).

Return a list of disk devices currently ignored.

Removes a disk device from the ignore list.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

Adds a file check used to monitor file sizes and make sure they don't grow beyond a certain size (in kilobytes).

Gets a list of available file checks.

Removes a file check.

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.

Gets load check.

Removes a load check.

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Sets the 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.

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes the AgentX information.

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.

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.

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.

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.

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.

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.

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.

Gets a list of read-only communities.

Removes read-only communities.

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.

Gets a list of read-write communities.

Removes read-write communities.

Creates SNMPv3 USM read-only users in the VACM access configuration tables.

Gets a list of the SNMPv3 USM read-only users in the VACM access configuration tables.

Removes SNMPv3 USM read-only users from the VACM access configuration tables.

Creates SNMPv3 USM read-write users in the VACM access configuration tables.

Gets a list of the SNMPv3 USM read-write users in the VACM access configuration tables.

Removes SNMPv3 USM read-write users from the VACM access configuration tables.

Creates mappings from a source/community pair to security names. The first source/community combination that matches the incoming packet is selected.

Gets a list of mappings from a source/community pair to security name.

Removes mappings from a source/community pair to security names.

Creates mappings from securitymodel/securityname to group.

Gets a list of mappings from securitymodel/securityname to group.

Removes mappings from securitymodel/securityname to group.

Creates named views.

Gets a list of named views.

Removes a list of named views.

Creates access maps from group/securitymodel/security level to a view.

Gets a list of access maps from group/securitymodel/security level to a view.

Removes access maps from group/securitymodel/security level to a view.

Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine id to be able to respond to SNMPv3 messages.

Gets the snmp engine identifier.

Removes the snmp engine identifier.

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.

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.

Removes SNMPv3 users.

Sets the system location, system contact, and system name for the agent. This information is reported in the 'system' 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).

Gets the system location, system contact, and system name for the agent. This information is reported in the 'system' group in the mibII tree.

Removes the system location, system contact, and system name for the agent. This information is reported in the 'system' 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).

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.

Gets a list of agent listen addresses.

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.

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 #.

Gets the agent group id.

Removes the agent group 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 '#'.

Gets the agent user id.

Removes the ugent ser id.

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.

Gets the agent interface information.

Removes the agent interface information.

Sets the authentication trap enabled state. Setting the trap state to Enabled, enables the generation of authentication failure traps. The default value is Disabled.

Gets the authentication trap enabled 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.

Sets the agent trap enabled state.

Gets the agent trap enabled 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.

Sets the trap community string. This defines the default community string to be used when sending traps.

Gets the trap community string.

Removes the trap community string. Note: As of v9.4.2, this method actually sets the trap community string back to the default.

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.

Returns a list of trap sinks.

Removes a list of trap sinks.

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.

This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list of generic traps.

This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes a list of generic traps.

Creates generic traps that allows any type of trap destination to be specified with any version of SNMP.

Gets a list of generic traps.

Removes a list of generic traps.

Creates a list of snmp proxies. This specifies that any incoming request under oid should be proxied on to a remote host instead.

Gets a list of snmp proxies.

Removes a list of snmp proxies.

Creates a list of pass through controls. This passes entire control of the mib oid to the executing program.

Gets a list of pass through controls.

Removes a list of pass through controls.

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.

Gets a list of persist pass through controls.

Removes a list of persist pass through controls.

Creates a list of client access controls. These are stored in the /etc/hosts.allow file.

Gets a list of client access controls.

Removes a list of client access controls.

Gets the version information for this interface.

Creates a process check. A process check is used to check to see if the process_name's processes are running on the agent's 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'd program is not found on the process table as reported by PSCMD.

Gets a list of process checks. A process check is used to check to see if the process_name'd processes are running on the agent's 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'd program is not found on the process table as reported by PSCMD.

Removes a process check. A process check is used to check to see if the process_name's processes are running on the agent's 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's program is not found on the process table as reported by PSCMD.

Sets a process fix instance that registers a command that knows how to fix errors with the given process.

Retrieves a list of the current process fix instances.

Removes a process fix instance.

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.

Gets a list of program instances.

Removes a program instance.

Sets an exec fix instance that registers a command that knows how to fix errors with the given program.

Gets a list of exec fix instances.

Removes an exec fix instance.

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.

Gets a list of disk check instances.

Removes a disk check instance.

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).

Return a list of disk devices currently ignored.

Removes a disk device from the ignore list.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

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 'Network Disks' 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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

Adds a file check used to monitor file sizes and make sure they don't grow beyond a certain size (in kilobytes).

Gets a list of available file checks.

Removes a file check.

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.

Gets load check.

Removes a load check.

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Sets the 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.

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes the AgentX information.

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.

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.

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.

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.

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.

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.

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.

Gets a list of read-only communities.

Removes read-only communities.

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.

Gets a list of read-write communities.

Removes read-write communities.

Creates SNMPv3 USM read-only users in the VACM access configuration tables.

Gets a list of the SNMPv3 USM read-only users in the VACM access configuration tables.

Removes SNMPv3 USM read-only users from the VACM access configuration tables.

Creates SNMPv3 USM read-write users in the VACM access configuration tables.

Gets a list of the SNMPv3 USM read-write users in the VACM access configuration tables.

Removes SNMPv3 USM read-write users from the VACM access configuration tables.

Creates mappings from a source/community pair to security names. The first source/community combination that matches the incoming packet is selected.

Gets a list of mappings from a source/community pair to security name.

Removes mappings from a source/community pair to security names.

Creates mappings from securitymodel/securityname to group.

Gets a list of mappings from securitymodel/securityname to group.

Removes mappings from securitymodel/securityname to group.

Creates named views.

Gets a list of named views.

Removes a list of named views.

Creates access maps from group/securitymodel/security level to a view.

Gets a list of access maps from group/securitymodel/security level to a view.

Removes access maps from group/securitymodel/security level to a view.

Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine id to be able to respond to SNMPv3 messages.

Gets the snmp engine identifier.

Removes the snmp engine identifier.

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.

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.

Removes SNMPv3 users.

Sets the system location, system contact, and system name for the agent. This information is reported in the 'system' 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).

Gets the system location, system contact, and system name for the agent. This information is reported in the 'system' group in the mibII tree.

Removes the system location, system contact, and system name for the agent. This information is reported in the 'system' 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).

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.

Gets a list of agent listen addresses.

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.

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 #.

Gets the agent group id.

Removes the agent group 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 '#'.

Gets the agent user id.

Removes the ugent ser id.

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.

Gets the agent interface information.

Removes the agent interface information.

Sets the authentication trap enabled state. Setting the trap state to Enabled, enables the generation of authentication failure traps. The default value is Disabled.

Gets the authentication trap enabled 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.

Sets the agent trap enabled state.

Gets the agent trap enabled 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.

Sets the trap community string. This defines the default community string to be used when sending traps.

Gets the trap community string.

Removes the trap community string. Note: As of v9.4.2, this method actually sets the trap community string back to the default.

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.

Returns a list of trap sinks.

Removes a list of trap sinks.

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.

This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list of generic traps.

This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes a list of generic traps.

Creates generic traps that allows any type of trap destination to be specified with any version of SNMP.

Gets a list of generic traps.

Removes a list of generic traps.

Creates a list of snmp proxies. This specifies that any incoming request under oid should be proxied on to a remote host instead.

Gets a list of snmp proxies.

Removes a list of snmp proxies.

Creates a list of pass through controls. This passes entire control of the mib oid to the executing program.

Gets a list of pass through controls.

Removes a list of pass through controls.

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.

Gets a list of persist pass through controls.

Removes a list of persist pass through controls.

Creates a list of client access controls. These are stored in the /etc/hosts.allow file.

Gets a list of client access controls.

Removes a list of client access controls.

Gets the version information for this interface.

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