Maintenance Scripts
Get-ADExchangeServer.ps1
Description
@GitHub Copilot - Welcome @BanterBoy, I’m your Copilot and I’m here to help you get things done faster. I can identify issues, explain and even improve code.
You can ask generic questions, but what I’m really good at is helping you with your code. For example:
Generate unit tests for my code Explain the selected code Propose a fix for the bugs in my code If you want to learn more about my capabilities and limitations, check out the Copilot documentation.
I’m powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.
@BanterBoy: - Explain what the script does and why it is useful.
@GitHub Copilot -
Script
Function Get-ADExchangeServer {
[CmdletBinding()]
Param(
[Parameter(Position = 0)]
[Management.Automation.PSCredential]$credential,
[Parameter(Position = 1)]
[String]$server,
[Parameter(Position = 2)]
[String]$siteName
)
Begin {
Function ConvertToExchangeRole {
Param(
[Parameter(Position = 0)]
[int]$roles
)
$roleNumber = @{
2 = 'MBX';
4 = 'CAS';
16 = 'UM';
32 = 'HUB';
64 = 'EDGE';
}
$roleList = New-Object -TypeName Collections.ArrayList
foreach ($key in ($roleNumber).Keys) {
if ($key -band $roles) {
[void]$roleList.Add($roleNumber.$key)
}
}
Write-Output $roleList
}
$adParameters = @{
ErrorAction = 'Stop';
}
$adExchProperties = @(
'msExchCurrentServerRoles',
'networkAddress',
'serialNumber',
'msExchServerSite'
)
}
Process {
Try {
$filter = "objectCategory -eq 'msExchExchangeServer'"
if ($PSBoundParameters.ContainsKey('credential')) {
$adParameters.Add('Credential', $credential)
}
if ($PSBoundParameters.ContainsKey('server')) {
$adParameters.Add('Server', $server)
}
$rootDse = Get-ADRootDse @adParameters
$adParameters.Add('SearchBase', $rootDse.ConfigurationNamingContext)
if ($PSBoundParameters.ContainsKey('siteName')) {
Write-Verbose "Getting Site: $siteName"
$site = Get-ADObject @adParameters `
-Filter "ObjectClass -eq 'site' -and Name -eq '$siteName'"
if (!$site) {
Write-Error "Site not found: [$siteName]" `
-ErrorAction Stop
}
$filter = "$filter -and msExchServerSite -eq '$($site.DistinguishedName)'"
}
$adParameters.Add('Filter', $filter)
$exchServers = Get-ADObject @adParameters `
-Properties $adExchProperties
foreach ($exServer in $exchServers) {
$roles = ConvertToExchangeRole -roles $exServer.msExchCurrentServerRoles
$fqdn = ($exServer.networkAddress |
Where-Object { $_ -like 'ncacn_ip_tcp:*' }).Split(':')[1]
New-Object -TypeName PSObject -Property @{
Name = $exServer.Name;
DnsHostName = $fqdn;
ExchangeVersion = $exServer.serialNumber[0];
ServerRoles = $roles;
DistinguishedName = $exServer.DistinguishedName;
Site = $exServer.msExchServerSite;
}
}
}
Catch {
Write-Error $_
}
}
End {}
}
Function Connect-ExchangeServer {
[CmdletBinding(DefaultParameterSetName = 'enumerate')]
Param(
[Parameter(Position = 0, Mandatory = $true, ParameterSetName = 'name')]
[String]$name,
[Parameter(Position = 0, ParameterSetName = 'Enumerate')]
[Bool]$enumerate = $true,
[Parameter(Position = 1)]
[Management.Automation.PSCredential]$credential,
[Parameter(Position = 2)]
[String]$domainController,
[Parameter(Position = 3, ParameterSetName = 'Enumerate')]
[String]$siteName
)
Begin {
$adParameters = @{
ErrorAction = 'Stop';
}
}
Process {
if ($PSBoundParameters.ContainsKey('credential')) {
$adParameters.Add('credential', $credential)
}
if ($PSBoundParameters.ContainsKey('domainController')) {
$adParameters.Add('server', $domainController)
}
if ($PSBoundParameters.ContainsKey('siteName')) {
$adParameters.Add('siteName', $siteName)
}
Try {
if ($enumerate) {
Write-Verbose "Getting list of Exchange Servers"
$exchServers = Get-ADExchangeServer @adParameters
}
else {
$exchServers = New-Object -TypeName PSObject -Property @{
DnsHostName = $name;
}
}
$winrmParameters = @{
'ErrorAction' = 'Stop';
}
$snParameters = @{
'ErrorAction' = 'Stop';
'ConfigurationName' = 'Microsoft.Exchange';
}
if ($adParameters.credential) {
$snParameters.Add('Credential', $adParameters.Credential)
}
foreach ($exServer in $exchServers) {
Try {
Write-Verbose "Testing WinRm: $($exServer.DnsHostName)"
$winrm = Test-WSMan @winrmParameters `
-ComputerName $exServer.DnsHostName
if ($winrm) {
Write-Verbose "Connecting to: $($exServer.DnsHostName)"
$exSn = New-PSSession @snParameters `
-ConnectionUri "http://$($exServer.DnsHostName)/powershell"
}
return $exSn
}
Catch {
$errMsg = "Server: $($exServer.DnsHostName)] $($_.Exception.Message)"
Write-Error -Message $errMsg
continue
}
}
}
Catch {
Write-Error $_
}
}
End {}
}
Download
Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.
Report Issues
You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.