Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-09
Use the Set-ClientAccessServer cmdlet to set properties on specified Client Access server objects.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-ClientAccessServer [-AutoDiscoverServiceInternalUri
<Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>]
<COMMON PARAMETERS>
|
Set-ClientAccessServer
[-AlternateServiceAccountCredential <PSCredential[]>]
[-CleanUpInvalidAlternateServiceAccountCredentials
<SwitchParameter>] [-RemoveAlternateServiceAccountCredentials
<SwitchParameter>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: -Identity
<ClientAccessServerIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-IsOutOfService <$true | $false>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example sets two properties on the Client Access server CAS-01.
 Copy Code |
|
|---|---|
Set-ClientAccessServer -Identity "CAS-01" -AutoDiscoverServiceInternalUri "https://cas01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" |
|
EXAMPLE 2
This example sets two properties on the Client Access server CASMail.
| Copy Code |
|
|---|---|
Set-ClientAccessServer -Identity "CASMail" -AutoDiscoverServiceInternalUri "https://casmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" |
|
EXAMPLE 3
This example sets two properties on the Client Access server WebMail.
| Copy Code |
|
|---|---|
Set-ClientAccessServer -Identity "WebMail" -AutoDiscoverServiceInternalUri "https://webmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail" |
|
Detailed Description
You can run the Set-ClientAccessServer cmdlet for a single Client Access server or for all Client Access servers in your Exchange organization.
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 |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter |
The Identity parameter specifies an individual Client Access server. |
|
AlternateServiceAccountCredential |
Optional |
System.Management.Automation.PSCredential[] |
The AlternateServiceAccountCredential parameter specifies a credential (consisting of a user name and password) to distribute to all Client Access servers in an organization. |
|
AutoDiscoverServiceInternalUri |
Optional |
System.Uri |
The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service. |
|
AutoDiscoverSiteScope |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AutoDiscoverSiteScope parameter specifies the site for which the Autodiscover service is authoritative. Clients that connect to the Autodiscover service by using the internal URL must belong to a listed site. |
|
CleanUpInvalidAlternateServiceAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The CleanUpInvalidAlternateServiceAccountCredentials parameter specifies whether to remove a previously set alternate service account credential that's no longer valid. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
IsOutOfService |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
|
RemoveAlternateServiceAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The RemoveAlternateServiceAccountCredentials parameter specifies whether to remove a previously distributed alternate service account credential. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.