APIs in Category: Eventclass | API version 5.0

EventclassAddCustom EventclassDeleteCustom EventclassList EventclassListIterEnd EventclassListIterNext EventclassListIterStart | 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 API version 5.0

EventclassAddCustom (supported) | [top]

> Supports adding custom event classes.

> Input Name | Type
> EventclassAddCustom | EventclassAddCustom
> Output Name | Type
> EventclassAddCustomResult | EventclassAddCustomResult

> Error Name | Description
> EAPIPRIVILEDGE |  |
> EEVENTCLASSEXISTS |  |
> EINVALIDINPUT |  |

EventclassDeleteCustom (supported) | [top]

> Supports deletion of custom event classes.

> Input Name | Type
> EventclassDeleteCustom | EventclassDeleteCustom
> Output Name | Type
> EventclassDeleteCustomResult | EventclassDeleteCustomResult

> Error Name | Description
> EAPIPRIVILEDGE |  |
> ENOSUCHEVENTCLASS |  |

EventclassList (supported) | [top]

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

> Input Name | Type
> EventclassList | EventclassList
> Output Name | Type
> EventclassListResult | EventclassListResult

> Error Name | Description
> EAPIPRIVILEDGE |  |
> ENOSUCHEVENTCLASS |  |

EventclassListIterEnd (supported) | [top]

> The EventclassListIter* set of APIs are used To retrieve the list of event classes. EventclassListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventclassListIterNext API for the particular Tag is no longer necessary.

> Input Name | Type
> EventclassListIterEnd | EventclassListIterEnd
> Output Name | Type
> EventclassListIterEndResult | EventclassListIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

EventclassListIterNext (supported) | [top]

> For more documentation please check EventclassListIterStart. The EventclassListIterNext API is used To iterate over the Members of the event classes stored in the temporary store created by the EventclassListIterStart API.

> Input Name | Type
> EventclassListIterNext | EventclassListIterNext
> Output Name | Type
> EventclassListIterNextResult | EventclassListIterNextResult

> Error Name | Description
> EINVALIDTAG |  |

EventclassListIterStart (supported) | [top]

> The EventclassListIter* set of APIs are used To retrieve the list of event classes in DFM. The EventclassListIterStart 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 EventclassListIterStart is invoked twice, then two distinct temporary stores are created.

> Input Name | Type
> EventclassListIterStart | EventclassListIterStart
> Output Name | Type
> EventclassListIterStartResult | EventclassListIterStartResult

Element definition: EventclassAddCustom | [top]

> Supports adding custom event classes.

> Name | Type | Description
> AboutMessage | xsd:string | Custom event class Description.
> EventClassName | xsd:string | Custom event class Name.
> EventNames | ArrayOfEventNameInfo | List of event names for this event class.
> EventNamespaceName | xsd:string | Namespace in which the event types are defined
> IsAllowDuplicates | xsd:boolean optional | Event Service will not drop duplicate Events of this event class if IsAllowDuplicates is true. Event is duplicate if it has same EventName as previous event with same EventClass and the same event-source. It is false by default. If an invalid Value is provided, it will be considered as true.
> IsMultiCurrent | xsd:boolean optional | Event Service should keep multiple current Events of this event class for each event-source. Valid only with IsAllowDuplicates. It is false by default. If an invalid Value is provided, it will be considered as true.

Element definition: EventclassAddCustomResult | [top]

> Name | Type | Description
> EventClassId | xsd:integer | Unique Id for the custom event class.

Element definition: EventclassDeleteCustom | [top]

> Supports deletion of custom event classes.

> Name | Type | Description
> EventClassName | xsd:string | Custom event class Name or its database identifier.

Element definition: EventclassDeleteCustomResult | [top]

> [none]

Element definition: EventclassList | [top]

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

> Name | Type | Description
> EventClassObjects | ArrayOfEventClassObject optional | List of custom event classes To be listed. If nothing is specified, all custom event classes are listed.

Element definition: EventclassListIterEnd | [top]

> The EventclassListIter* set of APIs are used To retrieve the list of event classes. EventclassListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventclassListIterNext API for the particular Tag is no longer necessary.

> Name | Type | Description
> Tag | xsd:string | An internal opaque handle used by the DFM station

Element definition: EventclassListIterEndResult | [top]

> [none]

Element definition: EventclassListIterNext | [top]

> For more documentation please check EventclassListIterStart. The EventclassListIterNext API is used To iterate over the Members of the event classes stored in the temporary store created by the EventclassListIterStart API.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve.
> Tag | xsd:string | Tag From a previous EventclassListIterStart. It's an opaque handle used by the DFM station To identify the temporary store created by EventclassListIterStart.

Element definition: EventclassListIterNextResult | [top]

> Name | Type | Description
> EventClasses | ArrayOfEventClassInfo | List of event classes.
> Records | xsd:integer | The number of Records actually returned as a Result of invoking this API.

Element definition: EventclassListIterStart | [top]

> The EventclassListIter* set of APIs are used To retrieve the list of event classes in DFM. The EventclassListIterStart 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 EventclassListIterStart is invoked twice, then two distinct temporary stores are created.

> [none]

Element definition: EventclassListIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number which tells you how many items have been saved for future retrieval with EventclassListIterNext.
> Tag | xsd:string | Tag To be used in subsequent calls To EventclassListIterNext. It is an opaque handle used by the DFM station To identify a temporary store.

Element definition: EventclassListResult | [top]

> Name | Type | Description
> EventClasses | ArrayOfEventClassInfo | List of custom event classes.

Element definition: ArrayOfEventClassInfo | [top]

> Name | Type | Description
> EventClassInfo | EventClassInfo[] |

Element definition: ArrayOfEventClassObject | [top]

> Name | Type | Description
> EventClassObject | EventClassObject[] |

Element definition: ArrayOfEventNameInfo | [top]

> Name | Type | Description
> EventNameInfo | EventNameInfo[] |

Element definition: EventClassInfo | [top]

> Information about an event class.

> Name | Type | Description
> AboutMessage | xsd:string | Description of the event class.
> EventClassId | xsd:integer | Database identifier of the custom event class or 0 in case of a canned event class.
> EventClassName | xsd:string | event class Name.
> EventNames | ArrayOfEventNameInfo | List of event names for this event class.
> IsAllowDuplicates | xsd:boolean | Event Service will not drop duplicate Events of this event class if IsAllowDuplicates is true. Event is duplicate if it has same EventName as previous event with same EventClass and the same event-source. It is false by default.
> IsMultiCurrent | xsd:boolean | Event Service keeps multiple current Events of this EventClass for each event-source. Valid only with allow-duplicates. It is false by default.

Element definition: EventClassObject | [top]

> Custom event class.

> Name | Type | Description
> EventClassName | xsd:string | Custom event class Name or its database identifier.

Element definition: EventNameInfo | [top]

> Information about an event Name.

> Name | Type | Description
> EventNamePretty | xsd:string | Display Name of the event Name.
> EventNameShort | xsd:string | Short Name of the event Name.
> Severity | xsd:string | Severity of the event Name. Possible Values: Emergency, Critical, Error, Warning, Information, Normal.