# 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

Name | Data Type | Value
--- | --- | ---

Description

string

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.

UMLPackagePath | string | CIM::System::Boot
Version | string | 2.6.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
DestinationAddress | string |

Description

string

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).

DestinationIsAckCapable | boolean |
Description | string | 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.
DestinationType | uint16 |
Description | string | 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).
ModelCorrespondence | string | CIM_OOBAlertService.OtherDestinationTypeDescription
ValueMap | string | 0, 1, 2, 3, 4
Values | string | Unknown, Other, Pager, TCP Port, UDP Port
EnablePresenceHeartbeats | boolean |
Description | string | When set to true causes the OOBAlertService to send Presence heart beat messages.
ModelCorrespondence | string | CIM_OOBAlertService.PresenceHeartbeatCapable
FixedPartOfMessage | string |
Description | string | 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.
MessageFormat | uint16 |
Description | string | The format of the Alert Message sent by the Service.
ModelCorrespondence | string | CIM_OOBAlertService.OtherMessageFormatDescription
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | Unknown, Other, Numeric, AlphaNumeric, Free Form Text, Platform Event Trap
OnlySendsFixedMessage | boolean |
Description | string | If the AlertService only uses a fixed message to send an alert, then this flag should be set to TRUE.
OtherDestinationTypeDescription | string |
Description | string | The description of the alert DestinationType. This is used when the DestinationType is set to "Other" (value=1).
ModelCorrespondence | string | CIM_OOBAlertService.DestinationType
OtherMessageFormatDescription | string |
Description | string | The description of the format of the alert message used by the Service when the AlertMessageFormat property is set to "Other" (value=1).
ModelCorrespondence | string | CIM_OOBAlertService.MessageFormat
PresenceHeartbeatCapable | boolean |
Description | string | If the OOB Alerting service is capable of sending Presence heart beat messages.
Read | boolean | true
RetryCount | uint16 |
Description | string | 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.
RetryInterval | uint16 |
Description | string | 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.
PUnit | string | second
Units | string | Seconds

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service