Powershell Exchange Environment Report (now on Exchange 2013)
On January 19, a new version of the script was released , which allows you to get visual information about the state of the Exchange infrastructure. Steve Goodman added support for Exchange 2013 in version 1.5.6. If you have not yet encountered this useful tool, we recommend that you do it today.
The script collects a lot of useful information on the Exchange infrastructure and displays it in an html file. You can also automate the receipt of reports by mail.
The list of what is included in the report is quite large - you can find it under the cut.
The script itself can be downloaded here .
Under the cut is a small translation of the author’s post about the script.
Exchange administrators often need a document that provides an overview of the current Exchange infrastructure. Word and Visio are not particularly suitable, as they do not allow you to constantly keep information up to date or just keep track of changes.
The proposed script allows you to automatically create a report for servers and DAGs (database availability groups) in Exchange 2003, 2007, 2010 and 2013, namely:
• The total number of servers per version and SP Exchange
• The total number of mailboxes per version and SP Exchange
• The total number Exchange of roles in your IT infrastructure
• Site breakdown for the following parameters:
o Mailboxes on the site
o Exchange servers, version, service pack and its version, service level, installed roles, OS version and service
• Breakdown by each Database Availability Group, including:
o Name of each DAG, number of members and their list
o Database information:
- Name
- The number of mailboxes per database and their average size
- The number of archive mailboxes per database and their average size - is shown only if the database is included in archive mailboxes
- Database size and free space
-% free space in the database and logical drive
- Time and the date of the last backup (n ovoe) - is displayed if at least one DAG database has a full backup
- Circular Logging Status (new) - is shown if cyclic logging
is enabled for at least one DAG database - The server on which the active copy
is located - List of servers on which the active copies are located and the number of copies
• Breakdown by non-DAG databases, including an Exchange 2007 and 2003 database with database information and the name of the Storage Group (where applicable).
The output is such a report (I quote a small part here).
It is worth noting that the script does not allow obtaining detailed information about the Exchange 2007/2003 CCR / SCC clusters, but they are shown as ClusMBX in the final report. Also at the moment, the script does not show information about Public folders, but if someone is interested, the author promises to add a couple of functions; and, of course, you yourself can make any changes to the code.
To run the script, you need the Exchange Management Shell (the latest version for your environment with Powershell 2.0) and the ability to get information about AD sites, Exchange servers, mailboxes, DAGs and databases. It uses WMI to retrieve OS information and identify Exchange 2007 clusters and calculate the size of the Exchange 2007 database and Remote Registy calls to obtain information about service packs. Any Exchange administrator can complete these tasks.
Running the script is simple - you just need to clarify where to write the HTML file:
.\Get-ExchangeEnvironmentReport -HTMLReport c:\report.html
If you want to receive reports by e-mail, the following parameters are available directly in the script to send the report:
.\Get-ExchangeEnvironmentReport -HTMLReport c:\report.html -SendMail:$true -MailFrom:you@example.com -MailTo:you@example.com -MailServer:smtp.example.com
Finally, to set a schedule for sending a report daily, 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 creating a report, he will try to create a task and ask you to enter the password of the user for whom you chose to send reports (via schtasks.exe).
Download Get-ExchangeEnvironmentReport.ps1
Upd: Since most voted to add the script to the post itself, I give it in its entirety.
Script
<#
.SYNOPSIS
Creates a HTML Report describing the Exchange environment
Steve Goodman
(Includes updates by Neil Johnson to support Exchange Server 2013)
THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE
RISK OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
Version 1.5.6, 16th Jan 2013
.DESCRIPTION
This script creates a HTML report showing the following information about an Exchange
2013, 2010 and to a lesser extent, 2007 and 2003, environment.
The following is shown:
* Report Generation Time
* Total Servers per Exchange Version (2003 > 2010 or 2007 > 2013)
* Total Mailboxes per Exchange Version and Organisation
* Total Roles in the environment
Then, per site:
* Total Mailboxes per site
* Exchange Servers with:
o Exchange Server Version
o Service Pack
o Update Rollup and rollup version
o Roles installed on server and mailbox counts
o OS Version and Service Pack
Then, per Database availability group (Exchange 2010/2013):
* Total members per DAG
* Member list
* Databases, detailing:
o Mailbox Count and Average Size
o Archive Mailbox Count and Average Size (Only shown if DAG includes Archive Mailboxes)
o Database Size and whitespace
o Database and log disk free
o Last Full Backup (Only shown if one or more DAG database has been backed up)
o Circular Logging Enabled (Only shown if one or more DAG database has Circular Logging enabled)
o Mailbox server hosting active copy
o List of mailbox servers hosting copies and number of copies
Finally, per Database (Non DAG DBs/Exchange 2007/Exchange 2003)
* Databases, detailing:
o Storage Group (if applicable) and DB name
o Server hosting database
o Mailbox Count and Average Size
o Archive Mailbox Count and Average Size (Only shown if DAG includes Archive Mailboxes)
o Database Size and whitespace
o Database and log disk free
o Last Full Backup (Only shown if one or more DAG database has been backed up)
o Circular Logging Enabled (Only shown if one or more DAG database has Circular Logging enabled)
This does not detail public folder infrastructure, or examine Exchange 2007/2003 CCR/SCC clusters
(although it attempts to detect Clustered Exchange 2007/2003 servers, signified by ClusMBX).
IMPORTANT NOTE: The script requires WMI and Remote Registry access to Exchange servers from the server
it is run from to determine OS version, Update Rollup, Exchange 2007/2003 cluster and DB size information.
.PARAMETER HTMLReport
Filename to write HTML Report to
.PARAMETER SendMail
Send Mail after completion. Set to $True to enable. If enabled, -MailFrom, -MailTo, -MailServer are mandatory
.PARAMETER MailFrom
Email address to send from. Passed directly to Send-MailMessage as -From
.PARAMETER MailTo
Email address to send to. Passed directly to Send-MailMessage as -To
.PARAMETER MailServer
SMTP Mail server to attempt to send through. Passed directly to Send-MailMessage as -SmtpServer
.PARAMETER ScheduleAs
Attempt to schedule the command just executed for 10PM nightly. Specify the username here, schtasks (under the hood) will ask for a password later.
.PARAMETER ViewEntireForest
By default, true. Set the option in Exchange 2007 or 2010 to view all Exchange servers and recipients in the forest.
.PARAMETER ServerFilter
Use a text based string to filter Exchange Servers by, e.g. NL-* - Note the use of the wildcard (*) character to allow for multiple matches.
.EXAMPLE
Generate the HTML report
.\Get-ExchangeEnvironmentReport.ps1 -HTMLReport .\report.html
#>
param(
[parameter(Position=0,Mandatory=$true,ValueFromPipeline=$false,HelpMessage='Filename to write HTML report to')][string]$HTMLReport,
[parameter(Position=1,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Send Mail ($True/$False)')][bool]$SendMail=$false,
[parameter(Position=2,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Mail From')][string]$MailFrom,
[parameter(Position=3,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Mail To')]$MailTo,
[parameter(Position=4,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Mail Server')][string]$MailServer,
[parameter(Position=4,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Schedule as user')][string]$ScheduleAs,
[parameter(Position=5,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Change view to entire forest')][bool]$ViewEntireForest=$true,
[parameter(Position=5,Mandatory=$false,ValueFromPipeline=$false,HelpMessage='Server Name Filter (eg NL-*)')][string]$ServerFilter="*"
)
# Sub-Function to Get Database Information. Shorter than expected..
function _GetDAG
{
param($DAG)
@{Name = $DAG.Name.ToUpper()
MemberCount = $DAG.Servers.Count
Members = [array]($DAG.Servers | % { $_.Name })
Databases = @()
}
}
# Sub-Function to Get Database Information
function _GetDB
{
param($Database,$ExchangeEnvironment,$Mailboxes,$ArchiveMailboxes,$E2010)
# Circular Logging, Last Full Backup
if ($Database.CircularLoggingEnabled) { $CircularLoggingEnabled="Yes" } else { $CircularLoggingEnabled = "No" }
if ($Database.LastFullBackup) { $LastFullBackup=$Database.LastFullBackup.ToString() } else { $LastFullBackup = "Not Available" }
# Mailbox Average Sizes
$MailboxStatistics = [array]($ExchangeEnvironment.Servers[$Database.Server.Name].MailboxStatistics | Where {$_.Database -eq $Database.Identity})
if ($MailboxStatistics)
{
[long]$MailboxItemSizeB = 0
$MailboxStatistics | %{ $MailboxItemSizeB+=$_.TotalItemSizeB }
[long]$MailboxAverageSize = $MailboxItemSizeB / $MailboxStatistics.Count
} else {
$MailboxAverageSize = 0
}
# Free Disk Space Percentage
if ($ExchangeEnvironment.Servers[$Database.Server.Name].Disks)
{
foreach ($Disk in $ExchangeEnvironment.Servers[$Database.Server.Name].Disks)
{
if ($Database.EdbFilePath.PathName -like "$($Disk.Name)*")
{
$FreeDatabaseDiskSpace = $Disk.FreeSpace / $Disk.Capacity * 100
}
if ($Database.ExchangeVersion.ExchangeBuild.Major -ge 14)
{
if ($Database.LogFolderPath.PathName -like "$($Disk.Name)*")
{
$FreeLogDiskSpace = $Disk.FreeSpace / $Disk.Capacity * 100
}
} else {
$StorageGroupDN = $Database.DistinguishedName.Replace("CN=$($Database.Name),","")
$Adsi=[adsi]"LDAP://$($Database.OriginatingServer)/$($StorageGroupDN)"
if ($Adsi.msExchESEParamLogFilePath -like "$($Disk.Name)*")
{
$FreeLogDiskSpace = $Disk.FreeSpace / $Disk.Capacity * 100
}
}
}
} else {
$FreeLogDiskSpace=$null
$FreeDatabaseDiskSpace=$null
}
if ($Database.ExchangeVersion.ExchangeBuild.Major -ge 14 -and $E2010)
{
# Exchange 2010 Database Only
$CopyCount = [int]$Database.Servers.Count
if ($Database.MasterServerOrAvailabilityGroup.Name -ne $Database.Server.Name)
{
$Copies = [array]($Database.Servers | % { $_.Name })
} else {
$Copies = @()
}
# Archive Info
$ArchiveMailboxCount = [int]([array]($ArchiveMailboxes | Where {$_.ArchiveDatabase -eq $Database.Name})).Count
$ArchiveStatistics = [array]($ArchiveMailboxes | Where {$_.ArchiveDatabase -eq $Database.Name} | Get-MailboxStatistics -Archive )
if ($ArchiveStatistics)
{
[long]$ArchiveItemSizeB = 0
$ArchiveStatistics | %{ $ArchiveItemSizeB+=$_.TotalItemSize.Value.ToBytes() }
[long]$ArchiveAverageSize = $ArchiveItemSizeB / $ArchiveStatistics.Count
} else {
$ArchiveAverageSize = 0
}
# DB Size / Whitespace Info
[long]$Size = $Database.DatabaseSize.ToBytes()
[long]$Whitespace = $Database.AvailableNewMailboxSpace.ToBytes()
$StorageGroup = $null
} else {
$ArchiveMailboxCount = 0
$CopyCount = 0
$Copies = @()
# 2003 & 2007, Use WMI (Based on code by Gary Siepser, http://bit.ly/kWWMb3)
$Size = [long](get-wmiobject cim_datafile -computername $Database.Server.Name -filter ('name=''' + $Database.edbfilepath.pathname.replace("\","\\") + '''')).filesize
if (!$Size)
{
Write-Warning "Cannot detect database size via WMI for $($Database.Server.Name)"
[long]$Size = 0
[long]$Whitespace = 0
} else {
[long]$MailboxDeletedItemSizeB = 0
if ($MailboxStatistics)
{
$MailboxStatistics | %{ $MailboxDeletedItemSizeB+=$_.TotalDeletedItemSizeB }
}
$Whitespace = $Size - $MailboxItemSizeB - $MailboxDeletedItemSizeB
if ($Whitespace -lt 0) { $Whitespace = 0 }
}
$StorageGroup =$Database.DistinguishedName.Split(",")[1].Replace("CN=","")
}
@{Name = $Database.Name
StorageGroup = $StorageGroup
ActiveOwner = $Database.Server.Name.ToUpper()
MailboxCount = [long]([array]($Mailboxes | Where {$_.Database -eq $Database.Identity})).Count
MailboxAverageSize = $MailboxAverageSize
ArchiveMailboxCount = $ArchiveMailboxCount
ArchiveAverageSize = $ArchiveAverageSize
CircularLoggingEnabled = $CircularLoggingEnabled
LastFullBackup = $LastFullBackup
Size = $Size
Whitespace = $Whitespace
Copies = $Copies
CopyCount = $CopyCount
FreeLogDiskSpace = $FreeLogDiskSpace
FreeDatabaseDiskSpace = $FreeDatabaseDiskSpace
}
}
# Sub-Function to get mailbox count per server.
# New in 1.5.2
function _GetExSvrMailboxCount
{
param($Mailboxes,$ExchangeServer,$Databases)
# The following *should* work, but it doesn't. Apparently, ServerName is not always returned correctly which may be the cause of
# reports of counts being incorrect
#([array]($Mailboxes | Where {$_.ServerName -eq $ExchangeServer.Name})).Count
# ..So as a workaround, I'm going to check what databases are assigned to each server and then get the mailbox counts on a per-
# database basis and return the resulting total. As we already have this information resident in memory it should be cheap, just
# not as quick.
$MailboxCount = 0
foreach ($Database in [array]($Databases | Where {$_.Server -eq $ExchangeServer.Name}))
{
$MailboxCount+=([array]($Mailboxes | Where {$_.Database -eq $Database.Identity})).Count
}
$MailboxCount
}
# Sub-Function to Get Exchange Server information
function _GetExSvr
{
param($E2010,$ExchangeServer,$Mailboxes,$Databases)
# Set Basic Variables
$MailboxCount = 0
$RollupLevel = 0
$RollupVersion = ""
# Get WMI Information
$tWMI = Get-WmiObject Win32_OperatingSystem -ComputerName $ExchangeServer.Name -ErrorAction SilentlyContinue
if ($tWMI)
{
$OSVersion = $tWMI.Caption.Replace("(R)","").Replace("Microsoft ","").Replace("Enterprise","Ent").Replace("Standard","Std").Replace(" Edition","")
$OSServicePack = $tWMI.CSDVersion
$RealName = $tWMI.CSName.ToUpper()
} else {
Write-Warning "Cannot detect OS information via WMI for $($ExchangeServer.Name)"
$OSVersion = "N/A"
$OSServicePack = "N/A"
$RealName = $ExchangeServer.Name.ToUpper()
}
$tWMI=Get-WmiObject -query "Select * from Win32_Volume" -ComputerName $ExchangeServer.Name -ErrorAction SilentlyContinue
if ($tWMI)
{
$Disks=$tWMI | Select Name,Capacity,FreeSpace | Sort-Object -Property Name
} else {
Write-Warning "Cannot detect OS information via WMI for $($ExchangeServer.Name)"
$Disks=$null
}
# Get Exchange Version
if ($ExchangeServer.AdminDisplayVersion.Major -eq 6)
{
$ExchangeMajorVersion = "$($ExchangeServer.AdminDisplayVersion.Major).$($ExchangeServer.AdminDisplayVersion.Minor)"
$ExchangeSPLevel = $ExchangeServer.AdminDisplayVersion.FilePatchLevelDescription.Replace("Service Pack ","")
} else {
$ExchangeMajorVersion = $ExchangeServer.AdminDisplayVersion.Major
$ExchangeSPLevel = $ExchangeServer.AdminDisplayVersion.Minor
}
# Exchange 2007+
if ($ExchangeMajorVersion -ge 8)
{
# Get Roles
$MailboxStatistics=$null
[array]$Roles = $ExchangeServer.ServerRole.ToString().Replace(" ","").Split(",");
if ($Roles -contains "Mailbox")
{
$MailboxCount = _GetExSvrMailboxCount -Mailboxes $Mailboxes -ExchangeServer $ExchangeServer -Databases $Databases
if ($ExchangeServer.Name.ToUpper() -ne $RealName)
{
$Roles = [array]($Roles | Where {$_ -ne "Mailbox"})
$Roles += "ClusteredMailbox"
}
# Get Mailbox Statistics the normal way, return in a consitent format
$MailboxStatistics = Get-MailboxStatistics -Server $ExchangeServer | Select DisplayName,@{Name="TotalItemSizeB";Expression={$_.TotalItemSize.Value.ToBytes()}},@{Name="TotalDeletedItemSizeB";Expression={$_.TotalDeletedItemSize.Value.ToBytes()}},Database
}
# Rollup Level / Versions (Thanks to Bhargav Shukla http://bit.ly/msxGIJ)
if ($ExchangeMajorVersion -ge 14)
{
$RegKey="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Installer\\UserData\\S-1-5-18\\Products\\AE1D439464EB1B8488741FFA028E291C\\Patches"
} else {
$RegKey="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Installer\\UserData\\S-1-5-18\\Products\\461C2B4266EDEF444B864AD6D9E5B613\\Patches"
}
$RemoteRegistry = [Microsoft.Win32.RegistryKey]::OpenRemoteBaseKey('LocalMachine', $ExchangeServer.Name);
if ($RemoteRegistry)
{
$RUKeys = $RemoteRegistry.OpenSubKey($RegKey).GetSubKeyNames() | ForEach {"$RegKey\\$_"}
if ($RUKeys)
{
[array]($RUKeys | %{$RemoteRegistry.OpenSubKey($_).getvalue("DisplayName")}) | %{
if ($_ -like "Update Rollup *")
{
$tRU = $_.Split(" ")[2]
if ($tRU -like "*-*") { $tRUV=$tRU.Split("-")[1]; $tRU=$tRU.Split("-")[0] } else { $tRUV="" }
if ($tRU -ge $RollupLevel) { $RollupLevel=$tRU; $RollupVersion=$tRUV }
}
}
}
} else {
Write-Warning "Cannot detect Rollup Version via Remote Registry for $($ExchangeServer.Name)"
}
}
# Exchange 2003
if ($ExchangeMajorVersion -eq 6.5)
{
# Mailbox Count
$MailboxCount = _GetExSvrMailboxCount -Mailboxes $Mailboxes -ExchangeServer $ExchangeServer -Databases $Databases
# Get Role via WMI
$tWMI = Get-WMIObject Exchange_Server -Namespace "root\microsoftexchangev2" -Computername $ExchangeServer.Name -Filter "Name='$($ExchangeServer.Name)'"
if ($tWMI)
{
if ($tWMI.IsFrontEndServer) { $Roles=@("FE") } else { $Roles=@("BE") }
} else {
Write-Warning "Cannot detect Front End/Back End Server information via WMI for $($ExchangeServer.Name)"
$Roles+="Unknown"
}
# Get Mailbox Statistics using WMI, return in a consistent format
$tWMI = Get-WMIObject -class Exchange_Mailbox -Namespace ROOT\MicrosoftExchangev2 -ComputerName $ExchangeServer.Name -Filter ("ServerName='$($ExchangeServer.Name)'")
if ($tWMI)
{
$MailboxStatistics = $tWMI | Select @{Name="DisplayName";Expression={$_.MailboxDisplayName}},@{Name="TotalItemSizeB";Expression={$_.Size}},@{Name="TotalDeletedItemSizeB";Expression={$_.DeletedMessageSizeExtended }},@{Name="Database";Expression={((get-mailboxdatabase -Identity "$($_.ServerName)\$($_.StorageGroupName)\$($_.StoreName)").identity)}}
} else {
Write-Warning "Cannot retrieve Mailbox Statistics via WMI for $($ExchangeServer.Name)"
$MailboxStatistics = $null
}
}
# Exchange 2000
if ($ExchangeMajorVersion -eq "6.0")
{
# Mailbox Count
$MailboxCount = _GetExSvrMailboxCount -Mailboxes $Mailboxes -ExchangeServer $ExchangeServer -Databases $Databases
# Get Role via ADSI
$tADSI=[ADSI]"LDAP://$($ExchangeServer.OriginatingServer)/$($ExchangeServer.DistinguishedName)"
if ($tADSI)
{
if ($tADSI.ServerRole -eq 1) { $Roles=@("FE") } else { $Roles=@("BE") }
} else {
Write-Warning "Cannot detect Front End/Back End Server information via ADSI for $($ExchangeServer.Name)"
$Roles+="Unknown"
}
$MailboxStatistics = $null
}
# Return Hashtable
@{Name = $ExchangeServer.Name.ToUpper()
RealName = $RealName
ExchangeMajorVersion = $ExchangeMajorVersion
ExchangeSPLevel = $ExchangeSPLevel
Edition = $ExchangeServer.Edition
Mailboxes = $MailboxCount
OSVersion = $OSVersion;
OSServicePack = $OSServicePack
Roles = $Roles
RollupLevel = $RollupLevel
RollupVersion = $RollupVersion
Site = $ExchangeServer.Site.Name
MailboxStatistics = $MailboxStatistics
Disks = $Disks
}
}
# Sub Function to Get Totals by Version
function _TotalsByVersion
{
param($ExchangeEnvironment)
$TotalMailboxesByVersion=@{}
if ($ExchangeEnvironment.Sites)
{
foreach ($Site in $ExchangeEnvironment.Sites.GetEnumerator())
{
foreach ($Server in $Site.Value)
{
if (!$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"])
{
$TotalMailboxesByVersion.Add("$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)",@{ServerCount=1;MailboxCount=$Server.Mailboxes})
} else {
$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"].ServerCount++
$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"].MailboxCount+=$Server.Mailboxes
}
}
}
}
if ($ExchangeEnvironment.Pre2007)
{
foreach ($FakeSite in $ExchangeEnvironment.Pre2007.GetEnumerator())
{
foreach ($Server in $FakeSite.Value)
{
if (!$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"])
{
$TotalMailboxesByVersion.Add("$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)",@{ServerCount=1;MailboxCount=$Server.Mailboxes})
} else {
$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"].ServerCount++
$TotalMailboxesByVersion["$($Server.ExchangeMajorVersion).$($Server.ExchangeSPLevel)"].MailboxCount+=$Server.Mailboxes
}
}
}
}
$TotalMailboxesByVersion
}
# Sub Function to Get Totals by Role
function _TotalsByRole
{
param($ExchangeEnvironment)
# Add Roles We Always Show
$TotalServersByRole=@{"ClientAccess" = 0
"HubTransport" = 0
"UnifiedMessaging" = 0
"Mailbox" = 0
"Edge" = 0
}
if ($ExchangeEnvironment.Sites)
{
foreach ($Site in $ExchangeEnvironment.Sites.GetEnumerator())
{
foreach ($Server in $Site.Value)
{
foreach ($Role in $Server.Roles)
{
if ($TotalServersByRole[$Role] -eq $null)
{
$TotalServersByRole.Add($Role,1)
} else {
$TotalServersByRole[$Role]++
}
}
}
}
}
if ($ExchangeEnvironment.Pre2007["Pre 2007 Servers"])
{
foreach ($Server in $ExchangeEnvironment.Pre2007["Pre 2007 Servers"])
{
foreach ($Role in $Server.Roles)
{
if ($TotalServersByRole[$Role] -eq $null)
{
$TotalServersByRole.Add($Role,1)
} else {
$TotalServersByRole[$Role]++
}
}
}
}
$TotalServersByRole
}
# Sub Function to return HTML Table for Sites/Pre 2007
function _GetOverview
{
param($Servers,$ExchangeEnvironment,$ExRoleStrings,$Pre2007=$False)
if ($Pre2007)
{
$BGColHeader="#880099"
$BGColSubHeader="#8800CC"
$Prefix=""
} else {
$BGColHeader="#000099"
$BGColSubHeader="#0000FF"
$Prefix="Site:"
}
$Output="";
#$Output+="";
$ExchangeEnvironment.TotalServersByRole.GetEnumerator()|Sort Name| %{$Output+=""}
$Output+=""
$TotalMailboxes=0
$Servers.Value | %{$TotalMailboxes += $_.Mailboxes}
$Output+=""
$ExchangeEnvironment.TotalServersByRole.GetEnumerator()|Sort Name| %{$Output+=""}
$Output+=""
$AlternateRow=0
foreach ($Server in $Servers.Value)
{
$Output+=""
if ($ShowStorageGroups)
{
$Output+=""
}
$Output+=""
if ($ShowArchiveDBs)
{
$Output+=""
}
$Output+=""
if ($ShowFreeDatabaseSpace)
{
$Output+=""
}
if ($ShowFreeLogDiskSpace)
{
$Output+=""
}
if ($ShowLastFullBackup)
{
$Output+=""
}
if ($ShowCircularLogging)
{
$Output+=""
}
if ($ShowCopies)
{
$Output+=""
}
$Output+=""
$AlternateRow=0;
foreach ($Database in $Databases)
{
$Output+="$($Database.MailboxCount)
"
if ($ShowArchiveDBs)
{
$Output+="";
}
$Output+="";
if ($ShowFreeDatabaseSpace)
{
$Output+=""
}
if ($ShowFreeLogDiskSpace)
{
$Output+=""
}
if ($ShowLastFullBackup)
{
$Output+="";
}
if ($ShowCircularLogging)
{
$Output+="";
}
if ($ShowCopies)
{
$Output+=""
}
$Output+="";
}
$Output+="$($Prefix) $($Servers.Key) Exchange Version Roles Installed OS Version OS Service Pack Mailboxes: $($TotalMailboxes) $($ExRoleStrings[$_.Key].Short) Server Storage Group Database Name Mailboxes Av. Mailbox Size Archive MBs Av. Archive Size DB Size DB Whitespace Database Disk Free Log Disk Free Last Full Backup Circular Logging Copies (n) $("{0:N2}" -f ($Database.MailboxAverageSize/1MB)) MB $($Database.ArchiveMailboxCount) $("{0:N2}" -f ($Database.ArchiveAverageSize/1MB)) MB $("{0:N2}" -f ($Database.Size/1GB)) GB $("{0:N2}" -f ($Database.Whitespace/1GB)) GB $("{0:N1}" -f $Database.FreeDatabaseDiskSpace)% $("{0:N1}" -f $Database.FreeLogDiskSpace)% $($Database.LastFullBackup) $($Database.CircularLoggingEnabled) $($Database.Copies|%{$_}) ($($Database.CopyCount))
"
$Output
}
# Sub Function to neatly update progress
function _UpProg1
{
param($PercentComplete,$Status,$Stage)
$TotalStages=5
Write-Progress -id 1 -activity "Get-ExchangeEnvironmentReport" -status $Status -percentComplete (($PercentComplete/$TotalStages)+(1/$TotalStages*$Stage*100))
}
# 1. Initial Startup
# 1.0 Check Powershell Version
if ((Get-Host).Version.Major -eq 1)
{
throw "Powershell Version 1 not supported";
}
# 1.1 Check Exchange Management Shell, attempt to load
if (!(Get-Command Get-ExchangeServer -ErrorAction SilentlyContinue))
{
if (Test-Path "C:\Program Files\Microsoft\Exchange Server\V14\bin\RemoteExchange.ps1")
{
. 'C:\Program Files\Microsoft\Exchange Server\V14\bin\RemoteExchange.ps1'
Connect-ExchangeServer -auto
} elseif (Test-Path "C:\Program Files\Microsoft\Exchange Server\bin\Exchange.ps1") {
Add-PSSnapIn Microsoft.Exchange.Management.PowerShell.Admin
.'C:\Program Files\Microsoft\Exchange Server\bin\Exchange.ps1'
} else {
throw "Exchange Management Shell cannot be loaded"
}
}
# 1.2 Check if -SendMail parameter set and if so check -MailFrom, -MailTo and -MailServer are set
if ($SendMail)
{
if (!$MailFrom -or !$MailTo -or !$MailServer)
{
throw "If -SendMail specified, you must also specify -MailFrom, -MailTo and -MailServer"
}
}
# 1.3 Check Exchange Management Shell Version
if ((Get-PSSnapin -Name Microsoft.Exchange.Management.PowerShell.Admin -ErrorAction SilentlyContinue))
{
$E2010 = $false;
if (Get-ExchangeServer | Where {$_.AdminDisplayVersion.Major -gt 14})
{
Write-Warning "Exchange 2010 or higher detected. You'll get better results if you run this script from an Exchange 2010 management shell"
}
}else{
$E2010 = $true
$localserver = get-exchangeserver $Env:computername
$localversion = $localserver.admindisplayversion.major
if ($localversion -eq 15) { $E2013 = $true }
}
# 1.4 Check view entire forest if set (by default, true)
if ($E2010)
{
Set-ADServerSettings -ViewEntireForest:$ViewEntireForest
} else {
$global:AdminSessionADSettings.ViewEntireForest = $ViewEntireForest
}
# 1.5 Initial Variables
# 1.5.1 Hashtable to update with environment data
$ExchangeEnvironment = @{Sites = @{}
Pre2007 = @{}
Servers = @{}
DAGs = @()
NonDAGDatabases = @()
}
# 1.5.7 Exchange Major Version String Mapping
$ExMajorVersionStrings = @{"6.0" = @{Long="Exchange 2000";Short="E2000"}
"6.5" = @{Long="Exchange 2003";Short="E2003"}
"8" = @{Long="Exchange 2007";Short="E2007"}
"14" = @{Long="Exchange 2010";Short="E2010"}
"15" = @{Long="Exchange 2013";Short="E2013"}}
# 1.5.8 Exchange Service Pack String Mapping
$ExSPLevelStrings = @{"0" = "RTM"
"1" = "SP1"
"2" = "SP2"
"3" = "SP3"
"4" = "SP4"}
# 1.5.9 Populate Full Mapping using above info
$ExVersionStrings = @{}
foreach ($Major in $ExMajorVersionStrings.GetEnumerator())
{
foreach ($Minor in $ExSPLevelStrings.GetEnumerator())
{
$ExVersionStrings.Add("$($Major.Key).$($Minor.Key)",@{Long="$($Major.Value.Long) $($Minor.Value)";Short="$($Major.Value.Short)$($Minor.Value)"})
}
}
# 1.5.10 Exchange Role String Mapping
$ExRoleStrings = @{"ClusteredMailbox" = @{Short="ClusMBX";Long="CCR/SCC Clustered Mailbox"}
"Mailbox" = @{Short="MBX";Long="Mailbox"}
"ClientAccess" = @{Short="CAS";Long="Client Access"}
"HubTransport" = @{Short="HUB";Long="Hub Transport"}
"UnifiedMessaging" = @{Short="UM";Long="Unified Messaging"}
"Edge" = @{Short="EDGE";Long="Edge Transport"}
"FE" = @{Short="FE";Long="Front End"}
"BE" = @{Short="BE";Long="Back End"}
"Unknown" = @{Short="Unknown";Long="Unknown"}}
# 2 Get Relevant Exchange Information Up-Front
# 2.1 Get Server, Exchange and Mailbox Information
_UpProg1 1 "Getting Exchange Server List" 1
$ExchangeServers = [array](Get-ExchangeServer $ServerFilter)
if (!$ExchangeServers)
{
throw "No Exchange Servers matched by -ServerFilter ""$($ServerFilter)"""
}
_UpProg1 10 "Getting Mailboxes" 1
$Mailboxes = [array](Get-Mailbox -ResultSize Unlimited) | Where {$_.Server -like $ServerFilter}
if ($E2010)
{
_UpProg1 60 "Getting Archive Mailboxes" 1
$ArchiveMailboxes = [array](Get-Mailbox -Archive -ResultSize Unlimited) | Where {$_.Server -like $ServerFilter}
_UpProg1 90 "Getting Databases" 1
if ($E2013)
{
$Databases = [array](Get-MailboxDatabase -IncludePreExchange2013 -Status) | Where {$_.Server -like $ServerFilter}
}
elseif ($E2010)
{
$Databases = [array](Get-MailboxDatabase -IncludePreExchange2010 -Status) | Where {$_.Server -like $ServerFilter}
}
$DAGs = [array](Get-DatabaseAvailabilityGroup) | Where {$_.Servers -like $ServerFilter}
} else {
$ArchiveMailboxes = $null
$ArchiveMailboxStats = $null
$DAGs = $null
_UpProg1 90 "Getting Databases" 1
$Databases = [array](Get-MailboxDatabase -IncludePreExchange2007 -Status) | Where {$_.Server -like $ServerFilter}
}
# 2.3 Populate Information we know
$ExchangeEnvironment.Add("TotalMailboxes",$Mailboxes.Count);
# 3 Process High-Level Exchange Information
# 3.1 Collect Exchange Server Information
for ($i=0; $i -lt $ExchangeServers.Count; $i++)
{
_UpProg1 ($i/$ExchangeServers.Count*100) "Getting Exchange Server Information" 2
# Get Exchange Info
$ExSvr = _GetExSvr -E2010 $E2010 -ExchangeServer $ExchangeServers[$i] -Mailboxes $Mailboxes -Databases $Databases
# Add to site or pre-Exchange 2007 list
if ($ExSvr.Site)
{
# Exchange 2007 or higher
if (!$ExchangeEnvironment.Sites[$ExSvr.Site])
{
$ExchangeEnvironment.Sites.Add($ExSvr.Site,@($ExSvr))
} else {
$ExchangeEnvironment.Sites[$ExSvr.Site]+=$ExSvr
}
} else {
# Exchange 2003 or lower
if (!$ExchangeEnvironment.Pre2007["Pre 2007 Servers"])
{
$ExchangeEnvironment.Pre2007.Add("Pre 2007 Servers",@($ExSvr))
} else {
$ExchangeEnvironment.Pre2007["Pre 2007 Servers"]+=$ExSvr
}
}
# Add to Servers List
$ExchangeEnvironment.Servers.Add($ExSvr.Name,$ExSvr)
}
# 3.2 Calculate Environment Totals for Version/Role using collected data
_UpProg1 1 "Getting Totals" 3
$ExchangeEnvironment.Add("TotalMailboxesByVersion",(_TotalsByVersion -ExchangeEnvironment $ExchangeEnvironment))
$ExchangeEnvironment.Add("TotalServersByRole",(_TotalsByRole -ExchangeEnvironment $ExchangeEnvironment))
# 3.4 Populate Environment DAGs
_UpProg1 5 "Getting DAG Info" 3
if ($DAGs)
{
foreach($DAG in $DAGs)
{
$ExchangeEnvironment.DAGs+=(_GetDAG -DAG $DAG)
}
}
# 3.5 Get Database information
_UpProg1 60 "Getting Database Info" 3
for ($i=0; $i -lt $Databases.Count; $i++)
{
$Database = _GetDB -Database $Databases[$i] -ExchangeEnvironment $ExchangeEnvironment -Mailboxes $Mailboxes -ArchiveMailboxes $ArchiveMailboxes -E2010 $E2010
$DAGDB = $false
for ($j=0; $j -lt $ExchangeEnvironment.DAGs.Count; $j++)
{
if ($ExchangeEnvironment.DAGs[$j].Members -contains $Database.ActiveOwner)
{
$DAGDB=$true
$ExchangeEnvironment.DAGs[$j].Databases += $Database
}
}
if (!$DAGDB)
{
$ExchangeEnvironment.NonDAGDatabases += $Database
}
}
# 4 Write Information
_UpProg1 5 "Writing HTML Report Header" 4
# Header
$Output="
Exchange Environment Report
Generated $((Get-Date).ToString())
"
# Show Column Headings based on the Exchange versions we have
$ExchangeEnvironment.TotalMailboxesByVersion.GetEnumerator()|Sort Name| %{$Output+=""}
$ExchangeEnvironment.TotalMailboxesByVersion.GetEnumerator()|Sort Name| %{$Output+=""}
$Output+=""
$ExchangeEnvironment.TotalServersByRole.GetEnumerator()|Sort Name| %{$Output+=""}
$Output+=""
$Output+=""
$ExchangeEnvironment.TotalMailboxesByVersion.GetEnumerator()|Sort Name| %{$Output+="" }
$ExchangeEnvironment.TotalMailboxesByVersion.GetEnumerator()|Sort Name| %{$Output+="" }
$Output+=""
$ExchangeEnvironment.TotalServersByRole.GetEnumerator()|Sort Name| %{$Output+=""}
$Output+="Total Servers: Total Mailboxes: Total Roles: $($ExVersionStrings[$_.Key].Short) $($ExVersionStrings[$_.Key].Short) Org $($ExRoleStrings[$_.Key].Short) $($_.Value.ServerCount) $($_.Value.MailboxCount) $($ExchangeEnvironment.TotalMailboxes) $($_.Value)
"
# Sites and Servers
_UpProg1 20 "Writing HTML Site Information" 4
foreach ($Site in $ExchangeEnvironment.Sites.GetEnumerator())
{
$Output+=_GetOverview -Servers $Site -ExchangeEnvironment $ExchangeEnvironment -ExRoleStrings $ExRoleStrings
}
_UpProg1 40 "Writing HTML Pre-2007 Information" 4
foreach ($FakeSite in $ExchangeEnvironment.Pre2007.GetEnumerator())
{
$Output+=_GetOverview -Servers $FakeSite -ExchangeEnvironment $ExchangeEnvironment -ExRoleStrings $ExRoleStrings -Pre2007:$true
}
_UpProg1 60 "Writing HTML DAG Information" 4
foreach ($DAG in $ExchangeEnvironment.DAGs)
{
if ($DAG.MemberCount -gt 0)
{
# Database Availability Group Header
$Output+="Database Availability Group Name Member Count Database Availability Group Members $($DAG.Name)
$($DAG.MemberCount) "
$DAG.Members | % { $Output+="$($_) " }
$Output+="
"
# Get Table HTML
$Output+=_GetDBTable -Databases $DAG.Databases
}
}
if ($ExchangeEnvironment.NonDAGDatabases.Count)
{
_UpProg1 80 "Writing HTML Non-DAG Database Information" 4
$Output+="Mailbox Databases (Non-DAG)
"
$Output+=_GetDBTable -Databases $ExchangeEnvironment.NonDAGDatabases
}
# End
_UpProg1 90 "Finishing off.." 4
$Output+="";
$Output | Out-File $HTMLReport
if ($SendMail)
{
_UpProg1 95 "Sending mail message.." 4
Send-MailMessage -Attachments $HTMLReport -To $MailTo -From $MailFrom -Subject "Exchange Environment Report" -BodyAsHtml $Output -SmtpServer $MailServer
}
if ($ScheduleAs)
{
_UpProg1 99 "Attempting to Schedule Task.." 4
$dir=(split-path -parent $myinvocation.mycommand.definition)
$params="-HTMLReport $HTMLReport"
if ($SendMail)
{
$params+=' -SendMail:$true'
$params+=" -MailFrom:$MailFrom -MailTo:$MailTo -MailServer:$MailServer"
}
$task = "powershell -c \""pushd $dir; $($myinvocation.mycommand.definition) $params\"""
Write-Output "Attempting to schedule task as $($ScheduleAs)..."
Write-Output "Task to schedule: $($task)"
schtasks /Create /RU $ScheduleAs /RP /SC DAILY /ST 22:00 /TN EER /TR $task
Only registered users can participate in the survey. Please come in.
Do I need to add the script itself to the post?
- 74.4% Yes 35
- 25.5% No 12