APIs in Category: event
API version 6.1

 
event-acknowledge
event-assign
event-iter
event-purge
event-resolve
event-status-change-list-iter-end
event-status-change-list-iter-next
event-status-change-list-iter-start
event-unassign

NetApp Manage ONTAP
 
event-acknowledge [top]

Acknowledge events. This terminates repeated notifications due to that event.
Input Name Range Type Description
event-id-list event-id-type[]
The event identifiers to be acknowledged.
 
Output Name Range Type Description
events-acknowledged-list event-action-info[]
List of timestamps for acknowledged events along with any errors.
 Errno  Description
 EINVALIDINPUT
 ENOSUCHEVENT
 EALREADYACKWED

 
event-assign [top]
Assign the events to the specified user.
Input Name Range Type Description
event-assignee-name string
Name of the user to which the events are to be assigned.
event-id-list event-id-type[]
The event identifiers to be assigned.
 
Output Name Range Type Description
assigned-events-list event-action-info[]
List of timestamps for assigned events and error codes in case of failure.
 Errno  Description
 ENOSUCHEVENT
 EINVALIDINPUT
 ENOTFOUNDUSER
 E_INVALID_EVENT_ASSIGNEE

 
event-iter [top]
Iterate over events ordered by event-id.
Input Name Range Type Description
event-id integer
optional
The identifier of the event that is to be listed.
event-impact-levels event-impact-level[]
optional
Lists events of the specified impact levels.
event-severities obj-status[]
optional
Lists events of the specified severities.
event-state-filter-list event-state[]
optional
List events of specified states. This filter can be specified in addition to other filters. if not specified, events of all states are returned.
event-type-filter-list event-type-filter[]
optional
If specified, the list of event types (interpreted as prefixes) will filter which events are returned. Events not matching will not be returned. Default is empty, meaning that all event types match.
greater-than-id integer
optional
If specified, the API will only return events whose identifier is greater than this value. Default is 0.
include-notes boolean
optional
If true, specifies that events should be returned with their related notes. The default is false, meaning that events are returned without notes.
max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance.
source resource-key
optional
Lists events against the specified source. If the provided resource key specifies a group, lists events against all members in that group.
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls.
time-range event-timestamp-range
optional
Lists all events which were generated in the range specified. Default is all events. time-out will be ignored if time-range is set.
timeout integer
optional
Number of seconds after which the API should terminate, if no events are received matching the input criteria. If the value is 0, or not specified, the API will terminate immediately (acting as an instantaneous poll for events).

If the timeout expires with no matching events, the API returns successfully with an empty list of events.

If a specific event-id is specified, then the timeout value is ignored.

If time-range is set, timeout is also ignored.

 
Output Name Range Type Description
next-tag string
optional
Tag for the next call. Not present when there are no more objects to return.
num-records integer
The number of records returned in this call.
records event-info[]
optional
The list of records.
 Errno  Description
 EINVALIDEVENTSEVERITY
 EINVALIDEVENTIMPACTLEVEL
 ENOSUCHEVENT

 
event-purge [top]
Purges the events that are older than the specified interval.
Input Name Range Type Description
interval [1..2^16-1] integer
The time interval in seconds. All non-current events with timestamp prior to the given interval will be purged.
 
Output Name Range Type Description
cutoff-timestamp timestamp
The timestamp prior to which all the non-current events were purged.
purged-events-count [1..2^16-1] integer
Number of events purged.
 Errno  Description
 EAPIMISSINGARGUMENT

 
event-resolve [top]
Resolve events. Terminates repeated notifications due to the event.
Input Name Range Type Description
event-id-list event-id-type[]
The event identifiers to be resolved.
 
Output Name Range Type Description
events-resolved-list event-action-info[]
Lists of timestamps for resolved ids along with any error returns.
 Errno  Description
 EINVALIDINPUT
 ENOSUCHEVENT

 
event-status-change-list-iter-end [top]
event-status-change-list-iter-end is used to indicate that the temporary store used to support the event-status-change-list-iter-next API for the particular tag is no longer necessary.
Input Name Range Type Description
tag string
An internal opaque handle.
 Errno  Description
 EINVALIDTAG

 
event-status-change-list-iter-next [top]
The event-status-change-list-iter-next API is used to iterate over the list of events stored in the temporary store created by the event-status-change-list-iter-start API.

A cursor is maintained pointing to the last record returned. Subsequent calls to this API will return the records after the cursor up to the specified "maximum" or number of actual records left.

Input Name Range Type Description
maximum integer
The maximum number of events to return.
tag string
An opaque handle used to identify the temporary store created by event-status-change-list-iter-start.
 
Output Name Range Type Description
events event-info[]
Array of events.
records [0..(2^31)-1] integer
The number of records actually returned.
 Errno  Description
 EINVALIDTAG

 
event-status-change-list-iter-start [top]
List events that had status changes (acknowledged or resolved) within the specified time range.

The event-status-change-list-iter-* set of APIs are used to retrieve the list of events that had status changes.

The event-status-change-list-iter-start API is used to load the list of events into a temporary store. The API returns a tag to temporary store so that subsequent APIs can be used to iterate over the list in the temporary store.

The returned list of events will be sorted according to when they had their status changed (either eventAcked timestamp or eventresolved timestamp). An event that's both acked and resolved within the requested timeframe would appear twice in the returned list of events, because those would count as 2 status changes, and appear in the returned list based on acked timestamp and resolved timestamp respectively.

Note that, depending on the input parameters, this API may take up to "timeout" seconds to return. Subsequent calls to event-status-change-list-iter-next() will return immediately.

Input Name Range Type Description
max-events [0..2^31-1] integer
optional
If specified, this is the maximum number of events that the client wishes to receive at once. If set to zero, return all events. The default value of this parameter is 50,000.
time-range event-timestamp-range
Lists all events which were generated in the range specified.

If the end-time of the time-range is not sometime in the future, time-out will be ignored.

timeout integer
optional
Number of seconds after which the API should terminate, if no events are received matching the input criteria. If the value is 0, or not specified, the API will terminate immediately (acting as an instantaneous poll for events).

If the timeout expires with no matching events, the API returns successfully with an empty list of events.

 
Output Name Range Type Description
records integer
The number of events matching the specified input criteria. This is the number of records that will be returned by subsequent calls to event-status-change-list-iter-next().
tag string
An opaque handle you must pass to event-status-change-list-iter-next() and event-status-change-list-iter-end() to refer to this list of events.

 
event-unassign [top]
Unassign the owner of an event or a set of events.
Input Name Range Type Description
event-id-list event-id-type[]
Identifiers of the events whose owner has to be unassigned.
 
Output Name Range Type Description
unassigned-events-list event-action-info[]
List consisting only identifiers of events which are unassigned. For any identifiers which were unable to be processed, an error codes with error message specifying the failure reason will also be in the output.
 Errno  Description
 ENOSUCHEVENT
 EINVALIDINPUT

 
Element definition: event-action-info [top]
Result of action taken on event. Timestamp returned on success, and error code on failure.
Name Range Type Description
error-code [1..2^32-1] integer
optional
Error code corresponding to errno returned from event acknowledge/resolve/assign. Absent on success.
error-message string
optional
Error message returned from event acknowledge/resolve/assign. Absent on success.
event-id [0..2^32-1] integer
The input event identifier.
timestamp [0..2^32-1] integer
optional
Timestamp when the event was acknowledged/resolved/assigned. Timestamps absent for IDs that can not be found, or have already been acknowledged/resolved.
warning-message string
optional
Warning message returned from event acknowledge/resolve/assign.

 
Element definition: event-id-type [top]
Event identifier.
[none]

 
Element definition: event-impact-level [top]
Impact level of the event.

Possible values are:

  • incident: An error or critical event.
  • risk: A warning event which could lead to an incident.
  • event: A simple event from Data ONTAP.
[none]

 
Element definition: event-info [top]
Event information structure
Name Range Type Description
event-about string
Description of the event type.
event-acknowledged-timestamp timestamp
optional
Timestamp when event was acknowledged.
event-acknowledged-user string
optional
User who acknowledged the event.
event-arguments key-value-pair[]
optional
Argument list for this particular event. Present only if include-event-arguments was set to true in the event-list-iter-start call. If the event has no arguments, this element will be empty. The arguments returned are dependent on the event type and status.
event-assigned-user string
optional
User to whom the event is assigned.
event-category event-category
optional
Category of the event.
event-condition string
Condition of the event.
event-id [1..2^31 - 1] integer
Id of the event.
event-impact-area event-impact-area
Impact area of the event.
event-impact-level event-impact-level
Impact level of the event.
event-name string
Name of the event. The list of all event names can be obtained using eventclass-list APIs. The element eventclass-info -> event-names[] -> event-name-pretty gives the name of an event.
event-notes event-note[]
optional
List of notes for this particular event. Present only if include-notes is set to true in the event-list-iter-start call. If the event has no notes, this element will be empty.
event-obsolete-condition string
optional
Condition that caused event to become obsolete. An event becomes obsolete when a newer event of the same type is generated.
event-obsolete-timestamp timestamp
optional
Timestamp when event became obsolete. An event becomes obsolete when a newer event of the same type is generated.
event-resolved-timestamp timestamp
optional
Timestamp when event was resolved.
event-resolved-user string
optional
User who resolved the event.
event-severity event-severity
Severity of the event.
event-source-name string
Name of the source of the event. Example: "storage01.example.com".
event-source-resource-key resource-key
Resource key of the source of the event.
event-source-type resource-type
Type of object that generated the event.
event-state event-state
State of the event.
event-time integer
Time when the event was fired.
event-type string
Type or class to which the event belongs to. A list of event types can be obtained by using eventclass-list-iter APIs. The element eventclass-info -> event-class-name in eventclass-info gives the name of an event type.

 
Element definition: event-state [top]
State of the event.

Possible values are: 'new', 'acknowledged', 'resolved', 'obsolete'.

  • new: The state of an event when it is first triggered.
  • acknowledged: The state of an event which has been acknowledged by a user (and is being worked on). Both new and acknowledged events identify events which are open and need user attention.
  • resolved: The state of an event after a user explicitly resolves it.
  • obsolete: The state of an event which is no longer deemed valid by the system. Both resolved and obsolete events together identify events that no longer need user attention.
[none]

 
Element definition: event-timestamp-range [top]
range of event timestamps
Name Range Type Description
end-time integer
End timestamp, in seconds elapsed since midnight on January 1, 1970.(UTC)
start-time integer
Start timestamp, in seconds elapsed since midnight on January 1, 1970.(UTC)

 
Element definition: event-type-filter [top]
Array of event filters.
Name Range Type Description
event-filter string
name of the event-filter.

 
Element definition: obj-status [top]
A status value which can be associated with an object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type.

Possible values are: 'normal', 'warning', 'error', 'critical'.

  • normal: An object has normal status when it is working within the thresholds specified.
  • warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption.
  • error: An object has error status when it does not cause any service disruption, but it may affect performance.
  • critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately.
In some contexts, it is important that severities are ordered (as above). For example, an alert might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.
[none]

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: timestamp [top]
Seconds since 1/1/1970 in UTC.
[none]

 
Element definition: event-category [top]
Severity of the event.

Possible values are:

  • aggregate_availability
  • aggregate_capacity
  • controller_availability
  • disk_failure
  • disk_shelf_availability
  • lun_availability
  • lun_capacity
  • node_availability
  • node_hardware_failure
  • port_failure
  • qtree_capacity
  • volume_availability
  • volume_capacity
  • vserver_data_availability
[none]

 
Element definition: event-impact-area [top]
Impact area of the event.

Possible values are: 'configuration', 'capacity', 'availability', 'protection'

[none]

 
Element definition: event-impact-level [top]
Impact level of the event.

Possible values are:

  • incident: An error or critical event.
  • risk: A warning event which could lead to an incident.
  • event: A simple event from Data ONTAP.
[none]

 
Element definition: event-note [top]
Event note.
Name Range Type Description
author string
Author of the note.
content string
Content of the note.
timestamp timestamp
Timestamp when the note was added.

 
Element definition: event-severity [top]
Severity of the event.

Possible values are: 'normal', 'information', 'warning', 'error', 'critical'

[none]

 
Element definition: key-value-pair [top]
The key/value for a generic object attribute.
Name Range Type Description
key string
key of the generic object attribute
value string
Value of the generic object attribute

 
Element definition: resource-type [top]
A canonical type name for a managed resource. Includes both Data ONTAP and OnCommand resource types. Valid Data ONTAP resource types:
  • aggregate
  • cluster
  • cluster_node
  • disk
  • export_policy
  • export_rule
  • fcp_lif
  • fcp_port
  • flash_device
  • igroup
  • iscsi_portal_group
  • lun
  • lun_mapping
  • network_lif
  • network_port
  • ontap_job_schedule
  • plex
  • portset
  • qtree
  • raid_group
  • routing_group
  • service_processor
  • sis_policy
  • snap_mirror
  • snapshot
  • snapshot_policy
  • snapshot_policy_schedule
  • storage_class
  • storage_shelf
  • volume
  • volume_move
  • vserver
Valid OnCommand resource types:
  • management_station
  • resource_pool
  • service_workflow
  • storage_service
  • storage_service_connection
  • storage_service_node
[none]

 
Element definition: timestamp [top]
Seconds since 1/1/1970 in UTC.
[none]