This is any extra info the user wants to have supplied
when the functions in the callback module is called.

Functions

add_agent_caps(SysORID, SysORDescr) -> SysORIndex

SysORID = oid()

SysORDescr = string()

SysORIndex = integer()

This function can be used to add an AGENT-CAPABILITY
statement to the sysORTable in the agent. The table is
defined in the SNMPv2-MIB.

del_agent_caps(SysORIndex) -> void()

SysORIndex = integer()

This function can be used to delete an AGENT-CAPABILITY
statement to the sysORTable in the agent. This table is
defined in the SNMPv2-MIB.

get_agent_caps() -> [[SysORIndex, SysORID, SysORDescr, SysORUpTime]]

SysORIndex = integer()

SysORId = oid()

SysORDescr = string()

SysORUpTime = integer()

Returns all AGENT-CAPABILITY statements in the sysORTable
in the agent. This table is defined in the SNMPv2-MIB.

get(Agent, Vars) -> Values | {error, Reason}

get(Agent, Vars, Context) -> Values | {error, Reason}

Agent = pid() | atom()

Vars = [oid()]

Context = string()

Values = [term()]

Reason = {atom(), oid()}

Performs a GET operation on the agent. All loaded MIB
objects are visible in this operation. The agent calls the
corresponding instrumentation functions just as if it was a
GET request coming from a manager.

Note that the request specific parameters (such as
current_request_id)
are not accessible for the instrumentation functions if this
function is used.

get_next(Agent, Vars) -> Values | {error, Reason}

get_next(Agent, Vars, Context) -> Values | {error, Reason}

Agent = pid() | atom()

Vars = [oid()]

Context = string()

Values = [{oid(), term()}]

Reason = {atom(), oid()}

Performs a GET-NEXT operation on the agent. All loaded MIB
objects are visible in this operation. The agent calls the
corresponding instrumentation functions just as if it was a
GET request coming from a manager.

Note that the request specific parameters (such as
snmpa:current_request_id/0 are not accessible for the
instrumentation functions if this function is used.

backup(BackupDir) -> ok | {error, Reason}

backup(Agent, BackupDir) -> ok | {error, Reason}

BackupDir = string()

Agent = pid() | atom()

Backup persistent/permanent data handled by the agent
(such as local-db, mib-data and vacm).

Data stored by mnesia is not handled.

BackupDir cannot be identical to DbDir.

info() -> [{Key, Value}]

info(Agent) -> [{Key, Value}]

Agent = pid() | atom()

Returns a list (a dictionary) containing information about
the agent. Information includes loaded MIBs, registered
sub-agents, some information about the memory allocation.

As of version 4.4 the format of the info has been changed.
To convert the info to the old format, call the
old_info_format
function.

old_info_format(NewInfo) -> OldInfo

OldInfo = NewInfo = [{Key, Value}]

As of version 4.4 the format of the info has been changed.
This function is used to convert to the old (pre-4.4) info
format.

load_mibs(Mibs) -> ok | {error, Reason}

load_mibs(Agent,Mibs) -> ok | {error, Reason}

Agent = pid() | atom()

Mibs = [MibName]

MibName = string()

Reason = term()

Loads Mibs into an agent. If the agent cannot load
all MIBs, it will indicate where loading was aborted. The
MibName is the name of the Mib, including the path to
where the compiled mib is found. For example,

unload_mibs(Mibs) -> ok | {error, Reason}

unload_mibs(Agent,Mibs) -> ok | {error, Reason}

Unloads MIBs into an agent. If it cannot unload all MIBs,
it will indicate where unloading was aborted.

which_mibs() -> Mibs

which_mibs(Agent) -> Mibs

Agent = pid() | atom()

Mibs = [{MibName, MibFile}]

MibName = atom()

MibFile = string()

Retrieve the list of all the mibs loaded into this agent. Default
is the master agent.

whereis_mib(MibName) -> {ok, MibFile} | {error, Reason}

whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason}

Agent = pid() | atom()

MibName = atom()

MibFile = string()

Reason = term()

Get the full path to the (compiled) mib-file.

current_request_id() -> {value, RequestId} | false

current_context() -> {value, Context} | false

current_community() -> {value, Community} | false

current_address() -> {value, Address} | false

RequestId = integer()

Context = string()

Community = string()

Address = term()

Get the request-id, context, community and address of the
request currently being processed by the agent.

Note that these functions is intended to be called by the
instrumentation functions and only if they are
executed in the context of the agent process (e.g. it does
not work if called from a spawned process).

enum_to_int(Name, Enum) -> {value, Int} | false

enum_to_int(Db, Name, Enum) -> {value, Int} | false

Db = term()

Name = atom()

Enum = atom()

Int = int()

Converts the symbolic value Enum to the
corresponding integer of the enumerated object or type
Name in a MIB. The MIB must be loaded.

false is returned if the object or type is not
defined in any loaded MIB, or if it does not define the
symbolic value as enumerated.

Db is a reference to the symbolic store database
(retrieved by a call to get_symbolic_store_db/0).

int_to_enum(Name, Int) -> {value, Enum} | false

int_to_enum(Db, Name, Int) -> {value, Enum} | false

Db = term()

Name = atom()

Int = int()

Enum = atom()

Converts the integer Int to the corresponding
symbolic value of the enumerated object or type Name in
a MIB. The MIB must be loaded.

false is returned if the object or type is not
defined in any loaded MIB, or if it does not define the
symbolic value as enumerated.

Db is a reference to the symbolic store database
(retrieved by a call to get_symbolic_store_db/0).

name_to_oid(Name) -> {value, oid()} | false

name_to_oid(Db, Name) -> {value, oid()} | false

Db = term()

Name = atom()

Looks up the OBJECT IDENTIFIER of a MIB object, given the
symbolic name. Note, the OBJECT IDENTIFIER is given for the
object, not for an instance.

false is returned if the object is not defined in any
loaded MIB.

Db is a reference to the symbolic store database
(retrieved by a call to get_symbolic_store_db/0).

oid_to_name(OID) -> {value, Name} | false

oid_to_name(Db, OID) -> {value, Name} | false

Db = term()

OID = oid()

Name = atom()

Looks up the symbolic name of a MIB object, given OBJECT
IDENTIFIER.

false is returned if the object is not defined in any
loaded MIB.

Db is a reference to the symbolic store database
(retrieved by a call to get_symbolic_store_db/0).

Converts an Audit Trail Log to a readable text file.
OutFile defaults to "./snmpa_log.txt".
LogName defaults to "snmpa_log".
LogFile defaults to "snmpa.log".
See snmp:log_to_txt
for more info.

change_log_size(NewSize) -> ok | {error, Reason}

NewSize = {MaxBytes, MaxFiles}

MaxBytes = integer()

MaxFiles = integer()

Reason = term()

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.

The change is permanent, as long as the log is not deleted.
That means, the log size is remembered across reboots.

set_log_type(NewType) -> {ok, OldType} | {error, Reason}

set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason}

NewType = OldType = atl_type()

Agent = pid() | atom()

Reason = term()

Changes the run-time Audit Trail log type.

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.

This function is primarily useful in testing/debugging
scenarios.

mib_of(Oid) -> {ok, MibName} | {error, Reason}

mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason}

Agent = pid() | atom()

Oid = oid()

MibName = atom()

Reason = term()

Finds the mib corresponding to the Oid. If it is a
variable, the Oid must be
<Oid for var>.0 and if it is a table, Oid must be
<table>.<entry>.<col>.<any>

me_of(Oid) -> {ok, Me} | {error, Reason}

me_of(Agent, Oid) -> {ok, Me} | {error, Reason}

Agent = pid() | atom()

Oid = oid()

Me = #me{}

Reason = term()

Finds the mib entry corresponding to the Oid. If it is a
variable, the Oid must be
<Oid for var>.0 and if it is a table, Oid must be
<table>.<entry>.<col>.<any>

Sends the notification Notification to the
management targets defined for NotifyName in the
snmpNotifyTable in SNMP-NOTIFICATION-MIB from the
specified context. If no NotifyName is specified (or
if it is ""), the notification is sent to all
management targets (Addresses below). If no ContextName
is specified, the default "" context is used.

The parameter Receiver specifies where information
about delivery of Inform-Requests should be sent. The agent
sends Inform-Requests and waits for acknowledgments from the
managers. Receiver can have three values:

no_receiver - No information is delivered.

{Tag, Recv} - The information is delivered either via messages
or via a function call according to the value of Recv.

notification_delivery_info() - The information is
delivered via a function call according to this data. See the
DATA TYPES section
above for details.

If Receiver has the value {Tag, Recv}, the delivery is
done according to Recv:

pid() | atom() - The info will be delivered in
the following messages:

{snmp_targets, Tag, Addresses}

This inform the user which target addresses the
notification was sent to.

{snmp_notification, Tag, {got_response, Address}}

This informs the user that this target address
acknowledged the notification.

{snmp_notification, Tag, {no_response, Address}}

This informs the user that this target address
did not acknowledge notification.

The notification is sent as an Inform-Request to each
target address in Addresses and if there are no
targets for which an Inform-Request is sent, Addresses
is the empty list [].

The receiver will first be sent the snmp_targets
message, and then for each address in Addresses list,
one of the two snmp_notification messages.

{Mod, Func, Args} - The info will be delivered via
the function call:

Mod:Func([Msg | Args])

where Msg has the same content and purpose as the
messages descrived above.

Address is a management target address and Addresses is a
list of management target addresses. They are defined as followes:

If Receiver is a notification_delivery_info() record,
then the information about the notification delivery will be delivered
to the receiver via the callback functions defined by the
snmpa_notification_delivery_info_receiver
behaviour according to the content of the notification_delivery_info()
record.

The optional argument Varbinds defines
values for the objects in the notification. If no value is
given for an object, the Agent performs a get-operation
to retrieve the value.

Varbinds is a list of Varbind, where each
Varbind is one of:

{Variable, Value}, where Variable is the
symbolic name of a scalar variable referred to in the notification
specification.

{Column, RowIndex, Value}, where Column
is the symbolic name of a column variable.
RowIndex is a list of indices for the specified
element. If this is the case, the OBJECT IDENTIFIER sent
in the notification is the RowIndex appended to the OBJECT
IDENTIFIER for the table column. This is the OBJECT
IDENTIFIER which specifies the element.

{OID, Value}, where OID is the OBJECT
IDENTIFIER for an instance of an object, scalar variable,
or column variable.

For example, to specify that sysLocation should have the
value "upstairs" in the notification, we could use one of:

{sysLocation, "upstairs"} or

{[1,3,6,1,2,1,1,6,0], "upstairs"} or

{?sysLocation_instance, "upstairs"} (provided
that the generated .hrl file is included)

If a variable in the notification is a table element, the
RowIndex for the element must be given in the
Varbinds list. In this case, the OBJECT IDENTIFIER sent
in the notification is the OBJECT IDENTIFIER that identifies this
element. This OBJECT IDENTIFIER could be used in a get
operation later.

This function is asynchronous, and does not return any
information. If an error occurs, user_err/2 of the error
report module is called and the notification is discarded.

Note!

Note that the use of the LocalEngineID argument is only intended
for special cases, if the agent is to "emulate" multiple EngineIDs!
By default, the agent uses the value of SnmpEngineID
(see SNMP-FRAMEWORK-MIB).