Get-ClusterAffinityRule.md

description	external help file	Module Name	ms.date	online version	schema	title
Get-ClusterAffinityRule	ClusterAffinityRule.cdxml-help.xml	FailoverClusters	07/27/2023	https://learn.microsoft.com/powershell/module/failoverclusters/get-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp	2.0.0	Get-ClusterAffinityRule

Get-ClusterAffinityRule

SYNOPSIS

This cmdlet is used to display the given rule and what type it is.

SYNTAX

Get-ClusterAffinityRule [[-Name] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

DESCRIPTION

This cmdlet is used to display the given rule and what type it is. The cmdlet lists all rules by default. Use the Name parameter to return a specific rule or rules.

EXAMPLES

Example 1 - Get a specific affinity rule

Get-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1

This example returns information about the cluster affinity rule with the name Rule1 from Cluster1.

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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

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

-Name

The name of the desired affinity rule. When this parameter isn't specified, the cmdlet lists every rule.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String[]

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

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance

Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule

The cmdlet returns an object representing an affinity rule as a CIM instance within the root/MSCLUSTER/MSCluster_AffinityRule path.

NOTES

RELATED LINKS

New-ClusterAffinityRule

Remove-ClusterAffinityRule

Set-ClusterAffinityRule