Edit

Share via


New-NetFirewallDynamicKeywordAddress

Creates a dynamic keyword address.

Syntax

Default (Default)

New-NetFirewallDynamicKeywordAddress
    [-Id <String>]
    [-Keyword <String>]
    [-Addresses <String>]
    [-AutoResolve <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-NetFirewallDynamicKeywordAddress cmdlet creates a dynamic keyword address.

A firewall rule can use dynamic keyword addresses instead of explicitly defining IP addresses for its remote address condition.

Examples

Example 1: Create dynamic keyword address with AutoResolve

$GUID = New-Guid
New-NetFirewallDynamicKeywordAddress -Id $('{' + $GUID + '}') -Keyword "ContosoSubnet" -AutoResolve $True

This example creates an AutoResolve dynamic keyword address.

The first command creates a GUID and assigns it to $GUID.

The second command creates the dynamic address with the specified keyword. The braces are required for the ID.

Example 2: Create dynamic keyword address

$GUID = New-Guid
New-NetFirewallDynamicKeywordAddress -Id $('{' + $GUID + '}') -Keyword "ContosoServerSubnet" -Addresses 10.0.0.21

This example creates a non-AutoResolve dynamic keyword address.

The first command creates a GUID and assigns it to $GUID.

The second command creates a dynamic address with the specified keyword. The address does not use AutoResolve.

You can use the form -Address instead of Addresses in the command, for clarity. The braces are required for the ID.

Parameters

-Addresses

Specifies the addresses for the dynamic keyword address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AutoResolve

Whether the dynamic key address uses AutoResolve. For AutoResolve, the keyword field represents a resolvable name and the IP addresses aren't defined when the dynamic key address is created.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies a GUID for the dynamic keyword address. Wrap the GUID value in braces.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Keyword

Specifies the keyword for the dynamic keyword address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

None

Outputs

Object