Health Check
Matrix42 Silverback Health Check
This document describes the handling of the Matrix42 Silverback Health Check. The Health Check is a separated tool which provides insights about server and database information based on executed queries and scripts. Based on the gathered information and historical issues or support cases with customers, this Health Check focuses and indicates important topics and provides with descriptions and validations hints for root causes or at least topics which should discussed or reviewed with the customer and or the support. As the sources for the Health Check are more Server and Database focused, a positive Health Check outcome might be different to the Device Management experience itself. E.g., if a Root Certificate has been changed and not created properly, the database and server is not able to check the functionality if iOS devices are able to install the MDM Profile on the device, but the Health Check displays a "positive" Root Certificate with an not expired date. Additionally it is not the intention of the Health Check, to analyze if the Silverback Hardening Guide has been executed by the customer. We recommend performing e.g with the customer together a device enrollment and check if the expectation from the Administrator is met. Additionally, you can perform the SSL Labs in the Hardening Guide to guide the Customer into the right direction.
Download
- Download the Health Check under the following link: Matrix42 Marketplace
- Import the *.zip file to the Silverback server
- Extract the *.zip file to any custom folder on C:\ on the server (don't use the Desktop)
- Review the other sections of this documentation before executing
Folder Structure
| Files & Folders | Description |
|---|---|
| Configurations | Contains the adjustable configuration XML. Includes controls for checks, descriptions, titles etc. and influences the outcome of the Health Check report. |
| Ps1Files | Contains all Windows PowerShell scripts and validators which will be executed with the Health Check |
| SQLFiles | Contains all SQL Queries which will be executed with the Health Check. All queries are structured in sub folders with named sections. |
| wkhtmltopdf | Contains a tool with libraries to convert the Health Check outcome from an HTML file to PDF. Will be locally installed during first run of the Silverback Health Check executable. |
| ExecutionErrors.log |
For Troubleshooting purpose this file will be generate if the Health Check identifies execution issues. The screenshot shows an issue where the Health Check has not been executed with Administrative privileges.
|
| LoadingErrors.log |
For Troubleshooting purpose this file will be generate if the Health Check identifies loading issues. The screenshot shows an issue where a previous Health Check Version has been imported, executed and deleted and afterwards a new Version has been opened for the first time. As the Health Check is using a caching functionality it tries to open previous conf.yaml file. In this case just click Load and reload the current existing one.
|
| Matrix42.Silverback.HealthCheck.exe | Executable must be run with Administrative account and represents the Silverback Health Check itself. |
| PsExec64.exe |
Is a helper to execute PowerShell scripts with a different user for retrieving required information in the Health Check, e.g. for the Certificate sections. When the Health Check will be executed the first time, the SysInternals Software License screen needs to be accepted:
|
User Interface
After running the Matrix42.Silverback.HealthCheck.exe with administrative privileges the following User Interface is shown. You will see the following:
- Tab section with Load, Report, Settings and About
- The currently used Configuration File, which is present under the Configurations Folder (conf.yaml)
- The Version of the Matrix42 Silverback Health Check
- The document structure (gathered from the conf.yaml) with the ability to enable and disable checks.
Handling
- Run the executable with administrative privileges
- After starting the Health Check, the tool will automatically check the Silverback Connection String from Database and retrieve in this way the Database Connection settings and the customer’s name from the License Information.
| Tab | Description |
|---|---|
| Load | Select and import the default or adjusted yaml file |
| Report |
With a click of Report you can select the output folder for the Health Check. After press Save the Health Check will be executed:The outcome will contain a HTML file and a PDF Name in the specified folder with the following file format:
|
| Settings |
System Settings contains the option to modify here the Libraries Folders if Silverback is installed not in the default folder Connection Settings are read from the registry and displayed here. The connection string is represented under Computer\HKEY_LOCAL_MACHINE\SOFTWARE\MATRIX42\Silverback With Apply different user you can apply a different Database User with higher privileges instead of the currently used database user for Silverback. A higher privileged user is able to retrieve more SQL information for the Health Check. You can run the Health Check e.g. twice to see the differences.
|
| About | Displays information about the Silverback Health Check with the Version Number and our Company Name |
Execution
- Run the executable with administrative privileges
- Review all possible checks and keep all enabled (recommended) or adjust them to your needs
- Select Report
- Select the output folder
- With pressing save, the Health Check will be executed
- A progress bar indicates the current progress
Executing Web Routes Checks might take a while, please be patient.
- After a successful run you will see the following information
- Navigate to your output folder
Report
- Open the exported *.pdf file
- Review the document structure, the descriptions, the validations and suggestions
