Set-BgpRouter
Set-BgpRouter
Modifies the local BGP router configuration.
Syntaxe
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>]
Description détaillée
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.
Paramètres
-AsJob
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-BgpIdentifier<IPAddress>
Specifies the IPv4 address of a local BGP router.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-CimSession<CimSession[]>
Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.
Alias |
Session |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-CompareMEDAcrossASN<Boolean>
Indicates whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-DefaultGatewayRouting<Boolean>
Indicates whether the cmdlet enables routing of the unresolvable routes to the default gateway.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-Force
Force la commande à s’exécuter sans demander confirmation à l’utilisateur.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-IPv6Routing<IPv6RoutingState>
Specifies the state of IPv6 routing for the BGP router. Les valeurs acceptables pour ce paramètre sont :
-- Enable
-- Disable
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-LocalASN<UInt32>
Specifies the autonomous system number (ASN) for the local router.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
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 |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-PassThru
Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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 |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-ThrottleLimit<Int32>
Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Confirm
Votre confirmation sera requise avant l’exécution de l’applet de commande.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entrées
Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.
Sorties
Le type de sortie est le type des objets émis par l’applet de commande.
- Microsoft.Management.Infrastructure.CimInstance#BgpRouterConfig
Exemples
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