|
APIs in Category: snmp |
API version 1.4 |
| snmp-community-add | [top] |
Adds a community to 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 added.
Errno Description EINVAL EINTERNALERROR
| snmp-community-delete | [top] |
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 EINVAL EINTERNALERROR
| snmp-community-delete-all | [top] |
Deletes all the communities.
Errno Description EINVAL EINTERNALERROR
| snmp-disable | [top] |
Disables snmp protocol.
| snmp-enable | [top] |
Enables snmp protocol.
| snmp-get | [top] |
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 value string
Value of the snmp object specified through the input argument "object-id".
Errno Description EINVAL
| snmp-get-next | [top] |
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 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 EINVAL
| snmp-status | [top] |
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.
Errno Description EINTERNALERROR
| snmp-trap-disable | [top] |
Disables snmp traps.
Errno Description EINTERNALERROR
| snmp-trap-enable | [top] |
Enables snmp traps.
Errno Description EINTERNALERROR
| snmp-traphost-add | [top] |
Adds a host to the list of trap hosts.
Input Name Range Type Description host string
Name of a host to be added. Host could be specified as a host name or an ip-address. If "host" is specified as a host name, the host name must resolve to an ip address.
Errno Description EINVAL EINTERNALERROR
| snmp-traphost-delete | [top] |
Deletes a host from the list of trap hosts.
Input Name Range Type Description host string
Name of a trap host to be deleted. Host could be specified as a host name or an ip-address.
Errno Description EINVAL EINTERNALERROR
| Element definition: community-info | [top] |
Information about a single community.
Name Range Type Description access-control string
Access control of the community. community string
Community name.
| Element definition: traphost-info | [top] |
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 ip-address string
IP address of the trap host.