Remove-NetVirtualizationLookupRecord

Remove-NetVirtualizationLookupRecord

Removes policy entries for IP addresses in a virtual network.

Syntax

Parameter Set: ByName
Remove-NetVirtualizationLookupRecord [-AsJob] [-CimSession <CimSession[]> ] [-Context <String[]> ] [-CustomerAddress <String[]> ] [-CustomerID <String[]> ] [-MACAddress <String[]> ] [-PassThru] [-ProviderAddress <String[]> ] [-Rule <RuleType[]> ] [-ThrottleLimit <Int32> ] [-UseVmMACAddress <Boolean[]> ] [-VirtualSubnetID <UInt32[]> ] [-VMName <String[]> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetVirtualizationLookupRecord -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Remove-NetVirtualizationLookupRecord cmdlet removes lookup record policy entries for IP addresses that belong to a virtual network. Network Virtualization allows more than one virtual network to exist on the same physical network. Computers can exchange network traffic with a virtual machine (VM) by using a Customer Address within the virtual network. Network Virtualization manages the Provider Addresses that are the physical network addresses. This cmdlet removes records that map a Customer Address to a Provider Address. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can specify which entries to remove, or you can remove all policy entries for a host. You can use the Get-NetVirtualizationLookupRecord cmdlet to get entries to remove.

Parameters

-AsJob

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

-Context<String[]>

Specifies an array of comments regarding policy entries.

-CustomerAddress<String[]>

Specifies an array of IP addresses within the virtual network. You can use both IPv4 and IPv6 addresses.

-CustomerID<String[]>

Specifies an array of IDs for policy entries or VMs.

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-MACAddress<String[]>

Specifies an array of media access control (MAC) addresses that corresponds to the Customer Addresses.

-PassThru

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

-ProviderAddress<String[]>

Specifies an array of IP addresses, either IPv4 or IPv6, for physical addresses that corresponds to the Customer Addresses.

-Rule<RuleType[]>

Specifies an array of virtualization mechanisms that policy entries use. The acceptable values for this parameter are:

-- TranslationMethodNat. IP address rewrite.
-- TranslationMethodEncap. Network Virtualization Generic Routing Encapsulation (NVGRE).
-- TranslationMethodNone. None.

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

-UseVmMACAddress<Boolean[]>

Specifies an array of Boolean values that indicate whether an entry uses its defined MAC address instead of physical MAC address.

-VirtualSubnetID<UInt32[]>

Specifies an array of IDs for the virtual subnet that the Customer address belongs to. The acceptable values for this parameter are:integers from 4096 through 16777214.

-VMName<String[]>

Specifies an array of names for the VM for a policy entry.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove all policy entries

This command removes all the policy entries for the current host.

PS C:\> Remove-NetVirtualizationLookupRecord

Example 2: Remove policy entries for a specified virtual subnet

This command removes all policy entries that belong to the virtual subnet that has the ID 10234.

PS C:\> Remove-NetVirtualizationLookupRecord -VirtualSubnetID 10234

Example 3: Remove policy entries for a specified VM name

This command removes all the policy entries that contain the specified VM name.

PS C:\> Remove-NetVirtualizationLookupRecord -VMName "Contoso-VM2"

Related topics

Get-NetVirtualizationLookupRecord

New-NetVirtualizationLookupRecord

Set-NetVirtualizationLookupRecord