Set-ClusterAffinityRule
Enable or disable an affinity rule, and update the rule type.
Syntax
Query (cdxml) (Default)
Set-ClusterAffinityRule
[[-Name] <String[]>]
[-RuleType <RuleType>]
[-Enabled <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
InputObject (cdxml)
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Enabled
Enables or disables the affinity rule. The accepted values for this parameter are:
0or$false. The affinity rule is disabled.1or$true. The affinity rule is enabled.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject (cdxml)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the affinity rule to change.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Query (cdxml)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns the original object passed to the command. By default, this cmdlet doesn't generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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).
Parameter properties
| Type: | RuleType |
| Default value: | None |
| Accepted values: | SameFaultDomain, SameNode, DifferentFaultDomain, DifferentNode |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.