Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish 09/25/2023, 3:30 PM #3635

Merged
merged 78 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
6ea7ed0
Update hyper-v firewall documentation
matthewige Jul 8, 2022
eebb2d2
Add missing -ManagementPointNetworkType parameter
peterschen Jul 19, 2023
a07d3f6
Fixed copy review suggestions
peterschen Jul 25, 2023
8ba8aec
Initial commit
robinharwood Jun 16, 2023
dfaa117
Updated examples and RuleType parameter text
robinharwood Jul 11, 2023
9404003
Formatting updates
robinharwood Jul 27, 2023
1910ca4
Adding new commands to module file
robinharwood Jul 27, 2023
c9a95a9
Updating ms.date
robinharwood Jul 27, 2023
56dcb3c
Update Get-PrintJob.md
msbemba Aug 6, 2023
e424b66
Update Get-PrintJob.md
msbemba Aug 6, 2023
8157847
Update Get-PrintJob.md
msbemba Aug 6, 2023
56848c5
Update Get-PrintJob.md
msbemba Aug 6, 2023
f6b838a
Update Get-PrintJob.md
msbemba Aug 6, 2023
fdd0d09
Update Get-ADPrincipalGroupMembership.md
msbemba Aug 6, 2023
5a7755b
Update Get-ADPrincipalGroupMembership.md
msbemba Aug 6, 2023
7c95d9d
Update Get-ADPrincipalGroupMembership.md
msbemba Aug 6, 2023
c39c8ec
Update docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMe…
msbemba Aug 7, 2023
5a33f0f
Update docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMe…
msbemba Aug 7, 2023
06d6e34
Update docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMe…
msbemba Aug 7, 2023
2887786
Merge branch 'MicrosoftDocs:main' into main
matthewige Aug 21, 2023
8bd17bb
update with profile
matthewige Aug 21, 2023
a6cc574
update rule set with profile arg
matthewige Aug 21, 2023
e728e13
Address CR
matthewige Aug 25, 2023
5e4fddc
Merge branch 'main' into main
matthewige Aug 29, 2023
cc65dd2
Merge branch 'main' into main
matthewige Aug 30, 2023
230275f
Apply suggestions from code review
matthewige Sep 6, 2023
d74ea5d
Editorial updates
robinharwood Sep 11, 2023
7ff86d8
Merge branch 'main' of https://github.com/MicrosoftDocs/windows-power…
robinharwood Sep 11, 2023
9f4ef2d
Merge branch 'main' into main
matthewige Sep 11, 2023
22a01bf
Applied feedback suggestions
robinharwood Sep 12, 2023
a016dd8
Update Set-ProcessMitigation.md
msbemba Sep 12, 2023
c9a1b35
Update Set-ProcessMitigation.md
msbemba Sep 12, 2023
768a444
Edits after feedback
robinharwood Sep 19, 2023
e431868
Merge branch 'main' into roharwoo_failoverclusters_ClusterAffinityRule
robinharwood Sep 19, 2023
1e55638
Fixed typo
robinharwood Sep 20, 2023
aad18f5
Apply suggestions from code review
robinharwood Sep 20, 2023
63f7d04
Merge branch 'main' into main
tiburd Sep 21, 2023
8918928
Merge pull request #3525 from robinharwood/roharwoo_failoverclusters_…
michaeltlombardi Sep 25, 2023
ce6dc6e
Adding new command the FailoverClusters module
robinharwood Jul 27, 2023
652be72
Updating Add-ClusterGroupToAffinityRule synopsis and description
robinharwood Sep 11, 2023
9f7b8bc
Introducing new command Remove-ClusterGroupFromAffinityRule
robinharwood Jul 11, 2023
cef84ba
Updating text formatting and adding command to the module file
robinharwood Jul 27, 2023
00633de
Adding missing full stop
robinharwood Sep 11, 2023
9d1d63d
Adding remove command to PR
robinharwood Sep 11, 2023
8a09997
Apply suggestions from code review
robinharwood Sep 12, 2023
d2e6d7e
Updates post feedback
robinharwood Sep 12, 2023
181acf2
Updated cluster group affinity rule commands after feedback
robinharwood Sep 20, 2023
8fe24f3
Fixing build validation issue
robinharwood Sep 20, 2023
7470ebb
Merge pull request #3570 from robinharwood/roharwoo_failoverclusters_…
michaeltlombardi Sep 25, 2023
d07e7fd
Introducing new Add-ClusterSharedVolumeToAffinityRule command
robinharwood Jul 11, 2023
54b61d7
Updating text formatting and adding command to the module file
robinharwood Jul 27, 2023
dd227dc
Updating Add-ClusterSharedVolumeToAffinityRule description
robinharwood Sep 11, 2023
d0602d4
Added new command to the FailoverCluster module
robinharwood Jul 28, 2023
0ff18c9
Added new command to the FailoverCluster module
robinharwood Jul 28, 2023
1e496ad
Fixing FailoverCluster.md link issue
robinharwood Sep 11, 2023
e34c9e6
Added related links and consolidating PRs
robinharwood Sep 11, 2023
2efe1c9
Line formatting updates
robinharwood Sep 11, 2023
cce97e0
Apply suggestions from code review
robinharwood Sep 12, 2023
aec338b
Updates post feedback
robinharwood Sep 12, 2023
c2439d5
Updated after feedback
robinharwood Sep 20, 2023
f80338b
Updated Remove-ClusterSharedVolumeFromAffinityRule input description
robinharwood Sep 20, 2023
f22eaf3
Correcting example
robinharwood Sep 20, 2023
ffb045e
Merge pull request #3552 from robinharwood/roharwoo_failoverclusters_…
michaeltlombardi Sep 25, 2023
8c006b9
Merge branch 'live' into main
Stacyrch140 Sep 25, 2023
b19e340
Merge branch 'main' into main
tiburd Sep 25, 2023
6dea426
Merge branch 'main' into patch-1
tiburd Sep 25, 2023
bb8a5a9
Merge branch 'main' into msbemba-patch-1-4
tiburd Sep 25, 2023
428b259
Merge branch 'main' into msbemba-patch-1-2
tiburd Sep 25, 2023
b0f2b5f
Merge branch 'main' into patch-164
tiburd Sep 25, 2023
5c00449
Merge pull request #3589 from msbemba/msbemba-patch-1-2
tiburd Sep 25, 2023
b1f3fe5
Merge branch 'main' into patch-164
tiburd Sep 25, 2023
7336fc9
Merge pull request #3620 from msbemba/patch-164
tiburd Sep 25, 2023
e3b6120
Merge branch 'main' into msbemba-patch-1-4
tiburd Sep 25, 2023
91e5ada
Merge pull request #3591 from msbemba/msbemba-patch-1-4
tiburd Sep 25, 2023
8631be5
Merge branch 'main' into patch-1
tiburd Sep 25, 2023
c702ccb
Merge pull request #3561 from peterschen/patch-1
tiburd Sep 25, 2023
4881019
Merge branch 'main' into main
tiburd Sep 25, 2023
6536e0a
Merge pull request #3602 from matthewige/main
tiburd Sep 25, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docset/winserver2012-ps/printmanagement/Get-PrintJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Accept wildcard characters: False

### -ID
Specifies the ID of the print job to retrieve.
You can use wildcard characters.
You cannot use wildcard characters.

```yaml
Type: UInt32
Expand Down
2 changes: 1 addition & 1 deletion docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Accept wildcard characters: False

### -ID
Specifies the ID of the print job to retrieve.
You can use wildcard characters.
You cannot use wildcard characters.

```yaml
Type: UInt32
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,27 @@ Accept wildcard characters: False
```

### -Partition
The default authentication method is Negotiate.
Specifies the distinguished name of an Active Directory partition.
The distinguished name must be one of the naming contexts on the current directory server.
The cmdlet searches this partition to find the object defined by the **Identity** parameter.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
In many cases, a default value is used for the **Partition** parameter if no value is specified.
The rules for determining the default value are given below.
Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated.

In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain.

In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context.
To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance.
- If none of the previous cases apply, the **Partition** parameter does not take any default value.

```yaml
Type: String
Expand All @@ -269,7 +287,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE)
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
2 changes: 1 addition & 1 deletion docset/winserver2016-ps/printmanagement/Get-PrintJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Accept wildcard characters: False

### -ID
Specifies the ID of the print job to retrieve.
You can use wildcard characters.
You cannot use wildcard characters.

```yaml
Type: UInt32
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,27 @@ Accept wildcard characters: False
```

### -Partition
The default authentication method is Negotiate.
Specifies the distinguished name of an Active Directory partition.
The distinguished name must be one of the naming contexts on the current directory server.
The cmdlet searches this partition to find the object defined by the **Identity** parameter.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
In many cases, a default value is used for the **Partition** parameter if no value is specified.
The rules for determining the default value are given below.
Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated.

In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain.

In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context.
To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance.
- If none of the previous cases apply, the **Partition** parameter does not take any default value.

```yaml
Type: String
Expand All @@ -269,11 +287,12 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE)
Accept pipeline input: False
Accept wildcard characters: False
```


### -ResourceContextPartition
Specifies the distinguished name of the partition of an AD or AD LDS instance to search.
Use this parameter with the *ResourceContextServer* parameter to specify a partition hosted by the specified server.
Expand Down
2 changes: 1 addition & 1 deletion docset/winserver2019-ps/printmanagement/Get-PrintJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Accept wildcard characters: False

### -ID
Specifies the ID of the print job to retrieve.
You can use wildcard characters.
You cannot use wildcard characters.

```yaml
Type: UInt32
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,27 @@ Accept wildcard characters: False
```

### -Partition
The default authentication method is Negotiate.
Specifies the distinguished name of an Active Directory partition.
The distinguished name must be one of the naming contexts on the current directory server.
The cmdlet searches this partition to find the object defined by the **Identity** parameter.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
In many cases, a default value is used for the **Partition** parameter if no value is specified.
The rules for determining the default value are given below.
Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated.

In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain.

In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases:

- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name.
- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive.
- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context.
To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance.
- If none of the previous cases apply, the **Partition** parameter does not take any default value.

```yaml
Type: String
Expand All @@ -269,7 +287,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE)
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
---
description: Add-ClusterGroupToAffinityRule
external help file: ClusterAffinityRule.cdxml-help.xml
Module Name: FailoverClusters
ms.date: 09/20/2023
online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergrouptoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Add-ClusterGroupToAffinityRule
---

# Add-ClusterGroupToAffinityRule

## SYNOPSIS
Adds a cluster group to an affinity rule.

## SYNTAX

### Query (cdxml) (Default)

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

### InputObject (cdxml)

```
Add-ClusterGroupToAffinityRule -InputObject <CimInstance[]> [-Groups] <String[]>
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
```

## DESCRIPTION

Adds a cluster group to a named affinity rule.

## EXAMPLES

### Example 1 - Add a group to an affinity rule

```powershell
Add-ClusterGroupToAffinityRule -Groups MyGroup -Name MyRule -Cluster MyCluster
```

This example adds the group named `MyGroup` to the affinity rule named `MyRule` on the cluster named
`MyCluster`.

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

```powershell
Get-ClusterAffinityRule -name Rule1 |
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.

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

This list of groups to be added to 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 affinity rule 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 Affinity rule to add the groups to.

```yaml
Type: String[]
Parameter Sets: Query (cdxml)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -PassThru

Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't
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 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[]

When a string is piped to this cmdlet, the value is used as the name of the affinity rule to add the
cluster shared volume to.

### Microsoft.Management.Infrastructure.CimInstance[]

This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the
[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet.

## OUTPUTS

### None

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

### Microsoft.Management.Infrastructure.CimInstance

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

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.

## NOTES

## RELATED LINKS

[Remove-ClusterGroupFromAffinityRule](Remove-ClusterGroupFromAffinityRule.md)
Loading