Generate Exchange Environment Reports using Powershell

Update 19th January '13 - V1.5.6 - Exchange 2013 support and bug fixes (see here for more information)

Update 17th August - V1.5.4 - New features and bug fixes (see here for more information)

Update 24th July - V1.5.3 - Bug fixes (see here for more information)

Update 21th July - V1.5 - Re-write with new features including Exchange 2003 support for mixed environments and more detailed information (see here for more information)

Update 21th June - V1.1 - Bug fixes, Exchange 2007-only support in addition to 2010/2010+2007, and new features.

As an Exchange administrator, there’s times when it’s useful to have a visual, straightforward and concise document that gives you a good overview of your environment. Although with tools like Visio and Word you can make such a document, it’s hard to keep these documents up to date or use previous versions to track and check changes.

This script, inspired by the output of an Exchange TAP tool, aims to automatically generate a report that gives you an overview of your environment, Exchange 2003, 2007, 2010 and 2013 servers and database availability groups - in particular:

• Total Servers per Exchange version & service pack
• Total Mailboxes per Exchange version & service pack
• Totals for Exchange roles across the environment
• A site-by-site breakdown for the following:
  • Mailboxes per site
  • Exchange servers, version, update rollup  and version, service level, highlighted installed roles, OS version and service pack
• A breakdown of each Database Availability Group including:
  • DAG name, member count and member list
  • Database information such as
    • Name
    • Mailboxes per database and Average Size
    • Archive mailboxes per database and Average Size - only shown if a DB includes Archive mailboxes
    • Database and whitespace size
    • Database and log disk free space percentage
    • Last full backup date/time (new) - only shown if at least one DAG DB has had a full backup
    • Circular Logging state (new) - only shown if at least one DAG DB has circular logging enabled
    • Server hosting the active copy
    • List of servers hosting copies and copy count
• A breakdown of Non-DAG databases including Exchange 2007 and 2003 DBs, including the database information above, along with Storage Group name (where applicable).

The script doesn’t support detailed information about Exchange 2007/2003 CCR/SCC clusters, but these are shown as ClusMBX in the output. At the moment, the script doesn’t show Public Folder information but if there is interest I can add extra features; and of course the source is provided should you wish to alter it to your own needs.

To be able to execute the script, you need to use the Exchange Management Shell (the latest version for your environment, with Powershell 2.0) and be able to get information about AD Sites, Exchange Servers, Mailboxes, Database Availability Groups and Databases. It uses WMI to retrieve OS information and detect Exchange 2007 clusters and calculate Exchange 2007 database size and Remote Registy calls to get Update Rollup information. A normal Exchange administrator should be able to perform these tasks.

Executing the script is straightforward – the only setting you need is to specify where to write the HTML file:

.\Get-ExchangeEnvironmentReport  -HTMLReport c:\report.html

If you want it to email the results, the follow parameters are available to allow the report to be sent directly from the script:

.\Get-ExchangeEnvironmentReport  -HTMLReport c:\report.html -SendMail:$true -MailFrom:you@example.com -MailTo:you@example.com -MailServer:smtp.example.com

Finally,  to schedule the report to be generated nightly, execute with your preferred options and add the -ScheduleAs parameter, for example:

.\Get-ExchangeEnvironmentReport  -HTMLReport c:\report.html -SendMail:$true -MailFrom:you@example.com -MailTo:you@example.com -MailServer:smtp.example.com -ScheduleAs:DOMAIN\user

After generating the report, it will attempt to schedule the task and prompt (via schtasks.exe) for the password of the user you have chosen to schedule the report as.

As usual, the script is provided to download as-is without any warranties, at the bottom of this post. Comments and suggestions are always welcome.

Download Get-ExchangeEnvironmentReport.ps1