Public/Invoke-CMHealthCheck.ps1

<#
.SYNOPSIS
    Generate Health Information from a Configuration Manager site
.DESCRIPTION
    Generate Health Information from a Configuration Manager site
.PARAMETER SmsProvider
    FQDN of the SMS Provider host in the Configuration Manager site, default is localhost
.PARAMETER DataFolder
    Path to output data for storing files during collection phase, default is "My Documents"
.PARAMETER PublishFolder
    Path to save the HTML report file, default is "My Documents"
.PARAMETER CustomerName
    Name of customer (default = "Customer Name"), or use AutoConfig file
.PARAMETER AuthorName
    Report Author name (default = "Your Name"), or use AutoConfig file
.PARAMETER CopyrightName
    Text to use for copyright footer string (default = "Your Company Name")
.PARAMETER MessagesFilename
    Status and error message lookup table (default = ".\assets\messages.xml")
    The file can be local, UNC or URI sourced as well
.PARAMETER HealthcheckFilename
    Name of configuration file (default is .\assets\cmhealthcheck.xml)
.PARAMETER Healthcheckdebug
    Enable verbose output (or use -Verbose)
.PARAMETER NumberOfDays
    Number of days to go back for alerts in logs (default = 7)
.PARAMETER Overwrite
    Overwrite existing output folder if found.
    Folder is named by datestamp, so this only applies when
    running repeatedly on the same date
.PARAMETER NoHotFix
    Skip inventory of installed hotfixes
.PARAMETER OpenBrowser
    Open HTML report in default web browser upon completion
.PARAMETER AutoConfig
    Load parameters from configuration file
    Example:
        ```
        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
        ```

.PARAMETER Detailed
    Display additional details (verbose)
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp"
    Standard/default settings to collect data, and generate HTML report
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp" -Overwrite
    Replaces an existing (previous) output from the same date
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp" -OpenBrowser
    Opens the HTML report in the default web browser, upon completion
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp" -Detailed
    Generates additional detail in the output report file
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp" -AutoConfig "config.txt"
    Loads reporting parameters from custom text file
.EXAMPLE
    Invoke-CMHealthCheck -SmsProvider "cm01.contoso.local" -CustomerName "Contoso" -AuthorName "Skatter Brainz" -CopyrightName "SkatterCorp" -NoHotFix
    Skips inventory of installed operating system hotfixes
.NOTES
    New function for 1.0.11 - 10/2019
.OUTPUTS
    collected data files, folders, and output HTML file, happiness, confusion, consternation, whatever that means
.LINK
    https://github.com/Skatterbrainz/CMHealthCheck/blob/master/Docs/Invoke-CMHealthCheck.md
#>

function Invoke-CMHealthCheck {
    [CmdletBinding(ConfirmImpact="Low")]
    param (
        [parameter()][ValidateNotNullOrEmpty()][string] $SmsProvider = "$(($env:COMPUTERNAME, $env:USERDNSDOMAIN) -join '.')",
        [parameter()][string] $CustomerName = "Customer Name",
        [parameter()][string] $AuthorName = "Your Name",
        [parameter()][string] $CopyrightName  = "Your Company Name",
        [parameter()][string] $DataFolder = "$([System.Environment]::GetFolderPath('Personal'))",
        [parameter()][ValidateNotNullOrEmpty()][string] $PublishFolder = "$([System.Environment]::GetFolderPath('Personal'))",
        [parameter()][switch] $OpenBrowser,
        [parameter()][switch] $OverWrite,
        [parameter()][switch] $NoHotfix ,
        [parameter()][switch] $AutoConfig,
        [parameter()][switch] $Detailed,
        [parameter()][string] $Template = "",
        [parameter()][ValidateSet('HTML','Word')][string] $ReportType = 'HTML',
        [parameter()][int] $NumberOfDays = 7,
        [parameter()][switch] $Healthcheckdebug,
        [parameter()][string] $Healthcheckfilename = "",
        [parameter()][string] $MessagesFilename = ""
    )
    $Time1 = Get-Date
    if ([string]::IsNullOrEmpty($SmsProvider)) {
        Write-Warning "SmsProvider must be specified"
        break
    }
    if ($env:USERPROFILE -eq 'c:\windows\system32\config\systemprofile') {
        Write-Verbose "mapping temp locations for SYSTEM context"
        $DataFolder = $env:TEMP
        $PublishFolder = $env:TEMP
    }
    $ReportFolder = Join-Path $DataFolder "$(Get-Date -f 'yyyy-MM-dd')\$SmsProvider"
    Write-Log -Message "report folder = $ReportFolder" -LogFile $logfile
    try {
        Write-Log -Message "report folder path = $ReportFolder" -LogFile $logfile
        $getParams = @{
            SmsProvider   = $SmsProvider
            OutputFolder  = $DataFolder
            NumberOfDays  = $NumberOfDays
            NoHotfix      = $NoHotfix
            OverWrite     = $OverWrite
            Verbose       = $VerbosePreference
        }
        Write-Log -Message "calling Get-CMHealthCheck with parameter set" -LogFile $logfile
        Get-CMHealthCheck @getParams
    } catch {
        Write-Error $_.Exception.Message
    }
    Write-Log -Message "------------------ begin report publishing ---------------------" -LogFile $logfile
    try {
        if (Test-Path $ReportFolder) {
            Write-Log -Message "calling Export-CMHealthReport with parameter set" -LogFile $logfile
            $expParams = @{
                ReportType       = $ReportType
                ReportFolder     = $ReportFolder
                OutputFolder     = $DataFolder
                SmsProvider      = $SmsProvider
                AuthorName       = $AuthorName
                CopyrightName    = $CopyrightName
                CustomerName     = $CustomerName
                AutoConfig       = $AutoConfig
                Detailed         = $Detailed
                CoverPage        = $CoverPage
                Template         = $Template
                MessagesFilename = $MessagesFilename
                Healthcheckdebug = $Healthcheckdebug
                Healthcheckfilename = $Healthcheckfilename
                Verbose          = $VerbosePreference
            }
            Export-CMHealthReport @expParams
            if ($OpenBrowser) {
                $newFile = Join-Path -Path $DataFolder -ChildPath "cmhealthreport`-$SmsProvider-$(Get-Date -f 'yyyyMMdd').htm"
                if (Test-Path $newFile) {
                    Write-Output "opening report in default web browser: $newFile"
                    Start-Process $newFile
                } else {
                    Write-Warning "file not found: $newFile"
                }
            }
        } else {
            throw "report folder not found: $ReportFolder"
        }
    } catch {
        Write-Error $_.Exception.Message
    }
    $RTime  = Get-TimeOffset -StartTime $Time1
    Write-Output "Collection and Reporting process completed. Total runtime: $RTime (hh`:mm`:ss)"
}