Export (0) Print
Expand All

Remove-WorkloadPolicy

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-03-05

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Remove-WorkloadPolicy cmdlet to remove a workload policy.

For information about the parameter sets in the Syntax section below, see Syntax.

Remove-WorkloadPolicy -Identity <WorkloadPolicyIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example removes the custom workload policy ImapTestWorkloadPolicy. You're prompted to confirm the command before it runs.

Remove-WorkloadPolicy -Identity ImapTestWorkloadPolicy

This example removes the custom workload policy ImapTestWorkloadPolicy. You aren't prompted to confirm the command before it runs.

Remove-WorkloadPolicy -Identity ImapTestWorkloadPolicy -Confirm:$false

The Remove-WorkloadPolicy cmdlet removes a custom workload policy object. You can also remove the default policy that was created during setup.

CautionCaution:
Caution should be taken when running this cmdlet because it can remove the workload policies that may be in use.

You will see the following prompt if you try to remove a workload policy. Are you sure you want to perform this action? Removing Workload Policy "<Workload Policy Name>".

You can use the Get-WorkloadPolicy -Identity <Workload 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.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.WorkloadPolicyIdParameter

The Identity parameter specifies the name of the workload policy to remove.

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 -Confirm:$False. You must include a colon ( : ) in 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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft