enable-ExchangeOnPremEntireForest.ps1

<#
    .SYNOPSIS
 
    This function ensures that view entire forest is set to TRUE for exchange on premsies connections.
     
    .DESCRIPTION
 
    This function ensures that view entire forest is set to TRUE for exchange on premsies connections.
 
    .OUTPUTS
 
    None
 
    .EXAMPLE
 
    enable-ExchangeOnPremEntireForest -isAudit:$TRUE
 
    #>

    Function enable-ExchangeOnPremEntireForest
     {
        Param
        (
            [Parameter(Mandatory = $false)]
            [boolean]$isAudit=$FALSE
        )

        #Output all parameters bound or unbound and their associated values.

        write-functionParameters -keyArray $MyInvocation.MyCommand.Parameters.Keys -parameterArray $PSBoundParameters -variableArray (Get-Variable -Scope Local -ErrorAction Ignore)
        
        #Declare function variables.

        #Start function processing.

        Out-LogFile -string "********************************************************************************"
        Out-LogFile -string "BEGIN enable-ExchangeOnPremEntireForest"
        Out-LogFile -string "********************************************************************************"

        try {
            out-logfile -string "Attempting to set view entire forest = TRUE."

            Set-ADServerSettings -ViewEntireForest:$TRUE -ErrorAction STOP
        }
        catch {
            out-logfile -string "Unable to set the entire forest settings to true."
            out-logfile -string $_ -isError:$TRUE -isAudit $isAudit
        }

        Out-LogFile -string "END enable-ExchangeOnPremEntireForest"
        Out-LogFile -string "********************************************************************************"
    }