Get-NetVirtualizationLookupRecord
Gets policy entries for virtual machines in a virtual network.
Syntax
Default (Default)
Get-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]
[<CommonParameters>]
Description
The Get-NetVirtualizationLookupRecord cmdlet gets 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 gets records that map a Customer Address to a Provider Address. For more information, see Network Virtualization technical details on TechNet.
Examples
Example 1: Get all policy entries for a host
PS C:\> Get-NetVirtualizationLookupRecord
This command gets all the policy entries for the current host.
Example 2: Get policy entries for a specified virtual subnet
PS C:\>Get-NetVirtualizationLookupRecord -VirtualSubnetID 50002
This command gets all policy entries that belong to the virtual subnet that has the ID 50002.
Example 3: Get policy entries for a physical IP address
PS C:\>Get-NetVirtualizationLookupRecord -ProviderAddress "192.168.3.24"
This command gets all the policy entries that contain the specified provider address.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Context
Specifies an array of comments regarding policy entries.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomerAddress
Specifies an array of IP addresses in the virtual network. You can use both IPv4 and IPv6 addresses.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomerID
Specifies an array of IDs for policy entries or virtual machines.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MACAddress
Specifies an array of media access control (MAC) addresses that corresponds to the Customer Addresses.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProviderAddress
Specifies an array of IP addresses, either IPv4 or IPv6, for physical addresses that corresponds to the Customer Addresses.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | RuleType[] |
| Default value: | None |
| Accepted values: | TranslationMethodNat, TranslationMethodEncap, TranslationMethodNone |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Specifies an array of types. The type determines the address mapping for a record.
Parameter properties
| Type: | Type[] |
| Default value: | None |
| Accepted values: | Static, Dynamic, GatewayWildcard, L2Only |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Unsynchronized
Specifies an array of Boolean values that indicates whether this record is not synchronized with the central policy controller. This is a read-only property of the lookup record that provides diagnostic information.
Parameter properties
| Type: | Boolean[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Unusable
Specifies an array of Boolean values that indicates whether this record is unusable for data communication. This is a read-only property of the lookup record that provides diagnostic information.
Parameter properties
| Type: | Boolean[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseVmMACAddress
Specifies an array of Boolean values that indicate whether an entry uses its defined MAC address instead of physical MAC address.
Parameter properties
| Type: | Boolean[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | UInt32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMName
Specifies an array of names for the virtual machine for a policy entry.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.