Get-ClientAccessArray

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-ClientAccessArray cmdlet to view legacy RPC Client Access arrays that exist in your Exchange organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ClientAccessArray [-Identity <ClientAccessArrayIdParameter>] [-DomainController <Fqdn>] [-Site <AdSiteIdParameter>]

This example returns a summary list of all Client Access arrays that exist in the local Active Directory site.

Get-ClientAccessArray

This example returns detailed information for the Client Access array named CASArray01.

Get-ClientAccessArray -Identity CASArray01 | Format-List

Client Access arrays were introduced in Exchange Server 2010 so Outlook clients in an Active Directory site could access the Client Access servers in the array by using RPC over TCP to a single, unified fully qualified domain name (FQDN). The RpcClientAccessServer property of new mailbox databases was automatically populated with the FQDN of the Client Access array, and this value was used during the creation of Outlook profiles for mailboxes in those databases.

Changes in the Exchange server architecture that were introduced in Exchange Server 2013 removed the need for RPC Client Access arrays:

  • Outlook clients can't use RPC over TCP to access mailboxes on Exchange Server 2013 or later versions, and RPC Client Access arrays only work with RPC over TCP.

  • Because the Client Access server role is now a stateless proxy, you use different and less complex methods to configure load balancing and high availability for internal and external client connections. For more information, see Load balancing.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Client Access server array settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessArrayIdParameter

The Identity parameter specifies the Client Access that you want to view. You can use any value that uniquely identifies the array. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Site

Optional

Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter

The Site parameter filters the results by Active Directory site. You can use any value that uniquely identifies the site. For example:

  • Name

  • Distinguished name (DN)

  • GUID

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: