AADConnect-CommunicationsTest.ps1
|
<#PSScriptInfo
.VERSION 4.5 .GUID 98fc7cbf-c135-4928-9cd7-499aea978c76 .DESCRIPTION AAD Communications Test: Use this script to test basic network connectivity to on-premises and online endpoints as well as name resolution. .AUTHOR Aaron Guilmette .COMPANYNAME Microsoft .COPYRIGHT 2022 .TAGS Azure AzureAD Office365 AADConnect seamless sso prerequisites azure ad connect installation .LICENSEURI .PROJECTURI https://www.undocumented-features.com/2018/02/10/aad-connect-network-and-name-resolution-test/ .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES .RELEASENOTES #> <# .SYNOPSIS Test basic system, connectivity, and name resolution compatibility for AAD Connect. Use this script to test basic network connectivity to on-premises and online endpoints as well as name resolution. If you are uncertain about your server's ability to connect to Office 365 for the purposes of deploying Azure AD Connect or to local network resources for configuring a multi-forest deployment, you can attempt to use this tool to report on connectivity and name resolution success/failure. For more information, read the blog at https://www.undocumented-features.com/2018/02/10/aad-connect-network-and-name-resolution-test/ or check out the entire history at https://www.undocumented-features.com/tag/aadnetwork/. .PARAMETER ActiveDirectory Run Active Directory checks (Single Label Domain, NetBIOS domain, AD Recycle Bin enabled, Forest Functional Level) .PARAMETER AllTests Run all tests with default settings (ActiveDirectory, AzureADCredentialCheck, OnlineEndpoints with Commercial endpoints, Network, Dns, SystemConfiguration). Can also set a Boolean FALSE for parameters. .PARAMETER AzureCredentialCheck Check the specified credential for Azure AD suitability (valid password, is a member of global administrators). .PARAMETER DCs Use this parameter to specify DCs to test against. Required if running on- premises network or DNS tests. This is auto-populated from the LOGONSERVER environment variable. If the server is not joined to a domain, populate this attribute with a DC for the domain/forest you will be configuration AAD Connect against. .PARAMETER DebugLogging Enable debug error logging to log file. .PARAMETER Dns Use this parameter to only run on-premises Dns tests. Requires FQDN and DCs parameters to be specified. .PARAMETER FixedDcRpcPort Use this optional parameter to specify a fixed Rpc port for DC communications. See https://support.microsoft.com/en-us/help/224196/restricting-active-directory-rpc-traffic-to-a-specific-port for more information. .PARAMETER InstallModules Use this parameter to install modules used during tests, including MSOnline, NuGet, PowerShell Gallery, Install-Module, and the Remote Server Administration Tools. .PARAMETER Logfile Self-explanatory. .PARAMETER Network Use this parameter to only run local network tests. Requires FQDN and DCs parameters to be specified if they are not automatically populated. They may not be automatically populated if the server running this tool has not been joined to a domain. That is a supported configuration; however, you will need to specify a forest FQDN and at least one DC. .PARAMETER OnlineEndPoints Use this parameter to conduct communication tests against online endpoints. .PARAMETER OnlineEndPointTarget Use this optional parameter to select GCC, Commercial, DOD, or GCC High environments. .PARAMETER OptionalADPortTest Use this optional parameter to specify ports that you may not need for communications. While the public documentation says port 88 is required for Kerberos, it may not be used in certain circumstances (such as adding an AD connector to a remote forest after AAD connect has been intalled). Optional ports include: - 88 (Kerberos) - 636 (Secure LDAP) - 3269 (Secure Global Catalog) You can enable secure LDAP after the AAD Connect installation has completed. .PARAMETER SkipDcDnsPortCheck If you are not using DNS services provided by the AD Site / Logon DC, then you may want to skip checking port 53. You must still be able to resolve ._ldap._tcp.<forestfqdn> in order for the Active Directory Connector configuration to succeed. .PARAMETER SystemConfiguration Report on system configuration items, including installed Windows Features, TLS registry entries and proxy configurations. .EXAMPLE .\AADConnect-CommunicationsTest.ps1 Runs all tests and writes to default log file location (YYYY-MM-DD_AADConnectivity.txt) .EXAMPLE .\AADConnect-CommunicationsTest.ps1 -Dns -Network Runs Dns and Network tests and writes to default log file location (YYYY-MM-DD_AADConnectivity.txt). .EXAMPLE .\AADConnect-CommunicationsTest.ps1 -OnlineEndPoints -OnlineEndPointTarget DOD Runs OnlineEndPoints test using the U.S. Department of Defense online endpoints list and writes to default log file location (YYYY-MM-DD_AADConnectivity.txt). .EXAMPLE .\AADConnect-CommunicationsTest.ps1 -AzureCredentialCheck -Network -DCs dc1.contoso.com -ForestFQDN contoso.com Runs Azure Credential Check and local networking tests using DC dc1.contoso.com and the forest contoso.com and writes to the default log file location (YYYY-MM-DD_AADConnectivity.txt). .EXAMPLE .\AADConnect-CommunicationsTest.ps1 -AllTests -Network:$false Run All system tests using defaults, excluding Network tests. .LINK https://www.undocumented-features.com/2018/02/10/aad-connect-network-and-name-resolution-test/ .LINK https://aka.ms/aadnetwork .NOTES - 2023-02-17 Removed installation for deprecated Microsoft Online Service Sign-In Assistant Staged area for AAD Cloud Sync steps Updated DOD/GCCH endpoints. - 2022-07-18 Updated how local domain controllers are checked Updated DOD/GCCH endpoints. - 2022-04-27 Updated additional password reset endpoints (@debatermsft). Updated RODC check syntax (@debatermsft). Resolved error when querying for Azure AD role status (@debatermsft). - 2022-01-22 Added updated checks for DCOM, Trusted Sites for MFA, Execution Policy - 2021-11-28 Added endpoint ssprdedicatedsbprodscu.servicebus.windows.net to GCC/Commercial for SSPR, per Didier Akakpo - 2021-07-21 Updated to support Hybrid Identity Administrator role. Updated to reflect Windows Server 2016 minimum version requirement. - 2021-04-30 Updated Commercial/GCCM endpoints. - 2020-04-29 Updated DOD/GCCH endpoints. Added check for RODCs in current site. - 2020-04-03 Rebranded as v4 and uploaded to PowerShellGallery.com - 2020-01-28 Updated endpoints. Updated to retrieve Azure AD Tenant ID for checking <tenantid>.registration.appproxy.net. Added Windows2016Forest forest mode to system configuration function. Cleaned up some error handling. - 2019-05-07 Updated to skip ActiveDirectory checks if ForestFQDN and DCs values are empty and can't be calculated. Updated logging for desktop/client versions in System Configuration. - 2019-03-13 Resolved issue with Azure credential check not running automatically. Resolved issue with Azure credential not displaying the user identity. Resolved issue with 'optional' network services testing in OnlineEndPoints test. - 2019-03-12 Restructured how parameters are processed using PSBoundParameters. Removed SkipAzureADCredentialCheck parameter. Added additional error trapping around Resolve-DnsName. Refreshed endpoints for AAD. Added AllTests parameter. AllTests also supports setting specific tests to Boolean FALSE. - 2018-10-28 Updated InstallModules param checking. - 2018-10-24 Initial release checking RSOP data for PowerShell Transcription GPO. - 2018-09-14 Added check for installation edition (server, server core, client, nano) based on https://docs.microsoft.com/en-us/windows/desktop/CIMWin32Prov/win32-operatingsystem. - 2018-08-30 Added -InstallModules switch. - 2018-07-30 Removed single-label domain references. - 2018-07-23 Added supported AD forest modes in System Configruation. Added AD Recycle Bin configuration check. Added ActiveDirectory parameter. - 2018-07-17 Updated Commerical/GCC endpoints: $CRL += http://ocsp.msocsp.com $RequiredResources += adminwebservice-s1-co2.microsoftonline.com $RequiredResourcesEndpoints += https://adminwebservice-s1-co2.microsoftonline.com/provisioningwebservice.svc - 2018-06-15 Fixed Windows 2016 detection display issue. Fixed issue querying PowerShell Transcription. - 2018-06-14 Updated query for system.net/defaultproxy/proxy. Added reg key for Wow6432Node/SchUseStrongCrypto for TLS 1.2. Added OS-specific support for determining .NET versions. Added OS-specific registry keys to test for TLS 1.2 configuration. - 2018-04-05 Removed proxy.cloudwebappproxy.net from Seamless SSO endpoint test. - 2018-04-03 Updated endpoints for Seamless SSO. - 2018-04-03 Added endpoints management.core.windows.net, s1.adhybridhealth.azure.com - 2018-04-02 Added endpoints for Seamless SSO. - 2018-02-16 Added optional port for Secure Global Catalog (3269) - 2018-02-14 Added FixedDcRpcPort, OptionalADPortTest, SystemConfiguration parameters - 2018-02-14 Added test for servicebus.windows.net to online endpoints - 2018-02-14 Expanded system configuration tests to capture TLS 1.2 configuration - 2018-02-14 Expanded system configuration tests to capture required server features - 2018-02-13 Added OnlineEndPointTarget parameter for selecting Commercial, GCC, DOD, or GCC high. - 2018-02-13 Added proxy config checks. - 2018-02-12 Added additional CRL/OCSP endpoints for Entrust and Verisign. - 2018-02-12 Added additional https:// test endpoints. - 2018-02-12 Added DebugLogging parameter and debug logging data. - 2018-02-12 Added extended checks for online endpoints. - 2018-02-12 Added check for Azure AD credential (valid/invalid password, is Global Admin) - 2018-02-12 Updated parameter check when running new mixes of options. - 2018-02-11 Added default values for ForestFQDN and DCs. - 2018-02-11 Added SkipDcDnsPortCheck parameter. - 2018-02-10 Resolved issue where tests would run twice under some conditions. - 2018-02-09 Initial release. #> param ( [switch]$ActiveDirectory, [switch]$AllTests, [switch]$AzureCredentialCheck, [Parameter(HelpMessage = "Specify the azure credential to check in the form of user@domain.com or user@tenant.onmicrosoft.com")]$Credential, [switch]$CloudSync, [array]$DCs, [switch]$DebugLogging, [switch]$Dns, [int]$FixedDcRpcPort, [string]$ForestFQDN, [switch]$InstallModules, [string]$Logfile = (Get-Date -Format yyyy-MM-dd) + "_AADConnectConnectivity.txt", [switch]$Network, [switch]$OnlineEndPoints, [ValidateSet("Commercial","DOD","GCC","GCCHigh")] [string]$OnlineEndPointTarget = "Commercial", [switch]$OptionalADPortTest, [ValidateSet("PasswordWriteBack")][string[]]$OptionalFeatureCheck, [switch]$SkipDcDnsPortCheck, [switch]$SystemConfiguration ) $Version = "4.0" # Hide the test-netconnection progress meter $ExistingProgressPreference = $ProgressPreference $global:ProgressPreference = 'SilentlyContinue' # If no DCs are supplied and no LOGON server value is available, then set # $ActiveDirectory to $false and exclude ActiveDirectory from executed tests If (!$DCs) { If ($env:LOGONSERVER -and $env:USERDNSDOMAIN) { # Original way $DCs = @() $DCs += (Get-ChildItem Env:\Logonserver).Value.ToString().Trim("\") + "." + (Get-ChildItem Env:\USERDNSDOMAIN).Value.ToString() # Added 2022-07-18 $CurrentSite = [System.DirectoryServices.ActiveDirectory.ActiveDirectorySite]::GetComputerSite().Name $DCs += (Get-ADDomainController -Filter {Site -eq $CurrentSite }).HostName $DCs = $DCs.ToLower() | Sort -Unique } Else { $ActiveDirectory = $false } } # If no ForestFQDN is supplied, check for it. If UserDnsDomain isn't populated, # set $ActiveDirectory to $false and exclude ActiveDirectory from executed tasks If (!$ForestFQDN) { If ($env:USERDNSDOMAIN) { $ForestFQDN = (Get-ChildItem Env:\USERDNSDOMAIN).Value.ToString() } Else { $ActiveDirectory = $false } } ## Functions # Logging function function Write-Log([string[]]$Message, [string]$LogFile = $Script:LogFile, [switch]$ConsoleOutput, [ValidateSet("SUCCESS", "INFO", "WARN", "ERROR", "DEBUG")][string]$LogLevel) { $Message = $Message + $Input If (!$LogLevel) { $LogLevel = "INFO" } switch ($LogLevel) { SUCCESS { $Color = "Green" } INFO { $Color = "White" } WARN { $Color = "Yellow" } ERROR { $Color = "Red" } DEBUG { $Color = "Gray" } } if ($Message -ne $null -and $Message.Length -gt 0) { $TimeStamp = [System.DateTime]::Now.ToString("yyyy-MM-dd HH:mm:ss") if ($LogFile -ne $null -and $LogFile -ne [System.String]::Empty) { Out-File -Append -FilePath $LogFile -InputObject "[$TimeStamp] [$LogLevel] $Message" } if ($ConsoleOutput -eq $true) { Write-Host "[$TimeStamp] [$LogLevel] :: $Message" -ForegroundColor $Color } } } # Test Office 365 Credentials function AzureCredential { If ($SkipAzureCredentialCheck) { "Skipping Azure AD Credential Check due to parameter."; Continue} Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting Office 365 global administrator and credential tests." If (!$Credential) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Credential required to validate Office 365 credentials. Enter global admin credential." $Credential = Get-Credential -Message "Office 365 Global Administrator" } # Attempt MSOnline installation Try { MSOnline } Catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to proceed with MSOnline check. Please install the Microsoft Online Services Module separately and re-run the script." -ConsoleOutput } # Attempt to log on as user try { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Attempting logon as $($Credential.UserName) to Azure Active Directory." $LogonResult = Connect-MsolService -Credential $Credential -ErrorAction Stop If (!($LogonResult)) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Successfully logged on to Azure Active Directory as $($Credential.UserName)." -ConsoleOutput ## Attempt to check membership in Global Admins, which is labelled as "Company Administrator" in the tenant ## Added "Hybrid Identity Administrator" as of 2021-07-21 [array]$RoleId = Get-MsolRole -RoleName "Company Administrator" | Select ObjectId,Name $RoleId += Get-MsolRole -RoleName "Hybrid Identity Administrator" | Select ObjectId,Name $Qualified = $false foreach ($Role in $RoleId) { If ((Get-MsolRoleMember -RoleObjectId $Role.ObjectId).EmailAddress -match "\b$($Credential.UserName)") { $Qualified = $True Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "User $($Credential.UserName) is a member of $($Role.Name) and can successfully configure AAD Connect." -ConsoleOutput } } If ($Qualified = $True) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "User $($Credential.Username) is a member of a supported installation group." -ConsoleOutput } Else { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "User $($Credential.UserName) is not a member of a supported installation group. In order for AAD Connect installation and configuration to be successful, the user must have either the the Global Administrator (also referred to as Company Administrator) or Hybrid Identity Administrator role granted in Office 365. Grant the appropriate access or select another user account to test." -ConsoleOutput } } Else { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to verify logon to Azure Active Directory as $($Credential.UserName)." -ConsoleOutput } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to log on to Azure Active Directory as $($Credential.UserName). Check $($Logfile) for additional details." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } # Attempt to get Tenant ID $AzureADModules = @(Get-Module -ListAvailable AzureAD*) If ($AzureADModules.Count -ge 1) { try { Import-Module $AzureADModules[0] $AADLogonResult = Connect-AzureAD -Credential $Credential -ea Stop -LogLevel None if ($AADLogonResult.TenantID) { $TenantID = "$($AADLogonResult.TenantId).registration.msappproxy.net" Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Azure AD Tenant ID is: $($TenantID)." } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception while attempting to log onto Azure AD to retrieve tenant ID. Exception data:" Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } } } # End Function AzureCredential # Test for/install MSOnline components function MSOnline { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Checking Microsoft Online Services Module." If (!(Get-Module -ListAvailable MSOnline -ea silentlycontinue) -and $InstallModules) { # Check if Elevated $wid = [system.security.principal.windowsidentity]::GetCurrent() $prp = New-Object System.Security.Principal.WindowsPrincipal($wid) $adm = [System.Security.Principal.WindowsBuiltInRole]::Administrator if ($prp.IsInRole($adm)) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -ConsoleOutput -Message "Elevated PowerShell session detected. Continuing." } else { Write-Log -LogFile $Logfile -LogLevel ERROR -ConsoleOutput -Message "This application/script must be run in an elevated PowerShell window. Please launch an elevated session and try again." Break } Write-Log -LogFile $Logfile -LogLevel INFO -ConsoleOutput -Message "This requires the Microsoft Online Services Module. Attempting to download and install." ## Deprecated Sign-In Assistant # wget https://download.microsoft.com/download/5/0/1/5017D39B-8E29-48C8-91A8-8D0E4968E6D4/en/msoidcli_64.msi -OutFile $env:TEMP\msoidcli_64.msi # If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Installing Sign-On Assistant." } # msiexec /i $env:TEMP\msoidcli_64.msi /quiet /passive # Installing Package Management Components If (!(Get-Command Install-Module)) { wget https://download.microsoft.com/download/C/4/1/C41378D4-7F41-4BBE-9D0D-0E4F98585C61/PackageManagement_x64.msi -OutFile $env:TEMP\PackageManagement_x64.msi } If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Installing PowerShellGet Supporting Libraries." } msiexec /i $env:TEMP\PackageManagement_x64.msi /qn If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Installing PowerShellGet Supporting Libraries (NuGet)." } Install-PackageProvider -Name Nuget -MinimumVersion 2.8.5.201 -Force -Confirm:$false # Installing Microsoft Online Services Module If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Installing Microsoft Online Services Module." } Install-Module MSOnline -Confirm:$false -Force If (!(Get-Module -ListAvailable MSOnline)) { Write-Log -LogFile $Logfile -LogLevel ERROR -ConsoleOutput -Message "This Configuration requires the MSOnline Module. Please download from https://connect.microsoft.com/site1164/Downloads/DownloadDetails.aspx?DownloadID=59185 and try again." Break } } If (Get-Module -ListAvailable MSOnline) { Import-Module MSOnline -Force } Else { Write-Log -LogFile $Logfile -LogLevel ERROR -ConsoleOutput -Message "This Configuration requires the MSOnline Module. Please download from https://connect.microsoft.com/site1164/Downloads/DownloadDetails.aspx?DownloadID=59185 and try again." } # Check for Azure AD Module Write-Log -LogFile $Logfile -LogLevel INFO -Message "Checking for Microsoft Azure AD Module." if (!($Result = Get-Module -ListAvailable AzureAD*)) { try { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Attempting to install Azure AD Module." Install-Module AzureAD -Force -SkipPublisherCheck -ea stop } catch { Write-Log -LogFile $Logfile -Message $_.Exception.Message.ToString() -LogLevel ERROR } } Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished Microsoft Online Service Module check." } # End Function MSOnline # Test Online Networking Only function OnlineEndPoints { switch -regex ($OnlineEndPointTarget) { 'commercial|gcc' { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting Online Endpoints tests (Commercial/GCC)." Write-Log -LogFile $Logfile -LogLevel INFO -Message "See https://support.office.com/en-us/article/office-365-urls-and-ip-address-ranges-8548a211-3fe7-47cb-abb1-355ea5aa88a2" Write-Log -LogFile $Logfile -LogLevel INFO -Message "for more details on Commercial/GCC endpoints." $CRL = @( "http://crl3.digicert.com", # Added 2021-04-30 "http://crl4.digicert.com", # Added 2021-04-30 "http://crl.microsoft.com/pki/crl/products/microsoftrootcert.crl", "http://mscrl.microsoft.com/pki/mscorp/crl/msitwww2.crl", "http://ocsp.entrust.net", "http://ocsp.msocsp.com", "http://ocsp.verisign.com", "http://ocsp.digicert.com", # Added 2021-04-30 "http://oneocsp.microsoft.com", # Added 2021-04-30 "http://root-c3-ca2-2009.ocsp.d-trust.net" # Added 2021-04-30 ) $RequiredResources = @( "aadcdn.msauth.net", "aadcdn.msauthimages.net", # added 2022-04-27 "aadcdn.msftauth.net", "adminwebservice.microsoftonline.com", #"adminwebservice-s1-co2.microsoftonline.com", # Removed 2020-01-28 "api.passwordreset.microsoftonline.com", # Self-service Password Reset, added 2020-01-28 #"bba800-anchor.microsoftonline.com", # Removed 2020-01-28 "becws.microsoftonline.com", # added 2020-01-28 "ccscdn.msauth.net", "ccscdn.msftauth.net", "graph.windows.net", "login.microsoftonline.com", "login.windows.net", "management.core.windows.net", "passwordreset.microsoftonline.com" # added 2022-04-27 "provisioningapi.microsoftonline.com", "secure.aadcdn.microsoftonline-p.com", # also required for MFA "sts.windows.net" # added 2021-04-30 ) $RequiredResourcesEndpoints = @( "https://adminwebservice.microsoftonline.com/provisioningservice.svc", # "https://adminwebservice-s1-co2.microsoftonline.com/provisioningservice.svc", # Removed 2020-01-28 "https://login.microsoftonline.com", "https://login.windows.net", "https://provisioningapi.microsoftonline.com/provisioningwebservice.svc", "https://secure.aadcdn.microsoftonline-p.com/ests/2.1.5975.9/content/cdnbundles/jquery.1.11.min.js" ) $OptionalResources = @( "account.activedirectory.windowsazure.com", # myapps portal, added 2020-01-28 "adds.aadconnecthealth.azure.com", "adhsprodwusehsyncia.servicebus.windows.net", # Azure AD health, added 2022-04-27 "adhsprodwusaadsynciadata.blob.core.windows.net", # Azure AD health, added 2022-04-27 "autoupdate.msappproxy.net", "clientconfig.microsoftonline-p.net", # added 2020-01-28 "enterpriseregistration.windows.net", # device registration "management.azure.com", # Azure AD SSPR requirement identified "management.core.windows.net", # Azure AD health, added 2021-04-30 "policykeyservice.dc.ad.msft.net", # Azure AD health agent "pfd.phonefactor.net", # MFA, added 2021-04-30 "prdf.aadg.msidentity.com", # added 2022-04-27 "s1.adhybridhealth.azure.com", "ssprdedicatedsbprodscu.servicebus.windows.net", # Self Service Password Reset Writeback, added 2021-11-28 "www.tm.f.prd.aadg.trafficmanager.net" # myapps, added 2022-04-27 ) $OptionalResourcesEndpoints = @( "https://device.login.microsoftonline.com", # Hybrid device registration "https://ssprdedicatedsbprodscu.servicebus.windows.net", # added 2022-04-27 "https://policykeyservice.dc.ad.msft.net/clientregistrationmanager.svc" ) $SeamlessSSOEndpoints = @( "autologon.microsoftazuread-sso.com", "aadg.windows.net.nsatc.net", "0.register.msappproxy.net", "0.registration.msappproxy.net", "proxy.cloudwebappproxy.net" ) # Tenant Registration Endpoint If ($TenantID) { $SeamlessSSOEndpoints += $Tenant } # Added 2020-01-28 # Use the AdditionalResources array to specify items that need a port test on a port other # than 80 or 443. $AdditionalResources = @( # "watchdog.servicebus.windows.net:5671" # Removed 2020-01-28 ) } 'dod|gcchigh' { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting Online Endpoints tests (DOD)." Write-Log -LogFile $Logfile -LogLevel INFO -Message "See https://support.office.com/en-us/article/office-365-u-s-government-dod-endpoints-5d7dce60-4892-4b58-b45e-ee42fe8a907f" Write-Log -LogFile $Logfile -LogLevel INFO -Message "for more details on DOD/GCCHigh endpoints." $CRL = @( "http://ocsp.msocsp.com", "https://mscrl.microsoft.com/pki/mscorp/crl/msitwww2.crl", "http://crl.microsoft.com/pki/crl/products/microsoftrootcert.crl", "http://ocsp.verisign.com", "http://ocsp.entrust.net" ) $RequiredResources = @( "aadcdn.msauth.net", # have not verified "aadcdn.msauthimages.net", # added 2022-04-27 "aadcdn.msftauth.net", # have not verified "aadcdn.msftauthimages.us", # added 2023-02-17 "adminwebservice.gov.us.microsoftonline.com", "adminwebservice-s1-bn1a.microsoftonline.com", "becws.gov.us.microsoftonline.com," # added 2020-01-28 "ccscdn.msauth.net", # have not verified "ccscdn.msftauth.net", # have not verified "clientconfig.microsoftonline-p.net", # added 2020-01-28 "dod-graph.microsoft.us", # added 2020-01-28 "adminwebservice-s1-dm2a.microsoftonline.com", "graph.microsoftazure.us", # added 2020-01-28 "graph.windows.net", "login.microsoftonline.us", "login.microsoftonline.com", "login.microsoftonline-p.com", "loginex.microsoftonline.com", "login-us.microsoftonline.com", "login.windows.net", "mscrl.microsoft.com", # added 2023-02-17, not sure why since CRL lookups should be done on p80 "nexus.microsoftonline-p.com", # added 2023-02-17 "passwordreset.activedirectory.windowsazure.us", # added 2022-07-18, per Matt Nimke #"passwordreset.microsoftonline.com", # added 2022-04-27, removed 2022-07-18 "provisioningapi.gov.us.microsoftonline.com", "provisioningapi-s1-dm2a.microsoftonline.com", "provisioningapi-s1-dm2r.microsoftonline.com", "secure.aadcdn.microsoftonline-p.com", "ssprdedicatedsbprodscu.servicebus.windows.net" # added 2022-04-27 ) $RequiredResourcesEndpoints = @( "https://adminwebservice.gov.us.microsoftonline.com/provisioningservice.svc", "https://adminwebservice-s1-bn1a.microsoftonline.com/provisioningservice.svc", "https://adminwebservice-s1-dm2a.microsoftonline.com/provisioningservice.svc", "https://login.microsoftonline.us" "https://login.microsoftonline.com", "https://loginex.microsoftonline.com", "https://login-us.microsoftonline.com", "https://login.windows.net", "https://provisioningapi.gov.us.microsoftonline.com/provisioningwebservice.svc", "https://provisioningapi-s1-dm2a.microsoftonline.com/provisioningwebservice.svc", "https://provisioningapi-s1-dm2r.microsoftonline.com/provisioningwebservice.svc", "https://secure.aadcdn.microsoftonline-p.com/ests/2.1.5975.9/content/cdnbundles/jquery.1.11.min.js" ) # These optional endpoints are newly listed for DOD/GCCHigh $OptionalResources = @( "management.azure.com", "policykeyservice.aadcdi.azure.us" # Azure AD Connect Health # ,"enterpriseregistration.windows.net" # Not currently listed for DOD/GCCH ) $OptionalResourcesEndpoints = @( "https://policykeyservice.aadcdi.azure.us/clientregistrationmanager.svc" # Azure AD Connect Health # ,"https://enterpriseregistration.windows.net" # Not currently listed for DOD/GCCH ) # Use the AdditionalResources array to specify items that need a port test on a port other # than 80 or 443. $AdditionalResources = @( # "watchdog.servicebus.windows.net:5671" # ServiceBus endpoints no longer needed ) #> } } # CRL Endpoint tests Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing CRL endpoint tests (Invoke-WebRequest)." -ConsoleOutput foreach ($url in $CRL) { try { $Result = Invoke-WebRequest -Uri $url -ea stop -wa silentlycontinue Switch ($Result.StatusCode) { 200 { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Successfully obtained CRL from $($url)." -ConsoleOutput } 400 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Bad request." -ConsoleOutput; } 401 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Unauthorized." -ConsoleOutput; } 403 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Forbidden." -ConsoleOutput; } 404 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Not found." -ConsoleOutput; } 407 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Proxy authentication required." -ConsoleOutput; } 502 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Bad gateway (likely proxy)." -ConsoleOutput; } 503 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Service unavailable (transient, try again)." -ConsoleOutput; } 504 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to obtain CRL from $($url): Gateway timeout (likely proxy)." -ConsoleOutput; } default { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to obtain CRL from $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($Result)" } } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception: Unable to obtain CRL from $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusCode Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusDescription If ($Result.RawContent.Length -lt 400) { $DebugContent = $Result.RawContent -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent } Else { $DebugContent = $Result.RawContent.Substring(0, 400) -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent } } } } # End Foreach CRL # Required Resource tests Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Required Resources (TCP:443)." -ConsoleOutput foreach ($url in $RequiredResources) { try { [array]$ResourceAddresses = (Resolve-DnsName $url -ErrorAction stop).IP4Address } catch { $ErrorMessage = $_; Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to resolve host $($url)." -ConsoleOutput; Write-Log -LogFile $Logfile -LogLevel ERROR -Message $($ErrorMessage); Continue } foreach ($ip4 in $ResourceAddresses) { try { $Result = Test-NetConnection $ip4 -Port 443 -ea stop -wa silentlycontinue switch ($Result.TcpTestSucceeded) { true { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($url) [$($ip4)]:443 successful." -ConsoleOutput } false { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "TCP connection to $($url) [$($ip4)]:443 failed." -ConsoleOutput; } } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Error resolving or connecting to $($url) [$($ip4)]:443" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url) [$($Result.RemoteAddress)]:443." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($url)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } } # End Foreach Resources # Option Resources tests Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Optional Resources (TCP:443)." -ConsoleOutput foreach ($url in $OptionalResources) { try { [array]$ResourceAddresses = (Resolve-DnsName $url -ErrorAction stop).IP4Address } catch { $ErrorMessage = $_; Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to resolve host $($url)." -ConsoleOutput; Write-Log -LogFile $Logfile -LogLevel ERROR -Message $($ErrorMessage); Continue } foreach ($ip4 in $ResourceAddresses) { try { $Result = Test-NetConnection $ip4 -Port 443 -ea stop -wa silentlycontinue switch ($Result.TcpTestSucceeded) { true { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($url) [$($ip4)]:443 successful." -ConsoleOutput } false { Write-Log -LogFile $Logfile -LogLevel WARN -Message "TCP connection to $($url) [$($ip4)]:443 failed." -ConsoleOutput; If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $($Result) } } } } catch { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Error resolving or connecting to $($url) [$($ip4)]:443" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel WARN -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url) [$($Result.RemoteAddress)]:443." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($url)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } } # End Foreach OptionalResources # Required Resources Endpoints tests Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Required Resources Endpoints (Invoke-Webrequest)." -ConsoleOutput foreach ($url in $RequiredResourcesEndpoints) { try { $Result = Invoke-WebRequest -Uri $url -ea stop -wa silentlycontinue Switch ($Result.StatusCode) { 200 { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Successfully connected to $($url)." -ConsoleOutput } 400 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Bad request." -ConsoleOutput; } 401 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Unauthorized." -ConsoleOutput; } 403 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Forbidden." -ConsoleOutput; } 404 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Not found." -ConsoleOutput; } 407 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Proxy authentication required." -ConsoleOutput; } 502 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Bad gateway (likely proxy)." -ConsoleOutput; } 503 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Service unavailable (transient, try again)." -ConsoleOutput; } 504 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Gateway timeout (likely proxy)." -ConsoleOutput; } default { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "OTHER: Failed to contact $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($Result)" -ConsoleOutput } } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception: Unable to contact $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusCode Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusDescription If ($Result.RawContent.Length -lt 400) { $DebugContent = $Result.RawContent -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent } Else { $DebugContent = $Result.RawContent -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent.Substring(0, 400) } } } } # End Foreach RequiredResourcesEndpoints # Optional Resources Endpoints tests Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Optional Resources Endpoints (Invoke-Webrequest)." -ConsoleOutput foreach ($url in $OptionalResourcesEndpoints) { try { $Result = Invoke-WebRequest -Uri $url -ea stop -wa silentlycontinue Switch ($Result.StatusCode) { 200 { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Successfully connected to $($url)." -ConsoleOutput } 400 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Bad request." -ConsoleOutput; } 401 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Unauthorized." -ConsoleOutput; } 403 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Forbidden." -ConsoleOutput; } 404 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Not found." -ConsoleOutput; } 407 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Proxy authentication required." -ConsoleOutput; } 502 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Bad gateway (likely proxy)." -ConsoleOutput; } 503 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Service unavailable (transient, try again)." -ConsoleOutput; } 504 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Failed to contact $($url): Gateway timeout (likely proxy)." -ConsoleOutput; } default { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "OTHER: Failed to contact $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($Result)" -ConsoleOutput } } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception: Unable to contact $($url)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusCode Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $Result.StatusDescription If ($Result.RawContent.Length -lt 400) { $DebugContent = $Result.RawContent -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent } Else { $DebugContent = $Result.RawContent -join ";" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DebugContent.Substring(0, 400) } } } } # End Foreach RequiredResourcesEndpoints # Seamless SSO Endpoints Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Seamless SSO Endpoints (TCP:443)." -ConsoleOutput foreach ($url in $SeamlessSSOEndpoints) { try { [array]$ResourceAddresses = (Resolve-DnsName $url -ErrorAction stop).IP4Address } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to resolve host $($url)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" Continue } foreach ($ip4 in $ResourceAddresses) { try { $Result = Test-NetConnection $ip4 -Port 443 -ea stop -wa silentlycontinue switch ($Result.TcpTestSucceeded) { true { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($url) [$($ip4)]:443 successful." -ConsoleOutput } false { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "TCP connection to $($url) [$($ip4)]:443 failed." -ConsoleOutput; } } } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Error resolving or connecting to $($url) [$($ip4)]:443" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($url) [$($Result.RemoteAddress)]:443." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($url)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } } # End Foreach Resources # Additional Resources tests If ($AdditionalResources) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Testing Additional Resources Endpoints (Invoke-Webrequest)." -ConsoleOutput foreach ($url in $AdditionalResources) { if ($url -match "\:") { $Name = $url.Split(":")[0] try { [array]$Resources = (Resolve-DnsName $Name -ErrorAction stop).IP4Address } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to resolve host $($Name)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" Continue } #[array]$Resources = (Resolve-DnsName $Name).Ip4Address $ResourcesPort = $url.Split(":")[1] } Else { $Name = $url try { [array]$Resources = (Resolve-DnsName $Name -ErrorAction stop).IP4Address } catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to resolve host $($url)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" Continue } #[array]$Resources = (Resolve-DnsName $Name).IP4Address $ResourcesPort = "443" } foreach ($ip4 in $Resources) { try { $Result = Test-NetConnection $ip4 -Port $ResourcesPort -ea stop -wa silentlycontinue switch ($Result.TcpTestSucceeded) { true { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($Name) [$($ip4)]:$($ResourcesPort) successful." -ConsoleOutput } false { Write-Log -LogFile $Logfile -LogLevel WARN -Message "TCP connection to $($Name) [$($ip4)]:$($ResourcesPort) failed." -ConsoleOutput If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $($Result) } } } } catch { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Error resolving or connecting to $($Name) [$($ip4)]:$($ResourcesPort)" -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel WARN -Message "$($_.Exception.Message)" } finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($Name) [$($Result.RemoteAddress)]:443." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($Name)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } # End ForEach ip4 } # End ForEach AdditionalResources } # End IF AdditionalResources Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished Online Endpoints tests." } # End Function OnlineEndPoints # Test for Optional Feature availability function OptionalFeatureCheck { If (!$Credential) { $Credential = Get-Credential -Message "Office 365 Global Administrator account" } If (!(Get-Module MSOnline)) { Import-Module MSOnline } else { try { $Result = Get-Command Get-MsolAccountSku -ea Stop } catch { Write-Log -LogFile ERROR -ConsoleOutput -LogLevel ERROR -Message "$($_.Exception.Message)" } } If (!($Result)) { Connect-MsolService -Credential $Credential } switch ($OptionalFeatureCheck) { "PasswordWriteBack" { [array]$Skus = Get-MsolAccountSku [array]$SkusWithAADPremiumServicePlan = @() foreach ($Sku in $Skus) { if ($Sku.ServiceStatus.ServicePlan.ServiceName -match "AAD_PREMIUM") { $SkusWithAADPremiumServicePlan += $Sku.SkuPartNumber } } If ($SkusWithAADPremiumServicePlan) { $SkusWithAADPremiumServicePlan | % { Write-Log -LogFile $Logfile -LogLevel INFO -Message "$($_) contains an Azure AD Premium Service to enable Password Write Back."} } } } } # End function OptionalFeatureCheck # Test Local Networking Only function Network { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting local network port tests." -ConsoleOutput If (!$DCs) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "If testing on-premises networking, you must specify at least one on-premises domain controller." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel INFO -Message "You can skip this test in the future with the parameter: -Network:`$false" -ConsoleOutput } Else { Foreach ($Destination in $DCs) { foreach ($Port in $Ports) { Try { $Result = (Test-NetConnection -ComputerName $Destination -Port $Port -ea Stop -wa SilentlyContinue) Switch ($Result.TcpTestSucceeded) { True { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($Destination):$($Port) succeeded." -ConsoleOutput } False { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "TCP connection to $($Destination):$($Port) failed." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$Result" } } # End Switch } Catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception: Error attempting TCP connection to $($Destination):$($Port)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } Finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($Destination) [$($Result.RemoteAddress)]:$($Port)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($Destination)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } # End Foreach Port in Ports foreach ($Port in $OptionalADPorts) { Try { $Result = (Test-NetConnection -ComputerName $Destination -Port $Port -ea Stop -wa SilentlyContinue) Switch ($Result.TcpTestSucceeded) { True { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "TCP connection to $($Destination):$($Port) succeeded." -ConsoleOutput } False { Write-Log -LogFile $Logfile -LogLevel WARN -Message "TCP connection to $($Destination):$($Port) failed." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel WARN -Message "$Result" } } # End Switch } Catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Error attempting TCP connection to $($Destination):$($Port)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } Finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($Destination) [$($Result.RemoteAddress)]:$($Port)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote endpoint: $($Destination)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Remote port: $($Result.RemotePort)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Interface Alias: $($Result.InterfaceAlias)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Source Interface Address: $($Result.SourceAddress.IPAddress)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Succeeded: $($Result.PingSucceeded)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) Status: $($Result.PingReplyDetails.Status)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Ping Reply Time (RTT) RoundTripTime: $($Result.PingReplyDetails.RoundtripTime)" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "TCPTestSucceeded: $($Result.TcpTestSucceeded)" } } } # End Foreach Port in OptionalADPorts } # End Foreach Destination Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished local network port tests." } } # End Function Network # Test local DNS resolution for domain controllers function Dns { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting local DNS resolution tests." If (!$ForestFQDN) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Local Dns resolution, you must specify for Active Directory Forest FQDN." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel INFO -Message "Local Dns resolution, you must specify for Active Directory Forest FQDN." -ConsoleOutput } If (!$DCs) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Local DNS resolution testing requires the DCs parameter to be specified." -ConsoleOutput Break } # Attempt DNS Resolution $DnsTargets = @("_ldap._tcp.$ForestFQDN") + $DCs Foreach ($HostName in $DnsTargets) { Try { $DnsResult = (Resolve-DnsName -Type ANY $HostName -ea Stop -wa SilentlyContinue) If ($DnsResult.Name) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Successfully resolved $($HostName)." -ConsoleOutput } Else { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Error attempting DNS resolution for $($HostName)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message $DnsResult } } Catch { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Exception: Error attempting DNS resolution for $($HostName)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "$($_.Exception.Message)" } Finally { If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "Debug log entry for $($HostName)." Write-Log -LogFile $Logfile -LogLevel DEBUG -Message $DnsResult } } } Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished local DNS resolution tests." } # End function Dns function ActiveDirectory { # Install if -InstallModules switch was used If (!(Get-Module -ListAvailable ActiveDirectory) -and $InstallModules) { # Check if Elevated $wid = [system.security.principal.windowsidentity]::GetCurrent() $prp = New-Object System.Security.Principal.WindowsPrincipal($wid) $adm = [System.Security.Principal.WindowsBuiltInRole]::Administrator if ($prp.IsInRole($adm)) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -ConsoleOutput -Message "Elevated PowerShell session detected. Continuing." } else { Write-Log -LogFile $Logfile -LogLevel ERROR -ConsoleOutput -Message "This application/script must be run in an elevated PowerShell window. Please launch an elevated session and try again." Break } Try { $Result = Add-WindowsFeature Rsat-Adds } Catch { Write-Log -LogFile $Logfile -ConsoleOutput -Message "Error adding Windows Feature Rsat-Adds." Write-Log -LogFile $Logfile -Message "Exception: $($_.Exception.Message)" } Finally { Switch ($Result.Success) { True { Write-Log -LogFile $Logfile -ConsoleOutput -LogLevel SUCCESS -Message "Remote Server Administration Tools for Active Directory Domain Services installation completed successfully." } False { Write-Log -LogFile $Logfile -ConsoleOutput -Loglevel ERROR -Message "Remote Server Administration Tools for Active Directory Domain Services installation failed." } } } } If (Get-Module -ListAvailable ActiveDirectory) { Write-Log -LogFile $Logfile -Loglevel INFO -Message "Starting Active Directory tests." # Forest Configuration [string]$ForestMode = (Get-ADForest $ForestFQDN).ForestMode switch ($ForestMode) { Windows2000Forest { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Forest is Windows 2000 mode. Unsupported. Upgrade forest functional level." -ConsoleOutput } Windows2003Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2003 mode. Supported." } Windows2003InterimForest { Write-Log -Logfile $Logfile -Loglevel ERROR -Message "Windows Server 2003 interim function mode. Unsupported. Upgrade forest functional level." } Windows2008Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2008 mode. Supported." } Windows2008R2Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2008 R2 mode. Supported." } Windows2012R2Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2012 R2 mode. Supported." } Windows8Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows 8 mode. Supported." } Windows2012Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2012 Mode. Supported." } Windows2016Forest { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Forest is Windows Server 2016 Mode. Supported."} } # Forest and domain character checks [string]$ForestNetBIOS = (Get-ADForest $ForestFQDN).NetBIOSName [string]$DomainNetBIOS = (Get-ADDomain).NetBIOSName If ($ForestNetBIOS -match "\." -or $DomainNetBIOS -match "\.") { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Domain NetBIOS name contains a period. AAD Connect is not supported in this environment (though it may be installed)." -ConsoleOutput } Else { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Domain NetBIOS name does not contain a period. Passed." } # AD Recycle Bin If (Get-Command Get-ADOptionalFeature -ea silentlycontinue) { $RecycleBin = (Get-ADOptionalFeature -Filter { name -eq "Recycle Bin Feature" }) } If (!($RecycleBin.EnabledScopes)) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "AD Recycle Bin IS NOT ENABLED. It is recommended to enable the AD Recycle Bin." Write-Log -LogFile $Logfile -LogLevel INFO -Message "To enable, run Enable-ADOptionalFeature -'Recycle Bin Feature' -Scope ForestOrConfigurationSet -Target $($ForestFQDN)" } Else { Write-Log -LogFile $Logfile -LogLevel INFO -Message "AD Recycle Bin is ENABLED." } # Check for Read-Only Domain Controllers $CurrentSite = [System.DirectoryServices.ActiveDirectory.ActiveDirectorySite]::GetComputerSite().Name # 2022-04-27 update $RODCsInSite = @(Get-ADDomainController -Discover -SiteName $CurrentSite | ? {$_.IsReadOnly -eq $true}) # Deprecated 2022-04-27 # $RODCsInSite = @(Get-ADDomainController -Filter {Site -eq "$CurrentSite" -and IsReadOnly -eq $true}) If ($RODCcsInSite -ge 1) { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Current site may contain Read-Only Domain Controllers. Read-Only Domain Controllers are not permitted for writeback operations or Password Hash Sync. Please verify if any DCs in the site $($CurrentSite) are Read-Only Domain Controllers." } } Else { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Active Directory Module is not loaded. Please install using Install-WindowsFeature RSAT-ADDS or the -InstallModules switch." } } # End function ActiveDirectory # Test suitability for Azure AD Cloud Sync forthcoming function CloudSync { # Check for RSAT modules # Check for DC at least 2012 R2 # Check PowerShell Execution Policy # Notify to create a hybrid identity administrator account } # End function CloudSync function SystemConfiguration { ## Show system configuration Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting system configuration gathering." [string]$OSVersion = ([System.Environment]::OSVersion.Version.Major.ToString() + "." + [System.Environment]::OSVersion.Version.Minor.ToString()) [string]$OperatingSystem = (Get-WmiObject -Class Win32_OperatingSystem -Namespace "root\cimv2").Caption [string]$OSBitness = [System.Environment]::Is64BitOperatingSystem [string]$OSMachineName = [System.Environment]::MachineName.ToString() [string]$OperatingSystemSKU = (Get-WmiObject -Class Win32_OperatingSystem).OperatingSystemSKU Write-Log -LogFile $Logfile -LogLevel INFO -Message "System name: $($OSMachineName)" Write-Log -LogFile $Logfile -LogLevel INFO -Message "64-bit operating system detected: $($OSBitness)" Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System: $($OperatingSystem) $($OSVersion)" Switch ($OperatingSystemSKU) { 0 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Undefined. Unable to determine operating system type. Azure AD Connect installation will probably fail." } 1 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Ultimate. Installation not supported." } 2 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Home Basic Edition. Installation not supported." } 3 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Home Premium Edition. Installation not supported." } 4 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Enterprise Edition. Installation not supported." } 6 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Business Edition. Installation not supported." } 7 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Standard Server. Installation may be supported if the Operating System version is supported." } 8 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Datacenter Server. Installation may be supported if the Operating System version is supported." } 9 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Small Business Server. Installation not supported." } 10 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Enterprise Server. Installation may be supported if the Operating System version is supported." } 11 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Starter. Installation not supported." } 12 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Datacenter Server Core. Installation not supported." } 13 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Standard Server Core. Installation not supported." } 14 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Enterprise Server Core. Installation not supported." } 17 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Web Server. Installation not supported." } 19 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Home Server. Installation not supported." } 20 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Express Server. Installation not supported." } 21 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Standard Server. Installation not supported." } 22 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Workgroup Server. Installation not supported." } 23 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Enterprise Server. Installation not supported." } 24 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Server for Small Business. Installation not supported." } 25 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Small Business Server Premium. Installation not supported." } 27 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Enterprise N. Installation not supported." } 28 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Ultimate N. Installation not supported." } 29 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Web Server Core. Installation not supported." } 36 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Standard Server (without Hyper-V). Installation may be supported if Operating System version is supported." } 37 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Datacenter Server (without Hyper-V). Installation may be supported if Operating System version is supported." } 38 { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Operating System Edition is Enterprise Server (without Hyper-V). Installation may be supported if Operating System version is supported." } 39 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Datacenter Core Server (without Hyper-V). Installation not supported." } 40 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Standard Core Server (without Hyper-V). Installation not supported." } 41 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Enterprise Core Server (without Hyper-V). Installation not supported." } 42 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Hyper-V Server. Installation not supported." } 43 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Server Express (Server Core). Installation not supported." } 44 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Server Standard (Server Core). Installation not supported." } 45 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Server Workgroup (Server Core). Installation not supported." } 45 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Storage Server Enterprise (Server Core). Installation not supported." } 50 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Server Essentials. Installation not supported." } 63 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Small Business Server Premium (Server Core). Installation not supported." } 64 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Computer Cluster Server (without Hyper-V). Installation not supported." } 97 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Windows RT. Installation not supported." } 101 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Home. Installation not supported." } 103 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Professional with Media Center. Installation not supported." } 104 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Mobile. Installation not supported." } 123 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is IoT (Internet of Things) Core. Installation not supported." } 143 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Datacenter Server (Nano). Installation not supported." } 144 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Standard Server (Nano). Installation not supported." } 147 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Datacenter Server (Server Core). Installation not supported." } 148 { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Operating System Edition is Standard Server (Server Core). Installation not supported." } default {Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Unable to determine Operating System Edition SKU value."} } If ($OSVersion -lt 10.0) { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Operating system version is less than 10.p (Windows Server 2016). AAD Connect versions later that 2.0.3.0 are not supported." -ConsoleOutput } # Netsh WinHTTP proxy Write-Log -LogFile $Logfile -LogLevel INFO -Message "WinHTTP proxy settings (netsh winhttp show proxy):" $WinHTTPProxy = (netsh winhttp show proxy) $WinHTTPProxy = ($WinHTTPProxy -join " ").Trim() Write-Log -LogFile $Logfile -LogLevel INFO -Message $WinHTTPProxy # .NET Proxy Write-Log -LogFile $Logfile -LogLevel INFO -Message ".NET proxy settings (machine.config/configuration/system.net/defaultproxy):" [xml]$machineconfig = gc $env:windir\Microsoft.NET\Framework64\v4.0.30319\Config\machine.config if (!$machineconfig.configuration.'system.net'.defaultproxy) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "No proxy configuration exists in $env:windir\Microsoft.NET\Framework64\v4.0.30319\Config\machine.config." } else { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The following proxy configuration exists in $env:windir\Microsoft.NET\Framework64\v4.0.30319\Config\machine.config." $nodes = $machineconfig.ChildNodes.SelectNodes("/configuration/system.net/defaultproxy/proxy") | Sort -Unique Write-Log -Logfile $Logfile -LogLevel INFO -Message "UseSystemDefault: $($nodes.usesystemdefault)" Write-Log -LogFile $Logfile -LogLevel INFO -Message "ProxyAddress: $($nodes.proxyaddress)" Write-Log -LogFile $Logfile -LogLevel INFO -Message "BypassOnLocal $($nodes.bypassonlocal)" } Write-Log -LogFile $Logfile -LogLevel INFO -Message "For more .NET proxy configuration parameters, see https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/network/proxy-element-network-settings" # .NET Framework Versions $NetFrameWorkVersion = (Get-ItemProperty "HKLM:SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\" -ErrorAction SilentlyContinue).Release.ToString() switch ($NetFrameWorkVersion) { { $NetFrameWorkVersion -ge 461808 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.7.2 or greater.";Break } { $NetFrameWorkVersion -ge 461308 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.7.1 or greater."; Break } { $NetFrameWorkVersion -ge 460798 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.7 or greater."; Break } { $NetFrameWorkVersion -ge 394802 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.6.2 or greater."; Break } { $NetFrameWorkVersion -ge 394254 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.6.1 or greater."; Break } { $NetFrameWorkVersion -ge 393295 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.6 or greater."; Break } { $NetFrameWorkVersion -ge 379893 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.5.2 or greater."; Break } { $NetFrameWorkVersion -ge 378675 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.5.1 or greater."; Break } { $NetFrameWorkVersion -ge 378389 } { Write-Log -LogFile $Logfile -LogLevel INFO -Message "The version of .NET Framework installed is 4.5 or greater." Write-Log -LogFile $Logfile -LogLevel WARN -Message "In order to install AAD Connect, upgrade to at least .NET Framework 4.5.1."; Break } default { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Unable to determine version of .NET Framework. AAD Connect requires .NET Framework 4.5.1 or greater."; Break} } # Check service packs $ServicePack = (Get-ItemProperty "HKLM\Software\Microsoft\Windows NT\CurrentVersion" -ea silentlycontinue).ServicePack switch ($OSVersion) { "6.1" { If (!$ServicePack) { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Windows Server 2008 R2 requires Service Pack 1 if Password Hash Synchronization will be used."; } } default { Write-Log -LogFile $Logfile -LogLevel INFO -Message "No service packs are required for this version of Windows."} } # Check PowerShell Versions switch ($OSVersion) { "6.0" { If ($PSVersionTable.Major -lt 3) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Windows Server 2008 requires Windows Management Framework 3.0 or higher."; } } "6.1" { If ($PSVersionTable.Major -lt 4) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Windows Server 2008 R2 requires Windows Management Framework 4.0 or higher."; } } "6.2" { If ($PSVersionTable.Major -lt 4) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Windows Server 2012 requires Windows Management Framework 4.0 or higher."; } } "10.0" { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Windows Server 2016 or Windows Server 2019 have the required PowerShell version."} } # Server Features parameters Write-Log -LogFile $Logfile -LogLevel INFO -Message "Attempting to check installed features." If (Get-Command Get-WindowsFeature -ErrorAction SilentlyContinue) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Command available. Checking installed features." $ServerFeatures = Get-WindowsFeature | ? { $_.Name -eq 'Server-Gui-Mgmt-Infra' -or ` $_.Name -eq 'Server-Gui-Shell' -or ` $_.Name -eq 'NET-Framework-45-Features' -or ` $_.Name -eq 'NET-Framework-45-Core' } foreach ($Feature in $ServerFeatures) { switch ($Feature.InstallState) { Installed { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Required feature $($Feature.DisplayName) [$($Feature.Name)] is installed." } Available { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Required feature $($Feature.DisplayName) [$($Feature.Name)] is not installed." } } # End Switch FeatureIsInstalled } # End Foreach Feature Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished checking installed features." } # End Server Feaatures Else { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Command not available. Unable to check installed features." } # Check for TLS capabilities switch ($OSVersion) { "10.0" { switch -regex ($OperatingSystem) { "(?i)(Server)" { Write-Log -Logfile $Logfile -ConsoleOutput -LogLevel INFO -Message "Checking TLS settings for Windows Server 2016 and Windows Server 2019." $KeysArray = @( @{ Path = "HKLM:SOFTWARE\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" } ) } default { Write-Log -LogFile $Logfile -ConsoleOutput -LogLevel INFO -Message "Desktop operating system is not a candidate for AAD Connect Installation." } } } # End 10.0 / Windows Server 2016 / 2019 "6.3" { Write-Log -Logfile $Logfile -ConsoleOutput -LogLevel INFO -Message "Checking TLS settings for Windows Server 2012 R2." $KeysArray = @( @{ Path = "HKLM:SOFTWARE\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" } ) } # End 6.3 / Windows Server 2012 R2 "6.2" { Write-Log -Logfile $Logfile -ConsoleOutput -LogLevel INFO -Message "Checking TLS settings for Windows Server 2012." $KeysArray = @( @{ Path = "HKLM:SOFTWARE\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" } ) } # End 6.2 / Windows Server 2012 "6.1" { Write-Log -Logfile $Logfile -ConsoleOutput -LogLevel INFO -Message "Checking TLS settings for Windows Server 2008 R2." $KeysArray = @( @{ Path = "HKLM:SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Client"; Item = "DisabledByDefault"; Type = "REG_DWORD"; Value = "0" }, @{ Path = "HKLM:SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Client"; Item = "Enabled"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Server"; Item = "DisabledByDefault"; type = "REG_DWORD"; Value = "0" }, @{ Path = "HKLM:SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Server"; Item = "Enabled"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SOFTWARE\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" }, @{ Path = "HKLM:SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319"; Item = "SchUseStrongCrypto"; type = "REG_DWORD"; Value = "1" } ) } # End 6.1 / Windows Server 2008 R2 "6.0" { Write-Log -Logfile $Logfile -ConsoleOutput -LogLevel INFO -Message "Checking TLS settings for Windows Server 2008." Write-Log -LogFile $Logfile -ConsoleOutput -LogLevel WARN -Message "TLS 1.2 cannot be enabled on Windows Server 2008." } # End 6.0 / Windows Server 2008 default { Write-Log -LogFile $Logfile -ConsoleOutput -LogLevel WARN -Message "Unable to determine Windows Version. TLS checks will be skipped." } } If ($KeysArray) { foreach ($Key in $KeysArray) { try { $Result = (Get-ItemProperty -erroraction SilentlyContinue $Key.Path).$($Key.Item).ToString() If ($Result) { If ($Result -match $Key.Value) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) with a value of $($Key.Value) is set correctly for TLS 1.2 Configuration." } Else { $RegKeyPath = ($Key.Path).Replace(":", "\") Write-Log -LogFile $Logfile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) with a value of $($Key.Value) is not set correctly for TLS 1.2 Configuration." Write-Log -LogFile $LogFile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) must be set to $($Key.Value) for TLS 1.2 support." Write-Log -LogFile $Logfile -LogLevel INFO -Message "To configure, run: REG ADD ""$($RegKeyPath)"" /v $($Key.Item) /d $($Key.Value) /t REG_DWORD /f" Write-Log -LogFile $Logfile -LogLevel INFO -Message "or us Set-ADSyncToolsTls12 to enable TLS 1.2" } } Else { $RegKeyPath = ($Key.Path).Replace(":", "\") Write-Log -LogFile $Logfile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) not found." Write-Log -LogFile $LogFile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) must be set to $($Key.Value) for TLS 1.2 support." Write-Log -LogFile $Logfile -LogLevel INFO -Message "To configure, run: REG ADD ""$($RegKeyPath)"" /v $($Key.Item) /d $($Key.Value) /t REG_DWORD /f" Write-Log -LogFile $Logfile -LogLevel INFO -Message "or us Set-ADSyncToolsTls12 to enable TLS 1.2" } } Catch { $RegKeyPath = ($Key.Path).Replace(":", "\") Write-Log -LogFile $Logfile -LogLevel INFO -Message "Exception or $($Key.Path)\$($Key.Item) not found." Write-Log -LogFile $LogFile -LogLevel INFO -Message "Key $($Key.Path)\$($Key.Item) must be set to $($Key.Value) for TLS 1.2 support." Write-Log -LogFile $Logfile -LogLevel INFO -Message "To configure, run: REG ADD ""$($RegKeyPath)"" /v $($Key.Item) /d $($Key.Value) /t REG_DWORD /f" Write-Log -LogFile $Logfile -LogLevel INFO -Message "or us Set-ADSyncToolsTls12 to enable TLS 1.2" } } Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished checking for TLS 1.2 Configuration settings." Write-Log -LogFile $Logfile -LogLevel INFO -Message "If you need to update the TLS 1.2 configuration, you can use the Set-ADSyncToolsTls12 cmdlet." } # Check Group Policy PowerShell Transcription has been enabled Try { $GPOTranscription = (Get-ItemProperty "HKLM:SOFTWARE\Policies\Microsoft\Windows\PowerShell\Transcription\" -ErrorAction SilentlyContinue).EnableTranscripting.ToString() } Catch { } If ($GPOTranscription) { switch ($GPOTranscription) { 0 { $Value = "disabled" }; 1 { $Value = "enabled" } } Write-Log -LogFile $Logfile -LogLevel ERROR -Message "PowerShell transcription is configured through Group Policy. The current value is $($GPOTranscription) ($($Value))." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel ERROR -Message "PowerShell transcription group policy must be set to 'Disabled' or 'Not Configured' or the installation process will fail." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel INFO -Message "PowerShell transcription detected. Attempting to determine which policy has it enabled." -ConsoleOutput # Check if Elevated $wid = [system.security.principal.windowsidentity]::GetCurrent() $prp = New-Object System.Security.Principal.WindowsPrincipal($wid) $adm = [System.Security.Principal.WindowsBuiltInRole]::Administrator if ($prp.IsInRole($adm)) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -ConsoleOutput -Message "Elevated PowerShell session detected. Continuing." $RsopFile = (Get-Date -Format yyyy-MM-dd) + "_AADConnectConnectivityRSOP.txt" gpresult /f /SCOPE Computer /X $RsopFile [xml]$Rsop = gc $RsopFile [array]$data = ($Rsop.Rsop.ComputerResults | ? { $_.InnerXml -like '*transcription*' } | Select -ExpandProperty GPO).Name foreach ($policy in $data) { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "The Group Policy Object $policy has a value configured for Turn on PowerShell Transcription. This will cause AAD Connect installation to fail." -ConsoleOutput} } else { Write-Log -LogFile $Logfile -LogLevel ERROR -ConsoleOutput -Message "Unable to export group policy information without elevation. Please launch an elevated session and try again." } } If (!$GPOTranscription) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "PowerShell transcription is not configured." } # Check for Trusted Sites Configuration, 2022-01-22 Function RecursiveRegQuery() { param ( [Parameter(Mandatory = $true)] [String]$ComputerName, [Parameter(Mandatory = $true)] [String]$RegPath, [String]$BaseKey ) $RegKeyFields = "KeyName", "ValueName", "Value"; [System.Collections.ArrayList]$RegKeysArray = $RegKeyFields; $Reg = [Microsoft.Win32.RegistryKey]::OpenRemoteBaseKey($BaseKey, $ComputerName) $RegKey = $Reg.OpenSubKey($RegPath); Function EnumKey() { param ( [Parameter(Mandatory = $true)] [AllowNull()] [AllowEmptyString()] [Microsoft.Win32.RegistryKey]$Key ) if ($Key.SubKeyCount -eq 0) { Foreach ($value in $Key.GetValueNames()) { if ($null -ne $Key.GetValue($value)) { $item = New-Object psobject; $item | Add-Member -NotePropertyName "KeyName" -NotePropertyValue $Key.Name; $item | Add-Member -NotePropertyName "ValueName" -NotePropertyValue $value.ToString(); $item | Add-Member -NotePropertyName "Value" -NotePropertyValue $Key.GetValue($value); [void]$RegKeysArray.Add($item); } } } else { if ($Key.ValueCount -gt 0) { Foreach ($value in $Key.GetValueNames()) { if ($null -ne $Key.GetValue($value)) { $item = New-Object PSObject; $item | Add-Member -NotePropertyName "KeyName" -NotePropertyValue $Key.Name; $item | Add-Member -NotePropertyName "ValueName" -NotePropertyValue $value.ToString(); $item | Add-Member -NotePropertyName "Value" -NotePropertyValue $Key.GetValue($value); [void]$RegKeysArray.Add($item); } } } # Recurse if ($Key.SubKeyCount -gt 0) { ForEach ($subKey in $Key.GetSubKeyNames()) { EnumKey -Key $Key.OpenSubKey($subKey); } } } } EnumKey -Key $RegKey $Reg.Close(); return $RegKeysArray; } $TrustedSitesData = @() $TrustedSitesData += RecursiveRegQuery -ComputerName $(hostname) -RegPath "Software\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains" -BaseKey CurrentUser $TrustedSitesData += RecursiveRegQuery -ComputerName $(hostname) -RegPath "Software\Policies\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains" -BaseKey CurrentUser $TrustedSitesData += RecursiveRegQuery -ComputerName $(hostname) -RegPath "Software\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains" -BaseKey LocalMachine $TrustedSitesData += RecursiveRegQuery -ComputerName $(hostname) -RegPath "Software\Policies\Microsoft\Windows\CurrentVersion\Internet Settings\ZoneMap\Domains" -BaseKey LocalMachine $Trusted = $TrustedSitesData | ? { ($_.KeyName -match "microsoftonline-p.com") -and ($_.KeyName -match "*" -or $_.KeyName -match "aadcdn") -and $_.Value -eq "2"} If (!$Trusted) { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Trusted sites does not appear to contain https://secure.aadcdn.microsoftonline-p.com. If installation will use an account that has MFA enabled, this site must be added to the Trusted Sites list." } Else {Write-Log -LogFile $Logfile -LogLevel INFO -Message "Trusted sites appears to contain https://secure.aadcdn.microsoftonline-p.com. MFA-enabled Global Admin can be used for installation."} # Check Ole reg property existence, 2022-01-22 $DefaultLaunchPermission = (Get-ItemProperty -Path HKLM:\Software\Microsoft\Ole -Name DefaultLaunchPermission -ea silentlycontinue).DefaultLaunchPermission $MachineAccessRestriction = (Get-ItemProperty -Path HKLM:\Software\Microsoft\Ole -Name MachineAccessRestriction -ea silentlycontinue).MachineAccessRestriction $MachineLaunchRestriction = (Get-ItemProperty -Path HKLM:\Software\Microsoft\Ole -Name MachineLaunchRestriction -ea silentlycontinue).MachineLaunchRestriction If ($DefaultLaunchPermission) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Microsoft Ole DefaultLaunchPermission value appears to be present." } Else {Write-Log } { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Microsoft Ole DefaultLaunchPermission value appears to be missing or invalid. Please verify before installation." -ConsoleOutput } If ($MachineAccessRestriction) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Microsoft Ole MachineAccessRestriction value appears to be present." } Else { Write-Log } { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Microsoft Ole MachineAccessRestriction value appears to be missing or invalid. Please verify before installation." -ConsoleOutput } If ($DefaultLaunchPermission) { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Microsoft Ole MachineLaunchRestriction value appears to be present." } Else { Write-Log } { Write-Log -LogFile $Logfile -LogLevel ERROR -Message "Microsoft Ole MachineLaunchRestriction value appears to be missing or invalid. Please verify before installation." -ConsoleOutput } # Check for Execution policy, 2022-01-22 $ExecutionPolicy = Get-ExecutionPolicy switch ($ExecutionPolicy) { "AllSigned" { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy). Installation may encounter errors." -ConsoleOutput } "Bypass" { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy)." } "RemoteSigned" { Write-Log -LogFile $Logfile -LogLevel SUCCESS -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy)." } "Restricted" { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy). Installation may encounter errors." -ConsoleOutput } "Undefined" { Write-Log -LogFile $Logfile -LogLevel WARN -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy). Installation may encounter errors." -ConsoleOutput } "Unrestricted" { Write-Log -LogFile $Logfile -LogLevel INFO -Message "Recommended PowerShell Execution Policy is 'RemoteSigned.' Current execution policy is $($ExecutionPolicy)." } } Write-Log -LogFile $Logfile -LogLevel INFO -Message "Finished gathering system configuration." } # End Function System Configuration ## Begin script Write-Log -LogFile $Logfile -LogLevel INFO -Message "=========================================================" Write-Log -LogFile $Logfile -LogLevel INFO -Message "Starting AAD Connect system requirement check." # If SkipDcDnsPortCheck is enabled, remove 53 from the list of ports to test on DCs If ($SkipDcDnsPortCheck) { $Ports = @('135', '389', '445', '3268') } Else { $Ports = @('53', '135', '389', '445', '3268') } # Use this switch if a statically configured Rpc port for AD traffic has been configured # on the target DC. This port may be called for Password Hash Sync configuration. If ($FixedDcRpcPort) { $Ports += $FixedDcRpcPort Write-Log -LogFile $Logfile -LogLevel INFO -Message "Port $($FixedDcRpcPort) will be tested as part of the DC/local network test." If ($DebugLogging) { Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "For more information on configuring a fixed RPC port for DC communications, please see" Write-Log -LogFile $Logfile -LogLevel DEBUG -Message "https://support.microsoft.com/en-us/help/224196/restricting-active-directory-rpc-traffic-to-a-specific-port" } } # Use the OptionalADPortTest switch to add the following ports: 88, 636, 3269 # In order to use ports 636 and 3269, domain controllers must be configured with a # valid server certificate. See https://social.technet.microsoft.com/wiki/contents/articles/18254.ldaps-636-and-msft-gc-ssl-3269-service.aspx # and https://social.technet.microsoft.com/wiki/contents/articles/2980.ldap-over-ssl-ldaps-certificate.aspx. If ($OptionalADPortTest) { $OptionalADPorts += @('88', '636','3269') } If ($AllTests -or $PSBoundParameters.Count -eq 0) { If (!$PSBoundParameters.ContainsKey("AzureCredentialCheck")) { $AzureCredentialCheck = $true } If (!$PSBoundParameters.ContainsKey("Dns")) { $Dns = $true } If (!$PSBoundParameters.ContainsKey("Network")) { $Network = $true } If (!$PSBoundParameters.ContainsKey("OnlineEndPoints")) { $OnlineEndPoints = $true } If (!$PSBoundParameters.ContainsKey("ActiveDirectory")) { $ActiveDirectory = $true } If (!$PSBoundParameters.ContainsKey("SystemConfiguration")) { $SystemConfiguration = $true } If (!$PSBoundParameters.ContainsKey("OptionalFeatureCheck")) { $OptionalFeatureCheck = "PasswordWriteBack"} } If ($AzureCredentialCheck) { AzureCredential } If ($CloudSync) { CloudSync } If ($Dns) { Dns } If ($Network) { Network } If ($OnlineEndPoints) { OnlineEndPoints } If ($OptionalFeatureCheck) { OptionalFeatureCheck } If ($ActiveDirectory) { ActiveDirectory } If ($SystemConfiguration) { SystemConfiguration } Write-Log -LogFile $Logfile -LogLevel INFO -Message "Done! Logfile is $($Logfile)." -ConsoleOutput Write-Log -LogFile $Logfile -LogLevel INFO -Message "---------------------------------------------------------" |