Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-NetNatExternalAddress

Add-NetNatExternalAddress

msft_netnatexternaladdress.cdxml

Synopsis

Adds an external address to a NAT instance.

Syntax

Add-NetNatExternalAddress [-NatName] [-AsJob] [-CimSession] [-PortEnd] [-PortStart] [-ThrottleLimit] [-IPAddress] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-NetNatExternalAddress cmdlet adds an external address to a network address translation (NAT) instance.

Parameters

-AsJob <SwitchParameter>

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 cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPAddress <String>

Specifies an external IP address for a NAT, as a string.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NatName <String>

Specifies the name for the NAT instance, as a string.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PortEnd <UInt16>

Specifies the high end of a dynamic port range from which to pick a port for a NAT session. Choose a port number that is greater than the PortStart parameter from the available ports. NAT associates a port number with an external address to identify the mapping between an internal network and an external network.

Aliases

None

Required?

false

Position

named

Default value

65535

Accept pipeline input?

false

Accept wildcard characters?

false

-PortStart <UInt16>

Specifies the low end of a dynamic port range from which to pick a port for a NAT session. Choose a port number that is less than the PortEnd parameter from the available ports. NAT associates a port number with an external address to identify the mapping between an internal network and an external network.

Aliases

None

Required?

false

Position

named

Default value

1024

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetNatExternalAddress

Notes

None

Examples

Example 1: Add an external address

This command adds the external address 10.20.30.120 to a NAT. This example uses the placeholder a.b.c.0/24 to represent a public Internet address prefix.

PS C:\> Add-NetNatExternalAddress -IPAddress "a.b.c.0/24"

Example 2: Add an external address and a port range

This command adds an external address to a specified NAT, and specifies a range of ports to use for outbound connections. This example uses the placeholder a.b.c.0/24 to represent a public Internet address prefix.

PS C:\> Add-NetNatExternalAddress -IPAddress "a.b.c.0/24" -PortEnd 19999 -PortStart 10000 

Online Version
Get-NetNatExternalAddress
Remove-NetNatExternalAddress