snmp_community_mib(3)

NAME
snmp_community_mib - Instrumentation Functions for SNMP-COMMUNITY-MIB

DESCRIPTION

The module snmp_community_mib implements the instrumentation functions for the SNMP-COMMUNITY-MIB, and functions for configuring the database.

The configuration files are described in the SNMP User's Manual.

DATA TYPES
index() = snmp_framework_mib:admin_string()

    SnmpAdminString (SIZE(1..32))
name() = string()

    OCTET STRING (SIZE(1..64))
security_name() = snmp_framework_mib:admin_string()

    SnmpAdminString
context_name() = snmp_framework_mib:admin_string()

    A human readable string.

    SnmpAdminString
transport_tag() = snmp_target_mib:tag_value()

    SnmpTagValue

EXPORTS

configure(ConfDir) -> snmp:void()

    Types:
        ConfDir = string()

    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 reason configuration_error.

    ConfDir is a string which points to the directory where the configuration files are found.

    The configuration file read is: community.conf.

reconfigure(ConfDir) -> snmp:void()

    Types:
        ConfDir = string()

    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-COMMUNITY-MIB, after this function has been called, is 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 reason configuration_error.

    ConfDir is a string which points to the directory where the configuration files are found.

    The configuration file read is: community.conf.

add_community(Idx, CommName, SecName, CtxName, TransportTag) ->
                 {ok, Key} | {error, Reason}
add_community(Idx, CommName, SecName, EngineId, CtxName,
              TransportTag) ->
                 {ok, Key} | {error, Reason}

    Types:
        Idx = index()
        CommName = name()
        SecName = security_name()
        EngineId = snmp_framework_mib:engine_id()
        CtxName = context_name()
        TransportTag = transport_tag()
        Key = Reason = term()

    Adds a community to the agent config. Equivalent to one line in the community.conf file.

    With the EngineId argument it is possible to override the configured engine-id (SNMP-FRAMEWORK-MIB).

delete_community(Key) -> ok | {error, Reason}

    Types:
        Key = Reason = term()

    Delete a community from the agent config.