Sup’ PSHomies,
Is it just me or are there way too many cool development in the community happening right now? You know you’re addicted to PowerShell if your idea of unwinding on a Sunday evening is scripting! 😛
How I discovered PScribo
I was busy creating a server documentation script based on WMI. I’ve used sydi-server in the past, but I wanted it to be PowerShell-based for obvious reasons… 😉
My first idea was to create a well-defined XML document and use CSS to generate the HTML file. HTML had my preference. My first attempt was using the specialized XmlTextWriter object. That was only the first part, I had to do the CSS as well. It was a lot of code. At that time I didn’t make use of snapshots.
My next attempt was to use ConvertTo-HTML -Fragment -As (list,Table). This worked out pretty well for what I wanted, still it’s no PScribo. I’ve probably done three versions of this script.
As luck would have it, while working on the third version, the PSConfEu 2015 was taking place in StockHolm. I didn’t attend that one. Luckily for me, the presentations were uploaded. One presentation immediately caught my eye Documenting xxIT.
This is exactly what I wanted! HTML reporting capabilities!!! Having a Word version was a bonus! I downloaded the module and tried every example. Took me 2 hours to master the syntax. After that I never looked back!
PowerShell documentation made easy
PScribo has been brought to us by Iain Brighton. Iain gave me some background information on how PScribo came to be:
I was helping Carl sort out a few “performance” issues with the Word functions he was using. As Carl’s documentation framework uses COM, it is painful! Here are a list of some of the issues:
- It’s slow
- When MS release a new version (or update) Word things can break
- There are localisation issues
- There is a reliance on Word actually being installed
- PS v5 has actually broken quite a lot of his code (although sped it up too)
- The code wasn’t factored particularly well, it is somewhat “better” now!
I told Carl I’d get rid of the Word dependency, improve performance and try to enforce a separation of concerns to aid maintenance. PScribo is the result of this.
So fun fact, I recently saw that Mr. Carl Webster is the guardian of Jeff Wouter’s ADHealthCheck script. A few lines into the script and I’m seeing a lot of Word configuration going on. I thought to myself this needs PScribo! In all my enthusiasm I sent a tweet to Mr Webster not knowing he already knew about PScribo 😛
Don’t I feel silly! I wasn’t trying to be cheeky or anything like that, I just thought I’d share what the advantages are of PScribo. I apologize for my ignorance. If I could just take a moment to demonstrate the awesomeness of PScribo, I’m sure you’ll be hooked as well!
Creating the ADHC snapshot
My mantra these days is to gather now and process later. I already did most of the grunt work with the Active Directory configuration snapshot. I just needed to extend it with Users, Privileged groups and Computers. With the snapshot, there’s no limitation where you get your source from. For Forest information, I gathered data using the Get-ADForest cmdlet and also [System.DirectoryServices.ActiveDirectory.Forest]::GetCurrentForest(). The latter also has sites,sitelinks and subnets data, which comes in handy if the Get-ADReplication* cmdlets aren’t available… Gather now, process later… 😉
Here’s what I came up with:
| <# | |
| Author: I.Strachan | |
| Version: | |
| Version History: | |
| Purpose: Get Snapshot of Active Directory current Health | |
| #> | |
| [cmdletbinding()] | |
| Param() | |
| Import-Module ActiveDirectory,GroupPolicy -Verbose:$false | |
| #region Helper Functions. Ideally this would be a module. You can also . Source an external script | |
| Function Get-SitesStats{ | |
| #Ahsley McGlone Freaky neat AD site links | |
| #https://blogs.technet.microsoft.com/ashleymcglone/2012/09/10/freaky-neat-active-directory-site-links-with-powershell/ | |
| Get-ADObject -LDAPFilter '(objectClass=site)' -SearchBase (Get-ADRootDSE).ConfigurationNamingContext -Properties WhenCreated, Description | | |
| Select-Object Name, | |
| @{label='IsEmpty';expression={If ($(Get-ADObject -Filter {ObjectClass -eq 'nTDSDSA'} -SearchBase $_.DistinguishedName)) {$false} else {$true}}}, | |
| @{label='DCCount';expression={@($(Get-ADObject -Filter {ObjectClass -eq 'nTDSDSA'} -SearchBase $_.DistinguishedName)).Count}}, | |
| @{label='SubnetCount';expression={@($(Get-ADObject -Filter {ObjectClass -eq 'subnet' -and siteObject -eq $_.DistinguishedName} -SearchBase (Get-ADRootDSE).ConfigurationNamingContext)).Count}}, | |
| @{label='SiteLinkCount';expression={@($(Get-ADObject -Filter {ObjectClass -eq 'sitelink' -and siteList -eq $_.DistinguishedName} -SearchBase (Get-ADRootDSE).ConfigurationNamingContext)).Count}}, | |
| WhenCreated,Description | |
| } | |
| Function Get-GPOsSoM { | |
| #Ashley McGlone GPO Report | |
| #https://blogs.technet.microsoft.com/ashleymcglone/2013/05/29/dude-wheres-my-gpo-using-powershell-to-find-all-of-your-group-policy-links/ | |
| BEGIN{ | |
| #region Get a list of all GPOs | |
| $GPOs = Get-GPO -All | | |
| Select-Object ID, Path, DisplayName, GPOStatus, WMIFilter | |
| #endregion | |
| #Array for GPLinks results | |
| $gPLinks = @() | |
| #region GPO Linked to the Domain | |
| $domainGPO = @{ | |
| Identity = ((Get-ADDomain).distinguishedName) | |
| Properties = @('name', 'distinguishedName', 'gPLink', 'gPOptions', 'canonicalname') | |
| } | |
| $gPlinks += Get-ADObject @domainGPO | | |
| Select-Object 'name', 'distinguishedName', 'gPLink', 'gPOptions', 'canonicalname', | |
| @{name='Depth';expression={0}} | |
| #endregion | |
| #region GPO Linked to OUs | |
| $ouGPOs = @{ | |
| Filter = '*' | |
| Properties = @('name', 'distinguishedName', 'gPLink', 'gPOptions', 'canonicalname') | |
| } | |
| $gPLinks += Get-ADOrganizationalUnit @ouGPOs | | |
| Select-Object name, distinguishedName, gPLink, gPOptions ,canonicalname , | |
| @{name='Depth';expression={($_.distinguishedName -split 'OU=').count - 1}} | |
| #endregion | |
| #region GPOs linked to sites | |
| $siteGPOs = @{ | |
| LDAPFilter = '(objectClass=site)' | |
| SearchBase = "CN=Sites,$((Get-ADRootDSE).configurationNamingContext)" | |
| SearchScope = 'Onelevel' | |
| Properties = @('name', 'distinguishedName', 'gPLink', 'gPOptions', 'canonicalname') | |
| } | |
| $gPLinks += Get-ADObject @siteGPOs | | |
| Select-Object name, distinguishedName, gPLink, gPOptions ,canonicalname, | |
| @{name='Depth';expression={0}} | |
| #endregion | |
| #Hashtable to lookup GPOs | |
| $lookupGPO = $GPOs | Group-Object -AsHashTable -Property 'Path' | |
| } | |
| PROCESS{ | |
| #Get the Scope of Management of each gPLink | |
| ForEach ($SOM in $gPLinks) { | |
| if ($SOM.gPLink) { | |
| If ($SOM.gPLink.length -gt 1) { | |
| $links = @($SOM.gPLink -split {$_ -eq '[' -or $_ -eq ']'} | Where-Object {$_}) | |
| For ( $i = $links.count - 1 ; $i -ge 0 ; $i-- ) { | |
| $GPOData = $links[$i] -split {$_ -eq '/' -or $_ -eq ';'} | |
| [PSCustomObject]@{ | |
| Depth = $SOM.Depth; | |
| Name = $SOM.Name; | |
| DistinguishedName = $SOM.distinguishedName; | |
| canonicalName = $SOM.canonicalname; | |
| PolicyDN = $GPOData[2]; | |
| LinkOrderNr = $links.count - $i | |
| GUID = $lookupGPO.$($GPOData[2]).ID; | |
| DisplayName = $lookupGPO.$($GPOData[2]).DisplayName; | |
| GPOStatus = $lookupGPO.$($GPOData[2]).GPOStatus; | |
| WMIFilter = $lookupGPO.$($GPOData[2]).WMIFilter.Name; | |
| Config = $GPOData[3]; | |
| LinkEnabled = [bool](!([int]$GPOData[3] -band 1)); | |
| Enforced = [bool]([int]$GPOData[3] -band 2); | |
| BlockInheritance = [bool]($SOM.gPOptions -band 1) | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| END{} | |
| } | |
| Function Get-PrivilegedGroups{ | |
| #Jeff Wouters script. | |
| Param ( | |
| $Domain | |
| ) | |
| BEGIN{ | |
| $PrivilegedGroups = @( | |
| "$($Domain.DomainSID)-512" #Domain Admins | |
| "$($Domain.DomainSID)-518" #Schema Admins | |
| "$($Domain.DomainSID)-519" #Enterprise Admins | |
| "$($Domain.DomainSID)-520" #Group Policy Creatr Owners | |
| 'S-1-5-32-544' #Builtin\Administrators | |
| 'S-1-5-32-548' #Builtin\Account Operators | |
| 'S-1-5-32-549' #Builtin\Server Operators | |
| 'S-1-5-32-550' #Builtin\Print Operators | |
| 'S-1-5-32-551' #Builtin\Backup Operators | |
| 'S-1-5-32-552' #Builtin\Replicators | |
| 'S-1-5-32-556' #Builtin\Network Configuration Operations | |
| 'S-1-5-32-557' #Builtin\Incoming Forest Trust Builders | |
| 'S-1-5-32-573' #Builtin\Event Log Readers | |
| 'S-1-5-32-578' #Builtin\Hyper-V Administrators | |
| 'S-1-5-32-580' #Builtin\Remote Management Users | |
| ) | |
| } | |
| PROCESS{ | |
| $objDomainPrivilegedGroups = @{ | |
| DomainSID = $Domain.DomainSID | |
| NETBIOSName = $Domain.Name | |
| FQDN = $Domain.DNSRoot | |
| } | |
| $colPrivilegedGroups = @() | |
| foreach($group in $PrivilegedGroups){ | |
| $colPrivilegedGroups += Get-ADGroup -Identity $group -Properties Members,MemberOf | |
| } | |
| $objDomainPrivilegedGroups.Groups = $colPrivilegedGroups | |
| [PSCustomObject]$objDomainPrivilegedGroups | |
| } | |
| END{} | |
| } | |
| #endregion | |
| $snapshot = @{ | |
| ADDS = @{} | |
| Users = @{} | |
| Groups = @{} | |
| GPOs = @{} | |
| Computers = @{} | |
| } | |
| #region: snapshotADDS | |
| $snapshot.ADDS.RootDSE = $(Get-ADRootDSE) | |
| $snapshot.ADDS.Forest = $(Get-ADForest) | |
| $snapshot.ADDS._Forest = [System.DirectoryServices.ActiveDirectory.Forest]::GetCurrentForest() | |
| $snapshot.ADDS.Domain = $(Get-ADDomain) | |
| $snapshot.ADDS._Domain = [System.DirectoryServices.ActiveDirectory.Domain]::GetCurrentDomain() | |
| $snapshot.ADDS.DomainControllers = $(Get-ADDomainController -Filter *) | |
| $snapshot.ADDS.DomainTrusts = (Get-ADTrust -Filter *) | |
| $snapshot.ADDS.DefaultPassWordPoLicy = $(Get-ADDefaultDomainPasswordPolicy) | |
| $snapshot.ADDS.AuthenticationPolicies = $(Get-ADAuthenticationPolicy -LDAPFilter '(name=AuthenticationPolicy*)') | |
| $snapshot.ADDS.AuthenticationPolicySilos = $(Get-ADAuthenticationPolicySilo -Filter 'Name -like "*AuthenticationPolicySilo*"') | |
| $snapshot.ADDS.CentralAccessPolicies = $(Get-ADCentralAccessPolicy -Filter *) | |
| $snapshot.ADDS.CentralAccessRules = $(Get-ADCentralAccessRule -Filter *) | |
| $snapshot.ADDS.ClaimTransformPolicies = $(Get-ADClaimTransformPolicy -Filter *) | |
| $snapshot.ADDS.ClaimTypes = $(Get-ADClaimType -Filter *) | |
| $snapshot.ADDS.DomainAdministrators =$( Get-ADGroup -Identity $('{0}-512' -f (Get-ADDomain).domainSID) | Get-ADGroupMember -Recursive) | |
| $snapshot.ADDS.OrganizationalUnits = $(Get-ADOrganizationalUnit -Filter *) | |
| $snapshot.ADDS.OptionalFeatures = $(Get-ADOptionalFeature -Filter *) | |
| $snapshot.ADDS.Sites = $(Get-ADReplicationSite -Filter *) #Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2 | |
| $snapshot.ADDS.Subnets = $(Get-ADReplicationSubnet -Filter *) #Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2 | |
| $snapshot.ADDS.SiteLinks = $(Get-ADReplicationSiteLink -Filter *) #Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2 | |
| $snapshot.ADDS.ReplicationMetaData = $(Get-ADReplicationPartnerMetadata -Target (Get-ADDomain).DNSRoot -Scope Domain) | |
| $snapshot.ADDS.SitesStats = $(Get-SitesStats) #Courtesy of Ashley McGlone | |
| $snapshot.ADDS.repadmin = $(repadmin.exe /showrepl * /csv | ConvertFrom-CSV) #Courtesy of Ashley McGlone | |
| #endregion | |
| #region snapshotGPOs | |
| $snapshot.GPOs.GPOsSoM = Get-GPOsSoM | |
| $snapshot.GPOs.All = Get-GPO -All | Select-Object '*' | |
| #endregion | |
| #region snapshotUsers | |
| $snapshot.Users.Disabled = Search-ADAccount -AccountDisabled | |
| $snapshot.Users.Expired = Search-ADAccount -AccountExpired | |
| $snapshot.Users.Expiring = Search-ADAccount -AccountExpiring | |
| $snapshot.Users.NoExpireDate = Get-ADUser -LDAPFilter '(|(accountExpires=0)(accountExpires=9223372036854775807))' | |
| $snapshot.Users.Inactive = Search-ADAccount -AccountInactive | |
| $snapshot.Users.NoKerberosPreAuth = get-aduser -filter * -properties DoesNotRequirePreAuth | Where-Object {$_.DoesNotRequirePreAuth} | |
| $snapshot.Users.MustChangePassWord = Get-ADUser -Filter {pwdLastSet -eq 0} | |
| $snapshot.Users.CannotChangePassWord = Get-ADUser -Filter * -Properties CannotChangePassword |Where-Object {$_.CannotChangePassword} | |
| $snapshot.Users.All = Get-ADUser -Filter '*' | Select-Object '*' | |
| #endregion | |
| #region snapshotGroups | |
| $snapshot.Groups.All = Get-ADGroup -Filter '*' | |
| $snapshot.Groups.Privileged = Get-PrivilegedGroups -Domain $(Get-ADDomain) | |
| #endregion | |
| #region snapshotComputers | |
| $snapshot.Computers.All = Get-ADComputer -Filter * -Properties OperatingSystem | |
| $snapshot.Computers.Disabled = Search-ADAccount -AccountDisabled -ComputersOnly | |
| $snapshot.Computers.Expired = Search-ADAccount -AccountExpired -ComputersOnly | |
| $snapshot.Computers.Expiring = Search-ADAccount -AccountExpiring -ComputersOnly | |
| #endregion | |
| #region Export to XML. Change folder to reflect your location | |
| $exportDate = Get-Date -Format ddMMyyyy | |
| $snapshot | Export-Clixml .\export\adds\ADHC-$($exportDate).xml -Encoding UTF8 | |
| #endregion | |
| #region Querying snapshot. Try each one seperately! | |
| "`nDisabled users`n" | |
| $snapshot.Users.Disabled | Select-Object Name | |
| "`nExpired users`n" | |
| $snapshot.Users.Expired | Select-Object Name | |
| "`nExpiring users`n" | |
| $snapshot.Users.Expiring | Select-Object Name | |
| "`nPrivilegedGroup`n" | |
| $snapshot.Groups.Privileged.Groups | Select-Object Name | |
| "`nPrivilegedGroup Members count`n" | |
| $snapshot.Groups.Privileged.Groups | | |
| Foreach-object { | |
| [PSCustomObject]@{ | |
| Name = $_.Name | |
| MemberCount = @($_.Members).Count | |
| } | |
| } #From here you can do your own filtering | |
| "`nGPOs`n" | |
| $snapshot.GPOs.All | Select-Object DisplayName,ID | |
| "`nGPOs Scope of Management Inheritance blocked`n" | |
| $snapshot.GPOs.GPOsSoM | Select-Object Displayname,BlockInheritance,GUID | |
| "`nMember servers`n" | |
| $snapshot.Computers.All | | |
| Where-Object { | |
| ($_.OperatingSystem -like '*server*') -and | |
| (!($_.DistinguishedName -like '*OU=Domain Controllers*')) | |
| } | | |
| Select-Object Name | |
| #endregion |
The snapshot helps me concentrate on the task at hand. It’s also a great way to separate the documentation process from gathering all the Active Directory bits and pieces. This makes a huge difference in maintenance! If you need to add anything just update the snapshot.
Now for the fun part!
Creating the PScribo ADHC report
First I need to import the saved snapshot. Export-CliXml & Import-CliXml are growing on me!
#Get ADSnapshot $ADHCSnapshot = Import-Clixml .\export\adds\ADHC-$($snapshotDate).xml
Next I need to initiate the Document. PScribo is DSL (Domain-specific Language) oriented. This makes the flow quite logical.
#region Create PScribo Document
$reportAD = Document &amp;quot;ADHC snapshot report - $($snapshotDate)&amp;quot; {
GlobalOption -ForceUppercaseSection -EnableSectionNumbering -PageSize A4 -Margin 24
BlankLine -Count 20
Paragraph &amp;quot;Active Directory Health report - $($snapshotDate)&amp;quot; -Style Title
BlankLine -Count 20
PageBreak
TOC -Name 'Table of Contents'
PageBreak
A “Document” is an object that contains one or more “sections”, TOC and Paragraphs just to name a few. Just have a look at the README.MD on github get an idea of what is possible and by all means try the examples!
To find the commands available in PScribo run
get-command -Module PScribo
Quick update: Iain just updated PScribo to include landscape page orientation!
Now to break the document down into sections. Sections can be nested to create sub-sections much like you would do in Word with Header1, Header2, Header 3 etc. The TOC (Table of Content) will be generated according to how the sections are nested. You can also exclude a section from the TOC.
For ADHC, I started with the Forest Information
Section -Style Heading1 'Forest Information' {
$ADForest = [Ordered]@{
Name = $($ADHCSnapshot.ADDS.Forest.Name)
RootDomain = $($ADHCSnapshot.ADDS.Forest.RootDomain)
ForestMode = $($ADHCSnapshot.ADDS.Forest.ForestMode.ToString())
Domains = $($ADHCSnapshot.ADDS.Forest.Domains)
}
Table -Name 'Forest Information' -List -Width 0 -Hashtable $ADForest
For this part I created an ordered hashtable to generate a list
My favorite part is the following: Selecting the properties I want to report!
Section -Style Heading2 'FSMO Roles' {
$ADHCSnapshot.ADDS.Forest |
Select-Object DomainNamingMaster,SchemaMaster |
Table -Name 'FSMO Roles Forest' -List -Width 0
Blankline
$ADHCSnapshot.ADDS.Domain |
Select-Object PDCEmulator,InfrastructureMaster,RIDMaster |
Table -Name 'FSMO Roles Domain' -List -Width 0
}
I demonstrated at the end of the ADHC snapshot how you can extract the information you want.
&amp;quot;`nDisabled users`n&amp;quot; $snapshot.Users.Disabled | Select-Object Name &amp;quot;`nExpired users`n&amp;quot; $snapshot.Users.Expired | Select-Object Name &amp;quot;`nExpiring users`n&amp;quot; $snapshot.Users.Expiring | Select-Object Name
To document, it’s as simple as selecting the properties and sending them down the pipeline.
Here’s where you do your formatting and filtering as well:
Section -Style Heading3 'Privileged groups count'{
#Create Style for Privileged Groups count greater than 5
Style -Name PrivilegedGroupsGT5 -Color White -BackgroundColor Firebrick
$PrivilegedGroupsGT5 = $ADHCSnapshot.Groups.Privileged.Groups |
Foreach-object {
[PSCustomObject]@{
Name = $_.Name
MemberCount = @($_.Members).Count
}
}
#Set Style for Privileged Groups count greater than 5
$PrivilegedGroupsGT5 | Where-object{ $_.MemberCount -gt 5} | Set-Style -Style 'PrivilegedGroupsGT5'
Table -InputObject $PrivilegedGroupsGT5 -Name 'Privileged groups count' -Width 0
}
For the privileged group member count I created a special style that would higlight any row where the count is greater than five.
How cool is that?!
Want a table with all the sites without a description?
Section -Style Heading3 'Sites without a description' {
$ADHCSnapshot.ADDS.Sites.Where{$_.Description -eq $null} |
Select-Object Name |
Table -Name 'Sites without a description' -Width 0
}
Here the reporting part:
| <# | |
| Author: I.Strachan | |
| Version: 1.0 | |
| Version History: | |
| Purpose: Active Directory Health Check PScribo/Excel report | |
| #> | |
| [CmdletBinding()] | |
| Param( | |
| $snapshotDate= '26052016' | |
| ) | |
| #PScribo link: https://github.com/iainbrighton/PScribo | |
| Import-Module PScribo,ImportExcel -Verbose:$false | |
| #ImportExcel link: https://github.com/dfinke/ImportExcel | |
| Import-Module ImportExcel -Verbose:$false | |
| #Get ADSnapshot | |
| $ADHCSnapshot = Import-Clixml .\export\adds\ADHC-$($snapshotDate).xml | |
| #region Create PScribo Document | |
| $reportAD = Document "ADHC snapshot report - $($snapshotDate)" { | |
| GlobalOption -ForceUppercaseSection -EnableSectionNumbering -PageSize A4 -Margin 24 | |
| BlankLine -Count 20 | |
| Paragraph "Active Directory Health report - $($snapshotDate)" -Style Title | |
| BlankLine -Count 20 | |
| PageBreak | |
| TOC -Name 'Table of Contents' | |
| PageBreak | |
| Section -Style Heading1 'Forest Information' { | |
| $ADForest = [Ordered]@{ | |
| Name = $($ADHCSnapshot.ADDS.Forest.Name) | |
| RootDomain = $($ADHCSnapshot.ADDS.Forest.RootDomain) | |
| ForestMode = $($ADHCSnapshot.ADDS.Forest.ForestMode.ToString()) | |
| Domains = $($ADHCSnapshot.ADDS.Forest.Domains) | |
| } | |
| Table -Name 'Forest Information' -List -Width 0 -Hashtable $ADForest | |
| Section -Style Heading2 'FSMO Roles' { | |
| $ADHCSnapshot.ADDS.Forest | | |
| Select-Object DomainNamingMaster,SchemaMaster | | |
| Table -Name 'Forest FSMO Roles' -List -Width 0 | |
| Blankline | |
| $ADHCSnapshot.ADDS.Domain | | |
| Select-Object PDCEmulator,InfrastructureMaster,RIDMaster | | |
| Table -Name 'Domain FSMO Roles' -List -Width 0 | |
| } | |
| Section -Style Heading2 'Global Catalogs' { | |
| $ADHCSnapshot.ADDS._Forest.GlobalCatalogs | | |
| Select-Object Name | | |
| Table -Name 'Global Catalogs' -Width 0 | |
| } | |
| } | |
| PageBreak | |
| Section -Style Heading1 'Domain Information' { | |
| $ADDomain = [Ordered]@{ | |
| NetBIOSName = $($ADHCSnapshot.ADDS.Domain.NetBIOSName) | |
| DomainMode = $($ADHCSnapshot.ADDS.Domain.DomainMode.ToString()) | |
| DistinguishedName = $($ADHCSnapshot.ADDS.Domain.DistinguishedName) | |
| DomainSID = $($ADHCSnapshot.ADDS.Domain.DomainSID) | |
| } | |
| Table -Name 'Domain Information' -List -Width 0 -Hashtable $ADDomain | |
| Section -Style Heading2 'Domain Controllers' { | |
| $ADHCSnapshot.ADDS.DomainControllers | | |
| Select-Object Name,OperatingSystem,IPv4Address,Site | | |
| Table -Name 'Domain Controllers' -List -Width 0 | |
| } | |
| Section -Style Heading2 'Default Domain Password Policy' { | |
| $ADHCSnapshot.ADDS.DefaultPassWordPoLicy | | |
| Select-Object ComplexityEnabled,LockoutDuration,LockoutObservationWindow,LockoutThreshold, | |
| MaxPasswordAge,MinPasswordAge,MinPasswordLength,PasswordHistoryCount,ReversibleEncryptionEnabled | | |
| Table -Name 'Default Domain Password Policy' -List -Width 0 | |
| } | |
| Section -Style Heading2 'Domain Administrators' { | |
| $ADHCSnapshot.ADDS.DomainAdministrators | | |
| Select-Object Name,DistinguishedName | | |
| Table -Name 'Domain Administrators' -Width 0 | |
| } | |
| PageBreak | |
| Section -Style Heading2 'Organizational Units' { | |
| $ADHCSnapshot.ADDS.OrganizationalUnits | | |
| Select-Object Name,DistinguishedName | | |
| Table -Name 'Organizational Units' -Width 0 | |
| } | |
| PageBreak | |
| Section -Style Heading2 'Groups' { | |
| $ADHCSnapshot.Groups.Privileged | | |
| Select-Object DomainSID,NETBIOSName,FQDN | | |
| Table -Name 'Groups' -list -Width 0 | |
| Section -Style Heading3 'Privileged groups'{ | |
| $ADHCSnapshot.Groups.Privileged.Groups | | |
| Foreach-Object{ | |
| [PSCustomObject]@{ | |
| Name = $_.Name | |
| Category = $_.GroupCategory.ToString() | |
| Scope = $_.GroupScope.ToString() | |
| SID = $_.SID | |
| } | |
| } | | |
| Table -Name 'Privileged groups' -Width 0 | |
| } | |
| Section -Style Heading3 'Privileged groups count'{ | |
| #Create Style for Privileged Groups count greater than 5 | |
| Style -Name PrivilegedGroupsGT5 -Color White -BackgroundColor Firebrick | |
| $PrivilegedGroupsGT5 = $ADHCSnapshot.Groups.Privileged.Groups | | |
| Foreach-object { | |
| [PSCustomObject]@{ | |
| Name = $_.Name | |
| MemberCount = @($_.Members).Count | |
| } | |
| } | |
| #Set Style for Privileged Groups count greater than 5 | |
| $PrivilegedGroupsGT5 | Where-object{ $_.MemberCount -gt 5} | Set-Style -Style 'PrivilegedGroupsGT5' | |
| Table -InputObject $PrivilegedGroupsGT5 -Name 'Privileged groups count' -Width 0 | |
| } | |
| } | |
| } | |
| PageBreak | |
| Section -Style Heading1 'Sites & Subnets' { | |
| Section -Style Heading2 'Sites' { | |
| $ADHCSnapshot.ADDS.Sites | | |
| Select-Object Name,Description,DistinguishedName | | |
| Table -Name 'Sites & Subnets' -Width 0 | |
| Section -Style Heading3 'Sites without a description' { | |
| $ADHCSnapshot.ADDS.Sites.Where{$_.Description -eq $null} | | |
| Select-Object Name | | |
| Table -Name 'Sites without a description' -Width 0 | |
| } | |
| if($ADHCSnapshot.ADDS._Forest.Sites.Where{@($_.Subnets).Count -eq 0 }){ | |
| Section -Style Heading3 'Sites without a subnet' { | |
| $ADHCSnapshot.ADDS._Forest.Sites.Where{@($_.Subnets).Count -eq 0 } | | |
| Select-Object Name | | |
| Table -Name 'Sites without a subnet' -Width 0 | |
| } | |
| } | |
| if($ADHCSnapshot.ADDS._Forest.Sites.Where{@($_.Servers).Count -eq 0 }){ | |
| Section -Style Heading3 'Sites without a DC' { | |
| $ADHCSnapshot.ADDS._Forest.Sites.Where{@($_.Servers).Count -eq 0 } | | |
| Select-Object Name | | |
| Table -Name 'Sites without a DC' -Width 0 | |
| } | |
| } | |
| Section -Style Heading3 'Sites Stats' { | |
| $ADHCSnapshot.ADDS.SitesStats | | |
| Table -Name 'Sites Stats' -Width 0 | |
| } | |
| } | |
| Section -Style Heading2 'Sitelinks' { | |
| $ADHCSnapshot.ADDS.SiteLinks | | |
| Select-Object Name,Cost,ReplicationFrequencyInMinutes | | |
| Table -Name 'Sitelinks' -Width 0 | |
| } | |
| Section -Style Heading2 'Subnets' { | |
| $ADHCSnapshot.ADDS.Subnets | | |
| Select-Object Name,Site | | |
| Table -Name 'Subnets' -Width 0 | |
| } | |
| } | |
| PageBreak | |
| Section -Style Heading1 'Group Policies' { | |
| $ADHCSnapshot.GPOs.All | | |
| Select-Object DisplayName,Description,GPOStatus,ModificationTime | | |
| Table -Name 'Group Policies' -Width 0 | |
| Section -Style Heading2 'Group Policy Scope of Management' { | |
| $ADHCSnapshot.GPOs.GPOsSoM | | |
| Select-Object DisplayName,LinkOrderNr,GPOStatus,LinkEnabled,Enforced,BlockInheritance | | |
| Table -Name 'Group Policy Scope of Management' -Width 0 | |
| } | |
| } | |
| } | |
| #endregion | |
| #region Render report in HTML,Word & XML format | |
| $reportAD | Export-Document -Path .\export\adds -Format Html,Word,XML | |
| #Or save it and render later on. | |
| $reportAD | Export-Clixml .\export\adds\ADHCRawPScriboDocument-$($snapshotDate).xml -Encoding UTF8 | |
| #endregion | |
| #region Export Users,Group & Computers to Excel | |
| $xlsxUserFile = ".\export\adds\ADHC - UserReport - $($snapshotDate).xlsx" | |
| $xlsxComputerFile = ".\export\adds\ADHC - ComputerReport - $($snapshotDate).xlsx" | |
| $xlsxGroupMembersFile = ".\export\adds\ADHC - PrivilegedMembersReport - $($snapshotDate).xlsx" | |
| $xlsxGroupMemberOfFile = ".\export\adds\ADHC - PrivilegedMemberOfReport - $($snapshotDate).xlsx" | |
| #Users xlsx file | |
| foreach($entry in $ADHCSnapshot.Users.Keys){ | |
| $WorkSheetName = $entry | |
| If($ADHCSnapshot.Users.$entry){ | |
| $ADHCSnapshot.Users.$entry | | |
| ConvertTo-Csv -Delimiter ';' -NoTypeInformation | | |
| ConvertFrom-Csv -Delimiter ';' | | |
| Export-Excel -Path $xlsxUserFile -WorkSheetname $WorkSheetName -AutoSize -BoldTopRow -FreezeTopRow | |
| } | |
| } | |
| #Computers xlsx file | |
| foreach($entry in $ADHCSnapshot.Computers.Keys){ | |
| $WorkSheetName = $entry | |
| if($ADHCSnapshot.Computers.$entry){ | |
| $ADHCSnapshot.Computers.$entry | | |
| ConvertTo-Csv -Delimiter ';' -NoTypeInformation | | |
| ConvertFrom-Csv -Delimiter ';' | | |
| Export-Excel -Path $xlsxComputerFile -WorkSheetname $WorkSheetName -AutoSize -BoldTopRow -FreezeTopRow | |
| } | |
| } | |
| #Groups xlsx file | |
| $snapshot.Groups.Privileged.Groups.ForEach{ | |
| if($_.Members){ | |
| $_.Members | | |
| ForEach-Object{ | |
| $_ | Get-ADObject | | |
| Select-Object Name,DistinguishedName | |
| } | | |
| Export-Excel -Path $xlsxGroupMembersFile -WorkSheetname $_.Name -AutoSize -BoldTopRow -FreezeTopRow | |
| } | |
| if($_.MemberOf){ | |
| $_.MemberOf | | |
| ForEach-Object{ | |
| $_ | Get-ADObject | | |
| Select-Object Name,DistinguishedName | |
| } | | |
| Export-Excel -Path $xlsxGroupMemberOfFile -WorkSheetname $_.Name -AutoSize -BoldTopRow -FreezeTopRow | |
| } | |
| } | |
| foreach($entry in $ADHCSnapshot.Computers.Keys){ | |
| $WorkSheetName = $entry | |
| if($ADHCSnapshot.Computers.$entry){ | |
| $ADHCSnapshot.Computers.$entry | | |
| ConvertTo-Csv -Delimiter ';' -NoTypeInformation | | |
| ConvertFrom-Csv -Delimiter ';' | | |
| Export-Excel -Path $xlsxComputerFile -WorkSheetname $WorkSheetName -AutoSize -BoldTopRow -FreezeTopRow | |
| } | |
| } | |
| #endregion |
Some cool tip & tricks courtesy of Iain
Well-defined XML File
Here’s something else you can do with PScribo: Generate a well-defined XML File!
Iain stated that there are bits of functionality missing. With a well-defined XML file you could do your own XML mapping as part of your Word document generation solution.
Export at a later time
You can export the “document” object with Export-CliXml if you wanted to generate a report later. That way you can recreate the “document” in any format, at any time! Gotta love Export-, Import-CliXml! 😉
Manipulate the object directly
It’s just a [PSCustomObject], but why mess with a good thing eh? Hehe…
Bonus: Excel reports for user, groups and computers
As a added bonus I also threw in some excel files for reporting Users, Groups and Computers using ImportExcel by Doug Finke. Instead of exporting to csv just to cut/paste in Excel, why not just export directly to a xlsx file!
I hope this gives you an idea what the possibilities are when it comes to reporting. PScribo is awesome! Add ImportExcel to the mix and you’ve got all you need when it comes to documentation!
Hope it’s worth something to you
Ttyl,
Urv
pshirwin 