{'Description':'Unique Name for the peering with specified BGP Neighbor.','In':True}
LocalIPAddress
string
1
✓
-
{'Description':'Local BGP Router?s peering IP Address. It can be of IPv4 or IPv6 address type.','In':True}
PeerIPAddress
string
2
✓
-
{'Description':'Neighbor BGP Router?s peering IP Address. It can be of IPv4 or IPv6 address type.','In':True}
LocalASN
uint32
3
✓
-
{'Description':'Local AS Number of the BGP Router instance for this peer.','In':True}
PeerASN
uint32
4
✓
-
{'Description':'Neighbor BGP Router?s AS Number.','In':True}
OperationMode
uint32
5
✓
-
{'Description':'BGP Router mode of operation
1. Peering Initiator as well as peering acceptor
2. Only acting as a passive peering request acceptor','In':True}
PeeringMode
uint32
6
✓
-
{'Description':'Enum parameter to configure peering mode for the given peer.','In':True}
HoldTimeSec
uint16
7
✓
-
{'Description':'Configured value of the HoldTime in seconds after which the BGP Session expires if no BGP message is received.','In':True}
IdleHoldTimeSec
uint16
8
✓
-
{'In':True}
Weight
uint16
9
✓
-
{'Description':'Administrative preference assigned to the routes received from this peer.','In':True}
MaxAllowedPrefix
uint32
10
✓
-
{'Description':'Maximum number of allowed IPv4 / IPv6 network prefixes that can be learned from the given neighbor.','In':True}
PassThru
boolean
11
✓
-
{'Description':'Indicates that cmdlet returns an output object.','In':True}
RoutingDomain
string
12
✓
-
{'Description':'User-defined unique alphanumeric ID for the Routing domain / Tenant.','In':True}
{'Description':'class BgpPeerConfig
{
string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant.
string PeerName Specifies the unique alphanumeric ID of the BGP peer
ipaddress LocalIPAddress Specifies the BGP router's local peering IP Address
ipaddress PeerIPAddress Specifies the BGP peer's peering IP Address
uint32 LocalASN Specifies the Local BGP router's AS Number for this peer
uint32 PeerASN Specifies the BGP peer's AS Number
string OperationMode Specifies the local BGP router's mode of operation for the peer
boolean PeeringMode Specifies whether the BGP peering session start type is manual or automatic for the peer
uint16 HoldTimeSec Specifies the value of timer after whose expiry, BGP peering session is automatically stopped.
uint16 Weight Specifies the administrative preference assigned to this peer
string ConnectivityStatus Specifies the connectivity status of the BGP peering session
uint32 MaxAllowedPrefix Specifies the maximum number of allowed BGP prefixes that can be learned from the given BGP peer
string IngressPolicyList[] Specifies the list of policies that are to be applied to the incoming route advertisements
string EngressPolicyList[] Specifies the list of policies that are to be applied to the outgoing route advertisements
}','EmbeddedInstance':'BgpPeerConfig','Out':True}
{'Description':'class BgpPeerConfig
{
string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant.
string PeerName Specifies the unique alphanumeric ID of the BGP peer
ipaddress LocalIPAddress Specifies the BGP router's local peering IP Address
ipaddress PeerIPAddress Specifies the BGP peer's peering IP Address
uint32 LocalASN Specifies the Local BGP router's AS Number for this peer
uint32 PeerASN Specifies the BGP peer's AS Number
string OperationMode Specifies the local BGP router's mode of operation for the peer
boolean PeeringMode Specifies whether the BGP peering session start type is manual or automatic for the peer
uint16 HoldTimeSec Specifies the value of timer after whose expiry, BGP peering session is automatically stopped.
uint16 Weight Specifies the administrative preference assigned to this peer
string ConnectivityStatus Specifies the connectivity status of the BGP peering session
uint32 MaxAllowedPrefix Specifies the maximum number of allowed BGP prefixes that can be learned from the given BGP peer
string IngressPolicyList[] Specifies the list of policies that are to be applied to the incoming route advertisements
string EngressPolicyList[] Specifies the list of policies that are to be applied to the outgoing route advertisements
}','EmbeddedInstance':'BgpPeerConfig','Out':True}
Description
'Get-BgpPeer cmdlet retrieves the BGP Peer configuration information for one or more BGP peers.'
{'Description':'Peer Name for which the configuration is to be modified.','In':True}
LocalIPAddress
string
1
✓
-
{'Description':'Local BGP Router?s peering IP Address. It can be of IPv4 or IPv6 address type.','In':True}
PeerIPAddress
string
2
✓
-
{'Description':'Neighbor BGP Router?s peering IP Address. It can be of IPv4 or IPv6 address type.','In':True}
LocalASN
uint32
3
✓
-
{'Description':'Local AS Number of the BGP Router instance for this peer.','In':True}
PeerASN
uint32
4
✓
-
{'Description':'Neighbor BGP Router?s AS Number.','In':True}
OperationMode
uint32
5
✓
-
{'Description':'BGP Router mode of operation
1. Peering Initiator as well as peering acceptor
2. Only acting as a passive peering request acceptor','In':True}
PeeringMode
uint32
6
✓
-
{'Description':'Enum parameter to configure peering mode for the given peer.','In':True}
HoldTimeSec
uint16
7
✓
-
{'Description':'Configured value of the HoldTime in seconds after which the BGP Session expires if no BGP message is received.','In':True}
IdleHoldTimeSec
uint16
8
✓
-
{'In':True}
Weight
uint16
9
✓
-
{'Description':'Administrative preference assigned to the routes received from this peer.','In':True}
MaxAllowedPrefix
uint32
10
✓
-
{'Description':'Maximum number of allowed IPv4 / IPv6 network prefixes that can be learned from the given neighbor.','In':True}
RoutingDomain
string
11
✓
-
{'Description':'User-defined unique alphanumeric ID for the Routing domain / Tenant.','In':True}
PassThru
boolean
12
✓
-
{'Description':'Indicates that cmdlet returns an output object.','In':True}
Force
boolean
13
✓
-
{'Description':'Indicates no confirmation prompt before modifying the configuration for peer.','In':True}
ClearPrefixLimit
boolean
14
✓
-
{'Description':'Clears the Maximum limit on prefixes to be learned from the peer. It resets the prefix learning to unlimited number.','In':True}
{'Description':'class BgpPeerConfig
{
string RoutingDomain Specifies the alphanumeric ID of the Routing Domain / Tenant.
string PeerName Specifies the unique alphanumeric ID of the BGP peer
ipaddress LocalIPAddress Specifies the BGP router's local peering IP Address
ipaddress PeerIPAddress Specifies the BGP peer's peering IP Address
uint32 LocalASN Specifies the Local BGP router's AS Number for this peer
uint32 PeerASN Specifies the BGP peer's AS Number
string OperationMode Specifies the local BGP router's mode of operation for the peer
boolean PeeringMode Specifies whether the BGP peering session start type is manual or automatic for the peer
uint16 HoldTimeSec Specifies the value of timer after whose expiry, BGP peering session is automatically stopped.
uint16 Weight Specifies the administrative preference assigned to this peer
string ConnectivityStatus Specifies the connectivity status of the BGP peering session
uint32 MaxAllowedPrefix Specifies the maximum number of allowed BGP prefixes that can be learned from the given BGP peer
string IngressPolicyList[] Specifies the list of policies that are to be applied to the incoming route advertisements
string EngressPolicyList[] Specifies the list of policies that are to be applied to the outgoing route advertisements
}','EmbeddedInstance':'BgpPeerConfig','Out':True}
Description
'Set-BgpPeer cmdlet modifies the configuration of the specified BGP peer.'