jdhitsolutions / adreportingtools

A set of PowerShell commands to gather information and create reports from Active Directory. Relies on the Active Directory module from Microsoft.

Jeff Hicks

I am a veteran IT Pro and scripting fanatic, going back to batch files in the early days of DOS. Today, I create content, code, and courses intended to teach PowerShell or to make an IT Pro's job a little easier. You can often find me speaking to user groups and at IT conferences like Techmentor. I blog frequently at https://jdhitsolutions.com/blog.

Here is a sample of my latest work:

• Pick Up The PowerShell Practice Primer
• GitHub Scripting Challenge Solution
• My Conference Future
• PowerShell Refresh
• Module Linking

You can find me on X and I hope you'll think about following me. I host an online Twitter/X chat on the first Friday of every month from 1:00-2:00 PM Eastern time. Follow along with the #PSTweetChat tag. You can catch up on past events with the chat transcripts. My engagement on Twitter is slowing and you'll find me more active on Mastodon.

Go Premium 📰

You might be interested in subscribing to my premium PowerShell newsletter, Behind the PowerShell Pipeline, which dives deeper into PowerShell and the culture around it. You can subscribe for free and receive limited content. Premium members get content like this article. Paid subscribers have full access to all published content going back to the beginning of 2022.

"Those who forget to automate are doomed to repeat their work."

💡 Current Work

The list below includes some of my current GitHub projects that I think will be of interest to most IT professionals. I write these modules not only to solve common problems or add value to your daily work routine but also to serve as teaching opportunities. As you might expect, much of my work is PowerShell-related, and most modules can be installed from the PowerShell Gallery. You can find all of my repositories by clicking the Repositories link above or here.

You might also find useful bits of information in my GitHub gists.

❤️ Sponsor

Name	Repository	PowerShell Gallery	Notes
PowerShell Scripting Tools	PSScriptTools		A set of PowerShell functions you might use to enhance your functions and scripts or to facilitate working in the console. Most commands should work in both Windows PowerShell and PowerShell 7, even cross-platform.
PS Release Tools	PSReleaseTools		A set of commands for working with PowerShell 7.x releases, including preview builds.
Windows Terminal Toolbox	WTToolBox		A set of PowerShell functions for managing and working with the Windows Terminal application from Microsoft.
Active Directory Reporting Tools	ADReportingTools		A set of PowerShell commands to gather information and create reports from Active Directory. Requires the ActiveDirectory module from Microsoft.

📖 Books and Courses 🎓

In addition to the well-known Learn PowerShell in a Month of Lunches book, you can find my other work on LeanPub.

	The PowerShell Practice Primer isn't a book to teach your PowerShell, but rather to re-enforce what you already know through 100+ console-based exercises. No scripting is required. Updated with PowerShell 7.x content.
	If you have read Learn PowerShell Scripting in a Month of Lunches, then you are ready for the next step. Don Jones and I wrote this book intending it to be the definitive guide on everything you need to know to be a better PowerShell scripter and toolmaker.
	I have been creating video training courses for over ten years. I have a large course catalog at Pluralsight, with an emphasis on PowerShell-related content. If you are just getting started with PowerShell 7, I got you covered there as well.

---

Recommendations

There is a wealth of code on GitHub. These are a few recommendations for PowerShell-related repositories. Many of these people have published modules in the PowerShell Gallery.

• 
• 
• 
• 
• 
• 
• 

---

My Stats

adreportingtools's Issues

CHANGE Get-ADGroupReport to show member count

Get-ADGroupReport should show a member count in the default display. Alert on 0 members in the formatting.

Change Get-ADSiteDetail to allow specifying by name

Modify Get-ADSiteDetail to let the user specify a site by name. The default can still be all sites.

CHANGE Get-ADSummary to use RootDSE

The AD command Get-RootDse is a better source of information for Get-ADSummary.

Add help documentation

Create initial command help and external help file.

Change Get-ADBranch to allow filtering

Get-ADBranch should allow filtering by object type, such as only displaying groups. Maybe allow for excluding BuiltIn and default containers.

mini error in readme ;-)

please correct in https://github.com/jdhitsolutions/ADReportingTools#readme and in the help manual pdf:
GetADGroupReport to Get-ADGroupReport
(just a spelling mistake in the header)

Bug New-ADDomainReport can't convert path to a file that doesn't exist

When creating a ADDomainReport, Convert-Path fails when the file hasn't been created yet. Need to updated to convert the parent path portion.

Bug Get-ADGroupUser not reporting title

Title property is missing for user accounts in the output.

BUG typo in Note value of $ADReportingHash.

Fix typo in Note property

BUG New-ADChangeReport CSS Path not detected.

This is a bug reported by @klaypigeon

PS C:\Windows\system32> new-adchangereport
You cannot call a method on a null-valued expression.
At C:\Program Files\WindowsPowerShell\Modules\ADReportingTools\1.0.0\Functions\ADChangeReport.ps1:130 char:13
+             $htmlParams.Add("CSSPath", $CSSPath)
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Couple items I noticed

I have had a few issues right off the rip. Just wanted to report up. PS Version : 5.1.17763.1490

PS C:\Windows\system32> show-domaintree
This command should be run in a PowerShell Console host.

Add Computername to services in domain controller health

The services reported by Get-ADDomainControllerHealth need to include the computername.

Add Get-ADGroupReport

Get-ADGroupReport

• Name
• DistinguishedName
• group type
• group scope
• group members
• description
• WhenCreated
• WhenModified

Make format colors customizable

Export color options to a user-configurable setting and update format files to use these values.

Module commands not exported

I have tried installing with Install-Module as well as locally via download yet the ExportedCommands list is empty. I have also tried using

Test-ModuleManifest -Path "C:\Program Files\WindowsPowerShell\Modules\ADReportingTools\1.3.0\ADR
eportingTools.psd1"

This DOES report the exported commands but I cannot seem to get the modules to work. Am I missing something obvious?

Add fsmo alias

Add an alias of smo to Get-ADFSMO.

ADD Show-DomainTree ANSI to ADReportingToolsOptions

Color schemes used in Show-DomainTree should be part of $ADReportingToolsOptions.

Add Get-ADCanonicalUser

Need a wrapper command to take name like Company\Artd and get the AD user account.

Change formatting for domain controller services

Services that are part of the Get-ADDomainControllerHealth command should be properly typed and have a defined formatted view.

Change default view for Get-ADFSMO

The default view for FSMO information should be a list.

Add Get-ADReportingTools command

Add a command to provide a summary of tools in this module.

Add module documentation PDF

Create a PDF and related command with all related help.

Add New-ADChangeReport

modify the ADChangeReport.ps1 script into a function. Use New-ADDomainReport as a guide.

CHANGE: Add ThreadJob requirement

Update module manifest to include a requirement for the ThreadJob module.