Share via

HealthCheck Element

  • Article

Specifies the PowerShell script or user-defined object that will be used to check the health status of a security component.

<xs:element maxOccurs="unbounded" name="HealthCheck">
  <xs:complexType>
    <xs:sequence>
      <xs:element minOccurs="0" name="Assembly" type="xs:string" />
      <xs:element minOccurs="0" name="Class" type="xs:string" />
      <xs:element minOccurs="0" name="Script" type="xs:string" />
      <xs:element minOccurs="0" name="ResultTrue">...</xs:element>
      <xs:element minOccurs="0" name="ResultFalse">...</xs:element>
    </xs:sequence>
    <xs:attribute name="Type" type="xs:string" use="required" />
  </xs:complexType>
</xs:element>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description

Type

Required string attribute.

Specifies how a health check will be performed for a security component. The health check can be performed with a user-defined object by using the Binary type or with a PowerShell script by using the PowerShell type.

Child Elements

Element Description

Assembly Element

Specifies the .dll file that contains the user-defined class for performing a health check or for providing detail information about the results of a health check.

Class Element

Specifies the user-defined class to use for performing a health check or for providing detail information about the results of a health check.

Script Element

Specifies the PowerShell script to use for performing a health check.

ResultTrue Element

Specifies the status value and detail information to be displayed if the health check returns True.

ResultFalse Element

Specifies the status value and detail information to be displayed if the health check returns False.

Parent Elements

Element Description

HealthChecks Element

Provides the PowerShell scripts or user-defined objects to check the health status of a security component.

Remarks

The XML file that uses this element is not validated against an .xsd file, it is used by internal classes to add security component data to the Windows SBS Console.

See Also

Concepts

Security Add-in XML Schema Reference
Walkthrough: Creating a Security Add-in Using XML and PowerShell
Walkthrough: Creating a Security Add-in Using XML and C#