Skip to content
PowerShell Commands

New-NetNat

New-NetNat [-Name*] <String> [-AsJob] [-CimSession <CimSession[]>] [-InternalRoutingDomainId <String>][-ThrottleLimit <Int32>] -ExternalIPInterfaceAddressPrefix* <String> [-Confirm] [-WhatIf] [<CommonParameters>]

The New-NetNat cmdlet creates a Network Address Translation (NAT) object that translates an internal network address to an external network address. NAT modifies IP address and port information in packet headers.

You can modify some settings by using the Set-NetNat cmdlet.

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.

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

-ExternalIPInterfaceAddressPrefix <String>

  • This value is required

Specifies the address prefix of the external interface, which connects the NAT to the external network.

-InternalRoutingDomainId <String>

Specifies the GUID of the routing domain of the internal interface.

-Name <String>

  • This value is required

Specifies a name for the NAT object.

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

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
None
Outputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetNat
Examples
  1. Create a NAT object for a routing domain:
    PS C:\>  New-NetNat -Name "TSQATenant" -ExternalIPInterfaceAddress "a.b.c.0/24" -InternalRoutingDomainId "{bb47986c-f134-4a29-ad87-24010bf2c92f}"

    This command creates a NAT object named TSQATenant. The command specifies an IP interface address and internal routing domain for TSQATenant. This example uses the placeholder a.b.c.0/24 to represent a public Internet address prefix.

  2. Create a NAT object for all the computers on a subnet:
    PS C:\>  New-NetNat -Name "AllTenants" -ExternalIPInterfaceAddress "a.b.c.0/24"

    This command creates a NAT object named AllTenants for all the computers in the specified subnet. This example uses the placeholder a.b.c.0/24 to represent a public Internet address prefix.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands