Get-NetVirtualizationLookupRecord
Get-NetVirtualizationLookupRecord
Gets policy entries for VMs in a virtual network.
Syntax
Parameter Set: ByName
Get-NetVirtualizationLookupRecord [-AsJob] [-CimSession <CimSession[]> ] [-Context <String[]> ] [-CustomerAddress <String[]> ] [-CustomerID <String[]> ] [-MACAddress <String[]> ] [-ProviderAddress <String[]> ] [-Rule <RuleType[]> ] [-ThrottleLimit <Int32> ] [-UseVmMACAddress <Boolean[]> ] [-VirtualSubnetID <UInt32[]> ] [-VMName <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-NetVirtualizationLookupRecord cmdlet gets 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 gets 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Context<String[]>
Specifies an array of comments regarding policy entries.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CustomerAddress<String[]>
Specifies an array of IP addresses within the virtual network. You can use both IPv4 and IPv6 addresses.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CustomerID<String[]>
Specifies an array of IDs for policy entries or VMs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MACAddress<String[]>
Specifies an array of medial access control (MAC) addresses that corresponds to the Customer Addresses.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProviderAddress<String[]>
Specifies an array of IP addresses, either IPv4 or IPv6, for physical addresses that corresponds to the Customer Addresses.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UseVmMACAddress<Boolean[]>
Specifies an array of Boolean values that indicate whether an entry uses its defined MAC address instead of physical MAC address.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies an array of names for the VM for a policy entry.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<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: Get all policy entries for a host
This command gets all the policy entries for the current host.
PS C:\> Get-NetVirtualizationLookupRecord
Example 2: Get policy entries for a specified virtual subnet
This command gets all policy entries that belong to the virtual subnet that has the ID 50002.
PS C:\> Get-NetVirtualizationLookupRecord -VirtualSubnetID 50002
Example 3: Get policy entries for a physical IP address
This command gets all the policy entries that contain the specified provider address.
PS C:\> Get-NetVirtualizationLookupRecord -ProviderAddress "192.168.3.24"
Related topics
New-NetVirtualizationLookupRecord