Input Name	Range	Type	Description
event-id		integer validate optional	The identifier of the event that has to be acknowledged. Must specify either event-id or event-id-list not both. Range: [1..2^32-1]
event-id-list		event-id-type[] optional	The event identifiers to be acknowledged. Must specify either event-id or event-id-list not both. Returns EINVALIDINPUT if neither or both arguments are included.
Output Name	Range	Type	Description
event-acknowledged		integer optional	Timestamp when the event is acknowledged. This element is returned only in response to an event-id input. Range: [0..2^32-1]
events-acknowledged-list		event-action-info[]	List of timestamps for acknowledged events along with any errors. This array is returned only in response to an event-id-list input.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDINPUT
ENOSUCHEVENT
EALREADYACKWED

Delete events. Terminates repeated notifications due to the event.

Input Name	Range	Type	Description
event-id		integer validate optional	The identifier of the event that has to be deleted. Must specify either event-id or event-id-list not both. Range: [1..2^32-1]
event-id-list		event-id-type[] optional	The event identifiers to be deleted. Must specify either event-id or event-id-list, not both.
Output Name	Range	Type	Description
event-deleted		integer optional	Timestamp when the event is deleted. This element is only returned in response to an event-id input. Range: [0..2^32-1]
events-deleted-list		event-action-info[] optional	Lists of timestamps for deleted ids along with any error returns. This array is returned only in response to an event-id-list input.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDINPUT
ENOSUCHEVENT

The event-generate API helps clients to generate events in the DFM system

Input Name	Range	Type	Description
event-message		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.
event-name		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		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		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.

Errno	Description
EAPIPRIVILEDGE
ENOTCUSTOMEVENTCLASS
EEVENTGENERATEFAILED
EAPIERROR

event-list-iter-end is used to tell the DFM station that the temporary store used by DFM to support the event-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
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG

The event-list-iter-next API is used to iterate over the list of events stored in the temporary store created by the event-list-iter-start 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	Range	Type	Description
maximum		integer	The maximum number of events to return.
tag		string	An opaque handle used by the DFM station to identify the temporary store created by event-list-iter-start.
Output Name	Range	Type	Description
events		event-info[]	Array of events managed by DFM.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG

List events. The event-list-iter-* set of APIs are used to retrieve the list of events. The event-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. Note that, depending on the input parameters, this API may take up to "timeout" seconds to return. Subsequent calls to event-list-iter-next() will return immediately.

Input Name	Range	Type	Description
event-application-list		event-application-type[] optional	If given, specifies a list of event-applications which is used as a filter for events that are to be returned.
event-id		integer optional	The 64-bit identifier of the event that has to be listed.
event-severities		obj-status[] optional	Lists events of the specified severities.
event-source-id		integer optional	Lists events generated by the specified source. The event-source-id is a name or object identifier returned by other APIs. For example, the event-source-id could refer to a storage system (from group-member-list-iter-start) or dataset (from dataset-list-iter-start). If the event-source-id identifies a group, lists events for all sources in that group.
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 (unsigned 64-bit values) is greater than this value. Default is 0.
include-dataset-resource-status-events		boolean optional	This input is considered only if event-source-id refers to a dataset. By default this is false. When this element is true, all events of dataset members, where the member can be through direct or indirect membership are returned. This helps in listing the set of events that constitutes the resource status of the dataset.
include-deleted-objects		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 event-source-id is set. Default is TRUE
is-acknowledged		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.
is-deleted		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.
is-history		boolean optional	If TRUE, lists all events generated in DFM after it has been installed; otherwise, show only "current" events. Default is FALSE.
is-most-severe-first		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.
is-oldest-first		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).
max-events		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]
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 is-history or is-deleted is set to TRUE, or if a specific event-id is specified, or if event-source-id is specified to be 0, then the timeout value is ignored. If time-range is set, timeout is also ignored.
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-list-iter-next().
tag		string	An opaque handle you must pass to event-list-iter-next() and event-list-iter-end() to refer to this list of events.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDEVENTSEVERITY
ENOSUCHEVENT

event-status-change-list-iter-end is used to tell the DFM station that the temporary store used by DFM 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 used by the DFM station

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG

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. 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	Range	Type	Description
maximum		integer	The maximum number of events to return.
tag		string	An opaque handle used by the DFM station to identify the temporary store created by event-status-change-list-iter-start.
Output Name	Range	Type	Description
events		event-info[]	Array of events managed by DFM.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG

List events that had status changes (acknowledged or deleted) 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 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 event-status-change-list-iter-next() will return immediately.

Input Name	Range	Type	Description
max-events		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]
time-range		event-timestamp-range	Lists all events which were generated in the range specified. If the end-time of the time-range is 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.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDEVENTSEVERITY
ENOSUCHEVENT

Result of action taken on event. Timestamp returned on success, and error code on failure.

Name	Range	Type	Description
error-code		integer optional	Error code corresponding to errno returned from event acknowledge/delete. Absent on success. Range: [1..2^32-1]
error-message		string optional	Error message returned from event acknowledge/delete. Absent on success.
event-id		integer	The input event identifier. Range: [0..2^32-1]
timestamp		integer 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'

[none]

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

[none]

Event information structure

Name	Range	Type	Description
event-about		string	Description of the event type
event-acknowledged		integer	Timestamp when event is acknowledged, or 0 if not acknowleged.
event-acknowledged-user		string	User who acknowledged the event.
event-condition		string	Condition of the event
event-deleted		integer	Timestamp when event is deleted, or 0 if not deleted.
event-deleted-user		string	User who deleted the event.
event-id		integer	Id of the event. Range: [1..2^31 - 1]
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-originating-id		integer optional	This is only returned if the event-type is object-deleted. It's the ID of the deleted object. And in this case, the event-source-id is the management station ID. Range: [1..2^31 - 1]
event-severity		obj-status	Severity of the event
event-source-id		integer	Id of the source of the event. Range: [1..2^31 - 1]
event-source-name		string	Name of the source of the event. Example: "storage01.example.com".
event-source-node-name		string optional	This is the name of the dataset node the event source is contained in. This is only returned in the case where include-dataset-resource-status-events is set to true.
event-source-type		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
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.
is-deleted		boolean	Deprecated in favor of event-deleted which returns the deleted timestamp

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)

Array of event filters.

Name	Range	Type	Description
event-filter		string	name of the event-filter.

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