GPODoc

1.0.2

Public/Export-GPOCommentReport.ps1

#requires -Modules GroupPolicy
<#
.SYNOPSIS
    Compile HTML Report of GPO comments
.DESCRIPTION
    Compile an HTML report of comments embedded within GPOs, GPO Settings
    and GP Preferences settings
.PARAMETER GPOName
    [string[]] (required) Name(s) of Group Policy Objects or '*' for all GPOs
.PARAMETER ReportFile
    [string] (required) Path and name of new HTML report file
.NOTES
    version 1.0.2 - DS - 2017.08.11
.EXAMPLE
    Export-GPOCommentReport -GPOName '*' -ReportFile ".\gpo.htm"
.EXAMPLE
    $GpoNames | Export-GPOCommentReport -ReportFile ".\gpo.htm"
#>

function Export-GPOCommentReport {
    param (
        [parameter(Mandatory=$True, ValueFromPipeline=$True, HelpMessage='Name of Policy or Policies')]
            [ValidateNotNullOrEmpty()]
            [string[]] $GPOName,
        [parameter(Mandatory=$True, HelpMessage='Path to report file')]
            [ValidateNotNullOrEmpty()]
            [string] $ReportFile
    )
    if ($GPOName -eq '*') {
        Write-Verbose "loading all policy objects: preferences"
        $gpos = Get-GPO -All | Sort-Object -Property DisplayName
    }
    else {
        Write-Verbose "loading specific policy objects"
        $gpos = $GPOName | Foreach-Object {Get-GPO -Name $_}
    }

    $fragments = @()
    $fragments += "<h1>Group Policy Report</h1>"

    foreach ($gpo in $gpos) {
        $gpoName = $gpo.DisplayName
        Write-Output "GPO: $gpoName"
        $desc = Get-GpoComment -GPOName $gpoName -PolicyGroup Policy
        $sett = Get-GpoComment -GPOName $gpoName -PolicyGroup Settings
        $pref = Get-GpoComment -GPOName $gpoName -PolicyGroup Preferences
        
        Write-Verbose $desc

        $fragments += "<h2>$gpoName</h2>"
        $fragments += $desc | ConvertTo-Html -As List

        $fragments += "<h3>Policy Settings</h3>"
        $fragments += $sett | ConvertTo-Html -Fragment

        $fragments += "<h3>Preferences</h3>"
        $fragments += $pref | ConvertTo-Html -Fragment
    }
    $fragments += "<p class='footer'>Generated by GPODoc 1.0.2 http://github.com/skatterbrainz/GPODoc - $(Get-Date)</p>"

    $convertParams = @{ 
  head = @"
 <Title>Group Policy Comments - $($env:COMPUTERNAME)</Title>
<style>
body { background-color:#eee;
       font-family:Calibri;
       font-size:10pt; }
td, th { border:0px solid black;
         border-collapse:collapse;
         white-space:pre; }
th { color:white;
     background-color:black; }
table, tr, td, th { padding: 2px; margin: 0px ;white-space:pre; }
td {background-color:#fff;}
tr:nth-child(odd) {background-color: lightgray}
table { width:95%;margin-left:5px; margin-bottom:20px;}
h2 {
    font-family:Tahoma;
    color:#000;
}
h2 {
    font-family:Tahoma;
    color:#6D7B8D;
}
h3 {
    font-family:Tahoma;
    color:#6D7B8D;
}
.alert {
 color: red;
 }
.footer
{ color:#6D7B8D;
  margin-left:10px;
  font-family:Tahoma;
  font-size:8pt;
  //font-style:italic;
}
</style>
"@
 body = $fragments
}
 
    ConvertTo-Html @convertParams | Out-File $ReportFile

}