View Source snmp_target_mib (snmp v5.15)
Instrumentation Functions for SNMP-TARGET-MIB
The module snmp_target_mib implements the instrumentation functions for the
SNMP-TARGET-MIB, and functions for configuring the database.
The configuration files are described in the SNMP User's Manual.
Legacy API functions add_addr/10 that does not specify
transport domain, and add_addr/11 that has got separate IpAddr and
PortNumber arguments still work as before for backwards compatibility reasons.
DATA TYPES
See the data types in snmpa_conf.
Summary
Types
Note
"An octet string containing a tag value. Tag values are preferably in human-readable form."
Functions
add_addr(Name, Domain, Addr, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret
add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret
configure(ConfDir) -> void()
delete_addr(Key) -> Ret
delete_params(Key) -> Ret
reconfigure(ConfDir) -> void()
set_target_engine_id(TargetAddrName, EngineId) -> boolean()
Types
-type tag_value() :: string().
Note
"An octet string containing a tag value. Tag values are preferably in human-readable form."
OCTET STRING (SIZE (0..255))
Functions
add_addr(Name, Domain_or_Ip, Addr_or_Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS)
View Sourceadd_addr(Name, Domain, Addr, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret
Adds a target address definition to the agent config. Equivalent to one line in
the target_addr.conf file.
add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret
Adds a target parameter definition to the agent config. Equivalent to one line
in the target_params.conf file.
configure(ConfDir) -> void()
This function is called from the supervisor at system start-up.
Inserts all data in the configuration files into the database and destroys all
old rows with StorageType volatile. The rows created from the configuration
file will have StorageType nonVolatile.
All snmp counters are set to zero.
If an error is found in the configuration file, it is reported using the
function config_err/2 of the error report module, and the function fails with
the reason configuration_error.
ConfDir is a string which points to the directory where the configuration
files are found.
The configuration files read are: target_addr.conf and target_params.conf.
delete_addr(Key) -> Ret
Delete a target address definition from the agent config.
delete_params(Key) -> Ret
Delete a target parameter definition from the agent config.
reconfigure(ConfDir) -> void()
Inserts all data in the configuration files into the database and destroys all
old data, including the rows with StorageType nonVolatile. The rows created
from the configuration file will have StorageType nonVolatile.
Thus, the data in the SNMP-TARGET-MIB, after this function has been called, is the data from the configuration files.
All snmp counters are set to zero.
If an error is found in the configuration file, it is reported using the
function config_err/2 of the , and the function fails with the reason
configuration_error.
ConfDir is a string which points to the directory where the configuration
files are found.
The configuration files read are: target_addr.conf and target_params.conf.
set_target_engine_id(TargetAddrName, EngineId) -> boolean()
Changes the engine id for a target in the snmpTargetAddrTable. If
notifications are sent as Inform requests to a target, its engine id must be
set.