Hyper-V Replication Health • Help Guide • CheckCentral by Binary Fortress Software

WARNING: You currently have Javascript disabled!
This website will not function correctly without Javascript enabled.

With Hyper-V, you can get the replication status using the Get-VMReplication command. This script gets the replication status from each of the servers you specify, and creates an activity in CheckCentral for each one, allowing you to have a separate check for each Hyper-V host that you want to monitor.

Setting Up the API Token and the Script

Installation

Download the script: hyperv_replication_health.ps1
In CheckCentral, go to Organization > API.

Click "Add Token."

Give the token a name, e.g.
```
SERVER01 Hyper-V Replication Script
```
.
Select "createActivities Only" in the Access Level drop-down and click Save.

Copy the token, and paste it in the
```
$apiToken
```
variable of the script.

Put the hostnames you want the script to run against in the $hvHosts variable of the script.

Run the script. You'll now see an unmatched activity in CheckCentral.

For multiple instances, consider using unique API keys. If at a later date one needs to be revoked, it will then only impact a single instance.

Scheduling

Configure this script to run on a machine somewhere as a regularly scheduled task. (Daily in this example)

Configure the Check

Create and Identify

In CheckCentral, go to Activities.

Select "Unmatched" from the Matched dropdown selector and then click the "Filter" button.

The results will show below.

Click the "Create Check" link next to the relevant activity.

Leave the Name as is.
Select an existing Check Group or create a new one by clicking "

Add Check Group
".
Select an existing Label or create a new one by typing the name in the text field of the dropdown (optional).
Add a description (optional).

The Asset ID is used exclusively with certain ticketing systems and is not required for Checks. Asset ID details and ticketing systems are more fully covered by other documents (e.g. Halo Integration (asset ID).)

Leave the Asset ID blank.

Your Check so far will look something like this:

Navigate to the next step in CheckCentral by clicking the "Next" button or the tab name.

Schedule

Leave "Scheduled" selected as we will be running the script regularly.
Assuming you'll run the script daily, leave the Expected Interval on "1" "Day(s)." If you plan to run the script on another interval, adjust accordingly.

The initial expectation time is set by the first email message that is received and processed by its Check. (For example, if a notification email arrives at noon and its Check is set for every half hour, it will expect another notification email at 12:30.)

Leave the Set as Overdue setting at "After 30 Minutes." If the script notification email is not received after this amount of time has been exceeded, the Check will be marked as a failure.

Leave Custom Schedule de-selected.

Matching

The Matching step is what matches a notification email to its specific Check. It's also where you'll set the notification's CheckCentral destination email. For email-based notifications, this email can be used for quick matching. Because this is an API-created activity, other Matching Rules are needed.

A Matching Rule is created by default with the Subject of the message crafted by the earlier test run of the script. The "Subject" "Is Exactly" dropdowns and the text

Hyper-V Replication Health:

are displayed, appended with the Computer Name of the computer running the script.

Leave the Matching Rule as is.
Leave Condense Whitespace and Combine Attachments enabled.

The email address will appear different based on your organization name and the name you specified for your check.

Status

The previous Matching step identifies the incoming message to the Check. The Status step looks for indicators of what type of notification you're receiving (e.g. The job was successfully run, it failed, or there were some issues.)

The activity the script creates will list the replication status for each VM on the host in the body, so you'll configure the check status conditions to confirm that the words "Critical" and "Warning" are not in the body text, and that the word "Healthy" is in the body text.

Leave the Default Status on "Failure."

The "Success Criteria" section is where you'll set the criteria that will mark an activity as successful.

Click

Add Success Rule
.
Set the rule to "Body Text" "Does Not Contain"
```
Critical
```
Click

Add Success Rule
.
Set the rule to "Body Text" "Does Not Contain"
```
Warning
```
Click

Add Success Rule
.
Set the rule to "Body Text" "Contains"
```
Healthy
```
Leave the Condense Whitespace and Combine Attachments checkboxes enabled.

Notifications

Notifications are simply how you want to be informed of Check Failures, Warnings, and some other Status changes.

Email, push, chat and other software can be integrated as well as ticketing systems, allowing for automatic ticket creation and management.

Further configuration is required for each to function and is done via the Notifications tab in the main menu. They can be configured before or after Check creation.

For more understanding of Notification setup, see the CheckCentral Beginner's Guide (Notifications).

Select the desired means of Notification. If in doubt of the selections here, leave the defaults.

Save

To confirm the activity now matches the check, click the Test button.

Under "Recent Messages Now Matched" your previously unmatched activity will be displayed with a green Status indicator (assuming the status was returned with no Errors or Warnings).

Close the Test window.
Click the "Save Check" button.

For more detail on Check creation and best practices, see our Check Creation Guide.

For other guides and support contact information, see CheckCentral Support

About CheckCentral

CheckCentral Monitoring consolidates and simplifies backup, system, and software email updates into a clean, graphical dashboard, bringing peace of mind to IT administrators of SMBs, Enterprises, and MSPs.

To learn more about CheckCentral, visit: https://www.checkcentral.cc

About Binary Fortress Software

Binary Fortress has spent 17 years in pursuit of one goal: create software to make life easier. Our software ranges from display management and system enhancement utilities to monitoring tools and digital signage. IT administrators, professional gamers, coffee-shop owners, and MSPs all rely on Binary Fortress to make their days better, and their lives easier.

Copyright © 2007-2024 Binary Fortress Software, all rights reserved.
The Binary Fortress logo is a trademark of Binary Fortress Software.
The CheckCentral logo is a trademark of Binary Fortress Software.

Binary Fortress Software
1000 Innovation Drive, Suite 500
Kanata, Ontario, Canada
K2K3E7
https://www.binaryfortress.com