Simple Network Management Protocol (SNMP)

Reference Manual

Version 5.4

Table of Contents

snmp
- Top of manual page
- bits_to_octet_string/1
- change_log_size/2
- config/0
- date_and_time/0
- date_and_time_to_string/1
- date_and_time_to_string/2
- date_and_time_to_string2/1
- date_and_time_to_universal_time_dst/1
- disable_trace/0
- enable_trace/0
- local_time_to_date_and_time_dst/1
- log_to_io/4
- log_to_io/5
- log_to_io/6
- log_to_io/7
- log_to_txt/5
- log_to_txt/6
- log_to_txt/7
- log_to_txt/8
- octet_string_to_bits/1
- passwd2localized_key/3
- print_version_info/0
- print_version_info/1
- print_versions/1
- print_versions/2
- read_mib/1
- reset_trace/1
- set_trace/1
- set_trace/2
- start/0
- start/1
- start_agent/0
- start_agent/1
- start_manager/0
- start_manager/1
- universal_time_to_date_and_time/1
- validate_date_and_time/1
- validate_date_and_time/2
- versions1/0
- versions2/0
snmp (App)
snmpa
- Top of manual page
- add_agent_caps/2
- backup/1
- backup/2
- change_log_size/1
- convert_config/1
- current_address/0
- current_community/0
- current_context/0
- current_request_id/0
- del_agent_caps/1
- disable_mibs_cache/0
- disable_mibs_cache/1
- disable_mibs_cache_autogc/0
- disable_mibs_cache_autogc/1
- discovery/2
- discovery/3
- discovery/3
- discovery/4
- discovery/4
- discovery/5
- discovery/6
- enable_mibs_cache/0
- enable_mibs_cache/1
- enable_mibs_cache_autogc/0
- enable_mibs_cache_autogc/1
- enum_to_int/2
- enum_to_int/3
- gc_mibs_cache/0
- gc_mibs_cache/1
- gc_mibs_cache/1
- gc_mibs_cache/2
- gc_mibs_cache/2
- gc_mibs_cache/3
- get/2
- get/3
- get_agent_caps/0
- get_next/2
- get_next/3
- info/0
- info/1
- int_to_enum/2
- int_to_enum/3
- invalidate_mibs_cache/0
- invalidate_mibs_cache/1
- load_mib/1
- load_mib/2
- load_mibs/1
- load_mibs/2
- load_mibs/2
- load_mibs/3
- log_to_io/1
- log_to_io/2
- log_to_io/3
- log_to_io/4
- log_to_io/5
- log_to_io/6
- log_to_io/6
- log_to_io/7
- log_to_txt/1
- log_to_txt/2
- log_to_txt/3
- log_to_txt/4
- log_to_txt/5
- log_to_txt/6
- log_to_txt/7
- log_to_txt/7
- log_to_txt/8
- me_of/1
- me_of/2
- mib_of/1
- mib_of/2
- name_to_oid/1
- name_to_oid/2
- oid_to_name/1
- oid_to_name/2
- old_info_format/1
- print_mib_info/0
- print_mib_tables/0
- print_mib_variables/0
- register_notification_filter/3
- register_notification_filter/4
- register_notification_filter/4
- register_notification_filter/5
- register_subagent/3
- restart_set_worker/0
- restart_set_worker/1
- restart_worker/0
- restart_worker/1
- send_notification/3
- send_notification/4
- send_notification/5
- send_notification/6
- send_notification/7
- send_notification2/3
- set_log_type/1
- set_log_type/2
- set_request_limit/1
- set_request_limit/2
- unload_mib/1
- unload_mib/2
- unload_mibs/1
- unload_mibs/2
- unload_mibs/2
- unload_mibs/3
- unregister_notification_filter/1
- unregister_notification_filter/2
- unregister_subagent/2
- update_mibs_cache_age/1
- update_mibs_cache_age/2
- update_mibs_cache_gclimit/1
- update_mibs_cache_gclimit/2
- verbosity/2
- whereis_mib/1
- whereis_mib/2
- which_aliasnames/0
- which_mibs/0
- which_mibs/1
- which_mibs_cache_size/0
- which_mibs_cache_size/1
- which_notification_filter/0
- which_notification_filter/1
- which_notifications/0
- which_tables/0
- which_variables/0
snmpa_conf
- Top of manual page
- agent_entry/2
- append_agent_config/2
- append_community_config/2
- append_context_config/2
- append_notify_config/2
- append_standard_config/2
- append_target_addr_config/2
- append_target_params_config/2
- append_usm_config/2
- append_vacm_config/2
- community_entry/1
- community_entry/5
- context_entry/1
- notify_entry/3
- read_agent_config/1
- read_community_config/1
- read_context_config/1
- read_notify_config/1
- read_standard_config/1
- read_target_addr_config/1
- read_target_params_config/1
- read_usm_config/1
- read_vacm_config/1
- standard_entry/2
- target_addr_entry/6
- target_addr_entry/7
- target_addr_entry/8
- target_addr_entry/10
- target_params_entry/2
- target_params_entry/4
- target_params_entry/5
- usm_entry/1
- usm_entry/13
- vacm_acc_entry/8
- vacm_s2g_entry/3
- vacm_vtf_entry/2
- vacm_vtf_entry/4
- write_agent_config/2
- write_agent_config/3
- write_community_config/2
- write_community_config/3
- write_context_config/2
- write_context_config/3
- write_notify_config/2
- write_notify_config/3
- write_standard_config/2
- write_standard_config/3
- write_target_addr_config/2
- write_target_addr_config/3
- write_target_params_config/2
- write_target_params_config/3
- write_usm_config/2
- write_usm_config/3
- write_vacm_config/2
- write_vacm_config/3
snmpa_discovery_handler
- Top of manual page
- stage1_finish/3
snmpa_error_report
- Top of manual page
- config_err/2
- user_err/2
snmpa_error
- Top of manual page
- config_err/2
- user_err/2
snmpa_error_io
- Top of manual page
- config_err/2
- user_err/2
snmpa_error_logger
- Top of manual page
- config_err/2
- user_err/2
snmpa_local_db
- Top of manual page
- dump/0
- match/2
- print/0
- print/1
- print/2
- table_create/1
- table_create_row/3
- table_delete/1
- table_delete_row/2
- table_exists/1
- table_get_row/2
snmpa_mib_data
- Top of manual page
- Module:backup/2
- Module:close/1
- Module:code_change/4
- Module:dump/2
- Module:info/1
- Module:load_mib/4
- Module:lookup/2
- Module:new/1
- Module:next/3
- Module:register_subagent/3
- Module:sync/1
- Module:unload_mib/2
- Module:unregister_subagent/2
- Module:whereis_mib/2
- Module:which_mib/2
- Module:which_mibs/1
snmpa_mib_storage
- Top of manual page
- Module:backup/2
- Module:close/1
- Module:delete/1
- Module:delete/2
- Module:info/1
- Module:match_delete/2
- Module:match_object/2
- Module:open/5
- Module:read/2
- Module:sync/1
- Module:tab2list/1
- Module:write/2
snmpa_mpd
- Top of manual page
- discarded_pdu/1
- generate_msg/5
- generate_msg/6
- generate_response_msg/5
- generate_response_msg/6
- init/1
- process_packet/5
- process_packet/6
- process_taddrs/1
snmpa_network_interface
- Top of manual page
- get_log_type/1
- info/1
- set_log_type/2
- start_link/4
- verbosity/2
snmpa_network_interface_filter
- Top of manual page
- accept_recv/2
- accept_recv_pdu/3
- accept_send/2
- accept_send_pdu/2
snmpa_notification_delivery_info_receiver
- Top of manual page
- delivery_info/4
- delivery_targets/3
snmpa_notification_filter
- Top of manual page
- handle_notification/2
snmpa_supervisor
- Top of manual page
- start_master_sup/1
- start_sub_agent/3
- start_sub_sup/1
- stop_sub_agent/1
snmp_community_mib
- Top of manual page
- add_community/5
- add_community/6
- configure/1
- delete_community/1
- reconfigure/1
snmp_framework_mib
- Top of manual page
- add_context/1
- configure/1
- delete_context/1
- init/0
snmp_generic
- Top of manual page
- get_index_types/1
- get_status_col/2
- get_status_col/2
- get_table_info/2
- table_func/2
- table_func/4
- table_get_elements/3
- table_next/2
- table_row_exists/2
- table_set_elements/3
- variable_func/2
- variable_func/3
- variable_get/1
- variable_set/2
snmp_index
- Top of manual page
- delete/1
- delete/2
- get/2
- get_last/1
- get_next/2
- insert/3
- key_to_oid/2
- new/1
snmp_notification_mib
- Top of manual page
- add_notify/3
- configure/1
- delete_notify/1
- reconfigure/1
snmp_pdus
- Top of manual page
- dec_message/1
- dec_message_only/1
- dec_pdu/1
- dec_scoped_pdu/1
- dec_scoped_pdu_data/1
- dec_usm_security_parameters/1
- enc_encrypted_scoped_pdu/1
- enc_message/1
- enc_message_only/1
- enc_pdu/1
- enc_scoped_pdu/1
- enc_usm_security_parameters/1
snmp_standard_mib
- Top of manual page
- configure/1
- inc/1
- inc/2
- reconfigure/1
- reset/0
- sys_up_time/0
snmp_target_mib
- Top of manual page
- add_addr/10
- add_params/5
- configure/1
- delete_addr/1
- delete_params/1
- reconfigure/1
- set_target_engine_id/2
snmp_user_based_sm_mib
- Top of manual page
- add_user/13
- configure/1
- delete_user/1
- reconfigure/1
snmp_view_based_acm_mib
- Top of manual page
- add_access/8
- add_sec2group/3
- add_view_tree_fam/4
- configure/1
- delete_access/1
- delete_sec2group/1
- delete_view_tree_fam/1
- reconfigure/1
snmpc
- Top of manual page
- compile/1
- compile/2
- is_consistent/1
- mib_to_hrl/1
snmpc(command)
snmpm
- Top of manual page
- agent_info/2
- async_get/3
- async_get/4
- async_get/4
- async_get/5
- async_get/6
- async_get2/3
- async_get2/4
- async_get_bulk/5
- async_get_bulk/6
- async_get_bulk/6
- async_get_bulk/7
- async_get_bulk/8
- async_get_bulk2/5
- async_get_bulk2/6
- async_get_next/3
- async_get_next/4
- async_get_next/4
- async_get_next/5
- async_get_next/6
- async_get_next2/3
- async_get_next2/4
- async_set/3
- async_set/4
- async_set/4
- async_set/5
- async_set/6
- async_set2/3
- async_set2/4
- backup/1
- cancel_async_request/2
- cancel_notify_started/1
- change_log_size/1
- demonitor/1
- format_reason/1
- format_reason/2
- info/0
- load_mib/1
- log_to_io/1
- log_to_io/2
- log_to_io/2
- log_to_io/3
- log_to_io/4
- log_to_io/5
- log_to_io/6
- log_to_io/6
- log_to_io/7
- log_to_txt/1
- log_to_txt/2
- log_to_txt/3
- log_to_txt/4
- log_to_txt/5
- log_to_txt/6
- log_to_txt/7
- log_to_txt/7
- log_to_txt/8
- monitor/0
- name_to_oid/1
- notify_started/1
- oid_to_name/1
- oid_to_type/1
- register_agent/3
- register_user/3
- register_user/4
- register_user_monitor/3
- register_user_monitor/4
- register_usm_user/3
- set_log_type/1
- sync_get/3
- sync_get/4
- sync_get/4
- sync_get/5
- sync_get/6
- sync_get2/3
- sync_get2/4
- sync_get_bulk/5
- sync_get_bulk/6
- sync_get_bulk/6
- sync_get_bulk/7
- sync_get_bulk/8
- sync_get_bulk2/5
- sync_get_bulk2/6
- sync_get_next/3
- sync_get_next/4
- sync_get_next/4
- sync_get_next/5
- sync_get_next/6
- sync_get_next2/3
- sync_get_next2/4
- sync_set/3
- sync_set/4
- sync_set/4
- sync_set/5
- sync_set/6
- sync_set2/3
- sync_set2/4
- unload_mib/1
- unregister_agent/2
- unregister_user/1
- unregister_usm_user/2
- update_agent_info/3
- update_agent_info/4
- update_usm_user_info/4
- usm_user_info/3
- verbosity/2
- which_agents/0
- which_agents/1
- which_mibs/0
- which_users/0
- which_usm_users/0
- which_usm_users/1
snmpm_conf
- Top of manual page
- agents_entry/12
- append_agents_config/2
- append_manager_config/2
- append_users_config/2
- append_usm_config/2
- manager_entry/2
- read_agents_config/1
- read_manager_config/1
- read_users_config/1
- read_usm_config/1
- users_entry/1
- users_entry/2
- users_entry/3
- usm_entry/6
- usm_entry/7
- write_agents_config/2
- write_agents_config/3
- write_manager_config/2
- write_manager_config/3
- write_users_config/2
- write_users_config/3
- write_usm_config/2
- write_usm_config/3
snmpm_mpd
- Top of manual page
- generate_msg/5
- generate_response_msg/4
- init_mpd/1
- process_msg/6
snmpm_network_interface
- Top of manual page
- get_log_type/1
- info/1
- inform_response/4
- note_store/2
- send_pdu/7
- set_log_type/2
- start_link/2
- stop/1
- verbosity/2
snmpm_user
- Top of manual page
- handle_agent/5
- handle_error/3
- handle_inform/3
- handle_invalid_result/2
- handle_pdu/4
- handle_report/3
- handle_trap/3
snmpm_network_interface_filter
- Top of manual page
- accept_recv/2
- accept_recv_pdu/3
- accept_send/2
- accept_send_pdu/3

snmp_standard_mib

Module

snmp_standard_mib

Module Summary

Instrumentation Functions for STANDARD-MIB and SNMPv2-MIB

Description

The module snmp_standard_mib implements the instrumentation functions for the STANDARD-MIB and SNMPv2-MIB, and functions for configuring the database.

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

Exports

configure(ConfDir) -> 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 the reason configuration_error.

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

The configuration file read is: standard.conf.

inc(Name) -> void()

inc(Name, N) -> void()

Types

Name = atom()

N = integer()

Increments a variable in the MIB with N, or one if N is not specified.

reconfigure(ConfDir) -> 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-STANDARD-MIB and SNMPv2-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 the reason configuration_error.

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

The configuration file read is: standard.conf.

reset() -> void()

Resets all snmp counters to 0.

sys_up_time() -> Time

Types

Time = int()

Gets the system up time in hundredth of a second.