Set-ClientAccessServer
Applies to: Exchange Server 2010
Topic Last Modified: 2011-03-19
Use the Set-ClientAccessServer cmdlet to set properties on specified Client Access server objects.
Set-ClientAccessServer -Identity <ClientAccessServerIdParameter> [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Set-ClientAccessServer -Identity <ClientAccessServerIdParameter> [-AlternateServiceAccountCredential <PSCredential[]>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-RemoveAlternateServiceAccountCredentials <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
| 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 an alternate service account credential to add to the Client Access Server. The caller can supply multiple credentials in a single call. Alternate service account credentials are used in configuring Kerberos authentication behind a network load balancer. |
|
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. |
|
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. |
|
RemoveAlternateServiceAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The RemoveAlternateServiceAccountCredentials parameter specifies whether all alternate service account credentials from the Client Access Server are removed. The default value is |
|
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. |
With the Set-ClientAccessServer cmdlet, you can set properties on specified Client Access server objects. You can run this cmdlet for a single Client Access server or all servers running Microsoft Exchange Server 2010 that have the Client Access server role installed in your 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 Client Access Permissions topic.
| Error | Description |
|---|---|
|
|
|
This example sets two properties on the Client Access server CAS-01.
Set-ClientAccessServer -Identity "CAS-01" -AutoDiscoverServiceInternalUri "https://cas01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"
This example sets two properties on the Client Access server CASMail.
Set-ClientAccessServer -Identity "CASMail" -AutoDiscoverServiceInternalUri "https://casmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"
This example sets several properties on the Client Access server WebMail.
Set-ClientAccessServer -Identity "WebMail" -AutoDiscoverServiceInternalUri "https://webmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"
