Set-BgpRouter
Set-BgpRouter
Modifies the local BGP router configuration.
Sintaxis
Parameter Set: Set3
Set-BgpRouter [-AsJob] [-BgpIdentifier <IPAddress> ] [-CimSession <CimSession[]> ] [-CompareMEDAcrossASN <Boolean> ] [-DefaultGatewayRouting <Boolean> ] [-Force] [-IPv6Routing <IPv6RoutingState> ] [-LocalASN <UInt32> ] [-LocalIPv6Address <IPAddress> ] [-PassThru] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Descripción detallada
The Set-BgpRouter cmdlet modifies the configuration of the local Border Gateway Protocol (BGP) router for a tenant. You can modify the IPv4 address of a local BGP router, specify whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems, and specify whether the cmdlet enables routing of the unresolvable routes to the default gateway. You can also modify the state of IPv6 routing for the BGP router and the IPv6 address of a local BGP router.
Use the Get-BgpRouter cmdlet to see the current settings.
Parámetros
-AsJob
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-BgpIdentifier<IPAddress>
Specifies the IPv4 address of a local BGP router.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
Session |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-CompareMEDAcrossASN<Boolean>
Indicates whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
false |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-DefaultGatewayRouting<Boolean>
Indicates whether the cmdlet enables routing of the unresolvable routes to the default gateway.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
false |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Force
Fuerza que el comando se ejecute sin pedir confirmación al usuario.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-IPv6Routing<IPv6RoutingState>
Specifies the state of IPv6 routing for the BGP router. Los valores aceptables para este parámetro son los siguientes:
-- Enable
-- Disable
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-LocalASN<UInt32>
Specifies the autonomous system number (ASN) for the local router.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-LocalIPv6Address<IPAddress>
Specifies the Internet IPv6 address of a local BGP router. This parameter specifies the global or site-local Internet IPv6 address for the local BGP router. The BGP router uses this IP address as the next hop value in the IPv6 route advertisements.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-RoutingDomain<String>
Specifies the name, as a string, of a routing domain. The name of a routing domain is a user-defined alphanumeric string. It must be unique.
Alias |
RoutingDomainName |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el cmdlet.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<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.
- Microsoft.Management.Infrastructure.CimInstance#BgpRouterConfig
Ejemplos
Example 1: Modify the configuration of the local BGP router
This command modifies the configuration of the local BGP router and restarts all the active BGP peerings. The command specifies that the ASN of the local BGP router instance is 64513. The command prompts the user for confirmation before it modifies the configuration of the router. The command includes the PassThru parameter, so the command sends a BgpRouterConfig object to the console.
PS C:\> Set-BgpRouter -LocalASN 64513 -PassThru
Example 2: Modify the configuration of the local BGP router without confirmation
This command modifies the configuration of the local BGP router and restarts all the active BGP peerings. The command specifies that the ASN of the local BGP router instance is 64513. The command does not prompt the user for confirmation before it modifies the configuration of the router.
PS C:\> Set-BgpRouter -LocalASN 64513 -Force -PassThru
Example 3: Modify the configuration of a BGP router in a routing domain
This command modifies the configuration of the BGP router for the routing domain named Rd_001. The command specifies the IP address of the local BGP router for the routing domain, and it specifies that the ASN of the local BGP router instance is 64522.
PS C:\> Set-BgpRouter -RoutingDomain "Rd_001" -BgpIdentifier 10.1.1.10 -LocalASN 64522 -PassThru