From 7e6fc9adad9ceeda10b10f7b140702f097e5e6e4 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:02:27 +0200 Subject: [snmp] Correct documentation Fix mistakes found by 'xmllint'. --- lib/snmp/doc/src/snmp_config.xml | 280 ++++++++++++++++++++------------------- 1 file changed, 141 insertions(+), 139 deletions(-) (limited to 'lib/snmp/doc/src/snmp_config.xml') diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml index f10574a2a9..a085252d90 100644 --- a/lib/snmp/doc/src/snmp_config.xml +++ b/lib/snmp/doc/src/snmp_config.xml @@ -130,16 +130,16 @@

Agent specific config options and types:

- - ]]> + + ]]>

If master, one master agent is started. Otherwise, no agents are started.

Default is master.

 - - ]]> + + ]]>

agent_discovery_opt() = {terminating, agent_terminating_discovery_opts()} | @@ -151,8 +151,8 @@

For defaults see the options in agent_discovery_opt().

 - - ]]> + + ]]>

agent_terminating_discovery_opt() = {enable, boolean()} | @@ -169,8 +169,8 @@ - - ]]> + + ]]>

agent_originating_discovery_opt() = {enable, boolean()}

@@ -183,38 +183,38 @@ - - ]]> + + ]]>

If true, the agent is multi-threaded, with one thread for each get request.

Default is false.

 - - ]]> + + ]]>

Defines where the SNMP agent internal db files are stored.

 - - ]]> + + ]]>

Defines the maximum number of varbinds allowed in a Get-BULK response.

Default is 1000.

 - - ]]> + + ]]>

local_db_opt() = {repair, agent_repair()} | {auto_save, agent_auto_save()} | {verbosity, verbosity()}

Defines options specific for the SNMP agent local database.

For defaults see the options in local_db_opt().

 - - ]]> + + ]]>

When starting snmpa_local_db it always tries to open an existing database. If false, and some errors occur, a new @@ -224,16 +224,16 @@

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

agent_net_if_option() = {module, agent_net_if_module()} | {verbosity, verbosity()} | @@ -243,8 +243,8 @@

For defaults see the options in agent_net_if_opt().

 - - ]]> + + ]]>

Module which handles the network interface part for the SNMP agent. Must implement the @@ -252,8 +252,8 @@

Default is snmpa_net_if.

 - - ]]> + + ]]>

agent_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -267,15 +267,15 @@

For defaults see the options in agent_net_if_option().

 - - ]]> + + ]]>

Max number of simultaneous requests handled by the agent.

Default is infinity.

 - - ]]> + + ]]>

These options are actually specific to the used module. @@ -284,8 +284,8 @@

For defaults see the options in agent_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP agent. Must implement the @@ -294,8 +294,8 @@

Default is snmpa_net_if_filter.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) that defines which MIBs are initially loaded into the SNMP master agent.

@@ -309,8 +309,8 @@

Default is [].

 - - ]]> + + ]]>

mib_storage_opt() = {module, mib_storage_module()} | {options, mib_storage_options()}

This option specifies how basic mib data is stored. @@ -319,8 +319,8 @@

Default is [{module, snmpa_mib_storage_ets}].

- - + +

Defines the mib storage module of the SNMP agent as defined by the snmpa_mib_storage @@ -334,8 +334,8 @@

Default module is snmpa_mib_storage_ets.

- - ]]> + + ]]>

This is implementattion depended. That is, it depends on the module. For each module a specific set of options are valid. @@ -429,8 +429,8 @@ This is the old format which is "supported", but not documented, in so far as it will be converted to the new format if found. - - ]]> + + ]]>

Specifies how info retrieved from the mibs will be stored.

If mib_storage is {ets, Dir}, the table will also be @@ -456,16 +456,16 @@ in so far as it will be converted to the new format if found. --> - - ]]> + + ]]>

mib_server_opt() = {mibentry_override, mibentry_override()} | {trapentry_override, trapentry_override()} | {verbosity, verbosity()} | {cache, mibs_cache()} | {data_module, mib_server_data_module()}

Defines options specific for the SNMP agent mib server.

For defaults see the options in mib_server_opt().

 - - ]]> + + ]]>

If this value is false, then when loading a mib each mib- entry is checked prior to installation of the mib. @@ -474,8 +474,8 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

If this value is false, then when loading a mib each trap is checked prior to installation of the mib. @@ -484,11 +484,13 @@ in so far as it will be converted to the new format if found.

Default is false.

 - + - ]]> + + ]]>

Defines the backend data module of the SNMP agent mib-server as defined by the @@ -505,24 +507,24 @@ in so far as it will be converted to the new format if found.

Default module is snmpa_mib_data_tttn.

- - ]]> + + ]]>

Shall the agent utilize the mib server lookup cache or not.

Default is true (in which case the mibs_cache_opts() default values apply).

 - - ]]> + + ]]>

mibs_cache_opt() = {autogc, mibs_cache_autogc()} | {gclimit, mibs_cache_gclimit()} | {age, mibs_cache_age()}

Defines options specific for the SNMP agent mib server cache.

For defaults see the options in mibs_cache_opt().

 - - ]]> + + ]]>

Defines if the mib server shall perform cache gc automatically or leave it to the user (see @@ -530,8 +532,8 @@ in so far as it will be converted to the new format if found.

Default is true.

 - - 0 ]]> + + 0 ]]>

Defines how old the entries in the cache will be allowed to become before they are GC'ed (assuming GC is performed). @@ -540,8 +542,8 @@ in so far as it will be converted to the new format if found.

Default is 10 timutes.

 - - 0 | infinity ]]> + + 0 | infinity ]]>

When performing a GC, this is the max number of cache entries that will be deleted from the cache.

@@ -551,8 +553,8 @@ in so far as it will be converted to the new format if found.

Default is 100.

 - - ]]> + + ]]>

Defines an error report module, implementing the snmpa_error_report @@ -561,38 +563,38 @@ in so far as it will be converted to the new format if found.

Default is snmpa_error_logger.

 - - symbolic_store() = [symbolic_store_opt()] + + symbolic_store() = [symbolic_store_opt()]

symbolic_store_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent symbolic store.

For defaults see the options in symbolic_store_opt().

 - - target_cache() = [target_cache_opt()] + + target_cache() = [target_cache_opt()]

target_cache_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent target cache.

For defaults see the options in target_cache_opt().

 - - ]]> + + ]]>

agent_config_opt() = {dir, agent_config_dir()} | {force_load, force_load()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP agent.

For defaults see the options in agent_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP agent configuration files are stored.

 - - ]]> + + ]]>

If true the configuration files are re-read during start-up, and the contents of the configuration @@ -606,16 +608,16 @@ in so far as it will be converted to the new format if found.

Manager specific config options and types:

- - ]]> + + ]]>

server_opt() = {timeout, server_timeout()} | {verbosity, verbosity()}

Specifies the options for the manager server process.

Default is silence.

 - - ]]> + + ]]>

Asynchronous request cleanup time. For every requests, some info is stored internally, in order to be able to @@ -635,44 +637,44 @@ in so far as it will be converted to the new format if found.

Default is 30000.

 - - ]]> + + ]]>

manager_config_opt() = {dir, manager_config_dir()} | {db_dir, manager_db_dir()} | {db_init_error, db_init_error()} | {repair, manager_repair()} | {auto_save, manager_auto_save()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP manager.

For defaults see the options in manager_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP manager configuration files are stored.

 - - ]]> + + ]]>

Defines where the SNMP manager store persistent data.

 - - ]]> + + ]]>

Defines the repair option for the persistent database (if and how the table is repaired when opened).

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

This option defines how the manager will handle the sending of response (acknowledgment) to received inform-requests.

@@ -701,16 +703,16 @@ in so far as it will be converted to the new format if found.

Default is auto.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) and defines which MIBs are initially loaded into the SNMP manager.

Default is [].

 - - ]]> + + ]]>

manager_net_if_opt() = {module, manager_net_if_module()} | {verbosity, verbosity()} | @@ -720,8 +722,8 @@ in so far as it will be converted to the new format if found.

For defaults see the options in manager_net_if_opt().

 - - ]]> + + ]]>

manager_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -734,8 +736,8 @@ in so far as it will be converted to the new format if found.

For defaults see the options in manager_net_if_option().

 - - ]]> + + ]]>

The module which handles the network interface part for the SNMP manager. It must implement the @@ -743,8 +745,8 @@ in so far as it will be converted to the new format if found.

Default is snmpm_net_if.

- - ]]> + + ]]>

manager_net_if_filter_option() = {module, manager_net_if_filter_module()}

These options are actually specific to the used module. @@ -754,8 +756,8 @@ in so far as it will be converted to the new format if found. manager_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP manager. Must implement the @@ -763,16 +765,16 @@ in so far as it will be converted to the new format if found.

Default is snmpm_net_if_filter.

 - - ]]> + + ]]>

The module implementing the default user. See the snmpm_user behaviour.

Default is snmpm_user_default.

 - - ]]> + + ]]>

Data for the default user. Passed to the user when calling the callback functions.

@@ -783,8 +785,8 @@ in so far as it will be converted to the new format if found.

Common config types:

- - restart_type() = permanent | transient | temporary + + restart_type() = permanent | transient | temporary

See supervisor documentation for more info.

@@ -792,8 +794,8 @@ in so far as it will be converted to the new format if found. for the manager.

 - - db_init_error() = terminate | create | create_db_and_dir + + db_init_error() = terminate | create | create_db_and_dir

Defines what to do if the agent is unable to open an existing database file. terminate means that the @@ -805,31 +807,31 @@ in so far as it will be converted to the new format if found.

Default is terminate.

 - - ]]> + + ]]>

Defines the Erlang priority for all SNMP processes.

Default is normal.

 - - ]]> + + ]]>

version() = v1 | v2 | v3

Which SNMP versions shall be accepted/used.

Default is [v1,v2,v3].

 - - ]]> + + ]]>

Verbosity for a SNMP process. This specifies now much debug info is printed.

Default is silence.

 - - ]]> + + ]]>

If true, net_if binds to the IP address. If false, net_if listens on any IP address on the host @@ -837,8 +839,8 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

If true, net_if does not specify that the IP and port address should be reusable. If false, @@ -846,30 +848,30 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

Receive buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

Send buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

note_store_opt() = {timeout, note_store_timeout()} | {verbosity, verbosity()}

Specifies the options for the SNMP note store.

For defaults see the options in note_store_opt().

 - - ]]> + + ]]>

Note cleanup time. When storing a note in the note store, each note is given lifetime. Every timeout the note_store @@ -878,8 +880,8 @@ in so far as it will be converted to the new format if found.

Default is 30000.

 - - ]]> + + ]]>

audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} | {size, atl_size()} | {repair, atl_repair()} | {seqno, atl_seqno()}

If present, this option specifies the options for the @@ -889,8 +891,8 @@ in so far as it will be converted to the new format if found.

If not present, audit trail logging is not used.

 - - ]]> + + ]]>

Specifies what type of an audit trail log should be used. The effect of the type is actually different for the the agent @@ -911,16 +913,16 @@ in so far as it will be converted to the new format if found.

Default is read_write.

 - - ]]> + + ]]>

Specifies where the audit trail log should be stored.

If audit_trail_log specifies that logging should take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies the size of the audit trail log. This parameter is sent to disk_log.

@@ -928,8 +930,8 @@ in so far as it will be converted to the new format if found. take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies if and how the audit trail log shall be repaired when opened. Unless this parameter has the value snmp_repair @@ -941,8 +943,8 @@ in so far as it will be converted to the new format if found.

Default is true.

 - - ]]> + + ]]>

Specifies if the audit trail log entries will be (sequence) numbered or not. The range of the sequence numbers are according -- cgit v1.2.3