In this blog, I present you a new tool for checking your existing Windows Server Failover Cluster setup, with or without SAP resources: The Cluster Check Tool.
The Cluster Check Tool collects configuration and logging data from your Windows Server Failover Cluster. Based on the collected information, the Cluster Check Tool validates your configuration and checks for common misconfigurations, for example:
- Cluster specific: Quorum configuration, Properties for Resource Groups and Resources, Resource Group Dependencies
- Cluster Nodes: Operating System Version, Version of SAPRC.dll, Windows Service Startup types, Permissions for file System objects and network share
- Network configuration: Forward/Backward Name Resolution of IP Addresses and Hostnames
Disclaimer: This tool is not part of the SAP Products and thus not officially supported by SAP. Use at your own risk.
Get and run the Cluster Check Tool
Until today, there is an early Beta version available. You can find the latest version of the Cluster Check Tool attached to SAP Note 2624843 – How to check a Windows Failover Cluster configuration?
Every node of the Cluster must fulfil the following system requirements:
- Windows Server 2008 SP2 or later, x64 only
- .NET Framework 4.5 or later
- Windows Management Framework 3.0 or later
You can get the Windows Management Framework 3.0 using the link https://www.microsoft.com/en-us/download/details.aspx?id=34595
- PowerShell 3.0 or later. PowerShell Remoting must be enabled
- The user used to run the Cluster Check Tool must be at least a member of the Active Directory group “Domain Users” and member of the local “Administrators” group on each node of the cluster.
- Disk space: The required disks space mainly depends on the size of the created cluster logs. The size of each cluster log file can exceed several hundreds of megabytes.
Running the Cluster Check Tool
Extract the archive to a local directory on one node of the cluster, for example C:\Cluster Check Tool.
Open an elevated PowerShell, navigate to the directory containing the Cluster Check Tool and run the PowerShell script Run-ClusterCheckTool.ps1:
PS > cd "C:\Cluster Check Tool" PS > .\Run-ClusterCheckTool.ps1
Please note: The Cluster Check Tool runs some prerequisite checks on the local system before starting the data collection on the cluster. If one of the prerequisite checks fails the execution will be canceled and the prerequisite check results will be displayed. You can rerun the tool after you have fixed the reported issues.
Wait until the Cluster Check Tool has collected all required information from your cluster. This may take some minutes depending on the performance of your cluster nodes. After the cluster check tool completed his work successfully, the report is opened automatically.
You should find a ClusterReport_<Timestamp> directory in the directory where the Run-ClusterCheckTool.ps1 is located. This directory contains all data that was collected by the Cluster Check Tool:
- This directory contains the cluster log files
- This directory contains one subdirectory <clusternodename> for each node storing the collected data
- This directory contains one subdirectory <SID> for each detected SAP System storing the collected data
- The Cluster Check Report
- The results of the prerequisite checks
The ZIP-Archive ClusterReport_<Timestamp>.zip is a compressed version of the ClusterReport_<Timestamp> directory. For example, you can attach this archive file to your incidents to provide us additional information about your cluster environment.
How it works
First, the Cluster Check Tool runs a set of prerequisite checks to ensure that it can collect the required data (Step 1). These also includes the check for the system requirements.
If the prerequisite checks passed successfully, the Cluster Check Tool collects information from the Windows Server Failover Cluster (Step 2): The resource groups, resources, and nodes of the cluster and some properties for each of these objects.
For each cluster node detected in step 2, detailed system information is queried mainly using WMI and Remote PowerShell calls (Step 3).
Based on the data from Step 2 and Step 3, the Cluster Check Tool detects the running SAP Systems and collects relevant information for each of these SAP Systems.