< Back
Set-NetVirtualizationCustomerRoute
Post
NAME Set-NetVirtualizationCustomerRoute
SYNOPSIS
Changes the metric value for virtual routes.
SYNTAX
Set-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-DestinationPrefix <String[]>] [-Metric <UInt32>]
[-NextHop <String[]>] [-PassThru] [-RoutingDomainID <String[]>] [-ThrottleLimit <Int32>] [-VirtualSubnetID
<UInt32[]>] [<CommonParameters>]
Set-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-PassThru] [-ThrottleLimit
<Int32>] [<CommonParameters>]
DESCRIPTION
The Set-NetVirtualizationCustomerRoute cmdlet changes the metric value for virtual routes in 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 a
virtual network. Network Virtualization uses the metric to select a preferred route from several possible routes.
For more information, see Network Virtualization technical details
(http://technet.microsoft.com/library/jj134174.aspx) on TechNet.
You can use the Get-NetVirtualizationCustomerRoute cmdlet to get routes to modify, or you can use any combination
of the following values to specify which routes to modify:
-- Destination prefix. A range of IP addresses as an IP prefix.
-- Next hop. A next hop gateway for the specified destination 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.
PARAMETERS
-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.
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 IPv4 and IPv6
addresses. Use prefix notation: 0.0.0.0/0.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Metric [<UInt32>]
Specifies a new value for the metric of a route.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate
any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RoutingDomainID [<String[]>]
Specifies an array of IDs for routing domains. Routing domains use a GUID style ID:
{11111111-2222-3333-4444-000000000000}.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Change a metric value
PS C:\\>Set-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -Metric 3
This command changes the metric value to 3 for a Customer Route that has the specified destination prefix.
Example 2: Change a metric value for mulitple Customer Routes
PS C:\\>Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Set-NetVirtualizationCustomerRoute -Metric 3
This command uses the Get-NetVirtualizationCustomerRoute to get all the Customer Routes that have a next hop
gateway of 172.16.0.1. The command passes them by using the pipe operator to the
Set-NetVirtualizationCustomerRoute cmdlet, which changes the metric value to 3 for those Customer Routes.
RELATED LINKS
Get-NetVirtualizationCustomerRoute
New-NetVirtualizationCustomerRoute
Remove-NetVirtualizationCustomerRoute
SYNOPSIS
Changes the metric value for virtual routes.
SYNTAX
Set-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-DestinationPrefix <String[]>] [-Metric <UInt32>]
[-NextHop <String[]>] [-PassThru] [-RoutingDomainID <String[]>] [-ThrottleLimit <Int32>] [-VirtualSubnetID
<UInt32[]>] [<CommonParameters>]
Set-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-PassThru] [-ThrottleLimit
<Int32>] [<CommonParameters>]
DESCRIPTION
The Set-NetVirtualizationCustomerRoute cmdlet changes the metric value for virtual routes in 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 a
virtual network. Network Virtualization uses the metric to select a preferred route from several possible routes.
For more information, see Network Virtualization technical details
(http://technet.microsoft.com/library/jj134174.aspx) on TechNet.
You can use the Get-NetVirtualizationCustomerRoute cmdlet to get routes to modify, or you can use any combination
of the following values to specify which routes to modify:
-- Destination prefix. A range of IP addresses as an IP prefix.
-- Next hop. A next hop gateway for the specified destination 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.
PARAMETERS
-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.
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 IPv4 and IPv6
addresses. Use prefix notation: 0.0.0.0/0.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Metric [<UInt32>]
Specifies a new value for the metric of a route.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate
any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RoutingDomainID [<String[]>]
Specifies an array of IDs for routing domains. Routing domains use a GUID style ID:
{11111111-2222-3333-4444-000000000000}.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Change a metric value
PS C:\\>Set-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -Metric 3
This command changes the metric value to 3 for a Customer Route that has the specified destination prefix.
Example 2: Change a metric value for mulitple Customer Routes
PS C:\\>Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Set-NetVirtualizationCustomerRoute -Metric 3
This command uses the Get-NetVirtualizationCustomerRoute to get all the Customer Routes that have a next hop
gateway of 172.16.0.1. The command passes them by using the pipe operator to the
Set-NetVirtualizationCustomerRoute cmdlet, which changes the metric value to 3 for those Customer Routes.
RELATED LINKS
Get-NetVirtualizationCustomerRoute
New-NetVirtualizationCustomerRoute
Remove-NetVirtualizationCustomerRoute