APIs in Category: snmp | Cluster-Mode API version 1.21

snmp-community-add snmp-community-delete snmp-community-delete-all snmp-disable snmp-enable snmp-get snmp-get-next snmp-status snmp-trap-disable snmp-trap-enable snmp-traphost-add snmp-traphost-delete | A note on snmp-community-* ZAPI: The snmp-community-* ZAPI must be executed on the Cluster LIF. Vserver tunneling must be used to add/delete an SNMP community for a Vserver. If Vserver tunneling is not used while executing these ZAPI, then it will default to Cserver.

NetApp Manage ONTAP

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
> EONTAPI_EINVAL |  |

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
> EONTAPI_EINVAL |  |

snmp-community-delete-all | [top]

> Deletes all the communities.

> Errno | Description
> EONTAPI_EINVAL |  |

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
> 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 |  |

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
> 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 |  |

snmp-status | [top]

> Returns configuration information of the SNMP agent daemon.

> Output Name | Range | Type | Description
> communities |  | community-info[] optional | 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[] optional | 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.

snmp-trap-disable | [top]

> Disables snmp traps.

snmp-trap-enable | [top]

> Enables snmp traps.

snmp-traphost-add | [top]

> 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 |  |

snmp-traphost-delete | [top]

> 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 |  |

Element definition: community-info | [top]

> 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.

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 Hostname will be a fully qualified Domain Name.
> ip-address |  | string | IP address of the trap host.