Skip to content

Commit 725e028

Browse files
Improves description of DisplayGroup & Group parameters of *-NetFirewallRule cmdlets
1 parent b05ee68 commit 725e028

32 files changed

+288
-504
lines changed

docset/winserver2016-ps/NetSecurity/Copy-NetFirewallRule.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -431,24 +431,19 @@ Accept wildcard characters: False
431431
432432
### -DisplayGroup
433433
Specifies that only matching firewall rules of the indicated group association are copied.
434-
Wildcard characters are accepted.
435-
The *Group* parameter specifies the source string for this parameter.
436-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
437-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
438-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
439-
It is good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
440-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
434+
The **Group** property specifies the source string for **DisplayGroup**.
435+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
441436
442437
```yaml
443438
Type: String[]
444439
Parameter Sets: ByQuery
445-
Aliases:
440+
Aliases:
446441

447442
Required: False
448443
Position: Named
449444
Default value: None
450445
Accept pipeline input: False
451-
Accept wildcard characters: False
446+
Accept wildcard characters: True
452447
```
453448
454449
### -DisplayName
@@ -547,13 +542,9 @@ Accept wildcard characters: False
547542
548543
### -Group
549544
Specifies that only matching firewall rules of the indicated group association are copied.
550-
Wildcard characters are accepted.
551-
This parameter specifies the source string for the *DisplayGroup* parameter.
552-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
553-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
554-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
555-
It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
556-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
545+
546+
> [!TIP]
547+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
557548

558549
```yaml
559550
Type: String[]
@@ -564,7 +555,7 @@ Required: False
564555
Position: Named
565556
Default value: None
566557
Accept pipeline input: False
567-
Accept wildcard characters: False
558+
Accept wildcard characters: True
568559
```
569560

570561
### -InputObject

docset/winserver2016-ps/NetSecurity/Disable-NetFirewallRule.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ PS C:\>Disable-NetFirewallRule -Group "@FirewallAPI.dll,-28502"
140140
```
141141

142142
This example disables all of the File and Printer Sharing rules on the local computer.
143-
Use the universal and world-ready indirect string @FirewallAPI to specify the group.
143+
"@FirewallAPI.dll,-28502" is an indirect string that specifies a "File and Printer Sharing" group.
144144

145145
### EXAMPLE 3
146146
```
@@ -427,24 +427,19 @@ Accept wildcard characters: False
427427
428428
### -DisplayGroup
429429
Specifies that only matching firewall rules of the indicated group association are disabled.
430-
Wildcard characters are accepted.
431-
The *Group* parameter specifies the source string for this parameter.
432-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
433-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
434-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
435-
It is a good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
436-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
430+
The **Group** property specifies the source string for **DisplayGroup**.
431+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
437432
438433
```yaml
439434
Type: String[]
440435
Parameter Sets: ByQuery
441-
Aliases:
436+
Aliases:
442437

443438
Required: False
444439
Position: Named
445440
Default value: None
446441
Accept pipeline input: False
447-
Accept wildcard characters: False
442+
Accept wildcard characters: True
448443
```
449444
450445
### -DisplayName
@@ -539,13 +534,9 @@ Accept wildcard characters: False
539534
540535
### -Group
541536
Specifies that only matching firewall rules of the indicated group association are disabled.
542-
Wildcard characters are accepted.
543-
This parameter specifies the source string for the *DisplayGroup* parameter.
544-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
545-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
546-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
547-
It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
548-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
537+
538+
> [!TIP]
539+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
549540

550541
```yaml
551542
Type: String[]
@@ -556,7 +547,7 @@ Required: False
556547
Position: Named
557548
Default value: None
558549
Accept pipeline input: False
559-
Accept wildcard characters: False
550+
Accept wildcard characters: True
560551
```
561552

562553
### -InputObject

docset/winserver2016-ps/NetSecurity/Enable-NetFirewallRule.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ PS C:\>Enable-NetFirewallRule -Group "@FirewallAPI.dll,-28502"
126126
```
127127

128128
This example enables all of the File and Printer Sharing rules.
129-
Use the universal and world-ready indirect string @FirewallAPI to specify the group.
129+
"@FirewallAPI.dll,-28502" is an indirect string that specifies a "File and Printer Sharing" group.
130130

131131
### EXAMPLE 2
132132
```
@@ -424,24 +424,19 @@ Accept wildcard characters: False
424424
425425
### -DisplayGroup
426426
Specifies that only matching firewall rules of the indicated group association are enabled.
427-
Wildcard characters are accepted.
428-
The *Group* parameter specifies the source string for this parameter.
429-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
430-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
431-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
432-
It is good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
433-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
427+
The **Group** property specifies the source string for **DisplayGroup**.
428+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
434429
435430
```yaml
436431
Type: String[]
437432
Parameter Sets: ByQuery
438-
Aliases:
433+
Aliases:
439434

440435
Required: False
441436
Position: Named
442437
Default value: None
443438
Accept pipeline input: False
444-
Accept wildcard characters: False
439+
Accept wildcard characters: True
445440
```
446441
447442
### -DisplayName
@@ -540,13 +535,9 @@ Accept wildcard characters: False
540535
541536
### -Group
542537
Specifies that only matching firewall rules of the indicated group association are enabled.
543-
Wildcard characters are accepted.
544-
This parameter specifies the source string for the *DisplayGroup* parameter.
545-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
546-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
547-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
548-
It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
549-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
538+
539+
> [!TIP]
540+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
550541

551542
```yaml
552543
Type: String[]
@@ -557,7 +548,7 @@ Required: False
557548
Position: Named
558549
Default value: None
559550
Accept pipeline input: False
560-
Accept wildcard characters: False
551+
Accept wildcard characters: True
561552
```
562553

563554
### -InputObject

docset/winserver2016-ps/NetSecurity/Get-NetFirewallRule.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -393,13 +393,8 @@ Accept wildcard characters: False
393393
394394
### -DisplayGroup
395395
Specifies that only matching firewall rules of the indicated group association are retrieved.
396-
Wildcard characters are accepted.
397-
The *Group* parameter specifies the source string for this parameter.
398-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
399-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
400-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
401-
It is good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
402-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
396+
The **Group** property specifies the source string for **DisplayGroup**.
397+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
403398
404399
```yaml
405400
Type: String[]
@@ -410,7 +405,7 @@ Required: False
410405
Position: Named
411406
Default value: None
412407
Accept pipeline input: False
413-
Accept wildcard characters: False
408+
Accept wildcard characters: True
414409
```
415410
416411
### -DisplayName
@@ -509,13 +504,9 @@ Accept wildcard characters: False
509504
510505
### -Group
511506
Specifies that only matching firewall rules of the indicated group association are retrieved.
512-
Wildcard characters are accepted.
513-
This parameter specifies the source string for the *DisplayGroup* parameter.
514-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
515-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
516-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
517-
It is a good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
518-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
507+
508+
> [!TIP]
509+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
519510

520511
```yaml
521512
Type: String[]
@@ -526,7 +517,7 @@ Required: False
526517
Position: Named
527518
Default value: None
528519
Accept pipeline input: False
529-
Accept wildcard characters: False
520+
Accept wildcard characters: True
530521
```
531522

532523
### -LocalOnlyMapping

docset/winserver2016-ps/NetSecurity/New-NetFirewallRule.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -379,14 +379,12 @@ Accept wildcard characters: False
379379
```
380380

381381
### -Group
382-
Specifies that only matching firewall rules of the indicated group association are copied.
383-
Wildcard characters are accepted.
384-
This parameter specifies the source string for the *DisplayGroup* parameter.
385-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
386-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
387-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
388-
It is a good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
389-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
382+
Specifies a group for the rule. Rule groups can be used to organize rules and allows easy batch modifications.
383+
It is a good practice to use an indirect string here, pointing to a localized string in a DLL (for example, `@FirewallAPI.dll,-34002`).
384+
The value of this property influences the value of the read-only **DisplayGroup** property:
385+
386+
- When a rule's **Group** property contains an indirect string, the **DisplayGroup** property contains the string located at the specified index.
387+
- When a rule's **Group** property contains a regular string, the **DisplayGroup** property just returns that string.
390388

391389
```yaml
392390
Type: String

docset/winserver2016-ps/NetSecurity/Remove-NetFirewallRule.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -421,24 +421,19 @@ Accept wildcard characters: False
421421
422422
### -DisplayGroup
423423
Specifies that only matching firewall rules of the indicated group association are removed.
424-
Wildcard characters are accepted.
425-
The *Group* parameter specifies the source string for this parameter.
426-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
427-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
428-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
429-
It is good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
430-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
424+
The **Group** property specifies the source string for **DisplayGroup**.
425+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
431426
432427
```yaml
433428
Type: String[]
434429
Parameter Sets: ByQuery
435-
Aliases:
430+
Aliases:
436431

437432
Required: False
438433
Position: Named
439434
Default value: None
440435
Accept pipeline input: False
441-
Accept wildcard characters: False
436+
Accept wildcard characters: True
442437
```
443438
444439
### -DisplayName
@@ -537,13 +532,9 @@ Accept wildcard characters: False
537532
538533
### -Group
539534
Specifies that only matching firewall rules of the indicated group association are removed.
540-
Wildcard characters are accepted.
541-
This parameter specifies the source string for the *DisplayGroup* parameter.
542-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
543-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
544-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
545-
It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
546-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
535+
536+
> [!TIP]
537+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
547538

548539
```yaml
549540
Type: String[]
@@ -554,7 +545,7 @@ Required: False
554545
Position: Named
555546
Default value: None
556547
Accept pipeline input: False
557-
Accept wildcard characters: False
548+
Accept wildcard characters: True
558549
```
559550

560551
### -InputObject

docset/winserver2016-ps/NetSecurity/Rename-NetFirewallRule.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -404,24 +404,19 @@ Accept wildcard characters: False
404404
405405
### -DisplayGroup
406406
Specifies that only matching firewall rules of the indicated group association are renamed.
407-
Wildcard characters are accepted.
408-
The *Group* parameter specifies the source string for this parameter.
409-
If the value for this parameter is a localizable string, then the *Group* parameter contains an indirect string.
410-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
411-
Using the Set-NetFirewallRule cmdlet, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
412-
It is a good practice to specify the *Group* parameter value with a universal and world-ready indirect @FirewallAPI name.
413-
This parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
407+
The **Group** property specifies the source string for **DisplayGroup**.
408+
If the **Group** property contains an indirect string, then you should use a localized string, located at the address specified in the **Group** property, as a value for this parameter.
414409
415410
```yaml
416411
Type: String[]
417412
Parameter Sets: ByQuery
418-
Aliases:
413+
Aliases:
419414

420415
Required: False
421416
Position: Named
422417
Default value: None
423418
Accept pipeline input: False
424-
Accept wildcard characters: False
419+
Accept wildcard characters: True
425420
```
426421
427422
### -DisplayName
@@ -520,13 +515,9 @@ Accept wildcard characters: False
520515
521516
### -Group
522517
Specifies that only matching firewall rules of the indicated group association are renamed.
523-
Wildcard characters are accepted.
524-
This parameter specifies the source string for the *DisplayGroup* parameter.
525-
If the *DisplayGroup* parameter value is a localizable string, then this parameter contains an indirect string.
526-
Rule groups can be used to organize rules by influence and allows batch rule modifications.
527-
Using the Set-NetFirewallRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications.
528-
It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name.
529-
The *DisplayGroup* parameter cannot be specified upon object creation using the New-NetFirewallRule cmdlet, but can be modified using dot-notation and the Set-NetFirewallRule cmdlet.
518+
519+
> [!TIP]
520+
> For most built-in rules, the group string is specified as an indirect string (for example, `@FirewallAPI.dll,-34002`). To retrieve such rules you should use those indirect strings in this parameter, rather their localized counterparts displayed in the UI. Alternatively, you can use the **DisplayGroup** parameter to filter by group display names.
530521

531522
```yaml
532523
Type: String[]
@@ -537,7 +528,7 @@ Required: False
537528
Position: Named
538529
Default value: None
539530
Accept pipeline input: False
540-
Accept wildcard characters: False
531+
Accept wildcard characters: True
541532
```
542533

543534
### -InputObject

0 commit comments

Comments
 (0)