COMMAND EVERYTHING.

Add-ClusterGroupToAffinityRule

Adds a cluster group to an affinity rule.

Windows Server · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft FailoverClusters reference: Adds a cluster group to an affinity rule. 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.

Add-ClusterGroupToAffinityRule [[-Name] <String[]>] [-Groups] <String[]>
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-ClusterGroupToAffinityRule. 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.
-Groups (required): This list of groups to be added to the affinity rule.
-InputObject (required): Specifies the affinity rule object that is used in a pipeline command.
-Name: The Affinity rule to add the groups to.
-PassThru: Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't generate any output.
-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.

Examples

Example 2 - Add a group to an affinity rule using pipeline

Add-ClusterGroupToAffinityRule -Groups MyGroup

The command gets the affinity rule Rule1 object and passes it to the Add-ClusterGroupToAffinityRule command. The command adds the cluster group MyGroup to the affinity rule. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/FailoverClusters/Add-ClusterGroupToAffinityRule.md

https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergrouptoaffinityrule?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer