Input Name	Type
AlarmCreate	AlarmCreate
Output Name	Type
AlarmCreateResult	AlarmCreateResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EGROUPDOESNOTEXIST
EINVALIDALARMTIME
EINVALIDEMAILADDR
EINVALIDEVENTCLASSEXP
EINVALIDEVENTSEVERITY
EINVALIDTRAPADDR
ENOSUCHEVENT
ENOTFOUNDUSER
ERUNASUNSUPPORTED

Delete an alarm. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm being destroyed is configured.

Input Name	Type
AlarmDestroy	AlarmDestroy
Output Name	Type
AlarmDestroyResult	AlarmDestroyResult

Error Name	Description
EACCESSDENIED
EALARMDOESNOTEXIST
EDATABASEERROR

Get the default Values of Attributes defined by this ZAPI set.

Input Name	Type
AlarmGetDefaults	AlarmGetDefaults
Output Name	Type
AlarmGetDefaultsResult	AlarmGetDefaultsResult

Ends listing of alarms.

Input Name	Type
AlarmListInfoIterEnd	AlarmListInfoIterEnd
Output Name	Type
AlarmListInfoIterEndResult	AlarmListInfoIterEndResult

Error Name	Description
EINVALIDTAG

Returns items From list generated by AlarmListInfoIterStart.

Input Name	Type
AlarmListInfoIterNext	AlarmListInfoIterNext
Output Name	Type
AlarmListInfoIterNextResult	AlarmListInfoIterNextResult

Error Name	Description
EINVALIDTAG

List all configured alarms.

Input Name	Type
AlarmListInfoIterStart	AlarmListInfoIterStart
Output Name	Type
AlarmListInfoIterStartResult	AlarmListInfoIterStartResult

Error Name	Description
EACCESSDENIED
EALARMDOESNOTEXIST
EDATABASEERROR

Modify settings of a DFM alarm. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EINVALIDEMAILADDR - If the email Address has spaces, semi-colons or unprintable characters. EINVALIDEVENTSEVERITY - If the EventSeverity specified is not one of 'normal', 'information', 'unknown', 'warning', 'Error', 'critical', 'emergency'. EINVALIDEVENTCLASSEXP - If the regular expression specified for the EventClass is not a valid POSIX.1 regular expression. EINVALIDALARMTIME - If the time-specified for TimeFrom or TimeTo is greater than 86399 ((24 * 60 * 60) - 1) seconds or if only one of TimeFrom and TimeTo Values are specified. EINVALIDTRAPADDR - If the trap Host specified is not reachable or when the port is greater than 65535 (2^15 - 1) ENOSUCHEVENT - If the event Name specified is not a valid EventName of DFM. EGROUPDOESNOTEXIST - If the Group specified in the alarm parameters is not a DFM Resource Group. ENOTFOUNDUSER - If the administrator Name specified in the alarm parameters is not a DFM administrator. ERUNASUNSUPPORTED - If script-runas parameter is specified on a Windows DFM platform. EINVALIDINPUT - If the EventSeverity Value is less than the Severity of the EventName event. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm is being configured. It is also set when the user sets script-runas parameter for the alarm and he does not have DFM.Database.Write Capability at global level.

Input Name	Type
AlarmModify	AlarmModify
Output Name	Type
AlarmModifyResult	AlarmModifyResult

Error Name	Description
EACCESSDENIED
EALARMDOESNOTEXIST
EAPIMISSINGARGUMENT
EDATABASEERROR
EGROUPDOESNOTEXIST
EINVALIDALARMTIME
EINVALIDEMAILADDR
EINVALIDEVENTCLASSEXP
EINVALIDEVENTSEVERITY
EINVALIDINPUT
EINVALIDTRAPADDR
ENOSUCHEVENT
ENOTFOUNDUSER
ERUNASUNSUPPORTED

Test an alarm by performing it's trigger actions. The test will be performed irrespective of whether the alarm is enabled or disabled. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EALARMTESTFAILED - If there is an Error sending the test alarm event To DataFabric Manager Event Service. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm is configured.

Input Name	Type
AlarmTest	AlarmTest
Output Name	Type
AlarmTestResult	AlarmTestResult

Error Name	Description
EACCESSDENIED
EALARMDOESNOTEXIST
EALARMTESTFAILED
EDATABASEERROR

Create a DFM alarm. The AlarmInfo element specifies all the parameters of the new alarm. Note that it is possible To specify a combination of the EventName, EventSeverity and EventClass such that this alarm will never be triggered. It is the user's responsibility To verify these settings are useful. Error Conditions: EINVALIDEMAILADDR - If the email Address has spaces, semi-colons or unprintable characters. EINVALIDEVENTSEVERITY - If the EventSeverity specified is not one of 'normal', 'information', 'unknown', 'warning', 'Error', 'critical', 'emergency'. EINVALIDEVENTCLASSEXP - If the regular expression specified for the EventClass is not a valid POSIX.1 regular expression. EINVALIDALARMTIME - If the time-specified for TimeFrom or TimeTo is greater than 86399 ((24 * 60 * 60) - 1) seconds or if only one of TimeFrom and TimeTo Values are specified. EINVALIDTRAPADDR - If the trap Host specified is not reachable or when the port is greater than 65535 (2^15 - 1) ENOSUCHEVENT - If the event Name specified is not a valid EventName of DFM. EGROUPDOESNOTEXIST - If the Group specified in the alarm parameters is not a DFM Resource Group. ENOTFOUNDUSER - If the administrator Name specified in the alarm parameters is not a DFM administrator. ERUNASUNSUPPORTED - If script-runas parameter is specified on a Windows DFM platform. EINVALIDINPUT - If the EventSeverity Value is less than the Severity of the EventName event. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm is being configured. It is also set when the user sets script-runas parameter for the alarm and he does not have global DFM.Database.Write Capability.

Name	Type	Description
AlarmInfo	AlarmInfo	Parameters of the new alarm.

Name	Type	Description
AlarmId	xsd:integer	ID of newly created alarm. Range: [1..2^15-1]

Delete an alarm. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm being destroyed is configured.

Name	Type	Description
AlarmId	xsd:integer	Identifier of the alarm. Range: [1..2^15-1]

[none]

Get the default Values of Attributes defined by this ZAPI set.

[none]

Name	Type	Description
AlarmDefaults	AlarmDefaults	The default Values of the Attributes defined by this ZAPI.

Ends listing of alarms.

Name	Type	Description
Tag	xsd:string	Tag returned From AlarmListInfoIterStart.

[none]

Returns items From list generated by AlarmListInfoIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve.
Tag	xsd:string	The Tag returned in AlarmListInfoIterStart call.

Name	Type	Description
AlarmList	ArrayOfAlarmInfo	Array of alarm information.
Records	xsd:integer optional	The number of Records actually returned. Range: [1..2^31-1].

List all configured alarms.

Name	Type	Description
AlarmId	xsd:integer optional	Identifier of the alarm To list. Range: [1..2^15-1]. If AlarmId is not specified, list all alarms.

Name	Type	Description
Records	xsd:integer	Number indicating how many items are available for future retrieval with AlarmListInfoIterNext.
Tag	xsd:string	Tag To be used in subsequent calls To AlarmListInfoIterNext or AlarmListInfoIterEnd.

Modify settings of a DFM alarm. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EINVALIDEMAILADDR - If the email Address has spaces, semi-colons or unprintable characters. EINVALIDEVENTSEVERITY - If the EventSeverity specified is not one of 'normal', 'information', 'unknown', 'warning', 'Error', 'critical', 'emergency'. EINVALIDEVENTCLASSEXP - If the regular expression specified for the EventClass is not a valid POSIX.1 regular expression. EINVALIDALARMTIME - If the time-specified for TimeFrom or TimeTo is greater than 86399 ((24 * 60 * 60) - 1) seconds or if only one of TimeFrom and TimeTo Values are specified. EINVALIDTRAPADDR - If the trap Host specified is not reachable or when the port is greater than 65535 (2^15 - 1) ENOSUCHEVENT - If the event Name specified is not a valid EventName of DFM. EGROUPDOESNOTEXIST - If the Group specified in the alarm parameters is not a DFM Resource Group. ENOTFOUNDUSER - If the administrator Name specified in the alarm parameters is not a DFM administrator. ERUNASUNSUPPORTED - If script-runas parameter is specified on a Windows DFM platform. EINVALIDINPUT - If the EventSeverity Value is less than the Severity of the EventName event. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm is being configured. It is also set when the user sets script-runas parameter for the alarm and he does not have DFM.Database.Write Capability at global level.

Name	Type	Description
AlarmInfo	AlarmInfo	Parameters To be modfied for the alarm. Any Value specified in AlarmInfo replaces Values configured for the alarm. Specifying any optional Attributes with a blank Value removes that setting From the alarm. Specifying an empty array for Attributes that take an array will remove all the entries. Specifying an array element with Values replaces the existing Values. If an array element is not specified, then no change happens. If none of the optional parameters are specified, then this API does nothing. Note that it is possible To specify a combination of the EventName, EventSeverity and EventClass such that this alarm will never be triggered. It is the user's responsibility To verify these settings are useful.

[none]

Test an alarm by performing it's trigger actions. The test will be performed irrespective of whether the alarm is enabled or disabled. Error Conditions: EALARMDOESNOTEXIST - If an alarm by the specified Id does not exist. EALARMTESTFAILED - If there is an Error sending the test alarm event To DataFabric Manager Event Service. EDATABASEERROR - A database Error occured during processing. EACCESSDENIED - When the user does not have DFM.Event.Write Capability on the Resource Group on which the alarm is configured.

Name	Type	Description
AlarmId	xsd:integer	Identifier of the alarm. Range: [1..2^15-1]

[none]

The default Values of the Attributes defined by this ZAPI.

Name	Type	Description
GroupId	xsd:integer	The default Group Id for an alarm is 0, representing the "global Group". This Value is returned.
IsDisabled	xsd:boolean	Unless otherwise specified, the IsDisabled attribute is set To false when the alarm is created.
IsRepeatNotify	xsd:boolean	Unless otherwise specified, the IsRepeatNotify attribute is set To false when the alarm is created.
RepeatInterval	xsd:integer	Unless otherwise specified, the RepeatInterval is set To this default minimum number of seconds between repeat notifications. If IsRepeatNotify is false, it does not apply. Range: [60..3932100]
TrapPort	xsd:integer	The default port for trap destinations. Range: [1..65535].

Information about a single alarm. This structure is used in three places: creating new alarms, modifying alarms, and listing alarms.

Name	Type	Description
AdminLoginNames	ArrayOfAdminName optional	Names of DFM administrators who will receive an alarm email when the alarm is triggered. The alarm email is sent To the email Address configured for the administrator.
AlarmId	xsd:integer optional	Identifier of the alarm. Required for list and modify, ignored on create. Range: [1..2^15-1]
AlarmScript	xsd:string optional	Path on DFM station of a script To run when the alarm is triggered. The script Path is not validated.
AlarmScriptRunas	xsd:string optional	Name of user To run alarm script. If not present, the alarm script runs with the same user ID as the DFM event process. This may only be specified as an input if AlarmScript is set and may only be specified for DFM stations not running Windows.
EmailAddresses	ArrayOfEmailAddress optional	Email addresses of non administrators who will receive alarm email when this alarm is triggered.
EventClass	xsd:string optional	Regular expression specifying the event class of Events that trigger this alarm. Only Events whose event class Match the regular expression will trigger the alarm. The regular expression is of POSIX.1 standard.
EventName	xsd:string optional	Event Name of Events that trigger this alarm. This should exactly Match the short Name or pretty Name of the event.
EventSeverity	ObjStatus optional	Minimum event Severity To trigger this alarm. If an event's Severity is equal To or more severe than this Value, the alarm will be triggered. Valid Values are only 'normal', 'information', 'unknown', 'warning', 'Error', 'critical', 'emergency'.
GroupId	xsd:integer optional	DFM Group Id which triggers alarm. If the event Source object is in this Group, the alarm will be triggered. Default is 0 which is the global Group. Range: [0..2^31-1]
GroupName	xsd:string optional	DFM Group Name which triggers alarm. If the event Source object is in this Group, the alarm will be triggered. This is returned in the output of AlarmList. If GroupId element is not present during input, then this element is considered. If both GroupId and GroupName are not present, then the alarm is configured for global Group.
IsDisabled	xsd:boolean optional	Whether this alarm is disabled. If it is disabled, it will never be triggered. Default Value is false.
IsRepeatNotify	xsd:boolean optional	Whether To repeat the notification for this alarm if the triggering event is not acknowledged. Default Value is false.
PagerAdminLoginNames	ArrayOfAdminName optional	Name of DFM administrators who will receive a shortened alarm email. The email messages are formatted To be easy To read on a pager. The alarm email is sent To the pager email Address configured for the administrator.
PagerEmailAddresses	ArrayOfEmailAddress optional	Email addresses of non administrators who will receive shortened alarm email. The email messages are formatted To be easy To read on a pager.
RepeatInterval	xsd:integer optional	Seconds between repeat notifications of the alarm. This will only be returned if repeat-notify is true and may only be specified as an input if IsRepeatNotify is set To true. The Value is rounded off To the nearest minute. It can have a Maximum Value of 65535 minutes. Default Value is 1800 seconds (30 minutes) Range: [60..3932100]
TimeFrom	xsd:integer optional	Start time of Day when alarm may be triggered, in seconds since Midnight UTC. The Value is rounded off To the nearest minute. The default is To always trigger the alarm. Range: [0..86399]
TimeTo	xsd:integer optional	End time of Day when alarm may be triggered, in seconds since Midnight UTC. The Value is rounded off To the nearest minute. The default is To always trigger the alarm. TimeTo Value is generally greater than TimeFrom Value. If it is lesser than TimeFrom Value, then it is considered as inverted TimeRange. In this case, if the Values of the fields are 20:00 and 2:00, then the alarm is triggered between 0:00 and 2:00 and 20:00 To 23:59. Range: [0..86399]
TrapDestinations	ArrayOfTrapDestination optional	IP Address or Host Name, SNMP community and port To which a SNMP trap is sent as part of this alarm.

Name	Type	Description
AlarmInfo	AlarmInfo[]

Name	Type	Description
AdminName	AdminName[]

Name	Type	Description
EmailAddress	EmailAddress[]

Name	Type	Description
TrapDestination	TrapDestination[]

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]

The Name of a DFM administrator To receive alarm notifications.

[none]

A single email Address. It cannot contain spaces, semi-colons or unprintable characters.

[none]

Destination parameters for a SNMP trap.

Name	Type	Description
TrapCommunity	xsd:string optional	SNMP community To use when sending trap. Default is "public".
TrapHost	xsd:string	Hostname or IP Address of trap destination.
TrapPort	xsd:integer optional	Port number where To send trap. Range: [1..65535]. Default Value is port 162.