Set-BgpPeer

Set-BgpPeer

Modifies BGP configuration.

Syntaxe

Parameter Set: Set3
Set-BgpPeer [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ClearPrefixLimit] [-Force] [-HoldTimeSec <UInt16> ] [-IdleHoldTimeSec <UInt16> ] [-LocalASN <UInt32> ] [-LocalIPAddress <IPAddress> ] [-MaxAllowedPrefix <UInt32> ] [-OperationMode <OperationMode> ] [-PassThru] [-PeerASN <UInt32> ] [-PeeringMode <PeeringMode> ] [-PeerIPAddress <IPAddress> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Weight <UInt16> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The Set-BgpPeer cmdlet modifies peer configuration for Border Gateway Protocol (BGP) routers. Specify a peer to modify by using its name. You can modify the following configuration settings:

-- Autonomous system number (ASN) for the local and peer router instances
-- IP address of the local and peer router instances
-- Maximum number of network prefixes that the local router instance can learn from this peer, or you can remove limit
-- Preference assigned to routes received from this peer
-- Operation mode and peering mode
-- Hold time, in seconds

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

-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

-ClearPrefixLimit

Indicates that the cmdlet removes the limit on the number of network prefixes learned from the peer. Specify a limit by using the MaxAllowedPrefix parameter. You cannot specify both the MaxAllowedPrefix parameter and the ClearPrefixLimit parameter.

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

-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

-HoldTimeSec<UInt16>

Specifies the hold time, in seconds. If this computer does not receive any messages from the peer within this time, the session expires.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	180
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-IdleHoldTimeSec<UInt16>

Specifies the time in seconds for which the BGP Peer stays in an idle state after an unsuccessful peer connection attempt.

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

-LocalIPAddress<IPAddress>

Specifies the IP address that the local router uses for the peer connection.

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

-MaxAllowedPrefix<UInt32>

Specifies the maximum number of network prefixes that this router learns from its peer. To remove this limit, specify the ClearPrefixLimit parameter. You cannot specify both the MaxAllowedPrefix parameter and the ClearPrefixLimit parameter.

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

-Name<String>

Specifies a name. The cmdlet modifies settings for the named peer.

Alias	PeerId,PeerName
Obligatoire ?	true
Position ?	2
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-OperationMode<OperationMode>

Specifies the BGP router mode of operation. Les valeurs acceptables pour ce paramètre sont :

-- Mixed. The peer both initiates and accepts requests.
-- Server. The peer only accepts requests.

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

-PeerASN<UInt32>

Specifies the ASN for the peer.

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

-PeeringMode<PeeringMode>

Specifies the peering mode for the peer. Les valeurs acceptables pour ce paramètre sont :

-- Automatic. Starts peering attempts automatically when added.
-- Manual. Starts peering attempts after you start the session by using the Start-BgpPeer cmdlet.

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

-PeerIPAddress<IPAddress>

Specifies the IP address of the peer.

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

-RoutingDomain<String>

Specifies the name of the routing domain as a string. The name is a unique, for the multitenant gateway, user-defined alphanumeric string.

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

-Weight<UInt16>

Specifies the preference, as an integer, assigned to routes received from this peer. Higher values have higher priority.

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

-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#BgpPeerConfig

Exemples

Example 1: Change the peering mode to Automatic

This command changes the peering mode of the peer named TenantSite17 to Automatic. The command includes the PassThru parameter, so it passes a BgpPeerConfig object to the console. Because the command includes the Force parameter, it does not prompt you for confirmation.

PS C:\> Set-BgpPeer -Name "TenantSite17" -Force -PeeringMode Automatic -PassThru

Example 2: Modify settings for a peer

This command modifies the operation mode and the peering mode of the peer named TenantSite17. The command includes the PassThru parameter, so it passes a BgpPeerConfig object to the console. Because the command does not include the Force parameter, it prompts you for confirmation.

PS C:\> Set-BgpPeer -Name "TenantSite17" -OperationMode Mixed -PeeringMode Automatic -PassThru

Example 3: Modify the ASN of a peer

This command modifies the ASN of the peer named TenantSite17 in the routing domain Rd002. The command includes the PassThru parameter, so it passes a BgpPeerConfig object to the console. Because the command does not include the Force parameter, it prompts you for confirmation.

PS C:\> Set-BgpPeer -Name "Tenant17" -PassThru -PeerASN 64515 -RoutingDomain "Rd002" -PassThru 

Rubriques connexes

Add-BgpPeer

Get-BgpPeer

Remove-BgpPeer

Start-BgpPeer

Stop-BgpPeer