Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-06-28

Use the Set-StorageGroup cmdlet to set a storage group's attributes in Active Directory directory service.

Syntax

Set-StorageGroup -Identity <StorageGroupIdParameter> [-CircularLoggingEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Name <String>] [-WhatIf [<SwitchParameter>]] [-ZeroDatabasePages <$true | $false>]
Set-StorageGroup [-CircularLoggingEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <StorageGroup>] [-Name <String>] [-WhatIf [<SwitchParameter>]] [-ZeroDatabasePages <$true | $false>]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.StorageGroupIdParameter

Use the Identity parameter to specify the GUID or distinguished name that represents a specific storage group. You can also include the server name by using the format ServerName\StorageGroup. The Identity parameter label is optional.

CircularLoggingEnabled

Optional

System.Boolean

The CircularLoggingEnabled parameter enables circular logging with a value of $true. The default value is $false.

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 of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the command.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.StorageGroup

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.

Name

Optional

System.String

The Name parameter sets the new name for the storage group

ZeroDatabasePages

Optional

System.Boolean

The ZeroDatabasePages parameter enables zeroing of deleted pages with a value of $true. The default value is $false.

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.

Detailed Description

To run the Set-StorageGroup 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.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code is an example of the Set-StorageGroup command that renames Storage_Group_1 to "MyStorageGroup."

Copy Code
Set-StorageGroup -Identity  "Exchange-Server-1.Contoso.com\StorageGroup-1" -Name MyStorageGroup