BgpPeerConfig
TOC
Collapse the table of content
Expand the table of content

BgpPeerConfig class

Retrieves information about a peer configuration of a Border Gateway Protocol (BGP) router.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[ClassVersion("1.0.0"), dynamic, provider("RAMgmtPSProvider"), AMENDMENT]
class BgpPeerConfig
{
  string  RoutingDomain;
  string  PeerName;
  string  LocalIPAddress;
  string  PeerIPAddress;
  uint32  LocalASN;
  uint32  PeerASN;
  uint32  OperationMode;
  uint32  PeeringMode;
  uint16  HoldTimeSec;
  uint16  IdleHoldTimeSec;
  uint16  Weight;
  uint32  ConnectivityStatus;
  string  IngressPolicyList[];
  string  EgressPolicyList[];
  uint32  MaxAllowedPrefix;
  boolean RouteReflectorClient;
};

Members

The BgpPeerConfig class has these types of members:

Properties

The BgpPeerConfig class has these properties.

ConnectivityStatus
Data type: uint32
Access type: Read-only

The status of the peer connection.

EgressPolicyList
Data type: string array
Access type: Read-only

The list of policy IDs that are applied to outgoing BGP route advertisements

HoldTimeSec
Data type: uint16
Access type: Read-only

When a BGP Session expires due to a lack of response from the peer, in seconds.

IdleHoldTimeSec
Data type: uint16
Access type: Read-only

When a BGP Session expires due to a lack of activity, in seconds.

IngressPolicyList
Data type: string array
Access type: Read-only

The list of policy IDs that are applied to incoming BGP route advertisements.

LocalASN
Data type: uint32
Access type: Read-only

The local Autonomous System Number (ASN) of the BGP router instance that connects with the peer.

LocalIPAddress
Data type: string
Access type: Read-only

The local IP address of the BGP router.

MaxAllowedPrefix
Data type: uint32
Access type: Read-only

The maximum number of IPv4 / IPv6 network prefixes that a neighbor is allowed to learn.

OperationMode
Data type: uint32
Access type: Read-only

The mode of operation of the BGP router.

PeerASN
Data type: uint32
Access type: Read-only

The ASN of the peer BGP router.

PeeringMode
Data type: uint32
Access type: Read-only

Whether manual peering mode is enabled for the peer.

PeerIPAddress
Data type: string
Access type: Read-only

The IP address of the peer BGP router.

PeerName
Data type: string
Access type: Read-only

The user-defined alphanumeric ID for the peer.

RouteReflectorClient
Data type: boolean
Access type: Read-only

Whether peer is a client peer or non-client peer.

Windows Server 2012 R2:  This property is not supported before Windows Server 2016 Technical Preview.

RoutingDomain
Data type: string
Access type: Read-only

The user-defined alphanumeric ID of the BGP routing domain.

Note  This property is only used with multi-tenant deployments.
 
Weight
Data type: uint16
Access type: Read-only

The administrative preferences that are assigned to peer routes.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

Root\Microsoft\Windows\RemoteAccess

MOF

RAMgmtPSProvider.Mof

DLL

RAMgmtPSProvider.dll

See also

RAMgmtPSProvider Provider Classes

 

 

Show:
© 2016 Microsoft