View Source snmp_user_based_sm_mib (snmp v5.15)
Instrumentation Functions for SNMP-USER-BASED-SM-MIB
The module snmp_user_based_sm_mib
implements the instrumentation functions for
the SNMP-USER-BASED-SM-MIB, and functions for configuring the database.
Note that authentication has been extended according to RFC 7860 (SNMP-USM-HMAC-SHA2-MIB).
The configuration files are described in the SNMP User's Manual.
Summary
Functions
add_user(EngineID, Name, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> Ret
configure(ConfDir) -> void()
delete_user(Key) -> Ret
reconfigure(ConfDir) -> void()
Functions
add_user(EngineID, Name, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey)
View Sourceadd_user(EngineID, Name, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> Ret
Adds a USM security data (user) to the agent config. Equivalent to one line in
the usm.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 file read is: usm.conf
.
delete_user(Key) -> Ret
Delete a USM security data (user) 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-USER-BASED-SM-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 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.