Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-06
Use the Get-ClientAccessServer cmdlet to return information for the Client Access server.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-ClientAccessServer [-Identity
<ClientAccessServerIdParameter>] [-DomainController
<Fqdn>] [-IncludeAlternateServiceAccountCredentialPassword
<SwitchParameter>]
[-IncludeAlternateServiceAccountCredentialStatus
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example returns information about the Exchange Client Access server with the FQDN of mail.contoso.com.
 Copy Code |
|
|---|---|
Get-ClientAccessServer -Identity "mail.contoso.com" |
|
EXAMPLE 2
This example returns information about all computers running Exchange that have the Client Access server role installed.
| Copy Code |
|
|---|---|
Get-ClientAccessServer |
|
EXAMPLE 3
This example returns information about the Exchange Client Access server with the FQDN of email.fourthcoffee.com.
| Copy Code |
|
|---|---|
Get-ClientAccessServer -Identity "email.fourthcoffee.com" |
|
Detailed Description
The Client Access server is one of two server types that can be installed with Microsoft Exchange Server 2013. The Get-ClientAccessServer cmdlet returns information about all Client Access servers in the organization.
The ExchangeVersion attribute returned is the minimum version of Exchange that you can use to manage the returned object.
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 settings" entry in the Clients and Mobile Devices Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter |
The Identity parameter specifies the name of the Exchange Client Access server. |
|
IncludeAlternateServiceAccountCredentialPassword |
Optional |
System.Management.Automation.SwitchParameter |
The IncludeAlternateServiceAccountCredentialPassword parameter specifies whether the credential password should be included with the request. |
|
IncludeAlternateServiceAccountCredentialStatus |
Optional |
System.Management.Automation.SwitchParameter |
The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether the status of the service account credential should be included with the request. |
Input Types
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.
Return Types
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.