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

Improves 'RemoteAddress' description for '*-NetFirewall*' cmdlets on supported OSes #3746

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 19 additions & 15 deletions docset/winserver2016-ps/netsecurity/New-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -798,21 +798,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice. NOTE: Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword "LocalSubnet4" means that all local IPv4 addresses are matching this rule).

Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
29 changes: 17 additions & 12 deletions docset/winserver2016-ps/netsecurity/Set-NetFirewallAddressFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,20 +246,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, hostname, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects. See the **Get-NetFirewallAddressFilter** cmdlet for more information.
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
33 changes: 19 additions & 14 deletions docset/winserver2016-ps/netsecurity/Set-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -898,19 +898,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down Expand Up @@ -1100,4 +1106,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th
[Set-NetFirewallSetting](./Set-NetFirewallSetting.md)

[Show-NetFirewallRule](./Show-NetFirewallRule.md)

34 changes: 19 additions & 15 deletions docset/winserver2019-ps/netsecurity/New-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -798,21 +798,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice. NOTE: Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword "LocalSubnet4" means that all local IPv4 addresses are matching this rule).

Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal (Windows 10 only).

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
29 changes: 17 additions & 12 deletions docset/winserver2019-ps/netsecurity/Set-NetFirewallAddressFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,20 +246,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, hostname, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal (Windows 10 only).

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects. See the **Get-NetFirewallAddressFilter** cmdlet for more information.
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
33 changes: 19 additions & 14 deletions docset/winserver2019-ps/netsecurity/Set-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -898,19 +898,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal (Windows 10 only).

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down Expand Up @@ -1100,4 +1106,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th
[Set-NetFirewallSetting](./Set-NetFirewallSetting.md)

[Show-NetFirewallRule](./Show-NetFirewallRule.md)

34 changes: 19 additions & 15 deletions docset/winserver2022-ps/netsecurity/New-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -798,21 +798,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice. NOTE: Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword "LocalSubnet4" means that all local IPv4 addresses are matching this rule).

Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
29 changes: 17 additions & 12 deletions docset/winserver2022-ps/netsecurity/Set-NetFirewallAddressFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,20 +246,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, hostname, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects. See the **Get-NetFirewallAddressFilter** cmdlet for more information.
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
33 changes: 19 additions & 14 deletions docset/winserver2022-ps/netsecurity/Set-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -880,19 +880,25 @@ Accept wildcard characters: False
```

### -RemoteAddress
Specifies that network packets with matching IP addresses match this rule.
This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range, or the following keyword: Any.
The acceptable formats for this parameter are:
- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4 through 1.2.3.7
- IPv6 Range: fe80::1 through fe80::9
Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
Specifies that network packets with matching IP addresses match this rule.
This parameter value is an IPv4 or IPv6 address, subnet, range or keyword.
The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal.

> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down Expand Up @@ -1097,4 +1103,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th
[Set-NetFirewallSetting](./Set-NetFirewallSetting.md)

[Show-NetFirewallRule](./Show-NetFirewallRule.md)

16 changes: 10 additions & 6 deletions docset/winserver2025-ps/netsecurity/New-NetFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -804,15 +804,19 @@ The acceptable formats for this parameter are:

- Single IPv4 Address: 1.2.3.4
- Single IPv6 Address: fe80::1
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Subnet (by network bit count): 1.2.3.4/24
- IPv6 Subnet (by network bit count): fe80::1/48
- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0
- IPv4 Range: 1.2.3.4-1.2.3.7
- IPv6 Range: fe80::1-fe80::9
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice. NOTE: Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword "LocalSubnet4" means that all local IPv4 addresses are matching this rule).
- Keyword: Any, LocalSubnet, DNS, DHCP, WINS, DefaultGateway, Internet, Intranet, IntranetRemoteAccess, PlayToDevice, CaptivePortal.

Querying for rules with this parameter can only be performed using filter objects.
See the Get-NetFirewallAddressFilter cmdlet for more information.
> [!TIP]
> Keywords can be restricted to IPv4 or IPv6 by appending a 4 or 6 (for example, keyword `LocalSubnet4` means that all local IPv4 addresses are matching this rule).

> [!NOTE]
> Querying for rules with this parameter can only be performed using filter objects.
> See the [`Get-NetFirewallAddressFilter`](./Get-NetFirewallAddressFilter.md) cmdlet for more information.

```yaml
Type: String[]
Expand Down
Loading