APIs in Category: eventclass | API version 3.7.1

eventclass-add-custom eventclass-delete-custom eventclass-list eventclass-list-iter-end eventclass-list-iter-next eventclass-list-iter-start | APIs related to adding, editing and deleting custom or user-defined event classes and listing all event classes in the management station.

NetApp Manage ONTAP

eventclass-add-custom | [top]

> Supports adding custom event classes.

> Input Name | Range | Type | Description
> about-message |  | string | Custom event class description.
> event-class-name |  | string | Custom event class name.
> event-names |  | event-name-info[] | List of event names for this event class.
> event-namespace-name |  | string | Namespace in which the event types are defined
> is-allow-duplicates |  | boolean optional | Event service will not drop duplicate events of this event class if is-allow-duplicates is true. Event is duplicate if it has same event-name as previous event with same event-class and the same event-source. It is false by default. If an invalid value is provided, it will be considered as true.
> is-multi-current |  | boolean optional | Event service should keep multiple current events of this event class for each event-source. Valid only with is-allow-duplicates. It is false by default. If an invalid value is provided, it will be considered as true.
> Output Name | Range | Type | Description
> event-class-id |  | integer | Unique Id for the custom event class.

> Errno | Description
> EAPIPRIVILEDGE |  |
> EINVALIDINPUT |  |
> EEVENTCLASSEXISTS |  |

eventclass-delete-custom | [top]

> Supports deletion of custom event classes.

> Input Name | Range | Type | Description
> event-class-name |  | string | Custom event class name or its database identifier.

> Errno | Description
> EAPIPRIVILEDGE |  |
> ENOSUCHEVENTCLASS |  |

eventclass-list | [top]

> Lists all or a sub-set of the custom event classes.

> Input Name | Range | Type | Description
> event-class-objects |  | event-class-object[] optional | List of custom event classes to be listed. If nothing is specified, all custom event classes are listed.
> Output Name | Range | Type | Description
> event-classes |  | event-class-info[] | List of custom event classes.

> Errno | Description
> EAPIPRIVILEDGE |  |
> ENOSUCHEVENTCLASS |  |

eventclass-list-iter-end | [top]

> The eventclass-list-iter-* set of APIs are used to retrieve the list of event classes. eventclass-list-iter-end is used to tell the DFM station that the temporary store used by DFM to support the eventclass-list-iter-next API for the particular tag is no longer necessary.

> Input Name | Range | Type | Description
> tag |  | string | An internal opaque handle used by the DFM station

> Errno | Description
> EINVALIDTAG |  |

eventclass-list-iter-next | [top]

> For more documentation please check eventclass-list-iter-start. The eventclass-list-iter-next API is used to iterate over the members of the event classes stored in the temporary store created by the eventclass-list-iter-start API.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve.
> tag |  | string | Tag from a previous eventclass-list-iter-start. It's an opaque handle used by the DFM station to identify the temporary store created by eventclass-list-iter-start.
> Output Name | Range | Type | Description
> event-classes |  | event-class-info[] | List of event classes.
> records |  | integer | The number of records actually returned as a result of invoking this API.

> Errno | Description
> EINVALIDTAG |  |

eventclass-list-iter-start | [top]

> The eventclass-list-iter-* set of APIs are used to retrieve the list of event classes in DFM. The eventclass-list-iter-start API is used to load the list of event classes into a temporary store. The API returns a tag that identifies that temporary store so that subsequent APIs can be used to iterate over the event classes in the temporary store. If eventclass-list-iter-start is invoked twice, then two distinct temporary stores are created.

> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with eventclass-list-iter-next.
> tag |  | string | Tag to be used in subsequent calls to eventclass-list-iter-next. It is an opaque handle used by the DFM station to identify a temporary store.

Element definition: event-class-info | [top]

> Information about an event class.

> Name | Range | Type | Description
> about-message |  | string | Description of the event class.
> event-class-id |  | integer | Database identifier of the custom event class or 0 in case of a canned event class.
> event-class-name |  | string | event class name.
> event-names |  | event-name-info[] | List of event names for this event class.
> is-allow-duplicates |  | boolean | Event service will not drop duplicate events of this event class if is-allow-duplicates is true. Event is duplicate if it has same event-name as previous event with same event-class and the same event-source. It is false by default.
> is-multi-current |  | boolean | Event service keeps multiple current events of this event-class for each event-source. Valid only with allow-duplicates. It is false by default.

Element definition: event-class-object | [top]

> Custom event class.

> Name | Range | Type | Description
> event-class-name |  | string | Custom event class name or its database identifier.

Element definition: event-name-info | [top]

> Information about an event name.

> Name | Range | Type | Description
> event-name-pretty |  | string | Display name of the event name.
> event-name-short |  | string | Short name of the event name.
> severity |  | string | Severity of the event name. Possible values: Emergency, Critical, Error, Warning, Information, Normal.