Set-ExchangeServer

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Set-ExchangeServer command to set Microsoft Exchange Server 2007 attributes in Active Directory for a specified server.

Syntax

Set-ExchangeServer -Identity <ServerIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ErrorReportingEnabled <$true | $false>] [-ProductKey <ProductKey>] [-StaticConfigDomainController <String>] [-StaticDomainControllers <MultiValuedProperty>] [-StaticExcludedDomainControllers <MultiValuedProperty>] [-StaticGlobalCatalogs <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Set-ExchangeServer [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ErrorReportingEnabled <$true | $false>] [-Instance <ExchangeServer>] [-ProductKey <ProductKey>] [-StaticConfigDomainController <String>] [-StaticDomainControllers <MultiValuedProperty>] [-StaticExcludedDomainControllers <MultiValuedProperty>] [-StaticGlobalCatalogs <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This command sets generic Exchange attributes in Active Directory for a specified computer running Exchange 2007 only. You can only use this task on one server at a time. If you wish to bulk manage your Exchange servers, add this task to a script.

To run the Set-ExchangeServer cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

This parameter specifies the GUID, distinguished name, or name of the server.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the domain controller that is used by the command.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.ExchangeServer

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts in which an entire object must be passed to the command.

ProductKey

Optional

Microsoft.Exchange.Management.SystemConfigurationTasks.ProductKey

This parameter specifies the server product key.

StaticConfigDomainController

Optional

System.String

This parameter is used to configure a domain controller to be used by the server via DSAccess.

StaticDomainControllers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is used to configure a list of domain controllers to be used by the server via Directory Service Access (DSAccess).

StaticExcludedDomainControllers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is used to exclude a list of domain controllers to be used by the server.

StaticGlobalCatalogs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is used to configure a list of global catalogs to be used by the server via DSAccess.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter.

ErrorReportingEnabled

Optional

System.Boolean

This parameter specifies whether error reporting is enabled.

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. You don't have to specify a value with the WhatIf parameter.

Input Types

Return Types

Errors

Error Description

Exceptions

Exceptions Description

Example

In this example, error reporting is disabled on the specified server.

Set-ExchangeServer -Identity TestServer.Contoso.com -ErrorReportingEnabled: $False