Input Name	Range	Type	Description
alert-id		string	Alert identification.
desired-attributes		diagnosis-alert-definition-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
Output Name	Range	Type	Description
attributes		diagnosis-alert-definition-info	The attributes of the Alert Definition.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of Alert Definition objects.

Input Name	Range	Type	Description
desired-attributes		diagnosis-alert-definition-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		diagnosis-alert-definition-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Alert Definition object. All Alert Definition objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		diagnosis-alert-definition-info[] optional	The list of attributes of Alert Definition objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Alert Definition objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Return a subsystem alert

Input Name	Range	Type	Description
alert-id		string	Alert identification.
alerting-resource		string	Unique name of resource that generated the alert.
desired-attributes		diagnosis-alert-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
Output Name	Range	Type	Description
attributes		diagnosis-alert-info	The attributes of the Alert Information.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of Alert Information objects.

Input Name	Range	Type	Description
desired-attributes		diagnosis-alert-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		diagnosis-alert-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Alert Information object. All Alert Information objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		diagnosis-alert-info[] optional	The list of attributes of Alert Information objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Alert Information objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Acknowledge/suppress an alert

Input Name	Range	Type	Description
acknowledge		boolean optional	Acknowledge the alert condition.
acknowledger		string optional	Person who acknowledged this alert
alert-id		string	Alert identification.
alerting-resource		string	Unique name of resource that generated the alert.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
suppress		boolean optional	Suppress this alert.
suppressor		string optional	Person who suppressed this alert

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Return the system health framework configuration

Input Name	Range	Type	Description
desired-attributes		diagnosis-config-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
Output Name	Range	Type	Description
attributes		diagnosis-config-info	The attributes of the Health Monitor Configuration.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of Health Monitor Configuration objects.

Input Name	Range	Type	Description
desired-attributes		diagnosis-config-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		diagnosis-config-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Health Monitor Configuration object. All Health Monitor Configuration objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		diagnosis-config-info[] optional	The list of attributes of Health Monitor Configuration objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Health Monitor Configuration objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Delete subsystem alert

Input Name	Range	Type	Description
alert-id		string	Alert identification.
alerting-resource		string	Unique name of resource that generated the alert.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Return policy definition

Input Name	Range	Type	Description
desired-attributes		diagnosis-policy-definition-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
policy-id		string	Policy identifier.
Output Name	Range	Type	Description
attributes		diagnosis-policy-definition-info	The attributes of the Policy Definition.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of Policy Definition objects.

Input Name	Range	Type	Description
desired-attributes		diagnosis-policy-definition-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		diagnosis-policy-definition-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Policy Definition object. All Policy Definition objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		diagnosis-policy-definition-info[] optional	The list of attributes of Policy Definition objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Policy Definition objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Enable/disable policy

Input Name	Range	Type	Description
enable		boolean optional	Enable/disable this policy.
monitor		hm-type	Type of health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor.
policy-id		string	Policy identifier.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Return the overall system health

Input Name	Range	Type	Description
desired-attributes		diagnosis-status optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Output Name	Range	Type	Description
attributes		diagnosis-status	The attributes of the System Health Status.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Create a new Subscriptions for Notifications.

Input Name	Range	Type	Description
class-name		string	Class name of changed resource.
event-type		hm-event-type	Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated.
fail-thresh	[0..2^32-1]	integer optional	Failure threshold for notification.
instance-name		string optional	Instance name of changed resource.
max-notify-period	[0..65535]	integer optional	Maximum expected time for Notification to complete.
monitor		hm-type	Type of source health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor and sends out notifications
notify-dest-hm		hm-type	Health monitor subsribing for notification.
notify-dest-node		node-name	Node hosting the health monitor that is subscribing for notification.
notify-table		string optional	Table name for DSMF notification.
psc-option		boolean optional	Enable/Disable periodic status confirmation.
return-record		boolean optional	If set to true, returns the Subscriptions for Notifications on successful creation. Default: false
subscription-id		string	Subscription identifier.
time-gap-notify	[0..65535]	integer optional	Time Period between two notifications.
Output Name	Range	Type	Description
result		diagnosis-subscriptions-info optional	The Subscriptions for Notifications created (keys or the entire object if requested)

Errno	Description
EINTERNALERROR

Return system health subscription

Input Name	Range	Type	Description
class-name		string	Class name of changed resource.
desired-attributes		diagnosis-subscriptions-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
event-type		hm-event-type	Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated.
monitor		hm-type	Type of source health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor and sends out notifications
notify-dest-hm		hm-type	Health monitor subsribing for notification.
notify-dest-node		node-name	Node hosting the health monitor that is subscribing for notification.
subscription-id		string	Subscription identifier.
Output Name	Range	Type	Description
attributes		diagnosis-subscriptions-info	The attributes of the Subscriptions for Notifications.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

Iterate over a list of Subscriptions for Notifications objects.

Input Name	Range	Type	Description
desired-attributes		diagnosis-subscriptions-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		diagnosis-subscriptions-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Subscriptions for Notifications object. All Subscriptions for Notifications objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		diagnosis-subscriptions-info[] optional	The list of attributes of Subscriptions for Notifications objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Subscriptions for Notifications objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Modify system health subscription

Input Name	Range	Type	Description
class-name		string	Class name of changed resource.
event-type		hm-event-type	Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated.
fail-thresh	[0..2^32-1]	integer optional	Failure threshold for notification.
instance-name		string optional	Instance name of changed resource.
max-notify-period	[0..65535]	integer optional	Maximum expected time for Notification to complete.
monitor		hm-type	Type of source health monitor (e.g. node_connect, system_connect, system).
node		string	Node hosting this health monitor and sends out notifications
notify-dest-hm		hm-type	Health monitor subsribing for notification.
notify-dest-node		node-name	Node hosting the health monitor that is subscribing for notification.
notify-table		string optional	Table name for DSMF notification.
psc-option		boolean optional	Enable/Disable periodic status confirmation.
subscription-id		string	Subscription identifier.
time-gap-notify	[0..65535]	integer optional	Time Period between two notifications.

Errno	Description
EOBJECTNOTFOUND
EINTERNALERROR

System Health Alert Definition When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
additional-information		string optional	Additional information about the alert. Attributes: non-creatable, non-modifiable
alert-id		string optional	Alert identification. Attributes: key, non-creatable, non-modifiable
alert-type		hm-alert-type optional	Type of alert (other,communications,quality-of-service,processing-error,device,environmental,model-change,security). Attributes: non-creatable, non-modifiable
corrective-actions		string optional	Recommended actions to correct the problem reported by alert. Attributes: non-creatable, non-modifiable
monitor		hm-type optional	Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
node		string optional	Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
perceived-severity		hm-perceived-sev optional	Severity of alert (Unknown,Other,Information,Degraded,Minor,Major,Critical,Fatal). Attributes: non-creatable, non-modifiable
possible-effect		string optional	Detailed description of the possible effect of the condition. Attributes: non-creatable, non-modifiable
probable-cause		hm-probable-cause optional	Probable cause for alert generation. Attributes: non-creatable, non-modifiable
probable-cause-description		string optional	Detailed description of probable cause for alert generation. Attributes: non-creatable, non-modifiable
subsystem		hm-subsystem optional	Type of subsystem being monitored (e.g. sas_connect). Attributes: non-creatable, non-modifiable

System Health Alert When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
acknowledge		boolean optional	Acknowledge the alert condition. Attributes: non-creatable, modifiable
acknowledger		string optional	Person who acknowledged this alert Attributes: non-creatable, modifiable
additional-info		string[] optional	Additional information from the resource that generated this alert Attributes: non-creatable, non-modifiable
alert-id		string optional	Alert identification. Attributes: key, non-creatable, non-modifiable
alerting-resource		string optional	Unique name of resource that generated the alert. Attributes: key, non-creatable, non-modifiable
alerting-resource-name		string optional	Display name of resource that generated the alert. Attributes: non-creatable, non-modifiable
corrective-actions		string optional	Recommended actions to correct the problem reported by alert. Attributes: non-creatable, non-modifiable
indication-time		date optional	Time of alert generation. Attributes: non-creatable, non-modifiable
monitor		hm-type optional	Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
node		string optional	Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
perceived-severity		hm-perceived-sev optional	Severity of alert. Attributes: non-creatable, non-modifiable
policy		string optional	Policy rule responsible for creating this alert. Attributes: non-creatable, non-modifiable
possible-effect		string optional	Possible effect seen due to this problem. Attributes: non-creatable, non-modifiable
probable-cause		hm-probable-cause optional	Probable cause for alert generation. Attributes: non-creatable, non-modifiable
probable-cause-description		string optional	Detailed description of probable cause for alert generation. Attributes: non-creatable, non-modifiable
subsystem		hm-subsystem optional	Type of subsystem being monitored (e.g. sas_connect). Attributes: non-creatable, non-modifiable
suppress		boolean optional	Suppress this alert. Attributes: non-creatable, modifiable
suppressor		string optional	Person who suppressed this alert Attributes: non-creatable, modifiable

System Health Config When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
aggregator		hm-type optional	Aggregating health monitor that aggregates status from this health monitor. Attributes: non-creatable, non-modifiable
context		hm-scope optional	Scope of health monitor (node-context, cluster-context). Attributes: non-creatable, non-modifiable
health		hm-status optional	Status of health monitor (ok, ok-with-suppressed, degraded). Attributes: non-creatable, non-modifiable
mon-version		string optional	Health Monitor version. Attributes: non-creatable, non-modifiable
monitor		hm-type optional	Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
node		string optional	Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
pol-version		string optional	Policy file version. Attributes: non-creatable, non-modifiable
resources		string[] optional	Resources monitored by this health monitor. Attributes: non-creatable, non-modifiable
sub-pol-versions		string optional	Subordinate policy file versions. Attributes: non-creatable, non-modifiable
subsystem		hm-subsystem[] optional	Type of subsystem being monitored (e.g. sas_connect). Attributes: non-creatable, non-modifiable

System Health Policy Definition When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
alert-count	[0..2^32-1]	integer optional	Count of alerts created as a result of this policy. Attributes: non-creatable, non-modifiable
alert-id		string optional	Alert identifier for alert to be generated on policy rule match. Attributes: non-creatable, non-modifiable
creation-time		datetime optional	Time when the previous alert was created due to this policy. Attributes: non-creatable, non-modifiable
enable		boolean optional	Enable/disable this policy. Attributes: non-creatable, modifiable
monitor		hm-type optional	Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
node		string optional	Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
policy-id		string optional	Policy identifier. Attributes: key, non-creatable, non-modifiable
responsible-resource-info		string optional	The resource responsible for creating this alert Attributes: non-creatable, non-modifiable
rule-expression		string optional	Arithmetic expression which defines alerts to be created as a result of this policy. Attributes: non-creatable, non-modifiable
where		string optional	Where clause of Arithmetic expression. Attributes: non-creatable, non-modifiable

System Health Status When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
status		hm-status optional	Overall system health (ok,ok-with-suppressed,degraded,unreachable) as determined by the diagnosis framework. Attributes: non-creatable, non-modifiable

System Health Subscriptions When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
class-name		string optional	Class name of changed resource. Attributes: key, required-for-create, non-modifiable
creation-time		datetime optional	Time at which this subscription was created. Attributes: non-creatable, non-modifiable
event-type		hm-event-type optional	Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated. Attributes: key, required-for-create, non-modifiable
fail-thresh	[0..2^32-1]	integer optional	Failure threshold for notification. Attributes: optional-for-create, modifiable
instance-name		string optional	Instance name of changed resource. Attributes: optional-for-create, modifiable
max-notify-period	[0..65535]	integer optional	Maximum expected time for Notification to complete. Attributes: optional-for-create, modifiable
monitor		hm-type optional	Type of source health monitor (e.g. node_connect, system_connect, system). Attributes: key, required-for-create, non-modifiable
node		string optional	Node hosting this health monitor and sends out notifications Attributes: key, non-creatable, non-modifiable
notify-dest-hm		hm-type optional	Health monitor subsribing for notification. Attributes: key, required-for-create, non-modifiable
notify-dest-node		node-name optional	Node hosting the health monitor that is subscribing for notification. Attributes: key, required-for-create, non-modifiable
notify-fptr	[0..2^64-1]	integer optional	Function pointer to be invoked. Attributes: non-creatable, non-modifiable
notify-table		string optional	Table name for DSMF notification. Attributes: optional-for-create, modifiable
notify-type		hm-notify-type optional	Type of notification (dsmf-type, fptr-type). Attributes: non-creatable, non-modifiable
psc-option		boolean optional	Enable/Disable periodic status confirmation. Attributes: optional-for-create, modifiable
subscription-id		string optional	Subscription identifier. Attributes: key, required-for-create, non-modifiable
time-gap-notify	[0..65535]	integer optional	Time Period between two notifications. Attributes: optional-for-create, modifiable

Event type

[none]

Type of Health Monitor

[none]

The node's name

[none]

Date (in seconds since Jan. 1, 1970 12:00:00) Range : [0..2^31-1].

[none]

The number of seconds since January 1, 1970. Range : [0..2^31-1].

[none]

Type of alert

[none]

Notify type

[none]

Alert severity

[none]

Probable cause for alert generation

[none]

Node or Cluster context of Health Monitor

[none]

Health Monitor Status

[none]

Health Monitor Subsystem

[none]