Set-DetailsTemplate

  • Article

 

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

Use the Set-DetailsTemplate cmdlet to modify the attributes of a details template.

Syntax

Set-DetailsTemplate -Identity <DetailsTemplateIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Set-DetailsTemplate [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <DetailsTemplate>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-DetailsTemplate cmdlet modifies the attributes of a details template.

To run the Set-DetailsTemplate cmdlet on a computer that has any role except the Edge Transport Server role installed, 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 Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DetailsTemplateIdParameter

Use the Identity parameter to specify the GUID or by specifying the details template type and language separated by a slash. For example: en-us\user. Details template types include:

  • User

  • Group

  • PublicFolder

  • SearchDialog

  • MailboxAgent

  • Contact

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Exchange, include the DomainController parameter in the command.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DetailsTemplate

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

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

The example sets attributes for the User details template, for the U.S. English language.

Set-DetailsTemplate -Identity en-us\User