TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Set-ClientAccessServer

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-ClientAccessServer cmdlet to modify the client access configuration settings on Mailbox servers.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-ClientAccessServer [-Array <ClientAccessArrayIdParameter>] [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] <COMMON PARAMETERS>

Set-ClientAccessServer [-AlternateServiceAccountCredential <PSCredential[]>] [-CleanUpInvalidAlternateServiceAccountCredentials <SwitchParameter>] [-RemoveAlternateServiceAccountCredentials <SwitchParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: -Identity <ClientAccessServerIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example configures the internal Autodiscover URL for the Active Directory site named Mail in the client access services on the server named MBX-01.

Set-ClientAccessServer -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"

The Set-ClientAccessServer cmdlet will be removed in a future version of Exchange. You should use the Set-ClientAccessService cmdlet instead.

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 service settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter

The Identity parameter specifies the server that you want to modify. You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • FQDN

  • GUID

AlternateServiceAccountCredential

Optional

System.Management.Automation.PSCredential[]

The AlternateServiceAccountCredential parameter specifies a credential an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments.

This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential.

Array

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessArrayIdParameter

This parameter is reserved for internal Microsoft use.

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 Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site.

To see the available Active Directory sites, use the Get-ADSite cmdlet.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

CleanUpInvalidAlternateServiceAccountCredentials

Optional

System.Management.Automation.SwitchParameter

The CleanUpInvalidAlternateServiceAccountCredentials switch specifies whether to remove a previously configured alternate service account that's no longer valid. You don't need to specify a value with this switch.

Confirm

Optional

System.Management.Automation.SwitchParameter

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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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.

RemoveAlternateServiceAccountCredentials

Optional

System.Management.Automation.SwitchParameter

The RemoveAlternateServiceAccountCredentials switch specifies whether to remove a previously distributed alternate service account. You don't need to specify a value with this switch.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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.

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.

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.

 
Show:
© 2016 Microsoft