TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Get-ClientAccessServer

 

Applies to: Exchange Server 2016

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

Use the Get-ClientAccessServer cmdlet to view settings that are associated with the Client Access server role.

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

Get-ClientAccessServer [-Identity <ClientAccessServerIdParameter>] [-DomainController <Fqdn>] [-IncludeAlternateServiceAccountCredentialPassword <SwitchParameter>] [-IncludeAlternateServiceAccountCredentialStatus <SwitchParameter>]

This example returns a summary list of all Exchange servers in your organization that have the Client Access server role installed.

Get-ClientAccessServer

This example returns detailed information for the server mail.contoso.com.

Get-ClientAccessServer -Identity mail.contoso.com | Format-List

The Get-ClientAccessServer cmdlet will be removed in a future version of Exchange. You should use the Get-ClientAccessService cmdlet instead.

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 service 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.ClientAccessServerIdParameter

The Identity parameter specifies the server with the Client Access server role installed that you want to view.

You can use any value that uniquely identifies the server. For example:

  • Name

    Example: Exchange01

  • Distinguished name (DN)

    Example: CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com

  • Exchange Legacy DN

    Example: /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01

  • GUID

    Example: bc014a0d-1509-4ecc-b569-f077eec54942

IncludeAlternateServiceAccountCredentialPassword

Optional

System.Management.Automation.SwitchParameter

The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch.

The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessServer <ServerIdentity> | Format-List AlternateServiceAccountConfiguration.

IncludeAlternateServiceAccountCredentialStatus

Optional

System.Management.Automation.SwitchParameter

The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch.

The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessServer <ServerIdentity> | Format-List AlternateServiceAccountConfiguration.

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:
© 2016 Microsoft