Class CIM_OOBAlertService
extends CIM_Service

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.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_OOBAlertService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis 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.
UMLPackagePathstringCIM::System::Boot
Versionstring2.6.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
DestinationAddressstring
DescriptionstringThe 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).
DestinationIsAckCapableboolean
DescriptionstringIf 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.
DestinationTypeuint16
DescriptionstringThe 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).
ModelCorrespondencestringCIM_OOBAlertService.OtherDestinationTypeDescription
ValueMapstring0, 1, 2, 3, 4
ValuesstringUnknown, Other, Pager, TCP Port, UDP Port
EnablePresenceHeartbeatsboolean
DescriptionstringWhen set to true causes the OOBAlertService to send Presence heart beat messages.
ModelCorrespondencestringCIM_OOBAlertService.PresenceHeartbeatCapable
FixedPartOfMessagestring
DescriptionstringThe 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.
MessageFormatuint16
DescriptionstringThe format of the Alert Message sent by the Service.
ModelCorrespondencestringCIM_OOBAlertService.OtherMessageFormatDescription
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringUnknown, Other, Numeric, AlphaNumeric, Free Form Text, Platform Event Trap
OnlySendsFixedMessageboolean
DescriptionstringIf the AlertService only uses a fixed message to send an alert, then this flag should be set to TRUE.
OtherDestinationTypeDescriptionstring
DescriptionstringThe description of the alert DestinationType. This is used when the DestinationType is set to "Other" (value=1).
ModelCorrespondencestringCIM_OOBAlertService.DestinationType
OtherMessageFormatDescriptionstring
DescriptionstringThe description of the format of the alert message used by the Service when the AlertMessageFormat property is set to "Other" (value=1).
ModelCorrespondencestringCIM_OOBAlertService.MessageFormat
PresenceHeartbeatCapableboolean
DescriptionstringIf the OOB Alerting service is capable of sending Presence heart beat messages.
Readbooleantrue
RetryCountuint16
DescriptionstringThe 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.
RetryIntervaluint16
DescriptionstringThe 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.
PUnitstringsecond
UnitsstringSeconds

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service