Export (0) Print
Expand All

AlertParameters (UnitMonitor)

System Center

Updated: May 18, 2012

Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager

Specifies the minimum unhealthy state at which an alert will be generated.

XML
Copy 

<AlertParameters>
   <AlertParameter>parameterString</AlertParameter>
</AlertParameters>

The following sections describe attributes, child elements, and the parent element of the AlertParameters element.

Attributes

None.

Child Elements

 

Element Description

AlertParameter1

Optional element. Represents an alert parameter string that will substitute {0} in the display string’s description string value.

AlertParameter2

Optional element. Represents an alert parameter string that will substitute {1} in the display string’s description string value.

AlertParameter3

Optional element. Represents an alert parameter string that will substitute {2} in the display string’s description string value.

AlertParameter4

Optional element. Represents an alert parameter string that will substitute {3} in the display string’s description string value.

AlertParameter5

Optional element. Represents an alert parameter string that will substitute {4} in the display string’s description string value.

AlertParameter6

Optional element. Represents an alert parameter string that will substitute {5} in the display string’s description string value.

AlertParameter7

Optional element. Represents an alert parameter string that will substitute {6} in the display string’s description string value.

AlertParameter8

Optional element. Represents an alert parameter string that will substitute {7} in the display string’s description string value.

AlertParameter9

Optional element. Represents an alert parameter string that will substitute {8} in the display string’s description string value.

AlertParameter10

Optional element. Represents an alert parameter string that will substitute {9} in the display string’s description string value.

Parent Elements

 

Element Description

AlertSettings (UnitMonitor)

Defines the alert to generate when the monitor reflects a specified unhealthy state.

Alert parameters allow you to provide contextual information in your alert descriptions. Up to 10 alert parameters can be defined. Consider the following monitor definition that contains two alert parameters:

Copy 

<UnitMonitor ID="Microsoft.SQLServer.2005.DBEngine.ServiceMonitor" Accessibility="Internal" Enabled="true" Target="SQL2005Core!Microsoft.SQLServer.2005.DBEngine" ParentMonitorID="SystemHealth!System.Health.AvailabilityState" Remotable="true" Priority="Normal" TypeID="Windows!Microsoft.Windows.CheckNTServiceStateMonitorType" ConfirmDelivery="false">
  <Category>AvailabilityHealth</Category>
  <AlertSettings AlertMessage="Microsoft.SQLServer.2005.DBEngine.ServiceMonitor.AlertMessage">
    <AlertOnState>Error</AlertOnState>
    <AutoResolve>true</AutoResolve> 
    <AlertPriority>Normal</AlertPriority> 
    <AlertSeverity>Error</AlertSeverity> 
    <AlertParameters>
      <AlertParameter1>$Target/Host/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$</AlertParameter1>
      <AlertParameter2>$Target/Property[Type="SQL!Microsoft.SQLServer.ServerRole"]/InstanceName$</AlertParameter2>
    </AlertParameters>
  </AlertSettings>
  <OperationalStates>
    <OperationalState ID="Success" MonitorTypeStateID="Running" HealthState="Success"/>
    <OperationalState ID="Error" MonitorTypeStateID="NotRunning" HealthState="Error"/>
  </OperationalStates>
  <Configuration>
    <ComputerName>$Target/Host/Property[Type="Windows!Microsoft.Windows.Computer"]/NetworkName$</ComputerName>
    <ServiceName>$Target/Property[Type="SQL!Microsoft.SQLServer.DBEngine"]/ServiceName$</ServiceName>
  </Configuration>
</UnitMonitor>

Each alert parameter uses variable notation to provide contextual values. For more information about variable notation, see Variable Notation. In this case, PrincipalName and InstanceName are the instance-specific properties that will be used to construct the actual alert description that is displayed to the user.

To use the alert parameter feature, you must define the AlertMessage attribute on the AlertSettings (UnitMonitor) element. The definition must be an ID of a StringResource element that is defined in your management pack.

Copy 

<StringResources>
  <StringResource ID="Microsoft.SQLServer.2005.DBEngine.ServiceMonitor.AlertMessage"/>
</StringResources>

Next, you must define a DisplayString element that defines the name and description of your alert message. The display string element references the string resource, Microsoft.SQLServer.2005.DBEngine.ServiceMonitor.AlertMessage. Display strings are located in the LanguagePack section of your management pack. The description string allows for string substitution, where {0} is substituted by AlertParameter1 and {1} is substituted by AlertParameter2.

Copy 

<DisplayStrings>
  <DisplayString ElementID="Microsoft.SQLServer.2005.DBEngine.ServiceMonitor.AlertMessage">
    <Name>SQL Server Service Stopped</Name>
    <Description>The Windows service for the DB Engine instance {1} has stopped on computer {0}.</Description>
  </DisplayString>
</DisplayStrings>
 
Show:
© 2015 Microsoft