Service Provider Foundation VMM web endpoint monitor

Microsoft.SystemCenter.SPF.Monitor.VMMEndpointGet (UnitMonitor)

Monitors the operational health of the SPF VMM web endpoint.

Knowledge Base article:

Summary

Monitors the accessibility and operability of the VMM web interface from the SPF web servers. This is done by periodically making a test web interface call to retrieve cloud resources.

Configuration

For this monitor to work correctly, it must have administrator permission to access cloud resources on VMM servers. Create a Run As Account that uses or has equal permission as the App Pool account specified for the VMM web endpoint and add it to the Run As Profile called Microsoft Service Provider Foundation VMM Account.

The following options can be configured on this monitor:

Option	Definition	Default
Alert On State	Health state for the monitor that generates an alert.	The monitor is in a critical health state
Alert Priority	Priority of the alert generated for this monitor.	High
Alert Severity	Priority of the alert generated for this monitor.	Critical
Auto-Resolve Alert	Specifies whether the alert should automatically be resolved when the monitor returns to a healthy state.	True
Enabled	Specifies whether the monitor should run.	True
Generates Alert	Specifies whether the monitor should generate an alert when changing to a warning or critical state.	True
Interval	Number of seconds between times that the monitor is run.	300

Causes

If this monitor is in error, and no other connectivity monitors are in error, then likely causes are either fabric configuration error or permission error. See the Configuration section for details on configuring the monitor.

Resolutions

Check the target VMM server for fabric configuration on cloud resources and ensure the access rights are granted to the administrator account. Ensure the security for the monitor is configured correctly.

Element properties:

Target

Microsoft.SystemCenter.SPF.SpfServer

Parent Monitor

System.Health.AvailabilityState

Category

AvailabilityHealth

Enabled

True

Alert Generate

True

Alert Severity

MatchMonitorHealth

Alert Priority

Normal

Alert Auto Resolve

True

Monitor Type

Microsoft.SystemCenter.ServiceProviderFoundation.PowerShellModule.TwoStateMonitorType.PropertyBag

Remotable

True

Accessibility

Public

Alert Message

Cannot Access VMM Endpoint

Service Provider Foundation VMM web endpoint is not accessible.

RunAs

Microsoft.SystemCenter.SPF.VmmEndpointAccount

Source Code:

<UnitMonitor ID="Microsoft.SystemCenter.SPF.Monitor.VMMEndpointGet" Accessibility="Public" Enabled="true" Target="Microsoft.SystemCenter.SPF.SpfServer" ParentMonitorID="Health!System.Health.AvailabilityState" Remotable="true" Priority="Normal" TypeID="Microsoft.SystemCenter.ServiceProviderFoundation.PowerShellModule.TwoStateMonitorType.PropertyBag" ConfirmDelivery="false" RunAs="Microsoft.SystemCenter.SPF.VmmEndpointAccount">

  <Category>AvailabilityHealth</Category>

  <AlertSettings AlertMessage="Microsoft.SystemCenter.SPF.Monitor.VMMEndpointGet.AlertMessage">

    <AlertOnState>Error</AlertOnState>

    <AutoResolve>true</AutoResolve>

    <AlertPriority>Normal</AlertPriority>

    <AlertSeverity>MatchMonitorHealth</AlertSeverity>

    <AlertParameters>

      <AlertParameter1>$Data/Context/Property[@Name='StatusCode']$</AlertParameter1>

    </AlertParameters>

  </AlertSettings>

  <OperationalStates>

    <OperationalState ID="Error" MonitorTypeStateID="Error" HealthState="Error"/>

    <OperationalState ID="Success" MonitorTypeStateID="Success" HealthState="Success"/>

  </OperationalStates>

  <Configuration>

    <IntervalSeconds>300</IntervalSeconds>

    <SyncTime/>

    <ScriptName>HealthOfSpfServer.ps1</ScriptName>

    <ScriptBody><Script>param 

(

	$PortNumber

)



$oAPI = new-object -comObject "MOM.ScriptAPI"

$propertyBag = $oAPI.CreatePropertyBag()



$errorActionSetting = $ErrorActionPreference



$downVmmServers = ""

$res = $null



try

{

	$ErrorActionPreference = "Stop"



    [Net.ServicePointManager]::ServerCertificateValidationCallback = {$true} 

    

    $req = [System.Net.WebRequest]::Create("https://localhost:$PortNumber/SC2012R2/VMM/Microsoft.Management.OData.svc/Clouds")

    $req.UseDefaultCredentials = $true

    $res = $req.GetResponse()

    $int = [int]$res.StatusCode

	if($int -eq 200)

    {

        $propertyBag.AddValue("Result", "Success")

    }

    else 

    {

        $propertyBag.AddValue("Result", "Failure")

    }



    $propertyBag.AddValue("StatusCode", $int)



}

catch

{

	$propertyBag.AddValue("Result", "Failure")

	$propertyBag.AddValue("StatusCode", $_.Exception.Message)

}

finally

{

	$ErrorActionPreference = $errorActionSetting

	if($res -ne $null)

	{

		$res.Close()

	}

	$propertyBag

}

</Script></ScriptBody>

    <Parameters>

      <Parameter>

        <Name>PortNumber</Name>

        <Value>$Target/Property[Type="Microsoft.SystemCenter.SPF.SpfServerBase"]/PortNumber$</Value>

      </Parameter>

    </Parameters>

    <TimeoutSeconds>300</TimeoutSeconds>

    <ErrorExpression>

      <SimpleExpression>

        <ValueExpression>

          <XPathQuery Type="String">Property[@Name='Result']</XPathQuery>

        </ValueExpression>

        <Operator>NotEqual</Operator>

        <ValueExpression>

          <Value Type="String">Success</Value>

        </ValueExpression>

      </SimpleExpression>

    </ErrorExpression>

    <SuccessExpression>

      <SimpleExpression>

        <ValueExpression>

          <XPathQuery Type="String">Property[@Name='Result']</XPathQuery>

        </ValueExpression>

        <Operator>Equal</Operator>

        <ValueExpression>

          <Value Type="String">Success</Value>

        </ValueExpression>

      </SimpleExpression>

    </SuccessExpression>

  </Configuration>

</UnitMonitor>