Enable or disable an affinity rule, and update the rule type.
Windows Server · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft FailoverClusters reference: Enable or disable an affinity rule, and update the rule type. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-ClusterAffinityRule. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / FailoverClusters · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about PowerShell background jobs, see about_Jobs.
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-Enabled
Enables or disables the affinity rule. The accepted values for this parameter are: - 0 or $false. The affinity rule is disabled. - 1 or $true. The affinity rule is enabled.
-InputObject (required)
Specifies the affinity rule object to change. The value must be an object representing an affinity rule, like the output that the Get-ClusterAffinityRule cmdlet returns.
-Name
The name of the affinity rule to change.
-PassThru
Returns the original object passed to the command. By default, this cmdlet doesn't generate any output.
-RuleType
The affinity type to set the rule to. The valid values for this parameter are: - SameFaultDomain - Resources must stay within the same fault domain. - SameNode - Resources must stay on the same cluster node. - DifferentFaultDomain - Resources must stay in different fault domain (anti-affinity). - DifferentNode - Resources must stay on different cluster nodes (anti-affinity).
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Prerequisites
Windows with the FailoverClusters module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
This example enables the cluster affinity rule named AffinityRule1. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.