Set-NetVirtualizationCustomerRoute

Set-NetVirtualizationCustomerRoute

Changes the metric value for virtual routes.

Sintaxis

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

Parameter Set: InputObject (cdxml)
Set-NetVirtualizationCustomerRoute -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Metric <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Descripción detallada

The Set-NetVirtualizationCustomerRoute cmdlet changes the metric value for virtual routes in 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 a virtual network. Network Virtualization uses the metric to choose a preferred route from several possible routes. For more information, see Network Virtualization technical details (https://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 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.

Parámetros

-AsJob

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

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

-InputObject<CimInstance[]>

Especifica la entrada para este cmdlet. Puede usar este parámetro o puede canalizar la entrada a este cmdlet.

-Metric<UInt32>

Specifies a new value for the metric of a route.

-NextHop<String[]>

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

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

-RoutingDomainID<String[]>

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

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

-VirtualSubnetID<UInt32[]>

Specifies an array of IDs for virtual subnets. Los valores aceptables para este parámetro son los siguientes:integers from 4096 through 16777214.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

Ejemplos

Example 1: Change a metric value

This command changes the metric value to 3 for a Customer Route that has the specified destination prefix.

PS C:\> Set-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -Metric 3

Example 2: Change a metric value for mulitple Customer Routes

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.

PS C:\> Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Set-NetVirtualizationCustomerRoute -Metric 3

Temas relacionados

Get-NetVirtualizationCustomerRoute

New-NetVirtualizationCustomerRoute

Remove-NetVirtualizationCustomerRoute