Support site configuration
Each
Heartbeat Plugin Assembly Operation will have an entry in the HeartbeatPluginTemplate
table
The following Heartbeat Plugin Templates are currently implemented:
|
Heartbeat Plugin Template
|
Administer IIS
Application Pool
|
|
Heartbeat Plugin
|
IISHeartbeatService
|
|
Description
|
Allows for the administration of IIS (6 and
7) App Pools.
-Action: REQUIRED -
Possible values {'Status', 'Stop', 'Start', 'Cycle', 'List'} **'List' will
return status information on all Application Pools**
-AdminUsername: REQUIRED for IIS6 - NT
user name with permission to access 'Active Directory Domain Services'.
-AdminPassword: REQUIRED for IIS6 - NT
user password with permission to access 'Active Directory Domain Services'.
-AppPoolName: REQUIRED when 'Action' is one of the following {Status,
Stop, Start, Cycle} - The
name of the Application Pool to be administered.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
AdministerAppPool
|
|
Heartbeat Plugin Template
|
Administer IIS
Website
|
|
Heartbeat Plugin
|
IISHeartbeatService
|
|
Description
|
Allows for the administration of IIS (6 and
7) web sites.
-Action: REQUIRED -
Possible values {'Status', 'Stop', 'Start', 'Cycle', 'List'} **'List' returns
status information on all sites**
-AdminUsername: REQUIRED for IIS6 - NT
user name with permission to access 'Active Directory Domain Services'.
-AdminPassword: REQUIRED for IIS6 - NT
user password with permission to access 'Active Directory Domain Services'.
-SiteName: REQUIRED when 'Action' is one of the following {Status,
Stop, Start, Cycle} - The
name of the website to be administered.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
AdministerSite
|
|
Heartbeat Plugin Template
|
QBO3 Operation
|
|
Heartbeat Plugin
|
QBO3HeartbeatService
|
|
Description
|
Invokes QBO3 operations by reflection.
**The current version only checks for the
presence of a Schedule Object.**
-User: REQUIRED - The
QBO3 user security context under which the operation will occur.
-ConfigurationFilePath: REQUIRED -
Absolute Path to Web.config on targeted QBO3 site.
-ClassName: REQUIRED - The
class name of the Object.
-Method: REQUIRED - The
object method to invoke.
-Additional Parameters: OPTIONAL - As
with any other QBO V3 operation additional parameters can be submitted as required.
-Evaluate: REQUIRED - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
V3Method
|
|
Heartbeat Plugin Template
|
Windows Service:
Cycle
|
|
Heartbeat Plugin
|
Windows Process
|
|
Description
|
Cycles a Windows Service running on the
target machine.
-ServiceName: REQUIRED - The
name of the Windows Service.
-TimeoutMilliseconds: REQUIRED - How
long to wait for the service to stop.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
Cycle
|
|
Heartbeat Plugin Template
|
Windows Service:
List
|
|
Heartbeat Plugin
|
Windows Process
|
|
Description
|
Lists all Windows Services running on the
target machine.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
List
|
|
Heartbeat Plugin Template
|
Windows Service:
Start
|
|
Heartbeat Plugin
|
Windows Process
|
|
Description
|
Starts a Windows Service running on the
target machine.
-ServiceName: REQUIRED - The
name of the Windows Service.
-TimeoutMilliseconds: REQUIRED - How
long to wait for the service to stop.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
Start
|
|
Heartbeat Plugin Template
|
Windows Service:
Status
|
|
Heartbeat Plugin
|
Windows Process
|
|
Description
|
Returns the status of a Windows Service
running on the target machine.
-ServiceName: REQUIRED - The
name of the Windows Service.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
Status
|
|
Heartbeat Plugin Template
|
Windows Service:
Stop
|
|
Heartbeat Plugin
|
Windows Process
|
|
Description
|
Stops a Windows Service running on the target
machine.
-ServiceName: REQUIRED - The
name of the Windows Service.
-TimeoutMilliseconds: REQUIRED - How
long to wait for the service to stop.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
Stop
|
|
Heartbeat Plugin Template
|
WMI: Get Disk
Information
|
|
Heartbeat Plugin
|
WMI Service
|
|
Description
|
Returns local disk space information.
-DriveList: OPTIONAL - A
comma separated list of Device IDs to check. For example 'C:,D:'.
-Threshold: OPTIONAL - The
minimum value, in Gigabytes, for a disk to be considered to have sufficient
free space. For example '2'. The default value is 2GB.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
DiskInfo
|
|
Heartbeat Plugin Template
|
WMI: List Windows
Services
|
|
Heartbeat Plugin
|
WMI Service
|
|
Description
|
Lists all Windows Services running on the
target machine.
-ServiceName: OPTIONAL - The
name of a specific Windows Service.
-Started: OPTIONAL - Return
Services that started or stopped. Possible values {'True', 'False'}
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
-Outcome: OPTIONAL - The
value to set the HeartbeatResult.Status to. Possible values {'Healthy' ,
'Offline'}. Defaults to 'Healthy'.
|
|
Operation
|
ServiceInfo
|
|
Heartbeat Plugin Template
|
WMI: Windows Event
Log Clear
|
|
Heartbeat Plugin
|
WMI Service
|
|
Description
|
Clears a Windows Event Log.
-LogFile: REQUIRED - The
name of event log file e.g. 'Application'.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
EventLogPurge
|
|
Heartbeat Plugin Template
|
WMI: Windows Event Log Information
|
|
Heartbeat Plugin
|
WMI Service
|
|
Description
|
Returns Windows Event Log Information.
-LogFile: REQUIRED - The
name of event log file e.g. 'Application'.
-EventType: OPTIONAL - A filter
value used to determine the types of event log entries to return. Possible
values {'1' = Error, '2' = Warning, '3' = Information, '4' = Security Audit
Success, '5' = Security Audit Failure}
-SearchString: OPTIONAL - A
string to search for in the event log. Only records containing this search
string will be returned.
-Keyword: REQUIRED when 'SearchString' has a value. -
A filter value used to determine whether to check for the presence or absence
of the 'SearchString'. Possible values {'Contains' , 'NotContains',
'Exists'}. **'Exists' checks for the presence of any results**
-Outcome: REQUIRED when 'Keyword' has a value. -
The value to set the HeartbeatResult.Status to if the 'SearchString' and
'Keyword' conditions are met. Possible values {'Healthy' , 'Offline'}
-FromDate: OPTIONAL - All
matching or existing event log records new than this date will be returned.
-Evaluate: OPTIONAL - When
true the Plugin will evaluate the result data and return a HeartbeatResult
record with STATUS and PRIORITY values determined by default business rules.
Possible values {'True', 'False'}
|
|
Operation
|
EventLogInfo
|
Heartbeat Templates
HeartbeatTemplates are a collection of related “Heartbeat
Operations” that are stored as HeartbeatTemplateItems which in turn are
collected by category under a HeartbeatTemplate. Typically these will be set up
by the Heartbeat Admin (Augustine Walker).
HeartbeatTemplateItems
|
HeartbeatTemplate
|
Name of the Heartbeat Item
|
|
Heartbeat Template Item
|
Name of the Heartbeat Template Item
|
|
Heartbeat Plugin Template
|
Name of the Heartbeat Plugin Template
associated with the Heartbeat Template Item
|
|
Description
|
A description of the capabilities of the
HeartbeatTemplateItem and what system/process it monitors.
|
|
Status
|
Current state of the HeartbeatItem. A
status of RequiresReview means that the HeartbeatItem is not fully configured
and therefore will not be included in Heartbeat requests.
|
|
HeartbeatTemplate Item Type
|
Any
Heartbeat Items modeled on this Heartbeat Template Item will be of the same
Type. If the Type is Information then when a Heartbeat Request is created the
Heartbeat Item will be included in the payload. If the Type is Action then the
Heartbeat Item is intended to make a change to the target system and will NOT
be included in any Heartbeat Requests.
|
|
Parameter Xml
|
Input parameter value(s) that will be
inherited by any Heartbeats that implement the HeartbeatTemplate associated
with this HeartbeatTemplateItem. These values will be submitted to the targeted
system’s Heartbeat Service. These value(s) can be overriden at the
HeartbeatItem level during the Heartbeat configuration. Fields with a pink
background are required to be populated during the HeartbeatItem configuration.
Fields with an Italic font will be read-only during the HeartbeatItem
configuration.
|
|
Matrix
|
Any
Heartbeat Items modeled on this Heartbeat Template Item will use the Matrix. The
Matrix will implement business rules that will be applied to any Heartbeat
Results that inherit.
|
Heartbeats
Power users can set up Heartbeats modeled on a specific
HeartbeatTemplate.
|
Heartbeat
|
Name of the
Heartbeat. Try and work the Machine Alias into the name.
|
|
Heartbeat Template
|
Name of the Heartbeat
Template associated with the Heartbeat.
|
|
Organization
|
Organization to be
associated with this Heartbeat
|
|
Server Name
|
The Server Name of
the machine the heartbeat request will be submitted to. In the handshake
process between the client and service, the Windows Communication Foundation
(WCF) infrastructure will ensure that the identity of the expected service
matches the values of this element, and thus can be authenticated. This
functions as a protection against phishing by preventing a client from being
redirected to an endpoint hosted by a malicious service.
|
|
Target IP
|
The Internet Protocol
address of the machine the heartbeat request will be submitted to. Prefix with ‘net.tcp://’
|
|
Status
|
Current state of the
Heartbeat
|
|
Description
|
A description of the
capabilities of the Heartbeat and what types of systems/processes it monitors.
|
|
Postback User Name
|
Username that the
Heartbeat Service on the target machine will use when returning Heartbeat
Results.
|
|
Postback Password
|
Password that the
Heartbeat Service on the target machine will use when returning Heartbeat
Results.
|
|
Schedule
|
the Schedule to be
used when queuing Heartbeat Requests via automation.
|
|
Next Run Date
|
The date and time the Heartbeat is next scheduled to
be run: Only populated if a schedule has been associated with the heartbeat
|
|
Schedule
Attempt Threshold
|
Maximum number of
times a heartbeat will be re-scheduled after it is determined to be offline.
|
|
Request
Max TimeSpan
|
Maximum time in
minutes to wait for all the results of a heartbeat request before recheduling
the heartbeat.
|
HeartbeatItems
Once a Heartbeat is
created it will inherit individual operations from the associated
HeartbeatTemplate’s HeartbeatTeplateItem list. They will be stored as Heartbeat
Items bound to the Heartbeat. Some of the Heartbeat Items
require that their Parameter XML values be reviewed and configured before the
Heartbeat can be scheduled. Default values are provided in many instances, but
some fields will require manual input in order to correctly configure the
'Heartbeat Item'. HeartbeatItems that are not configured will not be included in
Heartbeat requests.
|
Heartbeat Item
|
Name of the Heartbeat Item
|
|
Heartbeat
|
Name of the Heartbeat associated with the
Heartbeat Item
|
|
Heartbeat Template Item
|
Name of the HeartbeatTemplateItem
associated with the Heartbeat Item
|
|
Heartbeat Plugin Template
|
Name of the Heartbeat Plugin Template
associated with the Heartbeat Item
|
|
Description
|
A description of the capabilities of the
HeartbeatItem and what system/process it monitors.
|
|
Status
|
Current state of the HeartbeatItem. A
status of RequiresReview means that the HeartbeatItem is not fully configured
and therefore will not be included in Heartbeat requests.
|
|
Heartbeat Item Type
|
If
the Type is ‘Information’ then when a Heartbeat Request is created the
Heartbeat Item will be included in the payload. If the Type is ‘Action’ then
the Heartbeat Item is intended to make a change to the target system and will
NOT be included in any Heartbeat Requests.
|
|
Parameter Xml
|
These values will be submitted to the
targeted system’s Heartbeat Service. These value(s) can be overriden. This list can be
extended. Check Required if
this parameter requires a value. Check Read-Only if the value provided should not be overwritten.
|
|
Cache Duration
|
Time,
in minutes, the result of the last request based on this Heartbeat Item should
stay in memory on the target system. This is useful if you do not need to have the Heartbeat
Result for this Heartbeat Item returned each time a Heartbeat Request is made
because the likelihood that the result would be different in the elapsed time
between the Heartbeat Schedule interval is low.
|
|
|