From 526a9e1a84d658e1933f099a0487309d406b47de Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 11 Jul 2023 12:52:48 +0100 Subject: [PATCH] Introducing new command Remove-ClusterGroupFromAffinityRule --- .../Remove-ClusterGroupFromAffinityRule.md | 183 ++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md new file mode 100644 index 0000000000..00ad8043fa --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -0,0 +1,183 @@ +--- +description: Remove-ClusterGroupFromAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterGroupFromAffinityRule +--- + +# Remove-ClusterGroupFromAffinityRule + +## SYNOPSIS +Removes a cluster group from an affinity rule. + +## SYNTAX + +### Query (cdxml) (Default) +``` +Remove-ClusterGroupFromAffinityRule [[-Name] ] [-Groups] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +### InputObject (cdxml) +``` +Remove-ClusterGroupFromAffinityRule -InputObject [-Groups] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION +Removes a cluster group from an affinity rule. This does not remove the rule itself + +## EXAMPLES + +### Example 1 +```powershell +Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyCluster +``` +## 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](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +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](https://go.microsoft.com/fwlink/p/?LinkId=227967) +or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups +The groups to be removed from the affinity rule. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the affinity rule to remove groups from + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: Set + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 Windows 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. + +```yaml +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS