<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- snmpm</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/snmp-4.22.1.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Simple Network Management Protocol (SNMP)</strong><br><strong>Reference Manual</strong><br><small>Version 4.22.1</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li id="no" title="snmp " expanded="false">snmp<ul>
<li><a href="snmp.html">
Top of manual page
</a></li>
<li title="config-0"><a href="snmp.html#config-0">config/0</a></li>
<li title="start-0"><a href="snmp.html#start-0">start/0</a></li>
<li title="start-1"><a href="snmp.html#start-1">start/1</a></li>
<li title="start_agent-0"><a href="snmp.html#start_agent-0">start_agent/0</a></li>
<li title="start_agent-1"><a href="snmp.html#start_agent-1">start_agent/1</a></li>
<li title="start_manager-0"><a href="snmp.html#start_manager-0">start_manager/0</a></li>
<li title="start_manager-1"><a href="snmp.html#start_manager-1">start_manager/1</a></li>
<li title="date_and_time-0"><a href="snmp.html#date_and_time-0">date_and_time/0</a></li>
<li title="date_and_time_to_universal_time_dst-1"><a href="snmp.html#date_and_time_to_universal_time_dst-1">date_and_time_to_universal_time_dst/1</a></li>
<li title="date_and_time_to_string-1"><a href="snmp.html#date_and_time_to_string-1">date_and_time_to_string/1</a></li>
<li title="date_and_time_to_string-2"><a href="snmp.html#date_and_time_to_string-2">date_and_time_to_string/2</a></li>
<li title="date_and_time_to_string2-1"><a href="snmp.html#date_and_time_to_string2-1">date_and_time_to_string2/1</a></li>
<li title="local_time_to_date_and_time_dst-1"><a href="snmp.html#local_time_to_date_and_time_dst-1">local_time_to_date_and_time_dst/1</a></li>
<li title="universal_time_to_date_and_time-1"><a href="snmp.html#universal_time_to_date_and_time-1">universal_time_to_date_and_time/1</a></li>
<li title="validate_date_and_time-1"><a href="snmp.html#validate_date_and_time-1">validate_date_and_time/1</a></li>
<li title="validate_date_and_time-2"><a href="snmp.html#validate_date_and_time-2">validate_date_and_time/2</a></li>
<li title="passwd2localized_key-3"><a href="snmp.html#passwd2localized_key-3">passwd2localized_key/3</a></li>
<li title="octet_string_to_bits-1"><a href="snmp.html#octet_string_to_bits-1">octet_string_to_bits/1</a></li>
<li title="bits_to_octet_string-1"><a href="snmp.html#bits_to_octet_string-1">bits_to_octet_string/1</a></li>
<li title="read_mib-1"><a href="snmp.html#read_mib-1">read_mib/1</a></li>
<li title="log_to_txt-5"><a href="snmp.html#log_to_txt-5">log_to_txt/5</a></li>
<li title="log_to_txt-6"><a href="snmp.html#log_to_txt-6">log_to_txt/6</a></li>
<li title="log_to_txt-7"><a href="snmp.html#log_to_txt-7">log_to_txt/7</a></li>
<li title="log_to_io-4"><a href="snmp.html#log_to_io-4">log_to_io/4</a></li>
<li title="log_to_io-5"><a href="snmp.html#log_to_io-5">log_to_io/5</a></li>
<li title="log_to_io-6"><a href="snmp.html#log_to_io-6">log_to_io/6</a></li>
<li title="change_log_size-2"><a href="snmp.html#change_log_size-2">change_log_size/2</a></li>
<li title="print_version_info-0"><a href="snmp.html#print_version_info-0">print_version_info/0</a></li>
<li title="print_version_info-1"><a href="snmp.html#print_version_info-1">print_version_info/1</a></li>
<li title="versions1-0"><a href="snmp.html#versions1-0">versions1/0</a></li>
<li title="versions2-0"><a href="snmp.html#versions2-0">versions2/0</a></li>
<li title="print_versions-1"><a href="snmp.html#print_versions-1">print_versions/1</a></li>
<li title="print_versions-2"><a href="snmp.html#print_versions-2">print_versions/2</a></li>
<li title="enable_trace-0"><a href="snmp.html#enable_trace-0">enable_trace/0</a></li>
<li title="disable_trace-0"><a href="snmp.html#disable_trace-0">disable_trace/0</a></li>
<li title="set_trace-1"><a href="snmp.html#set_trace-1">set_trace/1</a></li>
<li title="reset_trace-1"><a href="snmp.html#reset_trace-1">reset_trace/1</a></li>
<li title="set_trace-2"><a href="snmp.html#set_trace-2">set_trace/2</a></li>
</ul>
</li>
<li title="snmp (App)"><a href="snmp_app.html">snmp (App)
</a></li>
<li id="no" title="snmpa " expanded="false">snmpa<ul>
<li><a href="snmpa.html">
Top of manual page
</a></li>
<li title="add_agent_caps-2"><a href="snmpa.html#add_agent_caps-2">add_agent_caps/2</a></li>
<li title="del_agent_caps-1"><a href="snmpa.html#del_agent_caps-1">del_agent_caps/1</a></li>
<li title="get_agent_caps-0"><a href="snmpa.html#get_agent_caps-0">get_agent_caps/0</a></li>
<li title="get-2"><a href="snmpa.html#get-2">get/2</a></li>
<li title="get-3"><a href="snmpa.html#get-3">get/3</a></li>
<li title="get_next-2"><a href="snmpa.html#get_next-2">get_next/2</a></li>
<li title="get_next-3"><a href="snmpa.html#get_next-3">get_next/3</a></li>
<li title="backup-1"><a href="snmpa.html#backup-1">backup/1</a></li>
<li title="backup-2"><a href="snmpa.html#backup-2">backup/2</a></li>
<li title="info-0"><a href="snmpa.html#info-0">info/0</a></li>
<li title="info-1"><a href="snmpa.html#info-1">info/1</a></li>
<li title="old_info_format-1"><a href="snmpa.html#old_info_format-1">old_info_format/1</a></li>
<li title="load_mibs-1"><a href="snmpa.html#load_mibs-1">load_mibs/1</a></li>
<li title="load_mibs-2"><a href="snmpa.html#load_mibs-2">load_mibs/2</a></li>
<li title="unload_mibs-1"><a href="snmpa.html#unload_mibs-1">unload_mibs/1</a></li>
<li title="unload_mibs-2"><a href="snmpa.html#unload_mibs-2">unload_mibs/2</a></li>
<li title="which_mibs-0"><a href="snmpa.html#which_mibs-0">which_mibs/0</a></li>
<li title="which_mibs-1"><a href="snmpa.html#which_mibs-1">which_mibs/1</a></li>
<li title="whereis_mib-1"><a href="snmpa.html#whereis_mib-1">whereis_mib/1</a></li>
<li title="whereis_mib-2"><a href="snmpa.html#whereis_mib-2">whereis_mib/2</a></li>
<li title="current_request_id-0"><a href="snmpa.html#current_request_id-0">current_request_id/0</a></li>
<li title="current_context-0"><a href="snmpa.html#current_context-0">current_context/0</a></li>
<li title="current_community-0"><a href="snmpa.html#current_community-0">current_community/0</a></li>
<li title="current_address-0"><a href="snmpa.html#current_address-0">current_address/0</a></li>
<li title="enum_to_int-2"><a href="snmpa.html#enum_to_int-2">enum_to_int/2</a></li>
<li title="enum_to_int-3"><a href="snmpa.html#enum_to_int-3">enum_to_int/3</a></li>
<li title="int_to_enum-2"><a href="snmpa.html#int_to_enum-2">int_to_enum/2</a></li>
<li title="int_to_enum-3"><a href="snmpa.html#int_to_enum-3">int_to_enum/3</a></li>
<li title="name_to_oid-1"><a href="snmpa.html#name_to_oid-1">name_to_oid/1</a></li>
<li title="name_to_oid-2"><a href="snmpa.html#name_to_oid-2">name_to_oid/2</a></li>
<li title="oid_to_name-1"><a href="snmpa.html#oid_to_name-1">oid_to_name/1</a></li>
<li title="oid_to_name-2"><a href="snmpa.html#oid_to_name-2">oid_to_name/2</a></li>
<li title="which_aliasnames-0"><a href="snmpa.html#which_aliasnames-0">which_aliasnames/0</a></li>
<li title="which_tables-0"><a href="snmpa.html#which_tables-0">which_tables/0</a></li>
<li title="which_variables-0"><a href="snmpa.html#which_variables-0">which_variables/0</a></li>
<li title="which_notifications-0"><a href="snmpa.html#which_notifications-0">which_notifications/0</a></li>
<li title="log_to_txt-1"><a href="snmpa.html#log_to_txt-1">log_to_txt/1</a></li>
<li title="log_to_txt-2"><a href="snmpa.html#log_to_txt-2">log_to_txt/2</a></li>
<li title="log_to_txt-3"><a href="snmpa.html#log_to_txt-3">log_to_txt/3</a></li>
<li title="log_to_txt-4"><a href="snmpa.html#log_to_txt-4">log_to_txt/4</a></li>
<li title="log_to_txt-5"><a href="snmpa.html#log_to_txt-5">log_to_txt/5</a></li>
<li title="log_to_txt-6"><a href="snmpa.html#log_to_txt-6">log_to_txt/6</a></li>
<li title="log_to_txt-7"><a href="snmpa.html#log_to_txt-7">log_to_txt/7</a></li>
<li title="log_to_io-1"><a href="snmpa.html#log_to_io-1">log_to_io/1</a></li>
<li title="log_to_io-2"><a href="snmpa.html#log_to_io-2">log_to_io/2</a></li>
<li title="log_to_io-3"><a href="snmpa.html#log_to_io-3">log_to_io/3</a></li>
<li title="log_to_io-4"><a href="snmpa.html#log_to_io-4">log_to_io/4</a></li>
<li title="log_to_io-5"><a href="snmpa.html#log_to_io-5">log_to_io/5</a></li>
<li title="log_to_io-6"><a href="snmpa.html#log_to_io-6">log_to_io/6</a></li>
<li title="change_log_size-1"><a href="snmpa.html#change_log_size-1">change_log_size/1</a></li>
<li title="set_log_type-1"><a href="snmpa.html#set_log_type-1">set_log_type/1</a></li>
<li title="set_log_type-2"><a href="snmpa.html#set_log_type-2">set_log_type/2</a></li>
<li title="mib_of-1"><a href="snmpa.html#mib_of-1">mib_of/1</a></li>
<li title="mib_of-2"><a href="snmpa.html#mib_of-2">mib_of/2</a></li>
<li title="me_of-1"><a href="snmpa.html#me_of-1">me_of/1</a></li>
<li title="me_of-2"><a href="snmpa.html#me_of-2">me_of/2</a></li>
<li title="invalidate_mibs_cache-0"><a href="snmpa.html#invalidate_mibs_cache-0">invalidate_mibs_cache/0</a></li>
<li title="invalidate_mibs_cache-1"><a href="snmpa.html#invalidate_mibs_cache-1">invalidate_mibs_cache/1</a></li>
<li title="enable_mibs_cache-0"><a href="snmpa.html#enable_mibs_cache-0">enable_mibs_cache/0</a></li>
<li title="enable_mibs_cache-1"><a href="snmpa.html#enable_mibs_cache-1">enable_mibs_cache/1</a></li>
<li title="disable_mibs_cache-0"><a href="snmpa.html#disable_mibs_cache-0">disable_mibs_cache/0</a></li>
<li title="disable_mibs_cache-1"><a href="snmpa.html#disable_mibs_cache-1">disable_mibs_cache/1</a></li>
<li title="which_mibs_cache_size-0"><a href="snmpa.html#which_mibs_cache_size-0">which_mibs_cache_size/0</a></li>
<li title="which_mibs_cache_size-1"><a href="snmpa.html#which_mibs_cache_size-1">which_mibs_cache_size/1</a></li>
<li title="gc_mibs_cache-0"><a href="snmpa.html#gc_mibs_cache-0">gc_mibs_cache/0</a></li>
<li title="gc_mibs_cache-1"><a href="snmpa.html#gc_mibs_cache-1">gc_mibs_cache/1</a></li>
<li title="gc_mibs_cache-1"><a href="snmpa.html#gc_mibs_cache-1">gc_mibs_cache/1</a></li>
<li title="gc_mibs_cache-2"><a href="snmpa.html#gc_mibs_cache-2">gc_mibs_cache/2</a></li>
<li title="gc_mibs_cache-2"><a href="snmpa.html#gc_mibs_cache-2">gc_mibs_cache/2</a></li>
<li title="gc_mibs_cache-3"><a href="snmpa.html#gc_mibs_cache-3">gc_mibs_cache/3</a></li>
<li title="enable_mibs_cache_autogc-0"><a href="snmpa.html#enable_mibs_cache_autogc-0">enable_mibs_cache_autogc/0</a></li>
<li title="enable_mibs_cache_autogc-1"><a href="snmpa.html#enable_mibs_cache_autogc-1">enable_mibs_cache_autogc/1</a></li>
<li title="disable_mibs_cache_autogc-0"><a href="snmpa.html#disable_mibs_cache_autogc-0">disable_mibs_cache_autogc/0</a></li>
<li title="disable_mibs_cache_autogc-1"><a href="snmpa.html#disable_mibs_cache_autogc-1">disable_mibs_cache_autogc/1</a></li>
<li title="update_mibs_cache_age-1"><a href="snmpa.html#update_mibs_cache_age-1">update_mibs_cache_age/1</a></li>
<li title="update_mibs_cache_age-2"><a href="snmpa.html#update_mibs_cache_age-2">update_mibs_cache_age/2</a></li>
<li title="update_mibs_cache_gclimit-1"><a href="snmpa.html#update_mibs_cache_gclimit-1">update_mibs_cache_gclimit/1</a></li>
<li title="update_mibs_cache_gclimit-2"><a href="snmpa.html#update_mibs_cache_gclimit-2">update_mibs_cache_gclimit/2</a></li>
<li title="register_notification_filter-3"><a href="snmpa.html#register_notification_filter-3">register_notification_filter/3</a></li>
<li title="register_notification_filter-4"><a href="snmpa.html#register_notification_filter-4">register_notification_filter/4</a></li>
<li title="register_notification_filter-4"><a href="snmpa.html#register_notification_filter-4">register_notification_filter/4</a></li>
<li title="register_notification_filter-5"><a href="snmpa.html#register_notification_filter-5">register_notification_filter/5</a></li>
<li title="unregister_notification_filter-1"><a href="snmpa.html#unregister_notification_filter-1">unregister_notification_filter/1</a></li>
<li title="unregister_notification_filter-2"><a href="snmpa.html#unregister_notification_filter-2">unregister_notification_filter/2</a></li>
<li title="which_notification_filter-0"><a href="snmpa.html#which_notification_filter-0">which_notification_filter/0</a></li>
<li title="which_notification_filter-1"><a href="snmpa.html#which_notification_filter-1">which_notification_filter/1</a></li>
<li title="set_request_limit-1"><a href="snmpa.html#set_request_limit-1">set_request_limit/1</a></li>
<li title="set_request_limit-2"><a href="snmpa.html#set_request_limit-2">set_request_limit/2</a></li>
<li title="register_subagent-3"><a href="snmpa.html#register_subagent-3">register_subagent/3</a></li>
<li title="unregister_subagent-2"><a href="snmpa.html#unregister_subagent-2">unregister_subagent/2</a></li>
<li title="send_notification2-3"><a href="snmpa.html#send_notification2-3">send_notification2/3</a></li>
<li title="send_notification-3"><a href="snmpa.html#send_notification-3">send_notification/3</a></li>
<li title="send_notification-4"><a href="snmpa.html#send_notification-4">send_notification/4</a></li>
<li title="send_notification-5"><a href="snmpa.html#send_notification-5">send_notification/5</a></li>
<li title="send_notification-6"><a href="snmpa.html#send_notification-6">send_notification/6</a></li>
<li title="send_notification-7"><a href="snmpa.html#send_notification-7">send_notification/7</a></li>
<li title="discovery-2"><a href="snmpa.html#discovery-2">discovery/2</a></li>
<li title="discovery-3"><a href="snmpa.html#discovery-3">discovery/3</a></li>
<li title="discovery-3"><a href="snmpa.html#discovery-3">discovery/3</a></li>
<li title="discovery-4"><a href="snmpa.html#discovery-4">discovery/4</a></li>
<li title="discovery-4"><a href="snmpa.html#discovery-4">discovery/4</a></li>
<li title="discovery-5"><a href="snmpa.html#discovery-5">discovery/5</a></li>
<li title="discovery-6"><a href="snmpa.html#discovery-6">discovery/6</a></li>
<li title="convert_config-1"><a href="snmpa.html#convert_config-1">convert_config/1</a></li>
<li title="restart_worker-0"><a href="snmpa.html#restart_worker-0">restart_worker/0</a></li>
<li title="restart_worker-1"><a href="snmpa.html#restart_worker-1">restart_worker/1</a></li>
<li title="restart_set_worker-0"><a href="snmpa.html#restart_set_worker-0">restart_set_worker/0</a></li>
<li title="restart_set_worker-1"><a href="snmpa.html#restart_set_worker-1">restart_set_worker/1</a></li>
<li title="print_mib_info-0"><a href="snmpa.html#print_mib_info-0">print_mib_info/0</a></li>
<li title="print_mib_tables-0"><a href="snmpa.html#print_mib_tables-0">print_mib_tables/0</a></li>
<li title="print_mib_variables-0"><a href="snmpa.html#print_mib_variables-0">print_mib_variables/0</a></li>
<li title="verbosity-2"><a href="snmpa.html#verbosity-2">verbosity/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_conf " expanded="false">snmpa_conf<ul>
<li><a href="snmpa_conf.html">
Top of manual page
</a></li>
<li title="agent_entry-2"><a href="snmpa_conf.html#agent_entry-2">agent_entry/2</a></li>
<li title="write_agent_config-2"><a href="snmpa_conf.html#write_agent_config-2">write_agent_config/2</a></li>
<li title="write_agent_config-3"><a href="snmpa_conf.html#write_agent_config-3">write_agent_config/3</a></li>
<li title="append_agent_config-2"><a href="snmpa_conf.html#append_agent_config-2">append_agent_config/2</a></li>
<li title="read_agent_config-1"><a href="snmpa_conf.html#read_agent_config-1">read_agent_config/1</a></li>
<li title="standard_entry-2"><a href="snmpa_conf.html#standard_entry-2">standard_entry/2</a></li>
<li title="write_standard_config-2"><a href="snmpa_conf.html#write_standard_config-2">write_standard_config/2</a></li>
<li title="write_standard_config-3"><a href="snmpa_conf.html#write_standard_config-3">write_standard_config/3</a></li>
<li title="append_standard_config-2"><a href="snmpa_conf.html#append_standard_config-2">append_standard_config/2</a></li>
<li title="read_standard_config-1"><a href="snmpa_conf.html#read_standard_config-1">read_standard_config/1</a></li>
<li title="context_entry-1"><a href="snmpa_conf.html#context_entry-1">context_entry/1</a></li>
<li title="write_context_config-2"><a href="snmpa_conf.html#write_context_config-2">write_context_config/2</a></li>
<li title="write_context_config-3"><a href="snmpa_conf.html#write_context_config-3">write_context_config/3</a></li>
<li title="append_context_config-2"><a href="snmpa_conf.html#append_context_config-2">append_context_config/2</a></li>
<li title="read_context_config-1"><a href="snmpa_conf.html#read_context_config-1">read_context_config/1</a></li>
<li title="community_entry-1"><a href="snmpa_conf.html#community_entry-1">community_entry/1</a></li>
<li title="community_entry-5"><a href="snmpa_conf.html#community_entry-5">community_entry/5</a></li>
<li title="write_community_config-2"><a href="snmpa_conf.html#write_community_config-2">write_community_config/2</a></li>
<li title="write_community_config-3"><a href="snmpa_conf.html#write_community_config-3">write_community_config/3</a></li>
<li title="append_community_config-2"><a href="snmpa_conf.html#append_community_config-2">append_community_config/2</a></li>
<li title="read_community_config-1"><a href="snmpa_conf.html#read_community_config-1">read_community_config/1</a></li>
<li title="target_addr_entry-5"><a href="snmpa_conf.html#target_addr_entry-5">target_addr_entry/5</a></li>
<li title="target_addr_entry-6"><a href="snmpa_conf.html#target_addr_entry-6">target_addr_entry/6</a></li>
<li title="target_addr_entry-8"><a href="snmpa_conf.html#target_addr_entry-8">target_addr_entry/8</a></li>
<li title="target_addr_entry-10"><a href="snmpa_conf.html#target_addr_entry-10">target_addr_entry/10</a></li>
<li title="target_addr_entry-11"><a href="snmpa_conf.html#target_addr_entry-11">target_addr_entry/11</a></li>
<li title="write_target_addr_config-2"><a href="snmpa_conf.html#write_target_addr_config-2">write_target_addr_config/2</a></li>
<li title="write_target_addr_config-3"><a href="snmpa_conf.html#write_target_addr_config-3">write_target_addr_config/3</a></li>
<li title="append_target_addr_config-2"><a href="snmpa_conf.html#append_target_addr_config-2">append_target_addr_config/2</a></li>
<li title="read_target_addr_config-1"><a href="snmpa_conf.html#read_target_addr_config-1">read_target_addr_config/1</a></li>
<li title="target_params_entry-2"><a href="snmpa_conf.html#target_params_entry-2">target_params_entry/2</a></li>
<li title="target_params_entry-4"><a href="snmpa_conf.html#target_params_entry-4">target_params_entry/4</a></li>
<li title="target_params_entry-5"><a href="snmpa_conf.html#target_params_entry-5">target_params_entry/5</a></li>
<li title="write_target_params_config-2"><a href="snmpa_conf.html#write_target_params_config-2">write_target_params_config/2</a></li>
<li title="write_target_params_config-3"><a href="snmpa_conf.html#write_target_params_config-3">write_target_params_config/3</a></li>
<li title="append_target_params_config-2"><a href="snmpa_conf.html#append_target_params_config-2">append_target_params_config/2</a></li>
<li title="read_target_params_config-1"><a href="snmpa_conf.html#read_target_params_config-1">read_target_params_config/1</a></li>
<li title="vacm_s2g_entry-3"><a href="snmpa_conf.html#vacm_s2g_entry-3">vacm_s2g_entry/3</a></li>
<li title="vacm_acc_entry-8"><a href="snmpa_conf.html#vacm_acc_entry-8">vacm_acc_entry/8</a></li>
<li title="vacm_vtf_entry-2"><a href="snmpa_conf.html#vacm_vtf_entry-2">vacm_vtf_entry/2</a></li>
<li title="vacm_vtf_entry-4"><a href="snmpa_conf.html#vacm_vtf_entry-4">vacm_vtf_entry/4</a></li>
<li title="write_vacm_config-2"><a href="snmpa_conf.html#write_vacm_config-2">write_vacm_config/2</a></li>
<li title="write_vacm_config-3"><a href="snmpa_conf.html#write_vacm_config-3">write_vacm_config/3</a></li>
<li title="append_vacm_config-2"><a href="snmpa_conf.html#append_vacm_config-2">append_vacm_config/2</a></li>
<li title="read_vacm_config-1"><a href="snmpa_conf.html#read_vacm_config-1">read_vacm_config/1</a></li>
<li title="usm_entry-1"><a href="snmpa_conf.html#usm_entry-1">usm_entry/1</a></li>
<li title="usm_entry-13"><a href="snmpa_conf.html#usm_entry-13">usm_entry/13</a></li>
<li title="write_usm_config-2"><a href="snmpa_conf.html#write_usm_config-2">write_usm_config/2</a></li>
<li title="write_usm_config-3"><a href="snmpa_conf.html#write_usm_config-3">write_usm_config/3</a></li>
<li title="append_usm_config-2"><a href="snmpa_conf.html#append_usm_config-2">append_usm_config/2</a></li>
<li title="read_usm_config-1"><a href="snmpa_conf.html#read_usm_config-1">read_usm_config/1</a></li>
<li title="notify_entry-3"><a href="snmpa_conf.html#notify_entry-3">notify_entry/3</a></li>
<li title="write_notify_config-2"><a href="snmpa_conf.html#write_notify_config-2">write_notify_config/2</a></li>
<li title="write_notify_config-3"><a href="snmpa_conf.html#write_notify_config-3">write_notify_config/3</a></li>
<li title="append_notify_config-2"><a href="snmpa_conf.html#append_notify_config-2">append_notify_config/2</a></li>
<li title="read_notify_config-1"><a href="snmpa_conf.html#read_notify_config-1">read_notify_config/1</a></li>
</ul>
</li>
<li id="no" title="snmpa_discovery_handler " expanded="false">snmpa_discovery_handler<ul>
<li><a href="snmpa_discovery_handler.html">
Top of manual page
</a></li>
<li title="stage1_finish-3"><a href="snmpa_discovery_handler.html#stage1_finish-3">stage1_finish/3</a></li>
</ul>
</li>
<li id="no" title="snmpa_error_report " expanded="false">snmpa_error_report<ul>
<li><a href="snmpa_error_report.html">
Top of manual page
</a></li>
<li title="config_err-2"><a href="snmpa_error_report.html#config_err-2">config_err/2</a></li>
<li title="user_err-2"><a href="snmpa_error_report.html#user_err-2">user_err/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_error " expanded="false">snmpa_error<ul>
<li><a href="snmpa_error.html">
Top of manual page
</a></li>
<li title="config_err-2"><a href="snmpa_error.html#config_err-2">config_err/2</a></li>
<li title="user_err-2"><a href="snmpa_error.html#user_err-2">user_err/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_error_io " expanded="false">snmpa_error_io<ul>
<li><a href="snmpa_error_io.html">
Top of manual page
</a></li>
<li title="config_err-2"><a href="snmpa_error_io.html#config_err-2">config_err/2</a></li>
<li title="user_err-2"><a href="snmpa_error_io.html#user_err-2">user_err/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_error_logger " expanded="false">snmpa_error_logger<ul>
<li><a href="snmpa_error_logger.html">
Top of manual page
</a></li>
<li title="config_err-2"><a href="snmpa_error_logger.html#config_err-2">config_err/2</a></li>
<li title="user_err-2"><a href="snmpa_error_logger.html#user_err-2">user_err/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_local_db " expanded="false">snmpa_local_db<ul>
<li><a href="snmpa_local_db.html">
Top of manual page
</a></li>
<li title="dump-0"><a href="snmpa_local_db.html#dump-0">dump/0</a></li>
<li title="match-2"><a href="snmpa_local_db.html#match-2">match/2</a></li>
<li title="print-0"><a href="snmpa_local_db.html#print-0">print/0</a></li>
<li title="print-1"><a href="snmpa_local_db.html#print-1">print/1</a></li>
<li title="print-2"><a href="snmpa_local_db.html#print-2">print/2</a></li>
<li title="table_create-1"><a href="snmpa_local_db.html#table_create-1">table_create/1</a></li>
<li title="table_create_row-3"><a href="snmpa_local_db.html#table_create_row-3">table_create_row/3</a></li>
<li title="table_delete-1"><a href="snmpa_local_db.html#table_delete-1">table_delete/1</a></li>
<li title="table_delete_row-2"><a href="snmpa_local_db.html#table_delete_row-2">table_delete_row/2</a></li>
<li title="table_exists-1"><a href="snmpa_local_db.html#table_exists-1">table_exists/1</a></li>
<li title="table_get_row-2"><a href="snmpa_local_db.html#table_get_row-2">table_get_row/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_mpd " expanded="false">snmpa_mpd<ul>
<li><a href="snmpa_mpd.html">
Top of manual page
</a></li>
<li title="init-1"><a href="snmpa_mpd.html#init-1">init/1</a></li>
<li title="process_packet-6"><a href="snmpa_mpd.html#process_packet-6">process_packet/6</a></li>
<li title="process_packet-7"><a href="snmpa_mpd.html#process_packet-7">process_packet/7</a></li>
<li title="generate_response_msg-5"><a href="snmpa_mpd.html#generate_response_msg-5">generate_response_msg/5</a></li>
<li title="generate_response_msg-6"><a href="snmpa_mpd.html#generate_response_msg-6">generate_response_msg/6</a></li>
<li title="generate_msg-5"><a href="snmpa_mpd.html#generate_msg-5">generate_msg/5</a></li>
<li title="generate_msg-6"><a href="snmpa_mpd.html#generate_msg-6">generate_msg/6</a></li>
<li title="discarded_pdu-1"><a href="snmpa_mpd.html#discarded_pdu-1">discarded_pdu/1</a></li>
</ul>
</li>
<li id="no" title="snmpa_network_interface " expanded="false">snmpa_network_interface<ul>
<li><a href="snmpa_network_interface.html">
Top of manual page
</a></li>
<li title="start_link-4"><a href="snmpa_network_interface.html#start_link-4">start_link/4</a></li>
<li title="info-1"><a href="snmpa_network_interface.html#info-1">info/1</a></li>
<li title="verbosity-2"><a href="snmpa_network_interface.html#verbosity-2">verbosity/2</a></li>
<li title="get_log_type-1"><a href="snmpa_network_interface.html#get_log_type-1">get_log_type/1</a></li>
<li title="set_log_type-2"><a href="snmpa_network_interface.html#set_log_type-2">set_log_type/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_network_interface_filter " expanded="false">snmpa_network_interface_filter<ul>
<li><a href="snmpa_network_interface_filter.html">
Top of manual page
</a></li>
<li title="accept_recv-2"><a href="snmpa_network_interface_filter.html#accept_recv-2">accept_recv/2</a></li>
<li title="accept_send-2"><a href="snmpa_network_interface_filter.html#accept_send-2">accept_send/2</a></li>
<li title="accept_recv_pdu-3"><a href="snmpa_network_interface_filter.html#accept_recv_pdu-3">accept_recv_pdu/3</a></li>
<li title="accept_send_pdu-2"><a href="snmpa_network_interface_filter.html#accept_send_pdu-2">accept_send_pdu/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_notification_delivery_info_receiver " expanded="false">snmpa_notification_delivery_info_receiver<ul>
<li><a href="snmpa_notification_delivery_info_receiver.html">
Top of manual page
</a></li>
<li title="delivery_targets-3"><a href="snmpa_notification_delivery_info_receiver.html#delivery_targets-3">delivery_targets/3</a></li>
<li title="delivery_info-4"><a href="snmpa_notification_delivery_info_receiver.html#delivery_info-4">delivery_info/4</a></li>
</ul>
</li>
<li id="no" title="snmpa_notification_filter " expanded="false">snmpa_notification_filter<ul>
<li><a href="snmpa_notification_filter.html">
Top of manual page
</a></li>
<li title="handle_notification-2"><a href="snmpa_notification_filter.html#handle_notification-2">handle_notification/2</a></li>
</ul>
</li>
<li id="no" title="snmpa_supervisor " expanded="false">snmpa_supervisor<ul>
<li><a href="snmpa_supervisor.html">
Top of manual page
</a></li>
<li title="start_sub_sup-1"><a href="snmpa_supervisor.html#start_sub_sup-1">start_sub_sup/1</a></li>
<li title="start_master_sup-1"><a href="snmpa_supervisor.html#start_master_sup-1">start_master_sup/1</a></li>
<li title="start_sub_agent-3"><a href="snmpa_supervisor.html#start_sub_agent-3">start_sub_agent/3</a></li>
<li title="stop_sub_agent-1"><a href="snmpa_supervisor.html#stop_sub_agent-1">stop_sub_agent/1</a></li>
</ul>
</li>
<li id="no" title="snmp_community_mib " expanded="false">snmp_community_mib<ul>
<li><a href="snmp_community_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_community_mib.html#configure-1">configure/1</a></li>
<li title="reconfigure-1"><a href="snmp_community_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="add_community-5"><a href="snmp_community_mib.html#add_community-5">add_community/5</a></li>
<li title="add_community-6"><a href="snmp_community_mib.html#add_community-6">add_community/6</a></li>
<li title="delete_community-1"><a href="snmp_community_mib.html#delete_community-1">delete_community/1</a></li>
</ul>
</li>
<li id="no" title="snmp_framework_mib " expanded="false">snmp_framework_mib<ul>
<li><a href="snmp_framework_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_framework_mib.html#configure-1">configure/1</a></li>
<li title="init-0"><a href="snmp_framework_mib.html#init-0">init/0</a></li>
<li title="add_context-1"><a href="snmp_framework_mib.html#add_context-1">add_context/1</a></li>
<li title="delete_context-1"><a href="snmp_framework_mib.html#delete_context-1">delete_context/1</a></li>
</ul>
</li>
<li id="no" title="snmp_generic " expanded="false">snmp_generic<ul>
<li><a href="snmp_generic.html">
Top of manual page
</a></li>
<li title="get_status_col-2"><a href="snmp_generic.html#get_status_col-2">get_status_col/2</a></li>
<li title="get_status_col-2"><a href="snmp_generic.html#get_status_col-2">get_status_col/2</a></li>
<li title="get_index_types-1"><a href="snmp_generic.html#get_index_types-1">get_index_types/1</a></li>
<li title="get_table_info-2"><a href="snmp_generic.html#get_table_info-2">get_table_info/2</a></li>
<li title="table_func-2"><a href="snmp_generic.html#table_func-2">table_func/2</a></li>
<li title="table_func-4"><a href="snmp_generic.html#table_func-4">table_func/4</a></li>
<li title="table_get_elements-3"><a href="snmp_generic.html#table_get_elements-3">table_get_elements/3</a></li>
<li title="table_next-2"><a href="snmp_generic.html#table_next-2">table_next/2</a></li>
<li title="table_row_exists-2"><a href="snmp_generic.html#table_row_exists-2">table_row_exists/2</a></li>
<li title="table_set_elements-3"><a href="snmp_generic.html#table_set_elements-3">table_set_elements/3</a></li>
<li title="variable_func-2"><a href="snmp_generic.html#variable_func-2">variable_func/2</a></li>
<li title="variable_func-3"><a href="snmp_generic.html#variable_func-3">variable_func/3</a></li>
<li title="variable_get-1"><a href="snmp_generic.html#variable_get-1">variable_get/1</a></li>
<li title="variable_set-2"><a href="snmp_generic.html#variable_set-2">variable_set/2</a></li>
</ul>
</li>
<li id="no" title="snmp_index " expanded="false">snmp_index<ul>
<li><a href="snmp_index.html">
Top of manual page
</a></li>
<li title="delete-1"><a href="snmp_index.html#delete-1">delete/1</a></li>
<li title="delete-2"><a href="snmp_index.html#delete-2">delete/2</a></li>
<li title="get-2"><a href="snmp_index.html#get-2">get/2</a></li>
<li title="get_last-1"><a href="snmp_index.html#get_last-1">get_last/1</a></li>
<li title="get_next-2"><a href="snmp_index.html#get_next-2">get_next/2</a></li>
<li title="insert-3"><a href="snmp_index.html#insert-3">insert/3</a></li>
<li title="key_to_oid-2"><a href="snmp_index.html#key_to_oid-2">key_to_oid/2</a></li>
<li title="new-1"><a href="snmp_index.html#new-1">new/1</a></li>
</ul>
</li>
<li id="no" title="snmp_notification_mib " expanded="false">snmp_notification_mib<ul>
<li><a href="snmp_notification_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_notification_mib.html#configure-1">configure/1</a></li>
<li title="reconfigure-1"><a href="snmp_notification_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="add_notify-3"><a href="snmp_notification_mib.html#add_notify-3">add_notify/3</a></li>
<li title="delete_notify-1"><a href="snmp_notification_mib.html#delete_notify-1">delete_notify/1</a></li>
</ul>
</li>
<li id="no" title="snmp_pdus " expanded="false">snmp_pdus<ul>
<li><a href="snmp_pdus.html">
Top of manual page
</a></li>
<li title="dec_message-1"><a href="snmp_pdus.html#dec_message-1">dec_message/1</a></li>
<li title="dec_message_only-1"><a href="snmp_pdus.html#dec_message_only-1">dec_message_only/1</a></li>
<li title="dec_pdu-1"><a href="snmp_pdus.html#dec_pdu-1">dec_pdu/1</a></li>
<li title="dec_scoped_pdu-1"><a href="snmp_pdus.html#dec_scoped_pdu-1">dec_scoped_pdu/1</a></li>
<li title="dec_scoped_pdu_data-1"><a href="snmp_pdus.html#dec_scoped_pdu_data-1">dec_scoped_pdu_data/1</a></li>
<li title="dec_usm_security_parameters-1"><a href="snmp_pdus.html#dec_usm_security_parameters-1">dec_usm_security_parameters/1</a></li>
<li title="enc_encrypted_scoped_pdu-1"><a href="snmp_pdus.html#enc_encrypted_scoped_pdu-1">enc_encrypted_scoped_pdu/1</a></li>
<li title="enc_message-1"><a href="snmp_pdus.html#enc_message-1">enc_message/1</a></li>
<li title="enc_message_only-1"><a href="snmp_pdus.html#enc_message_only-1">enc_message_only/1</a></li>
<li title="enc_pdu-1"><a href="snmp_pdus.html#enc_pdu-1">enc_pdu/1</a></li>
<li title="enc_scoped_pdu-1"><a href="snmp_pdus.html#enc_scoped_pdu-1">enc_scoped_pdu/1</a></li>
<li title="enc_usm_security_parameters-1"><a href="snmp_pdus.html#enc_usm_security_parameters-1">enc_usm_security_parameters/1</a></li>
</ul>
</li>
<li id="no" title="snmp_standard_mib " expanded="false">snmp_standard_mib<ul>
<li><a href="snmp_standard_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_standard_mib.html#configure-1">configure/1</a></li>
<li title="inc-1"><a href="snmp_standard_mib.html#inc-1">inc/1</a></li>
<li title="inc-2"><a href="snmp_standard_mib.html#inc-2">inc/2</a></li>
<li title="reconfigure-1"><a href="snmp_standard_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="reset-0"><a href="snmp_standard_mib.html#reset-0">reset/0</a></li>
<li title="sys_up_time-0"><a href="snmp_standard_mib.html#sys_up_time-0">sys_up_time/0</a></li>
</ul>
</li>
<li id="no" title="snmp_target_mib " expanded="false">snmp_target_mib<ul>
<li><a href="snmp_target_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_target_mib.html#configure-1">configure/1</a></li>
<li title="reconfigure-1"><a href="snmp_target_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="set_target_engine_id-2"><a href="snmp_target_mib.html#set_target_engine_id-2">set_target_engine_id/2</a></li>
<li title="add_addr-10"><a href="snmp_target_mib.html#add_addr-10">add_addr/10</a></li>
<li title="add_addr-11"><a href="snmp_target_mib.html#add_addr-11">add_addr/11</a></li>
<li title="delete_addr-1"><a href="snmp_target_mib.html#delete_addr-1">delete_addr/1</a></li>
<li title="add_params-5"><a href="snmp_target_mib.html#add_params-5">add_params/5</a></li>
<li title="delete_params-1"><a href="snmp_target_mib.html#delete_params-1">delete_params/1</a></li>
</ul>
</li>
<li id="no" title="snmp_user_based_sm_mib " expanded="false">snmp_user_based_sm_mib<ul>
<li><a href="snmp_user_based_sm_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_user_based_sm_mib.html#configure-1">configure/1</a></li>
<li title="reconfigure-1"><a href="snmp_user_based_sm_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="add_user-13"><a href="snmp_user_based_sm_mib.html#add_user-13">add_user/13</a></li>
<li title="delete_user-1"><a href="snmp_user_based_sm_mib.html#delete_user-1">delete_user/1</a></li>
</ul>
</li>
<li id="no" title="snmp_view_based_acm_mib " expanded="false">snmp_view_based_acm_mib<ul>
<li><a href="snmp_view_based_acm_mib.html">
Top of manual page
</a></li>
<li title="configure-1"><a href="snmp_view_based_acm_mib.html#configure-1">configure/1</a></li>
<li title="reconfigure-1"><a href="snmp_view_based_acm_mib.html#reconfigure-1">reconfigure/1</a></li>
<li title="add_sec2group-3"><a href="snmp_view_based_acm_mib.html#add_sec2group-3">add_sec2group/3</a></li>
<li title="delete_sec2group-1"><a href="snmp_view_based_acm_mib.html#delete_sec2group-1">delete_sec2group/1</a></li>
<li title="add_access-8"><a href="snmp_view_based_acm_mib.html#add_access-8">add_access/8</a></li>
<li title="delete_access-1"><a href="snmp_view_based_acm_mib.html#delete_access-1">delete_access/1</a></li>
<li title="add_view_tree_fam-4"><a href="snmp_view_based_acm_mib.html#add_view_tree_fam-4">add_view_tree_fam/4</a></li>
<li title="delete_view_tree_fam-1"><a href="snmp_view_based_acm_mib.html#delete_view_tree_fam-1">delete_view_tree_fam/1</a></li>
</ul>
</li>
<li id="no" title="snmpc " expanded="false">snmpc<ul>
<li><a href="snmpc.html">
Top of manual page
</a></li>
<li title="compile-1"><a href="snmpc.html#compile-1">compile/1</a></li>
<li title="compile-2"><a href="snmpc.html#compile-2">compile/2</a></li>
<li title="is_consistent-1"><a href="snmpc.html#is_consistent-1">is_consistent/1</a></li>
<li title="mib_to_hrl-1"><a href="snmpc.html#mib_to_hrl-1">mib_to_hrl/1</a></li>
</ul>
</li>
<li title="snmpc(command)"><a href="snmpc(command).html">snmpc(command)</a></li>
<li id="loadscrollpos" title="snmpm " expanded="true">snmpm<ul>
<li><a href="snmpm.html">
Top of manual page
</a></li>
<li title="monitor-0"><a href="snmpm.html#monitor-0">monitor/0</a></li>
<li title="demonitor-1"><a href="snmpm.html#demonitor-1">demonitor/1</a></li>
<li title="notify_started-1"><a href="snmpm.html#notify_started-1">notify_started/1</a></li>
<li title="cancel_notify_started-1"><a href="snmpm.html#cancel_notify_started-1">cancel_notify_started/1</a></li>
<li title="register_user-3"><a href="snmpm.html#register_user-3">register_user/3</a></li>
<li title="register_user-4"><a href="snmpm.html#register_user-4">register_user/4</a></li>
<li title="register_user_monitor-3"><a href="snmpm.html#register_user_monitor-3">register_user_monitor/3</a></li>
<li title="register_user_monitor-4"><a href="snmpm.html#register_user_monitor-4">register_user_monitor/4</a></li>
<li title="unregister_user-1"><a href="snmpm.html#unregister_user-1">unregister_user/1</a></li>
<li title="which_users-0"><a href="snmpm.html#which_users-0">which_users/0</a></li>
<li title="register_agent-3"><a href="snmpm.html#register_agent-3">register_agent/3</a></li>
<li title="unregister_agent-2"><a href="snmpm.html#unregister_agent-2">unregister_agent/2</a></li>
<li title="agent_info-2"><a href="snmpm.html#agent_info-2">agent_info/2</a></li>
<li title="update_agent_info-3"><a href="snmpm.html#update_agent_info-3">update_agent_info/3</a></li>
<li title="update_agent_info-4"><a href="snmpm.html#update_agent_info-4">update_agent_info/4</a></li>
<li title="which_agents-0"><a href="snmpm.html#which_agents-0">which_agents/0</a></li>
<li title="which_agents-1"><a href="snmpm.html#which_agents-1">which_agents/1</a></li>
<li title="register_usm_user-3"><a href="snmpm.html#register_usm_user-3">register_usm_user/3</a></li>
<li title="unregister_usm_user-2"><a href="snmpm.html#unregister_usm_user-2">unregister_usm_user/2</a></li>
<li title="usm_user_info-3"><a href="snmpm.html#usm_user_info-3">usm_user_info/3</a></li>
<li title="update_usm_user_info-4"><a href="snmpm.html#update_usm_user_info-4">update_usm_user_info/4</a></li>
<li title="which_usm_users-0"><a href="snmpm.html#which_usm_users-0">which_usm_users/0</a></li>
<li title="which_usm_users-1"><a href="snmpm.html#which_usm_users-1">which_usm_users/1</a></li>
<li title="sync_get2-3"><a href="snmpm.html#sync_get2-3">sync_get2/3</a></li>
<li title="sync_get2-4"><a href="snmpm.html#sync_get2-4">sync_get2/4</a></li>
<li title="sync_get-3"><a href="snmpm.html#sync_get-3">sync_get/3</a></li>
<li title="sync_get-4"><a href="snmpm.html#sync_get-4">sync_get/4</a></li>
<li title="sync_get-4"><a href="snmpm.html#sync_get-4">sync_get/4</a></li>
<li title="sync_get-5"><a href="snmpm.html#sync_get-5">sync_get/5</a></li>
<li title="sync_get-6"><a href="snmpm.html#sync_get-6">sync_get/6</a></li>
<li title="async_get2-3"><a href="snmpm.html#async_get2-3">async_get2/3</a></li>
<li title="async_get2-4"><a href="snmpm.html#async_get2-4">async_get2/4</a></li>
<li title="async_get-3"><a href="snmpm.html#async_get-3">async_get/3</a></li>
<li title="async_get-4"><a href="snmpm.html#async_get-4">async_get/4</a></li>
<li title="async_get-4"><a href="snmpm.html#async_get-4">async_get/4</a></li>
<li title="async_get-5"><a href="snmpm.html#async_get-5">async_get/5</a></li>
<li title="async_get-6"><a href="snmpm.html#async_get-6">async_get/6</a></li>
<li title="sync_get_next2-3"><a href="snmpm.html#sync_get_next2-3">sync_get_next2/3</a></li>
<li title="sync_get_next2-4"><a href="snmpm.html#sync_get_next2-4">sync_get_next2/4</a></li>
<li title="sync_get_next-3"><a href="snmpm.html#sync_get_next-3">sync_get_next/3</a></li>
<li title="sync_get_next-4"><a href="snmpm.html#sync_get_next-4">sync_get_next/4</a></li>
<li title="sync_get_next-4"><a href="snmpm.html#sync_get_next-4">sync_get_next/4</a></li>
<li title="sync_get_next-5"><a href="snmpm.html#sync_get_next-5">sync_get_next/5</a></li>
<li title="sync_get_next-6"><a href="snmpm.html#sync_get_next-6">sync_get_next/6</a></li>
<li title="async_get_next2-3"><a href="snmpm.html#async_get_next2-3">async_get_next2/3</a></li>
<li title="async_get_next2-4"><a href="snmpm.html#async_get_next2-4">async_get_next2/4</a></li>
<li title="async_get_next-3"><a href="snmpm.html#async_get_next-3">async_get_next/3</a></li>
<li title="async_get_next-4"><a href="snmpm.html#async_get_next-4">async_get_next/4</a></li>
<li title="async_get_next-4"><a href="snmpm.html#async_get_next-4">async_get_next/4</a></li>
<li title="async_get_next-5"><a href="snmpm.html#async_get_next-5">async_get_next/5</a></li>
<li title="async_get_next-6"><a href="snmpm.html#async_get_next-6">async_get_next/6</a></li>
<li title="sync_set2-3"><a href="snmpm.html#sync_set2-3">sync_set2/3</a></li>
<li title="sync_set2-4"><a href="snmpm.html#sync_set2-4">sync_set2/4</a></li>
<li title="sync_set-3"><a href="snmpm.html#sync_set-3">sync_set/3</a></li>
<li title="sync_set-4"><a href="snmpm.html#sync_set-4">sync_set/4</a></li>
<li title="sync_set-4"><a href="snmpm.html#sync_set-4">sync_set/4</a></li>
<li title="sync_set-5"><a href="snmpm.html#sync_set-5">sync_set/5</a></li>
<li title="sync_set-6"><a href="snmpm.html#sync_set-6">sync_set/6</a></li>
<li title="async_set2-3"><a href="snmpm.html#async_set2-3">async_set2/3</a></li>
<li title="async_set2-4"><a href="snmpm.html#async_set2-4">async_set2/4</a></li>
<li title="async_set-3"><a href="snmpm.html#async_set-3">async_set/3</a></li>
<li title="async_set-4"><a href="snmpm.html#async_set-4">async_set/4</a></li>
<li title="async_set-4"><a href="snmpm.html#async_set-4">async_set/4</a></li>
<li title="async_set-5"><a href="snmpm.html#async_set-5">async_set/5</a></li>
<li title="async_set-6"><a href="snmpm.html#async_set-6">async_set/6</a></li>
<li title="sync_get_bulk2-5"><a href="snmpm.html#sync_get_bulk2-5">sync_get_bulk2/5</a></li>
<li title="sync_get_bulk2-6"><a href="snmpm.html#sync_get_bulk2-6">sync_get_bulk2/6</a></li>
<li title="sync_get_bulk-5"><a href="snmpm.html#sync_get_bulk-5">sync_get_bulk/5</a></li>
<li title="sync_get_bulk-6"><a href="snmpm.html#sync_get_bulk-6">sync_get_bulk/6</a></li>
<li title="sync_get_bulk-6"><a href="snmpm.html#sync_get_bulk-6">sync_get_bulk/6</a></li>
<li title="sync_get_bulk-7"><a href="snmpm.html#sync_get_bulk-7">sync_get_bulk/7</a></li>
<li title="sync_get_bulk-8"><a href="snmpm.html#sync_get_bulk-8">sync_get_bulk/8</a></li>
<li title="async_get_bulk2-5"><a href="snmpm.html#async_get_bulk2-5">async_get_bulk2/5</a></li>
<li title="async_get_bulk2-6"><a href="snmpm.html#async_get_bulk2-6">async_get_bulk2/6</a></li>
<li title="async_get_bulk-5"><a href="snmpm.html#async_get_bulk-5">async_get_bulk/5</a></li>
<li title="async_get_bulk-6"><a href="snmpm.html#async_get_bulk-6">async_get_bulk/6</a></li>
<li title="async_get_bulk-6"><a href="snmpm.html#async_get_bulk-6">async_get_bulk/6</a></li>
<li title="async_get_bulk-7"><a href="snmpm.html#async_get_bulk-7">async_get_bulk/7</a></li>
<li title="async_get_bulk-8"><a href="snmpm.html#async_get_bulk-8">async_get_bulk/8</a></li>
<li title="cancel_async_request-2"><a href="snmpm.html#cancel_async_request-2">cancel_async_request/2</a></li>
<li title="log_to_txt-2"><a href="snmpm.html#log_to_txt-2">log_to_txt/2</a></li>
<li title="log_to_txt-3"><a href="snmpm.html#log_to_txt-3">log_to_txt/3</a></li>
<li title="log_to_txt-4"><a href="snmpm.html#log_to_txt-4">log_to_txt/4</a></li>
<li title="log_to_txt-5"><a href="snmpm.html#log_to_txt-5">log_to_txt/5</a></li>
<li title="log_to_txt-6"><a href="snmpm.html#log_to_txt-6">log_to_txt/6</a></li>
<li title="log_to_txt-7"><a href="snmpm.html#log_to_txt-7">log_to_txt/7</a></li>
<li title="log_to_io-1"><a href="snmpm.html#log_to_io-1">log_to_io/1</a></li>
<li title="log_to_io-2"><a href="snmpm.html#log_to_io-2">log_to_io/2</a></li>
<li title="log_to_io-2"><a href="snmpm.html#log_to_io-2">log_to_io/2</a></li>
<li title="log_to_io-3"><a href="snmpm.html#log_to_io-3">log_to_io/3</a></li>
<li title="log_to_io-4"><a href="snmpm.html#log_to_io-4">log_to_io/4</a></li>
<li title="log_to_io-5"><a href="snmpm.html#log_to_io-5">log_to_io/5</a></li>
<li title="log_to_io-6"><a href="snmpm.html#log_to_io-6">log_to_io/6</a></li>
<li title="change_log_size-1"><a href="snmpm.html#change_log_size-1">change_log_size/1</a></li>
<li title="set_log_type-1"><a href="snmpm.html#set_log_type-1">set_log_type/1</a></li>
<li title="load_mib-1"><a href="snmpm.html#load_mib-1">load_mib/1</a></li>
<li title="unload_mib-1"><a href="snmpm.html#unload_mib-1">unload_mib/1</a></li>
<li title="which_mibs-0"><a href="snmpm.html#which_mibs-0">which_mibs/0</a></li>
<li title="name_to_oid-1"><a href="snmpm.html#name_to_oid-1">name_to_oid/1</a></li>
<li title="oid_to_name-1"><a href="snmpm.html#oid_to_name-1">oid_to_name/1</a></li>
<li title="oid_to_type-1"><a href="snmpm.html#oid_to_type-1">oid_to_type/1</a></li>
<li title="backup-1"><a href="snmpm.html#backup-1">backup/1</a></li>
<li title="info-0"><a href="snmpm.html#info-0">info/0</a></li>
<li title="verbosity-2"><a href="snmpm.html#verbosity-2">verbosity/2</a></li>
<li title="format_reason-1"><a href="snmpm.html#format_reason-1">format_reason/1</a></li>
<li title="format_reason-2"><a href="snmpm.html#format_reason-2">format_reason/2</a></li>
</ul>
</li>
<li id="no" title="snmpm_conf " expanded="false">snmpm_conf<ul>
<li><a href="snmpm_conf.html">
Top of manual page
</a></li>
<li title="manager_entry-2"><a href="snmpm_conf.html#manager_entry-2">manager_entry/2</a></li>
<li title="write_manager_config-2"><a href="snmpm_conf.html#write_manager_config-2">write_manager_config/2</a></li>
<li title="write_manager_config-3"><a href="snmpm_conf.html#write_manager_config-3">write_manager_config/3</a></li>
<li title="append_manager_config-2"><a href="snmpm_conf.html#append_manager_config-2">append_manager_config/2</a></li>
<li title="read_manager_config-1"><a href="snmpm_conf.html#read_manager_config-1">read_manager_config/1</a></li>
<li title="users_entry-1"><a href="snmpm_conf.html#users_entry-1">users_entry/1</a></li>
<li title="users_entry-2"><a href="snmpm_conf.html#users_entry-2">users_entry/2</a></li>
<li title="users_entry-3"><a href="snmpm_conf.html#users_entry-3">users_entry/3</a></li>
<li title="write_users_config-2"><a href="snmpm_conf.html#write_users_config-2">write_users_config/2</a></li>
<li title="write_users_config-3"><a href="snmpm_conf.html#write_users_config-3">write_users_config/3</a></li>
<li title="append_users_config-2"><a href="snmpm_conf.html#append_users_config-2">append_users_config/2</a></li>
<li title="read_users_config-1"><a href="snmpm_conf.html#read_users_config-1">read_users_config/1</a></li>
<li title="agents_entry-12"><a href="snmpm_conf.html#agents_entry-12">agents_entry/12</a></li>
<li title="write_agents_config-2"><a href="snmpm_conf.html#write_agents_config-2">write_agents_config/2</a></li>
<li title="write_agents_config-3"><a href="snmpm_conf.html#write_agents_config-3">write_agents_config/3</a></li>
<li title="append_agents_config-2"><a href="snmpm_conf.html#append_agents_config-2">append_agents_config/2</a></li>
<li title="read_agents_config-1"><a href="snmpm_conf.html#read_agents_config-1">read_agents_config/1</a></li>
<li title="usm_entry-6"><a href="snmpm_conf.html#usm_entry-6">usm_entry/6</a></li>
<li title="usm_entry-7"><a href="snmpm_conf.html#usm_entry-7">usm_entry/7</a></li>
<li title="write_usm_config-2"><a href="snmpm_conf.html#write_usm_config-2">write_usm_config/2</a></li>
<li title="write_usm_config-3"><a href="snmpm_conf.html#write_usm_config-3">write_usm_config/3</a></li>
<li title="append_usm_config-2"><a href="snmpm_conf.html#append_usm_config-2">append_usm_config/2</a></li>
<li title="read_usm_config-1"><a href="snmpm_conf.html#read_usm_config-1">read_usm_config/1</a></li>
</ul>
</li>
<li id="no" title="snmpm_mpd " expanded="false">snmpm_mpd<ul>
<li><a href="snmpm_mpd.html">
Top of manual page
</a></li>
<li title="init_mpd-1"><a href="snmpm_mpd.html#init_mpd-1">init_mpd/1</a></li>
<li title="process_msg-7"><a href="snmpm_mpd.html#process_msg-7">process_msg/7</a></li>
<li title="generate_msg-5"><a href="snmpm_mpd.html#generate_msg-5">generate_msg/5</a></li>
<li title="generate_response_msg-4"><a href="snmpm_mpd.html#generate_response_msg-4">generate_response_msg/4</a></li>
</ul>
</li>
<li id="no" title="snmpm_network_interface " expanded="false">snmpm_network_interface<ul>
<li><a href="snmpm_network_interface.html">
Top of manual page
</a></li>
<li title="start_link-2"><a href="snmpm_network_interface.html#start_link-2">start_link/2</a></li>
<li title="stop-1"><a href="snmpm_network_interface.html#stop-1">stop/1</a></li>
<li title="send_pdu-7"><a href="snmpm_network_interface.html#send_pdu-7">send_pdu/7</a></li>
<li title="inform_response-4"><a href="snmpm_network_interface.html#inform_response-4">inform_response/4</a></li>
<li title="note_store-2"><a href="snmpm_network_interface.html#note_store-2">note_store/2</a></li>
<li title="info-1"><a href="snmpm_network_interface.html#info-1">info/1</a></li>
<li title="verbosity-2"><a href="snmpm_network_interface.html#verbosity-2">verbosity/2</a></li>
<li title="get_log_type-1"><a href="snmpm_network_interface.html#get_log_type-1">get_log_type/1</a></li>
<li title="set_log_type-2"><a href="snmpm_network_interface.html#set_log_type-2">set_log_type/2</a></li>
</ul>
</li>
<li id="no" title="snmpm_user " expanded="false">snmpm_user<ul>
<li><a href="snmpm_user.html">
Top of manual page
</a></li>
<li title="handle_error-3"><a href="snmpm_user.html#handle_error-3">handle_error/3</a></li>
<li title="handle_agent-5"><a href="snmpm_user.html#handle_agent-5">handle_agent/5</a></li>
<li title="handle_pdu-4"><a href="snmpm_user.html#handle_pdu-4">handle_pdu/4</a></li>
<li title="handle_trap-3"><a href="snmpm_user.html#handle_trap-3">handle_trap/3</a></li>
<li title="handle_inform-3"><a href="snmpm_user.html#handle_inform-3">handle_inform/3</a></li>
<li title="handle_report-3"><a href="snmpm_user.html#handle_report-3">handle_report/3</a></li>
</ul>
</li>
<li id="no" title="snmpm_network_interface_filter " expanded="false">snmpm_network_interface_filter<ul>
<li><a href="snmpm_network_interface_filter.html">
Top of manual page
</a></li>
<li title="accept_recv-2"><a href="snmpm_network_interface_filter.html#accept_recv-2">accept_recv/2</a></li>
<li title="accept_send-2"><a href="snmpm_network_interface_filter.html#accept_send-2">accept_send/2</a></li>
<li title="accept_recv_pdu-3"><a href="snmpm_network_interface_filter.html#accept_recv_pdu-3">accept_recv_pdu/3</a></li>
<li title="accept_send_pdu-3"><a href="snmpm_network_interface_filter.html#accept_send_pdu-3">accept_send_pdu/3</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>snmpm</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">snmpm</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Interface functions to the SNMP toolkit manager</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>The module <span class="code">snmpm</span> contains interface functions to the
SNMP manager. </p>
</p></div>
<h3><a name="id121454">Common Data Types</a></h3>
<div class="REFBODY">
<p>The following data types are used in the functions below:</p>
<div class="example"><pre>
oid() = [byte()] - The oid() type is used to represent an ASN.1 OBJECT IDENTIFIER
snmp_reply() = {error_status(), error_index(), varbinds()}
error_status() = noError | atom()
error_index() = integer()
varbinds() = [varbind()]
atl_type() = read | write | read_write
target_name() = string() - Is a unique *non-empty* string
vars_and_vals() = [var_and_val()]
var_and_val() = {oid(), value_type(), value()} | {oid(), value()}
value_type() = o ('OBJECT IDENTIFIER') |
i ('INTEGER') |
u ('Unsigned32') |
g ('Unsigned32') |
s ('OCTET SRING') |
b ('BITS') |
ip ('IpAddress') |
op ('Opaque') |
c32 ('Counter32') |
c64 ('Counter64') |
tt ('TimeTicks')
value() = term()
community() = string()
sec_model() = any | v1 | v2c | usm
sec_name() = string()
sec_level() = noAuthNoPriv | authNoPriv | authPriv
</pre></div>
<a name="monitor"></a>
</div>
<h3>EXPORTS</h3>
<p><a name="monitor-0"><span class="bold_code">monitor() -> Ref</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Ref = reference()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Monitor the SNMP manager. In case of a crash, the calling
(monitoring) process will get a 'DOWN' message (see the erlang
module for more info). </p>
<a name="demonitor"></a>
</p></div>
<p><a name="demonitor-1"><span class="bold_code">demonitor(Ref) -> void()</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Ref = reference()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Turn off monitoring of the SNMP manager. </p>
<a name="notify_started"></a>
</p></div>
<p><a name="notify_started-1"><span class="bold_code">notify_started(Timeout) -> Pid</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Timeout = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Pid = pid()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Request a notification (message) when the SNMP manager has
started. </p>
<p>The <span class="code">Timeout</span> is the time the request is valid. The
value has to be greater then zero. </p>
<p>The <span class="code">Pid</span> is the process handling the supervision of the
SNMP manager start. When the manager has started a completion
message will be sent to the client from this process:
<span class="code">{snmpm_started, Pid}</span>. If the SNMP manager was not started
in time, a timeout message will be sent to the client:
<span class="code">{snmpm_start_timeout, Pid}</span>. </p>
<p>A client application that is dependent on the SNMP manager
will use this function in order to be notified of when the
manager has started. There are two situations when this
is useful:</p>
<ul>
<li>
<p>During the start of a system, when a client application
<strong>could</strong> start prior to the SNMP manager but is dependent
upon it, and therefor has to wait for it to start.</p>
</li>
<li>
<p>When the SNMP manager has crashed, the dependent client
application has to wait for the SNMP manager to be restarted
before it can <strong>reconnect</strong>.</p>
</li>
</ul>
<p>The function returns the pid() of a handler process, that does
the supervision on behalf of the client application. Note that the
client application is linked to this handler. </p>
<p>This function is used in conjunction with the monitor function.</p>
<a name="cancel_notify_started"></a>
</p></div>
<p><a name="cancel_notify_started-1"><span class="bold_code">cancel_notify_started(Pid) -> void()</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Pid = pid()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Cancel a previous request to be notified of SNMP manager start.</p>
<a name="register_user"></a>
</p></div>
<p><a name="register_user-3"><span class="bold_code">register_user(Id, Module, Data) -> ok | {error, Reason}</span></a><br><a name="register_user-4"><span class="bold_code">register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Id = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Module = snmpm_user()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Data = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">DefaultAgentConfig = [default_agent_config()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">default_agent_config() = {Item, Val}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = community | timeout | max_message_size | version | sec_model | sec_name | sec_level</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">snmpm_user() = Module implementing the snmpm_user behaviour</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Register the manager entity (=user) responsible for specific
agent(s). </p>
<p><span class="code">Module</span> is the callback module (snmpm_user behaviour) which
will be called whenever something happens (detected
agent, incoming reply or incoming trap/notification).
Note that this could have already been done as a
consequence of the node config. (see users.conf).</p>
<p>The argument <span class="code">DefaultAgentConfig</span> is used as default
values when this user register agents.</p>
<p>The type of <span class="code">Val</span> depends on <span class="code">Item</span>: </p>
<div class="example"><pre>
community = string()
timeout = integer() | snmp_timer()
max_message_size = integer()
version = v1 | v2 | v3
sec_model = any | v1 | v2c | usm
sec_name = string()
sec_level = noAuthNoPriv | authNoPriv | authPriv
</pre></div>
<a name="register_user_monitor"></a>
</p></div>
<p><a name="register_user_monitor-3"><span class="bold_code">register_user_monitor(Id, Module, Data) -> ok | {error, Reason}</span></a><br><a name="register_user_monitor-4"><span class="bold_code">register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Id = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Module = snmpm_user()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">DefaultAgentConfig = [default_agent_config()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">default_agent_config() = {Item, Val}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = community | timeout | max_message_size | version | sec_model | sec_name | sec_level</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Data = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">snmpm_user() = Module implementing the snmpm_user behaviour</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Register the monitored manager entity (=user) responsible
for specific agent(s). </p>
<p>The process performing the registration will be monitored.
Which means that if that process should die, all agents
registered by that user process will be unregistered. All
outstanding requests will be canceled. </p>
<p><span class="code">Module</span> is the callback module (snmpm_user behaviour) which
will be called whenever something happens (detected
agent, incoming reply or incoming trap/notification).
Note that this could have already been done as a
consequence of the node config. (see users.conf).</p>
<p>The argument <span class="code">DefaultAgentConfig</span> is used as default values when
this user register agents.</p>
<p>The type of <span class="code">Val</span> depends on <span class="code">Item</span>: </p>
<div class="example"><pre>
community = string()
timeout = integer() | snmp_timer()
max_message_size = integer()
version = v1 | v2 | v3
sec_model = any | v1 | v2c | usm
sec_name = string()
sec_level = noAuthNoPriv | authNoPriv | authPriv
</pre></div>
<a name="unregister_user"></a>
</p></div>
<p><a name="unregister_user-1"><span class="bold_code">unregister_user(Id) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Id = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Unregister the user.</p>
<a name="which_users"></a>
</p></div>
<p><a name="which_users-0"><span class="bold_code">which_users() -> Users</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Users = [UserId]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get a list of the identities of all registered users.</p>
<a name="register_agent"></a>
</p></div>
<p><a name="register_agent-3"><span class="bold_code">register_agent(UserId, TargetName, Config) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Addr = ip_address()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Config = [agent_config()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">agent_config() = {Item, Val}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = engine_id | address | port | community | timeout | max_message_size | version | sec_model | sec_name | sec_level | tdomain</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Explicitly instruct the manager to handle this agent, with
<span class="code">UserId</span> as the responsible user. </p>
<p>Called to instruct the manager that this agent shall be handled.
This function is used when the user knows in advance which agents
the manager shall handle.
Note that there is an alternate way to do the same thing:
Add the agent to the manager config files (see
<span class="bold_code"><a href="snmp_manager_config_files.html#agents">agents.conf</a></span>).</p>
<p><span class="code">TargetName</span> is a non-empty string,
uniquely identifying the agent. </p>
<p>The type of <span class="code">Val</span> depends on <span class="code">Item</span>: </p>
<div class="example"><pre>
[mandatory] engine_id = string()
[mandatory] address = ip_address()
[optional] port = integer()
[optional] tdomain = transportDomainUdpIpv4 | transportDomainUdpIpv6
[optional] community = string()
[optional] timeout = integer() | snmp_timer()
[optional] max_message_size = integer()
[optional] version = v1 | v2 | v3
[optional] sec_model = any | v1 | v2c | usm
[optional] sec_name = string()
[optional] sec_level = noAuthNoPriv | authNoPriv | authPriv
</pre></div>
<p>Note that if no <span class="code">tdomain</span> is given, the default value,
<span class="code">transportDomainUdpIpv4</span>, is used.</p>
<p>Note that if no <span class="code">port</span> is given, the default value is used.</p>
<a name="unregister_agent"></a>
</p></div>
<p><a name="unregister_agent-2"><span class="bold_code">unregister_agent(UserId, TargetName) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Unregister the agent.</p>
<a name="agent_info"></a>
</p></div>
<p><a name="agent_info-2"><span class="bold_code">agent_info(TargetName, Item) -> {ok, Val} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Retrieve agent config.</p>
<a name="update_agent_info"></a>
</p></div>
<p><a name="update_agent_info-3"><span class="bold_code">update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason}</span></a><br><a name="update_agent_info-4"><span class="bold_code">update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Info = [{item(), item_value()}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = item()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">item() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = item_value()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">item_value() = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Update agent config. The function <span class="code">update_agent_info/3</span>
should be used when several values needs to be updated atomically. </p>
<p>See function
<span class="bold_code"><a href="#register_agent">register_agent</a></span>)
for more info about what kind of items are allowed. </p>
<a name="which_agents"></a>
</p></div>
<p><a name="which_agents-0"><span class="bold_code">which_agents() -> Agents</span></a><br><a name="which_agents-1"><span class="bold_code">which_agents(UserId) -> Agents</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Agents = [TargetName]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get a list of all registered agents or all agents registered
by a specific user.</p>
<a name="register_usm_user"></a>
</p></div>
<p><a name="register_usm_user-3"><span class="bold_code">register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">EngineID = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UserName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Conf = [usm_config()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">usm_config() = {Item, Val}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = sec_name | auth | auth_key | priv | priv_key</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Explicitly instruct the manager to handle this USM user.
Note that there is an alternate way to do the same thing:
Add the usm user to the manager config files (see
<span class="bold_code"><a href="snmp_manager_config_files.html#usm_user">usm.conf</a></span>).</p>
<p>The type of <span class="code">Val</span> depends on <span class="code">Item</span>: </p>
<div class="example"><pre>
sec_name = string()
auth = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocoltimeout
auth_key = [integer()] (length 16 if auth = usmHMACMD5AuthProtocol,
length 20 if auth = usmHMACSHAAuthProtocol)
priv = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol
priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb128Protocol).
</pre></div>
<a name="unregister_usm_user"></a>
</p></div>
<p><a name="unregister_usm_user-2"><span class="bold_code">unregister_usm_user(EngineID, UserName) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">EngineID = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UserName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Unregister this USM user.</p>
<a name="which_usm_users1"></a>
</p></div>
<p><a name="usm_user_info-3"><span class="bold_code">usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">EngineID = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UsmName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = sec_name | auth | auth_key | priv | priv_key</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Retrieve usm user config.</p>
<a name="update_usm_user_info"></a>
</p></div>
<p><a name="update_usm_user_info-4"><span class="bold_code">update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">EngineID = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UsmName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Item = sec_name | auth | auth_key | priv | priv_key</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Update usm user config.</p>
<a name="which_usm_users"></a>
</p></div>
<p><a name="which_usm_users-0"><span class="bold_code">which_usm_users() -> UsmUsers</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UsmUsers = [{EngineID,UserName}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">EngineID = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UsmName = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get a list of all registered usm users.</p>
<a name="which_usm_users2"></a>
</p></div>
<p><a name="which_usm_users-1"><span class="bold_code">which_usm_users(EngineID) -> UsmUsers</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UsmUsers = [UserName]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">UserName = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get a list of all registered usm users with engine-id
<span class="code">EngineID</span>.</p>
<a name="sync_get2"></a>
</p></div>
<p><a name="sync_get2-3"><span class="bold_code">sync_get2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get2-4"><span class="bold_code">sync_get2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ActualReason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SecInfo = [sec_info()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_tag() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExpectedValue = ReceivedValue = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpInfo = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-request</span>. </p>
<p><span class="code">Remaining</span> is the remaining time of the given (or default)
timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error.
<strong>ActualReason</strong> is the actual reason in this case. </p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<p>For <span class="code">SnmpInfo</span>, see the user callback function
<span class="bold_code"><a href="snmpm_user.html#handle_report">handle_report</a></span>.</p>
<a name="sync_get"></a>
</p></div>
<p><a name="sync_get-3"><span class="bold_code">sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get-4"><span class="bold_code">sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get-4"><span class="bold_code">sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get-5"><span class="bold_code">sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get-6"><span class="bold_code">sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">R = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SecInfo = [sec_info()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_tag() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExpectedValue = ReceivedValue = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpInfo = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-request</span>. </p>
<p><span class="code">Remaining</span> is the remaining time of the given or
default timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error. <strong>R</strong>
is the actual reason in this case. </p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>For <span class="code">SnmpInfo</span>, see the user callback function
<span class="bold_code"><a href="snmpm_user.html#handle_report">handle_report</a></span>.</p>
<a name="async_get2"></a>
</p></div>
<p><a name="async_get2-3"><span class="bold_code">async_get2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get2-4"><span class="bold_code">async_get2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-request</span>.</p>
<p>The reply, if it arrives, will be delivered to the user
through a call to the snmpm_user callback function
<span class="code">handle_pdu</span>.</p>
<p>The send option <span class="code">timeout</span> specifies for how long the request is
valid (after which the manager is free to delete it).</p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<a name="async_get"></a>
</p></div>
<p><a name="async_get-3"><span class="bold_code">async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get-4"><span class="bold_code">async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get-4"><span class="bold_code">async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get-5"><span class="bold_code">async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get-6"><span class="bold_code">async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Expire = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-request</span>.</p>
<p>The reply, if it arrives, will be delivered to the user
through a call to the snmpm_user callback function
<span class="code">handle_pdu</span>.</p>
<p>The <span class="code">Expire</span> time indicates for how long the request is
valid (after which the manager is free to delete it).</p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="sync_get_next2"></a>
</p></div>
<p><a name="sync_get_next2-3"><span class="bold_code">sync_get_next2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_next2-4"><span class="bold_code">sync_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ActualReason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SecInfo = [sec_info()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_tag() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExpectedValue = ReceivedValue = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpInfo = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-next-request</span>. </p>
<p><span class="code">Remaining</span> is the remaining time of the given (or default)
timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error.
<strong>ActualReason</strong> is the actual reason in this case. </p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<p>For <span class="code">SnmpInfo</span>, see the user callback function
<span class="bold_code"><a href="snmpm_user.html#handle_report">handle_report</a></span>.</p>
<a name="sync_get_next"></a>
</p></div>
<p><a name="sync_get_next-3"><span class="bold_code">sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_next-4"><span class="bold_code">sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_next-4"><span class="bold_code">sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_next-5"><span class="bold_code">sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_next-6"><span class="bold_code">sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">R = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-next-request</span>. </p>
<p><span class="code">Remaining</span> time of the given or default timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error. <strong>R</strong>
is the actual reason in this case. </p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="async_get_next2"></a>
</p></div>
<p><a name="async_get_next2-3"><span class="bold_code">async_get_next2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_next2-4"><span class="bold_code">async_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-next-request</span>. </p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The send option <span class="code">timeout</span> specifies for how long the request is
valid (after which the manager is free to delete it).</p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<a name="async_get_next"></a>
</p></div>
<p><a name="async_get_next-3"><span class="bold_code">async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_next-4"><span class="bold_code">async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_next-4"><span class="bold_code">async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_next-5"><span class="bold_code">async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_next-6"><span class="bold_code">async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Expire = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-next-request</span>. </p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The <span class="code">Expire</span> time indicates for how long the request is
valid (after which the manager is free to delete it).</p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="sync_set2"></a>
</p></div>
<p><a name="sync_set2-3"><span class="bold_code">sync_set2(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_set2-4"><span class="bold_code">sync_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">VarsAndVals = vars_and_vals()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ActualReason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SecInfo = [sec_info()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_tag() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExpectedValue = ReceivedValue = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpInfo = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">set-request</span>. </p>
<p><span class="code">Remaining</span> is the remaining time of the given (or default)
timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error.
<strong>ActualReason</strong> is the actual reason in this case. </p>
<p>When <strong>var_and_val()</strong> is <strong>{oid(), value()}</strong>, the
manager makes an educated guess based on the loaded mibs. </p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<p>For <span class="code">SnmpInfo</span>, see the user callback function
<span class="bold_code"><a href="snmpm_user.html#handle_report">handle_report</a></span>.</p>
<a name="sync_set"></a>
</p></div>
<p><a name="sync_set-3"><span class="bold_code">sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_set-4"><span class="bold_code">sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_set-4"><span class="bold_code">sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_set-5"><span class="bold_code">sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_set-6"><span class="bold_code">sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">VarsAndVals = vars_and_vals()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ActualReason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">set-request</span>. </p>
<p><span class="code">Remaining</span> time of the given or default timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error. <strong>R</strong>
is the actual reason in this case. </p>
<p>When <strong>var_and_val()</strong> is <strong>{oid(), value()}</strong>, the
manager makes an educated guess based on the loaded mibs. </p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="async_set2"></a>
</p></div>
<p><a name="async_set2-3"><span class="bold_code">async_set2(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_set2-4"><span class="bold_code">async_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">VarsAndVals = vars_and_vals()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">set-request</span>. </p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The send option <span class="code">timeout</span> specifies for how long the request is
valid (after which the manager is free to delete it).</p>
<p>When <strong>var_and_val()</strong> is <strong>{oid(), value()}</strong>, the
manager makes an educated guess based on the loaded mibs. </p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<a name="async_set"></a>
</p></div>
<p><a name="async_set-3"><span class="bold_code">async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_set-4"><span class="bold_code">async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_set-4"><span class="bold_code">async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_set-5"><span class="bold_code">async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_set-6"><span class="bold_code">async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">VarsAndVals = vars_and_vals()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Expire = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">set-request</span>. </p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The <span class="code">Expire</span> time indicates for how long the request is
valid (after which the manager is free to delete it).</p>
<p>When <strong>var_and_val()</strong> is <strong>{oid(), value()}</strong>, the
manager makes an educated guess based on the loaded mibs. </p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="sync_get_bulk2"></a>
</p></div>
<p><a name="sync_get_bulk2-5"><span class="bold_code">sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_bulk2-6"><span class="bold_code">sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">NonRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ActualReason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SecInfo = [sec_info()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">sec_tag() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExpectedValue = ReceivedValue = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpInfo = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-bulk-request</span> (See RFC1905).</p>
<p><span class="code">Remaining</span> is the remaining time of the given (or default)
timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error.
<strong>ActualReason</strong> is the actual reason in this case. </p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a option (when using the built in
net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<p>For <span class="code">SnmpInfo</span>, see the user callback function
<span class="bold_code"><a href="snmpm_user.html#handle_report">handle_report</a></span>.</p>
<a name="sync_get_bulk"></a>
</p></div>
<p><a name="sync_get_bulk-5"><span class="bold_code">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_bulk-6"><span class="bold_code">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_bulk-6"><span class="bold_code">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_bulk-7"><span class="bold_code">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br><a name="sync_get_bulk-8"><span class="bold_code">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">NonRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Timeout = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SnmpReply = snmp_reply()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Remaining = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Synchronous <span class="code">get-bulk-request</span> (See RFC1905).</p>
<p><span class="code">Remaining</span> time of the given or default timeout time.</p>
<p>When <strong>Reason</strong> is <strong>{send_failed, ...}</strong> it means that
the net_if process failed to send the message. This could happen
because of any number of reasons, i.e. encoding error. <strong>R</strong>
is the actual reason in this case. </p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="async_get_bulk2"></a>
</p></div>
<p><a name="async_get_bulk2-5"><span class="bold_code">async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_bulk2-6"><span class="bold_code">async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">NonRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SendOpts = send_opts()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opts() = [send_opt()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">send_opt() = {context, string()} | {timeout, pos_integer()} | {extra, term()} | {community, community()} | {sec_model, sec_model()} | {sec_name, string()} | {sec_level, sec_level()} | {max_message_size, pos_integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-bulk-request</span> (See RFC1905).</p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The send option <span class="code">timeout</span> specifies for how long the request is
valid (after which the manager is free to delete it).</p>
<p>The send option <span class="code">extra</span> specifies an opaque data structure
passed on to the net-if process. The net-if process included in this
application makes no use of this info, so the only use for it
in such a configuration (when using the built in net-if) would
be tracing.</p>
<p>Some of the send options (<span class="code">community</span>, <span class="code">sec_model</span>,
<span class="code">sec_name</span>, <span class="code">sec_level</span> and <span class="code">max_message_size</span>)
are <span class="code">override options</span>. That is,
for <strong>this</strong> request, they override any configuration done
when the agent was registered. </p>
<a name="async_get_bulk"></a>
</p></div>
<p><a name="async_get_bulk-5"><span class="bold_code">async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_bulk-6"><span class="bold_code">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_bulk-6"><span class="bold_code">async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_bulk-7"><span class="bold_code">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</span></a><br><a name="async_get_bulk-8"><span class="bold_code">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TargetName = target_name()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">NonRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxRep = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ContextName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Expire = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ExtraInfo = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Asynchronous <span class="code">get-bulk-request</span> (See RFC1905).</p>
<p>The reply will be delivered to the user through a call
to the snmpm_user callback function <span class="code">handle_pdu</span>.</p>
<p>The <span class="code">Expire</span> time indicates for how long the request is
valid (after which the manager is free to delete it).</p>
<p><span class="code">ExtraInfo</span> is an opaque data structure passed on to
the net-if process. The net-if process included in this
application makes, with one exception, no use of this info,
so the only use for it in such a configuration (when using the
built in net-if) would be tracing. The one usage exception is:
<strong>Any</strong> tuple with <span class="code">snmpm_extra_info_tag</span> as its first
element is reserved for internal use. </p>
<a name="cancel_async_request"></a>
</p></div>
<p><a name="cancel_async_request-2"><span class="bold_code">cancel_async_request(UserId, ReqId) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">UserId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">ReqId = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Cancel a previous asynchronous request.</p>
<a name="log_to_txt"></a>
</p></div>
<p><a name="log_to_txt-2"><span class="bold_code">log_to_txt(LogDir, Mibs)</span></a><br><a name="log_to_txt-3"><span class="bold_code">log_to_txt(LogDir, Mibs, OutFile) -> ok | {error, Reason}</span></a><br><a name="log_to_txt-4"><span class="bold_code">log_to_txt(LogDir, Mibs, OutFile, LogName) -> ok | {error, Reason}</span></a><br><a name="log_to_txt-5"><span class="bold_code">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {error, Reason}</span></a><br><a name="log_to_txt-6"><span class="bold_code">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start) -> ok | {error, Reason}</span></a><br><a name="log_to_txt-7"><span class="bold_code">log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">LogDir = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Mibs = [MibName]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">OutFile = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">LogName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">LogFile = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = disk_log_open_error() | file_open_error() | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">disk_log_open_error() = {LogName, term()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">file_open_error() = {OutFile, term()}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Converts an Audit Trail Log to a readable text file.
<span class="code">OutFile</span> defaults to "./snmpm_log.txt".
<span class="code">LogName</span> defaults to "snmpm_log".
<span class="code">LogFile</span> defaults to "snmpm.log".
See <span class="bold_code"><a href="snmp.html#log_to_txt">snmp:log_to_txt</a></span>
for more info.</p>
<a name="log_to_io"></a>
</p></div>
<p><a name="log_to_io-1"><span class="bold_code">log_to_io(LogDir) -> ok | {error, Reason}</span></a><br><a name="log_to_io-2"><span class="bold_code">log_to_io(LogDir, Mibs) -> ok | {error, Reason}</span></a><br><a name="log_to_io-2"><span class="bold_code">log_to_io(LogDir, Mibs) -> ok | {error, Reason}</span></a><br><a name="log_to_io-3"><span class="bold_code">log_to_io(LogDir, Mibs, LogName) -> ok | {error, Reason}</span></a><br><a name="log_to_io-4"><span class="bold_code">log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {error, Reason}</span></a><br><a name="log_to_io-5"><span class="bold_code">log_to_io(LogDir, Mibs, LogName, LogFile, Start) -> ok | {error, Reason}</span></a><br><a name="log_to_io-6"><span class="bold_code">log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">LogDir = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Mibs = [MibName]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">LogName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">LogFile = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Start = Stop = null | datetime() | {local_time,datetime()} | {universal_time,datetime()} </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = disk_log_open_error() | file_open_error() | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">disk_log_open_error() = {LogName, term()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">file_open_error() = {OutFile, term()}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Converts an Audit Trail Log to a readable format and
prints it on stdio.
<span class="code">LogName</span> defaults to "snmpm_log".
<span class="code">LogFile</span> defaults to "snmpm.log".
See <span class="bold_code"><a href="snmp.html#log_to_io">snmp:log_to_io</a></span>
for more info.</p>
<a name="change_log_size"></a>
</p></div>
<p><a name="change_log_size-1"><span class="bold_code">change_log_size(NewSize) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">NewSize = {MaxBytes, MaxFiles}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxBytes = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MaxFiles = integer()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Changes the log size of the Audit Trail Log. The application must
be configured to use the audit trail log function. Please refer to
disk_log(3) in Kernel Reference Manual for a description of how to
change the log size.
</p>
<p>The change is permanent, as long as the log is not deleted.
That means, the log size is remembered across reboots.</p>
<a name="set_log_type"></a>
</p></div>
<p><a name="set_log_type-1"><span class="bold_code">set_log_type(NewType) -> {ok, OldType} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">NewType = OldType = atl_type()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Changes the run-time Audit Trail log type. </p>
<p>Note that this has no effect on the application configuration as
defined by configuration files, so a node restart will revert the
config to whatever is in those files. </p>
<p>This function is primarily useful in testing/debugging
scenarios. </p>
<a name="load_mib"></a>
</p></div>
<p><a name="load_mib-1"><span class="bold_code">load_mib(Mib) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Mib = MibName</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Load a <span class="code">Mib</span> into the manager. The <span class="code">MibName</span> is the
name of the Mib, including the path to where the compiled mib is
found. For example,</p>
<div class="example"><pre>
Dir = code:priv_dir(my_app) ++ "/mibs/",
snmpm:load_mib(Dir ++ "MY-MIB").
</pre></div>
<a name="unload_mib"></a>
</p></div>
<p><a name="unload_mib-1"><span class="bold_code">unload_mib(Mib) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Mib = MibName</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Unload a <span class="code">Mib</span> from the manager. The <span class="code">MibName</span> is the
name of the Mib, including the path to where the compiled mib is
found. For example,</p>
<div class="example"><pre>
Dir = code:priv_dir(my_app) ++ "/mibs/",
snmpm:unload_mib(Dir ++ "MY-MIB").
</pre></div>
<a name="which_mibs"></a>
</p></div>
<p><a name="which_mibs-0"><span class="bold_code">which_mibs() -> Mibs</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Mibs = [{MibName, MibFile}]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibName = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">MibFile = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Get a list of all the mib's loaded into the manager.</p>
<a name="name_to_oid"></a>
</p></div>
<p><a name="name_to_oid-1"><span class="bold_code">name_to_oid(Name) -> {ok, Oids} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Name = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Oids = [oid()]</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Transform a alias-name to its oid.</p>
<p>Note that an alias-name is only unique within the mib, so
when loading several mib's into a manager, there might be
several instances of the same aliasname.</p>
<a name="oid_to_name"></a>
</p></div>
<p><a name="oid_to_name-1"><span class="bold_code">oid_to_name(Oid) -> {ok, Name} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Oid = oid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Name = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Transform a oid to its aliasname.</p>
<a name="oid_to_type"></a>
</p></div>
<p><a name="oid_to_type-1"><span class="bold_code">oid_to_type(Oid) -> {ok, Type} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Oid = oid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Type = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Retreive the type (asn1 bertype) of an oid.</p>
<a name="backup"></a>
</p></div>
<p><a name="backup-1"><span class="bold_code">backup(BackupDir) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">BackupDir = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Backup persistent data handled by the manager. </p>
<p>BackupDir cannot be identical to DbDir. </p>
<a name="info"></a>
</p></div>
<p><a name="info-0"><span class="bold_code">info() -> [{Key, Value}]</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Key = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Returns a list (a dictionary) containing information about
the manager. Information includes statistics counters,
miscellaneous info about each process (e.g. memory allocation),
and so on.</p>
<a name="verbosity"></a>
</p></div>
<p><a name="verbosity-2"><span class="bold_code">verbosity(Ref, Verbosity) -> void()</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Ref = server | config | net_if | note_store | all</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Verbosity = verbosity()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">verbosity() = silence | info | log | debug | trace </span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Sets verbosity for the designated process. For the lowest
verbosity <span class="code">silence</span>, nothing is printed. The higher the
verbosity, the more is printed.</p>
<a name="format_reason"></a>
</p></div>
<p><a name="format_reason-1"><span class="bold_code">format_reason(Reason) -> string()</span></a><br><a name="format_reason-2"><span class="bold_code">format_reason(Prefix, Reason) -> string()</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Prefix = integer() | string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This utility function is used to create a formatted
(pretty printable) string of the error reason received
from either:
</p>
<ul>
<li>
<p>The <span class="code">Reason</span> returned value if any of the
sync/async get/get-next/set/get-bulk
functions returns <span class="code">{error, Reason}</span></p>
</li>
<li>
<p>The <span class="code">Reason</span> parameter in the
<span class="bold_code"><a href="snmpm_user.html#handle_error">handle_error</a></span> user callback function.</p>
</li>
</ul>
<p><span class="code">Prefix</span> should either be an indention string
(e.g. a list of spaces) or a positive integer (which will be used
to create the indention string of that length).</p>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
1338
