Edit

Set-ClusterAffinityRule

  • Reference
Module:
FailoverClusters

Enable or disable an affinity rule, and update the rule type.

Syntax

Set-ClusterAffinityRule
   [[-Name] <String[]>]
   [-RuleType <RuleType>]
   [-Enabled <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-ClusterAffinityRule
   -InputObject <CimInstance[]>
   [-RuleType <RuleType>]
   [-Enabled <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]

Description

The Set-ClusterAffinityRule cmdlet can enable or disable an existing affinity rule. It can also change the RuleType.

Examples

Example 1 - Enable an affinity rule

Set-ClusterAffinityRule -Name AffinityRule1 -Enabled $true

This example enables the cluster affinity rule named AffinityRule1.

Example 2 - Disable an affinity rule

Set-ClusterAffinityRule -Name AffinityRule1 -Enabled $false

This example disables the cluster affinity rule named AffinityRule1.

Example 3 - Change an affinity rule type

Get-ClusterAffinityRule -Name AffinityRule1 | Set-ClusterAffinityRule -RuleType DifferentNode

This example gets the affinity rule named AffinityRule1 and pipes the affinity rule object to the Set-ClusterAffinityRule cmdlet. The Set-ClusterAffinityRule cmdlet changes the affinity rule type to DifferentNode.

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.
Type:UInt32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the affinity rule to change.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns the original object passed to the command. By default, this cmdlet doesn't generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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).
Type:RuleType
Accepted values:SameFaultDomain, SameNode, DifferentFaultDomain, DifferentNode
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String[]

When a string is piped to this cmdlet, the value is used as the name of the affinity rule to change.

CimInstance[]

This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the Get-ClusterAffinityRule cmdlet.

Outputs

None

By default, the cmdlet doesn't return any output.

CimInstance

CimInstance

When the PassThru parameter is specified, the cmdlet returns an object representing an affinity rule as a CIM instance within the root/MSCLUSTER/MSCluster_AffinityRule path.