Input Name	Range	Type	Description
access-control		string	Access control for the community. Possible values are "ro" (read-only) and "rw" (read-write). But, only "ro" (read-only) communities are supported.
community		string	Community name to be added.

Errno	Description
EONTAPI_EINVAL

Deletes a community from the list of communities.

Input Name	Range	Type	Description
access-control		string	Access control for the community. Possible values are "ro" (read-only) and "rw" (read-write). But, only "ro" (read-only) communities are supported.
community		string	Community name to be deleted.

Errno	Description
EONTAPI_EINVAL

Deletes all the communities.

Errno	Description
EONTAPI_EINVAL

Disables snmp protocol.

Enables snmp protocol.

Retrieves the value of a snmp object.

Input Name	Range	Type	Description
object-id		string	Fully qualified object identifier of a snmp object. Only numeric OID's (ex: .1.3.6.1.4.1.789.1.1.1.0) are allowed.
Output Name	Range	Type	Description
is-value-hexadecimal		boolean optional	If true, the string returned in 'value' is the hexadecimal representation of the octet string returned by a snmp call to the object-id. This output is not present if 'value' is a normal string.
value		string	Value of the snmp object specified through the input argument "object-id".

Errno	Description
EONTAPI_EINVAL

This is used to retrieve the next OID in the mib tree of data. Instead of returning the data you requested, it returns the next OID in the tree and its value. Unlike the snmp-get api, this api does return data for a OID which is too short or is missing the index part of the OID.

Input Name	Range	Type	Description
object-id		string	Object Identifier of a snmp object. The OID can be a fully qualified OID or a partial OID. Only numeric OID's (ex: .1.3.6.1.4.1.789.1.1.1.0) are allowed.
Output Name	Range	Type	Description
is-value-hexadecimal		boolean optional	If true, the string returned in 'value' is the hexadecimal representation of the octet string returned by a snmp call to the object-id. This output is not present if 'value' is a normal string.
next-object-id		string	Object Identifier of the next snmp object in the mib.
value		string	Value of the snmp object reported through the output argument "next-object-id".

Errno	Description
EONTAPI_EINVAL

Returns configuration information of the SNMP agent daemon.

Output Name	Range	Type	Description
communities		community-info[]	Returns a list of communities and their access control settings.
contact		string	Contact name.
is-trap-enabled		boolean	Retuns "true" if traps are enabled. "false" otherwise.
location		string	Location name.
traphosts		traphost-info[]	Returns a list of registered trap hosts followed by their IP addresses. Only resolvable trap hosts are returned. If a host name cannot be found in /etc/hosts for a previously registered IP address, its name defaults to a string representation of its IP address.

Delete a user defined trap.

Input Name	Range	Type	Description
trap-name		string	Name of the trap to be deleted.

Errno	Description
EONTAPI_EINVAL

Disables snmp traps.

Enables snmp traps.

List all user defined traps and their attributes.

Output Name	Range	Type	Description
trap-list		trap-info[]	The list of user defined snmp traps and their attributes.

Errno	Description
EONTAPI_EINVAL
EONTAPI_ENOMEM

Loads traps from a specified file.

Input Name	Range	Type	Description
filename		string	Name, including full PATH, of the file specifying the user defined traps. Example: /etc/MyTraps.txt would open the MyTraps.txt file located on the filer's /etc directory.

Errno	Description
EONTAPI_EINVAL
EONTAPI_ENOENT
EONTAPI_ENOMEM

Reloads one or all user defined traps from registry.

Input Name	Range	Type	Description
trap-name		string optional	Name of the trap to be reset. If absent, all traps are reset.

List all user defined traps and their attributes.

Input Name	Range	Type	Description
trap-def		trap-info	Characterizes a user defined trap and its attributes.

Errno	Description
EONTAPI_EINVAL
EONTAPI_ENOENT
EONTAPI_ENOMEM

Adds a host to the list of trap hosts.

Input Name	Range	Type	Description
host		string	Specify the host to be added. Host may be specified in Domain Name format such as MyHost.MyNetwork.com, or as an IP address such as 10.20.30.40. If a Domain Name is used, the host must resolve to an IP address.

Errno	Description
EONTAPI_EINVAL

Deletes a host from the list of trap hosts.

Input Name	Range	Type	Description
host		string	Specify the host to be added. Host may be specified in Domain Name format such as MyHost.MyNetwork.com, or as an IP address such as 10.20.30.40. If a Domain Name is used, the host must resolve to an IP address.

Errno	Description
EONTAPI_EINVAL

Information about a single community.

Name	Range	Type	Description
access-control		string	Access control of the community. Possible values are "ro" (read-only), and "rw" (read-write).
community		string	Community name.

Information about a single user defined trap.

Name	Range	Type	Description
OID		string optional	Specifies the OID of the MIB object that is queried to determine the trap's value. This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.
active		string optional	Notification state of trap. Possible values are "on" indicating agent will deliver notification if triggered, "off" indicating trap is inactive, and "incomplete" indicating one or more of the required attributes have not been defined. The default value for a fully defined trap is "off".
backoff-calculator		string optional	Specifies a method by which the frequency of trap evaluation may be modified. Possible values are "step-backoff", "exponential-backoff", and "no-backoff" This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "no-backoff".
backoff-multiplier		integer optional	Factor by which interval is multiplied when exponential-backoff method used. Used with "exponential-backoff" calculator. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 1. Range may be [0..2^31-1].
backoff-step		integer optional	Time in seconds by which evaluation interval is increased when step-backoff method used. Used with "step-backoff" calculator. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..2^31-1].
current-value		integer optional	Value of trap at time of query. On input, this attribute is ignored. Range may be [-2^31..2^31-1].
edge-1		integer optional	Threshold value at which trap is triggered. If not specified on input, the default value is 2^31-1. Range may be [-2^31..2^31-1].
edge-1-direction		string optional	Sets the direction of travel across the edge-1 threshold beyond which the trap is triggered. Possible values are "up", and "down". If not specified on input, the default value is "up".
edge-2		integer optional	Threshold value at which trap is triggered. Used with double-edge-trigger condition. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [-2^31..2^31-1].
edge-2-direction		string optional	Sets the direction of travel across the edge-2 threshold beyond which the trap is triggered. Possible values are "up", and "down". Used with double-edge-trigger condition. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "down".
interval		integer optional	Time in seconds between evaluations of the trap. A trap can send data only as often as it is evaluated. If not specified on input, the default value is 3600 seconds (1-hour). Range may be [0..31536000].
interval-offset		integer optional	Time in seconds until the first trap evaluation. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..31536000].
message		string optional	Message associated with trap. May be either a literal string, or specifies an OID. This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.
priority		string optional	Priority level of trap. Possible values (in descending order of severity) are "emergency", "alert", "critical", "error", "warning", "notification", "informational", or "debug". This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "notification".
rate-interval		integer optional	Time in seconds over which rate of change is calculated from sample data. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..2^31-1].
trap-name		string	Name of the trap given by the user. Note that trap-name may not contain embedded periods.
trigger		string optional	Sets the condition under which the trap will send a notification. Possible values are "single-edge-trigger", "double-edge-trigger", or "level-trigger". This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.

Information about a single registered trap host.

Name	Range	Type	Description
host-name		string	Name of the trap host given by the user. Can be one of the following: hostname, ip-address, or alias Hostname will be a fully qualified Domain Name.
ip-address		string	IP address of the trap host.