Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-16
Use the Set-ClientAccessArray cmdlet to specify an object that represents a load-balanced array of Client Access servers within a single Active Directory site.
Syntax
Set-ClientAccessArray -Identity
<ClientAccessArrayIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Fqdn
<Fqdn>] [-Name <String>] [-Site
<AdSiteIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The Set-ClientAccessArray cmdlet configures a load-balanced array of Client Access servers within an Active Directory site.
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 array settings" entry in the Client Access Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.ClientAccessArrayIdParameter |
The Identity parameter specifies the unique identifier of the Client Access server array. |
|
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. |
|
Fqdn |
Optional |
Microsoft.Exchange.Data.Fqdn |
The Fqdn parameter specifies the FQDN of the Client Access server array. |
|
Name |
Optional |
System.String |
The Name parameter specifies the name of the Client Access server array. |
|
Site |
Optional |
Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter |
The Site parameter specifies the Active Directory site that contains the Client Access server array. |
|
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.
Examples
EXAMPLE 1
This example names the Client Access server array CASArray.
 Copy Code |
|
|---|---|
Set-ClientAccessArray -Identity "ContosoArray" -Name "CASArray" |
|
EXAMPLE 2
This example returns the Client Access server array associated with the site for the FQDN mail.contoso.com.
| Copy Code |
|
|---|---|
Set-ClientAccessArray -Identity "ContosoArray" -FQDN "mail.contoso.com" |
|
EXAMPLE 3
This example associates the existing array object ContosoArray with the Active Directory site SiteEU.
| Copy Code |
|
|---|---|
Set-ClientAccessArray -Identity "ContosoArray" -Site "SiteEU" |
|