Set method of the PS_BgpPeer class
Updates the configuration of the specified BGP peer.
Syntax
uint32 Set(
[in] string Name,
[in] string LocalIPAddress,
[in] string PeerIPAddress,
[in] uint32 LocalASN,
[in] uint32 PeerASN,
[in] uint32 OperationMode,
[in] uint32 PeeringMode,
[in] uint16 HoldTimeSec,
[in] uint16 IdleHoldTimeSec,
[in] uint16 Weight,
[in] boolean RouteReflectorClient,
[in] uint32 MaxAllowedPrefix,
[in] string RoutingDomain,
[in] boolean PassThru,
[in] boolean Force,
[in] boolean ClearPrefixLimit,
[out] BgpPeerConfig cmdletOutput
);
Parameters
-
Name [in]
-
The name of the peer to update.
-
LocalIPAddress [in]
-
The IP address of the local BGP router.
-
PeerIPAddress [in]
-
The IP address of the BGP router for the peer.
-
LocalASN [in]
-
The Autonomous System Number (ASN) of the local BGP router instance.
-
PeerASN [in]
-
The ASN of the BGP router instance for the peer.
-
OperationMode [in]
-
The mode of operation for the local BGP router. You must set this parameter to one of the following values.
-
1
-
Initiates and accepts peering requests.
-
2
-
Passively accepts peering requests.
PeeringMode [in]
An enumeration parameter that specifies the peering mode for the peer.
HoldTimeSec [in]
Configured value of the HoldTime in seconds after which the BGP Session expires if no BGP message is received.
IdleHoldTimeSec [in]
The duration, in seconds, before a BGP session expires due to inactivity.
Weight [in]
The administrative preference assigned to the routes of the peer.
RouteReflectorClient [in]
Whether the peer is a client peer or non-client peer.
Windows Server 2012 R2: This parameter is not supported before Windows Server 2016.
MaxAllowedPrefix [in]
The maximum number IP network prefixes that the local BGP router can learn from the peer.
RoutingDomain [in]
The user-defined unique alphanumeric ID of the routing domain.
PassThru [in]
Indicates whether the cmdlet returns an output object. True to return an output object; otherwise false.
Force [in]
Indicates whether to use a confirmation prompt to modify the configuration of the peer. True to use a confirmation prompt; otherwise false.
ClearPrefixLimit [in]
Indicates whether an unlimited number of network prefixes is to be learned from the peer. True to learn an unlimited number of network prefixes; otherwise false.
cmdletOutput [out]
The BgpPeerConfig object that receives the additional BGP peer.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\Windows\RemoteAccess |
| MOF |
|
| DLL |
|