Usage and Syntax

The collection and reporting process can be run as a single process, or as separate processes, to suit the constraints of various environments.

Option 1 - Run as a Single Process (collection and reporting)

1. Run Invoke-CMHealthCheck to gather and produce an HTML report

Option 2 - Run as Separate Processes (collection, then reporting)

1. Collect the data using Get-CMHealthCheck

2. If choosing to publish the report in Microsoft Word format:

   • Log onto a computer which has a supported version of Microsoft Office
   • Run Export-CMHealthReport -ReportType Word

3. If choosing to publish the report in HTML format:

   • From any computer, run Export-CMHealthReport -ReportType HTML

Reporting Options

The Invoke-CMHealthCheck function exports to an HTML document. The Export-CMHealthCheck function exports to Microsoft Word. The Export-CMHealthCheck function exports to an HTML document.

Outputs and Logging

The Get-CMHealthCheck and Invoke-CMHealthCheck functions both create folders under the Documents folder of the user session. Information is pulled from Configuration Manager, the SQL Server database instance, the Windows Server host(s), and all site systems in the hierarchy.

By default, the output folder is created under $env:USERPROFILE\Documents. Two folders are created by default:

• _Logs
• YYYY-MM-DD

Beneath the folder YYYY-MM-DD (ex. 2019-03-06) will be sub-folders for each site system. For example...

• 2019-10-03\cm01.contoso.local

When the query process is complete, the Export-CMHealthCheck (or Export-CMHealthCheckHTML) function will refer to the site-system folder using the -ReportFolder parameter.

More Information

• Refer to the Docs markdown documents or use the Get-Help function, to view detailed examples.