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

Topic Last Modified: 2012-11-19

Use the Set-ManagementScope cmdlet to change an existing management scope.

Syntax

Set-ManagementScope -Identity <ManagementScopeIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Name <String>] [-RecipientRestrictionFilter <String>] [-RecipientRoot <OrganizationalUnitIdParameter>] [-WhatIf [<SwitchParameter>]]
Set-ManagementScope -Identity <ManagementScopeIdParameter> -ServerRestrictionFilter <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Set-ManagementScope -Identity <ManagementScopeIdParameter> -DatabaseRestrictionFilter <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Set-ManagementScope -Identity <ManagementScopeIdParameter> -PartnerDelegatedTenantRestrictionFilter <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

If you change a scope that has been associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all of the associated role assignments. For more information about changing scopes, see Change a Role Scope.

Important:
Microsoft Exchange Server 2010 Service Pack 1 (SP1) introduces database scopes in addition to server and recipient scopes. Database scopes are only enforced on servers running Exchange 2010 SP1. If a user connects to a server running the release to manufacturing (RTM) version of Exchange 2010, management role assignments associated with database scopes won't be applied. Also, database scopes won't be visible to the Get-ManagementScope cmdlet when it's run on an Exchange 2010 RTM server.

For more information about regular and exclusive scopes, see Understanding Management Role Scopes.

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 "Management scopes" entry in the Role Management Permissions topic.

Parameters

Parameter Required Type Description

DatabaseRestrictionFilter

Required

System.String

The DatabaseRestrictionFilter parameter specifies the filter to apply to database objects. When the DatabaseRestrictionFilter parameter is specified, only database objects that match the filter are included in the scope. If you use the DatabaseRestrictionFilter parameter, you can't use the ServerRestrictionFilter, RecipientRestrictionFilter or RecipientRoot parameters. For a list of filterable database properties, see Understanding Management Role Scopes.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ManagementScopeIdParameter

The Identity parameter specifies the name of the management scope to modify. If the name contains spaces, enclose it in quotation marks (").

PartnerDelegatedTenantRestrictionFilter

Required

System.String

This parameter is reserved for internal Microsoft use.

ServerRestrictionFilter

Required

System.String

The ServerRestrictionFilter parameter specifies the filter to apply to server objects. When the ServerRestrictionFilter parameter is specified, only recipient objects that match the filter are included in the scope. If you use the ServerRestrictionFilter parameter, you can't use the DatabaseRestrictionFilter, RecipientRestrictionFilter, or RecipientRoot parameters. For a list of filterable server properties, see Understanding Management Role Scopes.

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.

Force

Optional

System.Management.Automation.SwitchParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter.

Name

Optional

System.String

The Name parameter specifies the name of the management scope. The management scope name can be a maximum of 64 characters. If the name contains spaces, enclose it in quotation marks (").

RecipientRestrictionFilter

Optional

System.String

The RecipientRestrictionFilter parameter specifies the filter to apply to recipient objects. When the RecipientRestrictionFilter parameter is specified, only server objects that match the filter are included in the scope. If you use the RecipientRestrictionFilter parameter, you can't use the DatabaseRestrictionFilter or ServerRestrictionFilter parameters. For more information about recipient filters, see Filterable Properties for the -Filter Parameter.

RecipientRoot

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. If you use the RecipientRoot parameter, you can't use the ServerRestrictionFilter or DatabaseRestrictionFilter parameters.

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 changes the recipient restriction filter on the Seattle Mailboxes management scope to match all mailboxes that have Seattle in the City mailbox property.

Copy Code
Set-ManagementScope "Seattle Mailboxes" -RecipientRestrictionFilter { City -Eq "Seattle" -And RecipientType -Eq "UserMailbox" }

EXAMPLE 2

This example changes the recipient root for the Sales Recipients management scope to match only recipient objects contained under the contoso.com/Sales OU.

Copy Code
Set-ManagementScope "Sales Recipients" -RecipientRoot contoso.com/Sales

EXAMPLE 3

This example changes the Active Directory Domain Services (AD DS) site used in the server restriction filter for the Vancouver Servers management scope to "NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com".

Copy Code
Set-ManagementScope "Vancouver Servers" -ServerRestrictionFilter { ServerSite -Eq "NA-CDN-Vancouver,CN=Sites,CN=Configuration,DC=contoso,DC=com" }