<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_OOBAlertService"></a> <H1>Class CIM_OOBAlertService<BR>extends <a href="CIM_Service.html">CIM_Service</a> </H1>This Service is implemented by a LogicalDevice (e.g. a NetworkAdapter or Modem) that is capable of sending alert messages to a remote destination. The alert messages reflect the state of one or more ManagedSystemElements. The Elements for which alert messages are forwarded, are defined by enumerating the ProvidesServiceToElement association for the Service. Out of Band (OOB) refers to the mechanisms in use when normal OS-based management mechanisms are not possible. This occurs when the OS is down or not functioning properly.<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a> <br data="@NAME"> |<br> +--<a href="CIM_LogicalElement.html">CIM_LogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_Service.html">CIM_Service</a> <br data="@NAME"> |<br> +--<b>CIM_OOBAlertService</b> <br data="CIM_OOBAlertService -- CIM_Service"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This Service is implemented by a LogicalDevice (e.g. a NetworkAdapter or Modem) that is capable of sending alert messages to a remote destination. The alert messages reflect the state of one or more ManagedSystemElements. The Elements for which alert messages are forwarded, are defined by enumerating the ProvidesServiceToElement association for the Service. Out of Band (OOB) refers to the mechanisms in use when normal OS-based management mechanisms are not possible. This occurs when the OS is down or not functioning properly.</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::System::Boot</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.6.0</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Local Class Properties</H3> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Data Type</B></TH><TH ROWSPAN="2"><B>Default Value</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">DestinationAddress</TH><TD ROWSPAN="2" VALIGN="TOP">string</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The address where this Service sends the alerts. The format of this address depends on the DestinationType. For example, if the DestinationType is a UDP Port (value=4), then this property contains a string identifying the IP address of the Port (for example, 111.222.333.444:4567). If DestinationType is a pager (value=2), then the address is a Pager number (for example, 18002257654).</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">DestinationIsAckCapable</TH><TD ROWSPAN="2" VALIGN="TOP">boolean</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If the destination is capable of sending an acknowledgement to the alert, then this flag is set to TRUE. The format of the acknowledgement is determined by the DestinationType and the MessageFormat.</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">DestinationType</TH><TD ROWSPAN="5" VALIGN="TOP">uint16</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The type of the alert destination. For example, the alert may be received by an application listening on a UDP Port on a remote destination, or could be sent to a pager (values 4 or 2, respectively).</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OOBAlertService.OtherDestinationTypeDescription</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Other, Pager, TCP Port, UDP Port</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">EnablePresenceHeartbeats</TH><TD ROWSPAN="3" VALIGN="TOP">boolean</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">When set to true causes the OOBAlertService to send Presence heart beat messages.</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OOBAlertService.PresenceHeartbeatCapable</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">FixedPartOfMessage</TH><TD ROWSPAN="2" VALIGN="TOP">string</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The AlertService may require some fixed data to send as part of the message. This may include things like the address or name of the System. This string contains the complete message when the property, OnlySendsFixedMessage, is set to TRUE.</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">MessageFormat</TH><TD ROWSPAN="5" VALIGN="TOP">uint16</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The format of the Alert Message sent by the Service.</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OOBAlertService.OtherMessageFormatDescription</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">0, 1, 2, 3, 4, 5</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Unknown, Other, Numeric, AlphaNumeric, Free Form Text, Platform Event Trap</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">OnlySendsFixedMessage</TH><TD ROWSPAN="2" VALIGN="TOP">boolean</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If the AlertService only uses a fixed message to send an alert, then this flag should be set to TRUE.</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">OtherDestinationTypeDescription</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The description of the alert DestinationType. This is used when the DestinationType is set to "Other" (value=1).</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OOBAlertService.DestinationType</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">OtherMessageFormatDescription</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The description of the format of the alert message used by the Service when the AlertMessageFormat property is set to "Other" (value=1).</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OOBAlertService.MessageFormat</TD> </TR> <TR> <TH ROWSPAN="3" VALIGN="TOP">PresenceHeartbeatCapable</TH><TD ROWSPAN="3" VALIGN="TOP">boolean</TD><TD ROWSPAN="3" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">If the OOB Alerting service is capable of sending Presence heart beat messages.</TD> </TR> <TR> <TD VALIGN="TOP">Read</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TH ROWSPAN="2" VALIGN="TOP">RetryCount</TH><TD ROWSPAN="2" VALIGN="TOP">uint16</TD><TD ROWSPAN="2" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The AlertService may retry and send an alert more than once. The RetryCount identifies how often the operation will be repeated. If DestinationIsAckCapable is set to TRUE, then the retry will only be done if an Ack is not received. Otherwise, the retries are done unconditionally.</TD> </TR> <TR> <TH ROWSPAN="4" VALIGN="TOP">RetryInterval</TH><TD ROWSPAN="4" VALIGN="TOP">uint16</TD><TD ROWSPAN="4" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The interval between each successive retry, in seconds. If DestinationIsAckCapable is set to TRUE, then this interval is used as a timeout interval, before the next retry is done.</TD> </TR> <TR> <TD VALIGN="TOP">PUnit</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">second</TD> </TR> <TR> <TD VALIGN="TOP">Units</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Seconds</TD> </TR> </TABLE> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CommunicationStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CreationClassName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">DetailedStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledDefault</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">EnabledState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">HealthState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstallDate</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Name</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">OperatingStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OtherEnabledState</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerContact</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryOwnerName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">RequestedState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Started</TH><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">StartMode</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">Status</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">SystemCreationClassName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">SystemName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">TimeOfLastStateChange</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">TransitioningToState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">AvailableRequestedStates</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OperationalStatus</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">StatusDescriptions</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> <H3>Inherited Class Methods</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Return Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">ChangeAffectedElementsAssignedSequence</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">RequestStateChange</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_EnabledLogicalElement.html">CIM_EnabledLogicalElement</a></TD> </TR> <TR> <TH VALIGN="TOP">StartService</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> <TR> <TH VALIGN="TOP">StopService</TH><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP"><a href="CIM_Service.html">CIM_Service</a></TD> </TR> </TABLE> </body> </html>
