Set-ClientAccessServer
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Set-ClientAccessServer command sets properties on specified Client Access server objects.
Syntax
Set-ClientAccessServer -Identity <ClientAccessServerIdParameter> [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Set-ClientAccessServer [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <ClientAccessServer>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-ClientAccessServer command lets you set properties on specified Client Access server objects. You can run this command for a single Client Access server or all Microsoft Exchange Server 2007 computers that have the Client Access server role installed in your organization.
To run the Set-ClientAccessServer cmdlet, the account you use must be delegated the Exchange Organization Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter |
This parameter specifies an individual Client Access server. |
AutoDiscoverServiceInternalUri |
Optional |
System.Uri |
This parameter specifies the internal URL of the Autodiscover service. |
AutoDiscoverSiteScope |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This 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 site listed here. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.Management.ClientAccessServer |
This parameter specifies an instance of a Client Access server. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $false. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code example sets two properties on the Client Access server that is named CAS-01.
Set-ClientAccessServer -Identity "CAS-01" -AutodiscoverServiceInternalURI "https://cas.mail.contoso.com/autodiscover/autodiscover.xml" -AutodiscoverServiceSiteScope "Mail"