Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-11
Use the Remove-WorkloadManagementPolicy cmdlet to remove a workload management policy.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-WorkloadManagementPolicy -Identity
<WorkloadManagementPolicyIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example removes a workload management policy. You're prompted to confirm the command before it runs.
Copy Code | |
---|---|
Remove-WorkloadManagementPolicy -Identity WLMPolicyMigration |
EXAMPLE 2
This example removes a workload management policy. You aren't prompted to confirm your command before it runs.
Copy Code | |
---|---|
Remove-WorkloadManagementPolicy -Identity WLMPolicyMigration -Confirm:$false |
Detailed Description
You can use the Remove-WorkloadManagementPolicy cmdlet to remove a custom Workload Management Policy object. You can also remove the default policy that was created during setup.
Caution: |
---|
Caution should be taken when running this cmdlet because it can remove a custom workload management policy that may be in use. |
You will see the following prompt if you try to remove
a workload management policy. Are you sure you want to
perform this action? Removing Workload Management Policy
"<Workload Management Policy Name>", including all the
Workload Policy and Resource Policy objects under it.
You can use the Get-WorkloadManagementPolicy
-Identity <Workload Management Policy Name> |
Format-Table
command to view the workload management policy
objects associated with a specified policy.
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 "Exchange workload throttling" entry in the Server Health and Performance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.WorkloadManagementPolicyIdParameter |
The Identity parameter specifies the name for the custom workload management policy to create. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
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. |
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.