Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-12-11

Use the Set-ClientAccessServer cmdlet to set properties on specified Client Access server objects.

Syntax


Set-ClientAccessServer -Identity <ClientAccessServerIdParameter> [-AutoDiscoverServiceInternalUri <Uri>] [-AutoDiscoverSiteScope <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IrmLogEnabled <$true \| $false>] [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] [-IsOutOfService <$true \| $false>] [-MigrationLogFilePath <LocalLongFullPath>] [-MigrationLogLoggingLevel <None \| Error \| Warning \| Information \| Verbose>] [-MigrationLogMaxAge <EnhancedTimeSpan>] [-MigrationLogMaxDirectorySize <ByteQuantifiedSize>] [-MigrationLogMaxFileSize <ByteQuantifiedSize>] [-WhatIf [<SwitchParameter>]]

Set-ClientAccessServer -Identity
<ClientAccessServerIdParameter>
[-AutoDiscoverServiceInternalUri <Uri>]
[-AutoDiscoverSiteScope <MultiValuedProperty>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-IrmLogEnabled <$true | $false>] [-IrmLogMaxAge
<EnhancedTimeSpan>] [-IrmLogMaxDirectorySize
<Unlimited>] [-IrmLogMaxFileSize <ByteQuantifiedSize>]
[-IrmLogPath <LocalLongFullPath>] [-IsOutOfService <$true
| $false>] [-MigrationLogFilePath <LocalLongFullPath>]
[-MigrationLogLoggingLevel <None | Error | Warning | Information
| Verbose>] [-MigrationLogMaxAge <EnhancedTimeSpan>]
[-MigrationLogMaxDirectorySize <ByteQuantifiedSize>]
[-MigrationLogMaxFileSize <ByteQuantifiedSize>] [-WhatIf
[<SwitchParameter>]]


Set-ClientAccessServer -Identity <ClientAccessServerIdParameter> [-AlternateServiceAccountCredential <PSCredential[]>] [-CleanUpInvalidAlternateServiceAccountCredentials <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IrmLogEnabled <$true \| $false>] [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] [-IsOutOfService <$true \| $false>] [-MigrationLogFilePath <LocalLongFullPath>] [-MigrationLogLoggingLevel <None \| Error \| Warning \| Information \| Verbose>] [-MigrationLogMaxAge <EnhancedTimeSpan>] [-MigrationLogMaxDirectorySize <ByteQuantifiedSize>] [-MigrationLogMaxFileSize <ByteQuantifiedSize>] [-RemoveAlternateServiceAccountCredentials <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Set-ClientAccessServer -Identity
<ClientAccessServerIdParameter>
[-AlternateServiceAccountCredential <PSCredential[]>]
[-CleanUpInvalidAlternateServiceAccountCredentials
<SwitchParameter>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-IrmLogEnabled <$true |
$false>] [-IrmLogMaxAge <EnhancedTimeSpan>]
[-IrmLogMaxDirectorySize <Unlimited>] [-IrmLogMaxFileSize
<ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>]
[-IsOutOfService <$true | $false>] [-MigrationLogFilePath
<LocalLongFullPath>] [-MigrationLogLoggingLevel <None |
Error | Warning | Information | Verbose>] [-MigrationLogMaxAge
<EnhancedTimeSpan>] [-MigrationLogMaxDirectorySize
<ByteQuantifiedSize>] [-MigrationLogMaxFileSize
<ByteQuantifiedSize>]
[-RemoveAlternateServiceAccountCredentials <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]

Detailed Description

You can run the Set-ClientAccessServer cmdlet for a single Client Access server or for 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.

Parameters

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 a credential (consisting of a user name and password) to distribute to all Client Access servers in an organization.
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.
CleanUpInvalidAlternateServiceAccountCredentials	Optional	System.Management.Automation.SwitchParameter	The CleanUpInvalidAlternateServiceAccountCredentials parameter specifies whether to remove a previously set alternate service account credential that's no longer valid.
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.
IrmLogEnabled	Optional	System.Boolean	The IrmLogEnabled parameter specifies whether logging is enabled for Information Rights Management (IRM).
IrmLogMaxAge	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The IrmLogMaxAge parameter specifies the max age for IRM logs. Logs older than the specified value are deleted. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify a 15-hour interval, enter 15:00:00.
IrmLogMaxDirectorySize	Optional	Microsoft.Exchange.Data.Unlimited	The IrmLogMaxDirectorySize parameter specifies the maximum directory size for IRM logs. When the maximum directory size is reached, the server deletes the old log files first. A value of `unlimited` means no limit for the maximum directory size for the IRM logs.
IrmLogMaxFileSize	Optional	Microsoft.Exchange.Data.ByteQuantifiedSize	The IrmLogMaxFileSize parameter specifies the maximum size of the IRM log. This value can't be larger than the IrmLogMaxDirectorySize parameter.
IrmLogPath	Optional	Microsoft.Exchange.Data.LocalLongFullPath	The IrmLogPath parameter specifies the path to the log file.
IsOutOfService	Optional	System.Boolean
MigrationLogFilePath	Optional	Microsoft.Exchange.Data.LocalLongFullPath	This parameter is reserved for internal Microsoft use.
MigrationLogLoggingLevel	Optional	Microsoft.Exchange.Data.MigrationEventType	This parameter is reserved for internal Microsoft use.
MigrationLogMaxAge	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	This parameter is reserved for internal Microsoft use.
MigrationLogMaxDirectorySize	Optional	Microsoft.Exchange.Data.ByteQuantifiedSize	This parameter is reserved for internal Microsoft use.
MigrationLogMaxFileSize	Optional	Microsoft.Exchange.Data.ByteQuantifiedSize	This parameter is reserved for internal Microsoft use.
RemoveAlternateServiceAccountCredentials	Optional	System.Management.Automation.SwitchParameter	The RemoveAlternateServiceAccountCredentials parameter specifies whether to remove a previously distributed alternate service account credential.
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 sets two properties on the Client Access server CAS-01.

	Copy Code
Set-ClientAccessServer -Identity "CAS-01" -AutoDiscoverServiceInternalUri "https://cas01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"

EXAMPLE 2

This example sets two properties on the Client Access server CASMail.

	Copy Code
Set-ClientAccessServer -Identity "CASMail" -AutoDiscoverServiceInternalUri "https://casmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"

EXAMPLE 3

This example sets several properties on the Client Access server WebMail.

	Copy Code
Set-ClientAccessServer -Identity "WebMail" -AutoDiscoverServiceInternalUri "https://webmail.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"