Export (0) Print
Expand All

Get-NetVirtualizationCustomerRoute

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-NetVirtualizationCustomerRoute

Gets virtual network routes.

Syntax

Parameter Set: ByName
Get-NetVirtualizationCustomerRoute [-AsJob] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-Metric <UInt32[]> ] [-NextHop <String[]> ] [-RoutingDomainID <String[]> ] [-ThrottleLimit <Int32> ] [-VirtualSubnetID <UInt32[]> ] [ <CommonParameters>]




Detailed Description

The Get-NetVirtualizationCustomerRoute cmdlet gets virtual network routes in a Microsoft® Hyper-V® Server 2012 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 a virtual network. This command gets Customer Routes that Network Virtualization use to manage traffic on a virtual network. For more information, see Network Virtualization technical details (http://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can use any combination of the following values to specify which routes to get:

-- Destination prefix. A range of IP addresses as an IP prefix.
-- Next hop. A next hop gateway for the specified destionation addresses.
-- Routing domain ID. An ID for a virtual network that can include multiple virtual subnets.
-- Virtual subnet ID. An ID for a virtual subnet.
-- Route metric. A value that routing uses to select from possible routes.

Parameters

-AsJob

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.


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

-DestinationPrefix<String[]>

Specifies an array of IP prefixes, as strings, for destination networks. You can specify both IPv4 and IPv6 addresses. Use prefix notation: 0.0.0.0/0.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-Metric<UInt32[]>

Specifies an array of integer values for the metrics of routes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NextHop<String[]>

Specifies an array of IP addresses for next hop gateways for routes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-RoutingDomainID<String[]>

Specifies an array of IDs for routing domains. Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000}.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-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

-VirtualSubnetID<UInt32[]>

Specifies an array of IDs for virtual subnets. 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

<CommonParameters>

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

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 a Customer Route

This command gets a Customer Route that has the specified destination prefix.


PS C:\> Get-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" 


Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft