< Back

Remove-NetNatStaticMapping

Tue Jan 29, 2019 10:27 pm

NAME Remove-NetNatStaticMapping



SYNOPSIS

Removes static mappings from a NAT instance.





SYNTAX

Remove-NetNatStaticMapping [[-NatName] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-StaticMappingID <UInt32[]>] [-ThrottleLimit

<Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Remove-NetNatStaticMapping [-AsJob] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject <CimInstance[]> [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-NetNatStaticMapping cmdlet removes one or more static mappings configured on network address translation (NAT) instances. A static

mapping enables an incoming connection from an external network to an internal network through the NAT.





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



-InputObject <CimInstance[]>

Specifies an array of NAT static mapping objects. To obtain a NAT static mapping object, use the Get-NetNatStaticMapping cmdlet.



Required? true

Position? named

Default value

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-NatName <String[]>

Specifies an array of names of NAT instances.



Required? false

Position? 1

Default value

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StaticMappingID <UInt32[]>

Specifies an array of static mapping IDs.



Required? false

Position? named

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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



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.



Required? false

Position? named

Default value false

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_NetNatStaticMapping







Example 1: Remove all static mappings from a NAT instance



PS C:\\> Remove-NetNatStaticMapping



This command removes all static mapping of NAT instances configured on the local computer.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294378

Add-NetNatStaticMapping

Get-NetNatStaticMapping