Convert extracted ConfigMgr site information to Word Document
Export-CMHealthReport [[-ReportFolder] <String>] [[-ReportType] <String>] [[-OutputFolder] <String>]
[[-CustomerName] <String>] [-AutoConfig] [[-SmsProvider] <String>] [-Detailed] [[-CoverPage] <String>]
[[-Template] <String>] [[-AuthorName] <String>] [[-CopyrightName] <String>] [[-ImageFile] <String>]
[[-Healthcheckfilename] <String>] [[-MessagesFilename] <String>] [[-Healthcheckdebug] <Boolean>] [-Show]
[<CommonParameters>]
Converts the data output from Get-CMHealthCheck to generate a report document using Microsoft Word (2010, 2013, 2016). Intended to be invoked on a desktop computer which has Office installed.
Export-CMHealthCheck -Detailed -CustomerName "Contoso" -AuthorName "David Stein" -CopyrightName "ACME Consulting" -Overwrite -Verbose
Export-CMHealthCheck -ReportFolder "2019-03-06\cm01.contoso.local" -Detailed -Template ".\contoso.docx" -CustomerName "Contoso" -AuthorName "David Stein" -CopyrightName "ACME Consulting" -Overwrite -Verbose
Export-CMHealthCheck -ReportFolder "2019-03-06\cm01.contoso.local" -AutoConfig -CustomerName "Contoso"
Path to output data folder (e.g. “My Documents\2019-03-06\cm01.contoso.local”)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: "$([System.Environment]::GetFolderPath('Personal'))"
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: "$([System.Environment]::GetFolderPath('Personal'))"
Accept pipeline input: False
Accept wildcard characters: False
Name of customer (default = “Customer Name”), or use AutoConfig file
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Customer Name
Accept pipeline input: False
Accept wildcard characters: False
Use an auto configuration file, cmhealthconfig.txt in “My Documents” folder to fill-in AuthorName, CopyrightName, Theme, CssFilename, TableRowStyle
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Collect more granular data for final reporting, or use AutoConfig file
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Word theme cover page (default = “Slice (Light)”), or use AutoConfig file
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: Slice (Light)
Accept pipeline input: False
Accept wildcard characters: False
Word document file to use as a template. Should have a cover page already in place. If Template is specified, CoverPage and Copyright are ignored.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Report Author name (default = “Your Name”), or use AutoConfig file
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Text to use for copyright footer string (default = “Your Company Name”)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Your Company Name
Accept pipeline input: False
Accept wildcard characters: False
Path to jpg or png file for custom logo on report. Default is using PS gallery icon
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Healthcheck configuration XML file name (default = “.\assets\cmhealthcheck.xml”) The file can be local, UNC or URI sourced as well
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Status and error message lookup table (default = “.\assets\messages.xml”) The file can be local, UNC or URI sourced as well
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Enable verbose output (or use -Verbose)
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Display report in default web browser when completed
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Sample AutoConfig file cmhealthconfig.txt… AuthorName=John Wick CopyrightName=Retirement Specialists Theme=Ocean Detailed=True TableRowStyle=Solid CssFilename=c:\docs\wickrocks.css ImageFile=c:\docs\bodybags.png CoverPage= Template= HealthcheckFilename= MessagesFilename= HealthcheckDebug=False Overwrite=True