Input Name	Type
EventAcknowledge	EventAcknowledge
Output Name	Type
EventAcknowledgeResult	EventAcknowledgeResult

Error Name	Description
EACCESSDENIED
EALREADYACKWED
EINTERNALERROR
EINVALIDINPUT
ENOSUCHEVENT

Delete Events. Terminates repeated notifications due To the event.

Input Name	Type
EventDelete	EventDelete
Output Name	Type
EventDeleteResult	EventDeleteResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDINPUT
ENOSUCHEVENT

The EventGenerate API helps clients To generate Events in the DFM system

Input Name	Type
EventGenerate	EventGenerate
Output Name	Type
EventGenerateResult	EventGenerateResult

Error Name	Description
EAPIERROR
EAPIPRIVILEDGE
EEVENTGENERATEFAILED
ENOTCUSTOMEVENTCLASS

EventListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventListIterNext API for the particular Tag is no longer necessary.

Input Name	Type
EventListIterEnd	EventListIterEnd
Output Name	Type
EventListIterEndResult	EventListIterEndResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDTAG

The EventListIterNext API is used To iterate over the list of Events stored in the temporary store created by the EventListIterStart API. The DFM station, internally, maintains a cursor 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	Type
EventListIterNext	EventListIterNext
Output Name	Type
EventListIterNextResult	EventListIterNextResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDTAG

List Events. The EventListIter* set of APIs are used To retrieve the list of Events. The EventListIterStart 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. Note that, depending on the input parameters, this API may take up To "Timeout" seconds To return. Subsequent calls To EventListIterNext() will return immediately.

Input Name	Type
EventListIterStart	EventListIterStart
Output Name	Type
EventListIterStartResult	EventListIterStartResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDEVENTSEVERITY
ENOSUCHEVENT

EventStatusChangeListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventStatusChangeListIterNext API for the particular Tag is no longer necessary.

Input Name	Type
EventStatusChangeListIterEnd	EventStatusChangeListIterEnd
Output Name	Type
EventStatusChangeListIterEndResult	EventStatusChangeListIterEndResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDTAG

The EventStatusChangeListIterNext API is used To iterate over the list of Events stored in the temporary store created by the EventStatusChangeListIterStart API. The DFM station, internally, maintains a cursor 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	Type
EventStatusChangeListIterNext	EventStatusChangeListIterNext
Output Name	Type
EventStatusChangeListIterNextResult	EventStatusChangeListIterNextResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDTAG

List Events that had Status changes (acknowledged or deleted) within the specified time range. The EventStatusChangeListIter* set of APIs are used To retrieve the list of Events that had Status changes. The EventStatusChangeListIterStart 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 eventDeleted Timestamp). An event that's both acked and deleted 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 deleted Timestamp respectively. Note that, depending on the input parameters, this API may take up To "Timeout" seconds To return. Subsequent calls To EventStatusChangeListIterNext() will return immediately.

Input Name	Type
EventStatusChangeListIterStart	EventStatusChangeListIterStart
Output Name	Type
EventStatusChangeListIterStartResult	EventStatusChangeListIterStartResult

Error Name	Description
EACCESSDENIED
EINTERNALERROR
EINVALIDEVENTSEVERITY
ENOSUCHEVENT

Acknowledge Events. This terminates repeated notifications due To that event.

Name	Type	Description
EventId	xsd:integer optional	The identifier of the event that has To be acknowledged. Must specify either EventId or EventIdList not both. Range: [1..2^32-1]
EventIdList	ArrayOfEventIdType optional	The event identifiers To be acknowledged. Must specify either EventId or EventIdList not both. Returns EINVALIDINPUT if neither or both arguments are included.

Name	Type	Description
EventAcknowledged	xsd:unsignedInt optional	Timestamp when the event is acknowledged. This element is returned only in Response To an EventId input. Range: [0..2^32-1]
EventsAcknowledgedList	ArrayOfEventActionInfo	List of timestamps for acknowledged Events along with any Errors. This array is returned only in Response To an EventIdList input.

Delete Events. Terminates repeated notifications due To the event.

Name	Type	Description
EventId	xsd:integer optional	The identifier of the event that has To be deleted. Must specify either EventId or EventIdList not both. Range: [1..2^32-1]
EventIdList	ArrayOfEventIdType optional	The event identifiers To be deleted. Must specify either EventId or EventIdList, not both.

Name	Type	Description
EventDeleted	xsd:unsignedInt optional	Timestamp when the event is deleted. This element is only returned in Response To an EventId input. Range: [0..2^32-1]
EventsDeletedList	ArrayOfEventActionInfo optional	Lists of timestamps for deleted ids along with any Error returns. This array is returned only in Response To an EventIdList input.

The EventGenerate API helps clients To generate Events in the DFM system

Name	Type	Description
EventMessage	xsd:string optional	A message specific To this event. This message will be displayed in the Event Details page. If not specified, nothing will be shown in the Condition field of Event Details page.
EventName	xsd:string	The event Name that is being generated. Currently this can be only the event names corresponding To user-defined event added To DFM.
Source	xsd:string	The id/name of the Source object of the event. This is the object id/short name/long Name DFM generates for an object. Suppose, for a Host, a Host id/name can be found by using the CLI "dfm Host list".
Timestamp	xsd:integer optional	The date-time when the event is generated This is the number of seconds elapsed since midnight on January 1, 1970.(UTC) If not specified or invalid Timestamp specified , the time on the DFM server when the api is invoked is used.

[none]

EventListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventListIterNext API for the particular Tag is no longer necessary.

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

[none]

The EventListIterNext API is used To iterate over the list of Events stored in the temporary store created by the EventListIterStart API. The DFM station, internally, maintains a cursor 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.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of Events To return.
Tag	xsd:string	An opaque handle used by the DFM station To identify the temporary store created by EventListIterStart.

Name	Type	Description
Events	ArrayOfEventInfo	Array of Events managed by DFM.
Records	xsd:integer	The number of Records actually returned. Range: [0..(2^31)-1]

List Events. The EventListIter* set of APIs are used To retrieve the list of Events. The EventListIterStart 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. Note that, depending on the input parameters, this API may take up To "Timeout" seconds To return. Subsequent calls To EventListIterNext() will return immediately.

Name	Type	Description
EventApplicationList	ArrayOfEventApplicationType optional	If given, specifies a list of event-applications which is used as a filter for Events that are To be returned.
EventId	xsd:integer optional	The 64-bit identifier of the event that has To be listed.
EventSeverities	ArrayOfObjStatus optional	Lists Events of the specified severities.
EventSourceId	xsd:integer optional	Lists Events generated by the specified Source. The EventSourceId is a Name or object identifier returned by other APIs. For example, the EventSourceId could refer To a storage system (From GroupMemberListIterStart) or Dataset (From dataset-list-iter-start). If the EventSourceId identifies a Group, lists Events for all sources in that Group.
EventTypeFilterList	ArrayOfEventTypeFilter 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.
GreaterThanId	xsd:integer optional	If specified, the API will only return Events whose identifier (unsigned 64-bit Values) is greater than this Value. Default is 0.
IncludeDatasetResourceStatusEvents	xsd:boolean optional	This input is considered only if EventSourceId refers To a Dataset. By default this is false. When this element is true, all Events of resources associated with Members of the Dataset are returned. This helps in listing the set of Events that constitutes the Resource Status of the Dataset.
IncludeDeletedObjects	xsd:boolean optional	if TRUE, also lists Events on Objects which have been marked "deleted" in DFM's database. If FALSE, only list Events generated on Objects that have not been "deleted" From DFM's database. This field is ignored if EventSourceId is set. Default is TRUE
IncludeEventArguments	xsd:boolean optional	If present and true, include the EventArguments output element for each listed event. If not present, do not include EventArguments.
IncludeRelated	xsd:boolean optional	if TRUE, include Events of related Objects that resolve From EventSourceId. Would be ignored if EventSourceId is not specified in the input. For e.g: if EventSourceId is Aggregate, all the Events of the Aggregate and its related Storage System, Volumes, Qtrees, Disks and Luns shall be included.
IsAcknowledged	xsd:boolean optional	If TRUE, lists all acknowledged Events. If FALSE, list all unacknowledged Events. If this parameter is not specified, lists all Events irrespective of their Status. Default is empty.
IsDeleted	xsd:boolean optional	if TRUE, lists all Events which have been marked "deleted" in DFM's database. Such Events are not normally shown in event Views. If FALSE, list all un-deleted Events. If this parameter is not specified, lists all Events irrespective of their deletion Status. Default is empty.
IsHistory	xsd:boolean optional	If TRUE, lists all Events generated in DFM after it has been installed; otherwise, show only "current" Events. Default is FALSE.
IsMostSevereFirst	xsd:boolean optional	If TRUE, specifies that Events should be returned in descending order of Severity, then by Timestamp. The default is FALSE, meaning that Events are returned in order of Timestamp only.
IsOldestFirst	xsd:boolean optional	If TRUE, specifies that Events should be returned in ascending order of Timestamp (that is, oldest Events first). The default is FALSE, meaning that Events are returned in descending order of Timestamp (that is, newest Events first).
MaxEvents	xsd: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. Range: [0..2^31-1]
ObjectManagementFilter	ObjectManagementInterface optional	Filter the Events based on the mode of event's Source object. filter "cluster" indicates c-mode Objects and "node" indicates 7-mode Objects. If no filter is supplied, all Events will be considered.
TimeRange	WrapperOfEventTimestampRange optional	Lists all Events which were generated in the range specified. Default is all Events. time-out will be ignored if TimeRange is set.
Timeout	xsd: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 IsHistory or IsDeleted is set To TRUE, or if a specific EventId is specified, or if EventSourceId is specified To be 0, then the Timeout Value is ignored. If TimeRange is set, Timeout is also ignored.

Name	Type	Description
Records	xsd:integer	The number of Events matching the specified input criteria. This is the number of Records that will be returned by subsequent calls To EventListIterNext().
Tag	xsd:string	An opaque handle you must pass To EventListIterNext() and EventListIterEnd() To refer To this list of Events.

EventStatusChangeListIterEnd is used To tell the DFM station that the temporary store used by DFM To support the EventStatusChangeListIterNext API for the particular Tag is no longer necessary.

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

[none]

The EventStatusChangeListIterNext API is used To iterate over the list of Events stored in the temporary store created by the EventStatusChangeListIterStart API. The DFM station, internally, maintains a cursor 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.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of Events To return.
Tag	xsd:string	An opaque handle used by the DFM station To identify the temporary store created by EventStatusChangeListIterStart.

Name	Type	Description
Events	ArrayOfEventInfo	Array of Events managed by DFM.
Records	xsd:integer	The number of Records actually returned. Range: [0..(2^31)-1]

List Events that had Status changes (acknowledged or deleted) within the specified time range. The EventStatusChangeListIter* set of APIs are used To retrieve the list of Events that had Status changes. The EventStatusChangeListIterStart 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 eventDeleted Timestamp). An event that's both acked and deleted 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 deleted Timestamp respectively. Note that, depending on the input parameters, this API may take up To "Timeout" seconds To return. Subsequent calls To EventStatusChangeListIterNext() will return immediately.

Name	Type	Description
MaxEvents	xsd: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. Range: [0..2^31-1]
TimeRange	WrapperOfEventTimestampRange	Lists all Events which were generated in the range specified. If the EndTime of the TimeRange is sometime in the future, time-out will be ignored.
Timeout	xsd: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.

Name	Type	Description
Records	xsd:integer	The number of Events matching the specified input criteria. This is the number of Records that will be returned by subsequent calls To EventStatusChangeListIterNext().
Tag	xsd:string	An opaque handle you must pass To EventStatusChangeListIterNext() and EventStatusChangeListIterEnd() To refer To this list of Events.

Name	Type	Description
EventActionInfo	EventActionInfo[]

Name	Type	Description
EventApplicationType	EventApplicationType[]

Name	Type	Description
EventIdType	EventIdType[]

Name	Type	Description
EventInfo	EventInfo[]

Name	Type	Description
EventTypeFilter	EventTypeFilter[]

Name	Type	Description
ObjStatus	ObjStatus[]

Specify the management Interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible Values are: "node" - For Objects manageable by node management Interface "cluster" - For Objects manageable by cluster management Interface

[none]

Name	Type	Description
EventTimestampRange	EventTimestampRange

Result of Action taken on event. Timestamp returned on success, and Error code on failure.

Name	Type	Description
ErrorCode	xsd:integer optional	Error code corresponding To Errno returned From event acknowledge/delete. Absent on success. Range: [1..2^32-1]
ErrorMessage	xsd:string optional	Error message returned From event acknowledge/delete. Absent on success.
EventId	xsd:unsignedInt	The input event identifier. Range: [0..2^32-1]
Timestamp	xsd:unsignedInt optional	Timestamp when the event was acknowledged/deleted. Timestamps absent for IDs that can not be found, or have already been acknowledged/deleted. Range: [0..2^32-1]

Denotes the kind of application the event is for. Possible Values: 'monitoring', 'data_protection' , 'performance' , 'performance_diagnosis'

[none]

Event identifier. Range: [1..2^32-1]

[none]

Event information structure

Name	Type	Description
EventAbout	xsd:string	Description of the event Type
EventAcknowledged	xsd:integer	Timestamp when event is acknowledged, or 0 if not acknowledged.
EventAcknowledgedUser	xsd:string	User who acknowledged the event.
EventArguments	ArrayOfKeyValuePair optional	Argument list for this particular event. Present only if IncludeEventArguments was set To true in the EventListIterStart call. If the event has no arguments, this element will be empty. For example, some possible arguments are jobId, backupJobId, protectionJobId, or datasetId (the Values for these all integer ids). The arguments returned are dependent on the event Type and Status. The list of possible arguments is variable with each Version and large which is why it is not included here.
EventCondition	xsd:string	Condition of the event
EventDeleted	xsd:integer	Timestamp when event is deleted, or 0 if not deleted.
EventDeletedUser	xsd:string	User who deleted the event.
EventId	xsd:integer	Id of the event. Range: [1..2^31 - 1]
EventName	xsd:string	Name of the event. The list of all event names can be obtained using EventclassList APIs. The element eventclass-info -> event-names[] -> EventNamePretty gives the Name of an event.
EventOriginatingId	xsd:integer optional	This is only returned if the EventType is object-deleted. It's the ID of the deleted object. And in this case, the EventSourceId is the management station ID. Range: [1..2^31 - 1]
EventSeverity	ObjStatus	Severity of the event
EventSourceId	xsd:integer	Id of the Source of the event. Range: [1..2^31 - 1]
EventSourceName	xsd:string	Name of the Source of the event. Example: "storage01.example.com".
EventSourceNodeName	xsd:string optional	This is the Name of the Dataset node the event Source is contained in. This is only returned in the case where IncludeDatasetResourceStatusEvents is set To true.
EventSourceType	xsd:string	Type of object that generated the event. Possible Values: unknown resource_group Host Aggregate Volume Qtree Interface administrator network mgmt_station configuration quotauser initiator_group lun_path fc_switch_port fcp_target Directory hba fcp_initiator san_host_cluster srm_path mirror script script_schedule script_job role data_set storage_set resource_pool dp_policy dp_schedule dp_throttle ossv_directory prov_policy vfiler_template disk
EventTime	xsd:integer	Time when the event was fired.
EventType	xsd:string	Type or class To which the event belongs To. A list of event types can be obtained by using EventclassListIterStart APIs. The element eventclass-info -> EventClassName in eventclass-info gives the Name of an event Type.
IsDeleted	xsd:boolean	Deprecated in favor of EventDeleted which returns the deleted Timestamp

range of event timestamps

Name	Type	Description
EndTime	xsd:integer	End Timestamp, in seconds elapsed since midnight on January 1, 1970.(UTC)
StartTime	xsd:integer	Start Timestamp, in seconds elapsed since midnight on January 1, 1970.(UTC)

Array of event filters.

Name	Type	Description
EventFilter	xsd:string	Name of the EventFilter.

A Status Value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI Type string. The Severity associated with an event has this Type. Possible Values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'Error', 'critical', 'emergency'. unknown: An object has an unknown Status when it transitions From one state To another. Ideally, an object will have this Status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal Status when it is working within the Thresholds specified in DFM. information: The information Events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered To be unmanaged when the login and Password are not set for the storage system or agent. 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. emergency: An object is in emergency Status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given Severity "or worse" occurs. In this example, worse means "after" in the list above.

[none]

Name	Type	Description
KeyValuePair	KeyValuePair[]

The key/value for a generic object attribute.

Name	Type	Description
Key	xsd:string	Key of the generic object attribute
Value	xsd:string	Value of the generic object attribute