Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-NetVirtualizationLookupRecord

Last Updated: 2/14/2017

SYNOPSIS

Removes policy entries for IP addresses in a virtual network.

SYNTAX

ByName (Default)

Remove-NetVirtualizationLookupRecord [-CustomerAddress <String[]>] [-MACAddress <String[]>]
 [-VirtualSubnetID <UInt32[]>] [-ProviderAddress <String[]>] [-CustomerID <String[]>] [-Context <String[]>]
 [-Rule <RuleType[]>] [-VMName <String[]>] [-UseVmMACAddress <Boolean[]>] [-Type <Type[]>]
 [-Unusable <Boolean[]>] [-Unsynchronized <Boolean[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [-PassThru] [<CommonParameters>]

InputObject (cdxml)

Remove-NetVirtualizationLookupRecord -InputObject <CimInstance[]> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]

DESCRIPTION

The Remove-NetVirtualizationLookupRecord cmdlet removes lookup record policy entries for IP addresses that belong to a Microsoft® Hyper-V® Server 2016 virtual network. Network Virtualization allows for more than one virtual network to exist on the same physical network. Computers can exchange network traffic with a virtual machine by using a Customer Address in 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 on TechNet.

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

EXAMPLES

Example 1: Remove all policy entries

PS C:\> Remove-NetVirtualizationLookupRecord

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

Example 2: Remove policy entries for a specified virtual subnet

PS C:\>Remove-NetVirtualizationLookupRecord -VirtualSubnetID 10234

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

Example 3: Remove policy entries for a specified virtual machine name

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

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

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Context

Specifies an array of comments regarding policy entries.

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CustomerAddress

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

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CustomerID

Specifies an array of IDs for policy entries or virtual machines.

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-MACAddress

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

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProviderAddress

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

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Rule

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.
Type: RuleType[]
Parameter Sets: ByName
Aliases: 
Accepted values: TranslationMethodNat, TranslationMethodEncap, TranslationMethodNone

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

Specifies an array of types. The type determines the address mapping for a record.

Type: Type[]
Parameter Sets: ByName
Aliases: 
Accepted values: Static, Dynamic, GatewayWildcard, L2Only

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Unsynchronized

Specifies an array of Boolean values that indicate whether a record is not synchronized with the central policy controller.

Type: Boolean[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Unusable

Specifies an array of Boolean values that indicate whether a record is unusable for data communication.

Type: Boolean[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseVmMACAddress

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

Type: Boolean[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VMName

Specifies an array of names for the virtual machine for a policy entry.

Type: String[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VirtualSubnetID

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.

Type: UInt32[]
Parameter Sets: ByName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Get-NetVirtualizationLookupRecord

New-NetVirtualizationLookupRecord

Set-NetVirtualizationLookupRecord

© 2017 Microsoft