< Back
Get-NetNat
Post
NAME Get-NetNat
SYNOPSIS
Gets NAT objects.
SYNTAX
Get-NetNat [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-NetNat cmdlet gets Network Address Translation (NAT) objects configured on a computer. NAT modifies IP address and port information in
packet headers.
Specify a value for the Name parameter to get specific NAT objects. To get all the NAT objects for a computer, do not include the Name parameter.
You can use this cmdlet to get NAT objects to modify by using the Set-NetNat cmdlet or NAT objects to remove by using the Remove-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.
For more information about Windows PowerShell???? background jobs, see about_Jobs.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies an array of names of NAT objects.
Required? false
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetNat
Example 1: Get all the NAT objects for the current computer
PS C:\\> Get-NetNat
This command gets all the NAT objects for the current computer.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294370
New-NetNat
Remove-NetNatExternalAddress
Set-NetNat
SYNOPSIS
Gets NAT objects.
SYNTAX
Get-NetNat [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-NetNat cmdlet gets Network Address Translation (NAT) objects configured on a computer. NAT modifies IP address and port information in
packet headers.
Specify a value for the Name parameter to get specific NAT objects. To get all the NAT objects for a computer, do not include the Name parameter.
You can use this cmdlet to get NAT objects to modify by using the Set-NetNat cmdlet or NAT objects to remove by using the Remove-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.
For more information about Windows PowerShell???? background jobs, see about_Jobs.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String[]>
Specifies an array of names of NAT objects.
Required? false
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetNat
Example 1: Get all the NAT objects for the current computer
PS C:\\> Get-NetNat
This command gets all the NAT objects for the current computer.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294370
New-NetNat
Remove-NetNatExternalAddress
Set-NetNat