Set-ClientAccessArray

This cmdlet is available only in Exchange Server 2010. 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. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Set-ClientAccessArray
   [-Identity] <ClientAccessArrayIdParameter>
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Fqdn <Fqdn>]
   [-Name <String>]
   [-Site <AdSiteIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Set-ClientAccessArray -Identity "ContosoArray" -Name "CASArray"

This example names the Client Access server array CASArray.

-------------------------- Example 2 --------------------------

Set-ClientAccessArray -Identity "ContosoArray" -FQDN "mail.contoso.com"

This example returns the Client Access server array associated with the site for the FQDN mail.contoso.com.

-------------------------- Example 3 --------------------------

Set-ClientAccessArray -Identity "ContosoArray" -Site "SiteEU"

This example associates the existing array object ContosoArray with the Active Directory site SiteEU.

Required Parameters

-Identity

The Identity parameter specifies the unique identifier of the Client Access server array.

Type:ClientAccessArrayIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010

Optional Parameters

-Confirm

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-DomainController

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-Fqdn

The Fqdn parameter specifies the FQDN of the Client Access server array.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-Name

The Name parameter specifies the name of the Client Access server array.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-Site

The Site parameter specifies the Active Directory site that contains the Client Access server array.

Type:AdSiteIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010
-WhatIf

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.