BgpRouteInfo class

Retrieves the configuration of a Border Gateway Protocol (BGP) route.

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 BgpRouteInfo
{
  string        RoutingDomain;
  string        Network;
  string        NextHop;
  string        Origin;
  ASPathSegment ASPath[];
  uint32        LocalPref;
  string        Community[];
  uint32        MED;
  string        LearnedFromPeer;
  uint32        State[];
  uint32        ClusterList[];
  string        OriginatorId;
  string        Aggregator;
  boolean       Aggregate;
};

Members

The BgpRouteInfo class has these types of members:

• Properties

Properties

The BgpRouteInfo class has these properties.

Aggregate

Data type: boolean

Access type: Read-only

True if the route is an aggregate route.

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

Aggregator

Data type: string

Access type: Read-only

Contains the 2 byte ASN|IpAddress of the aggregating node in case the route is an aggregated route

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

ASPath

Data type: ASPathSegment array

Access type: Read-only

Qualifiers: EmbeddedInstance ("ASPathSegment")

An array of the Autonomous System Numbers (ASN) of the autonomous system (AS) path of the BGP route.

ClusterList

Data type: uint32 array

Access type: Read-only

The Cluster Ids that make up the cluster list of the route.

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

Community

Data type: string array

Access type: Read-only

The community attribute values associated with the prefix of the BGP route.

LearnedFromPeer

Data type: string

Access type: Read-only

The PeerID that indicates the origin of the of the prefix of the BGP route.

LocalPref

Data type: uint32

Access type: Read-only

The local preference value of the BGP route.

MED

Data type: uint32

Access type: Read-only

The multi-exit discriminator (MED) of the BGP route.

Network

Data type: string

Access type: Read-only

An array of the IPv4 or IPv6 network address from the BGP router's Local Routing Information Base (Local-RIB), and the network mask for the Classless Inter-Domain Routing (CIDR) network address.

NextHop

Data type: string

Access type: Read-only

The IP address of the next hop on the destination network

Origin

Data type: string

Access type: Read-only

The path origin type of the destination network.

The possible values are.

IGP ("IGP")

EGP ("EGP")

INCOMPLETE ("INCOMPLETE")

OriginatorId

Data type: string

Access type: Read-only

The BGP identifier of the originator of the route in the local autonomous system (AS).

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

RoutingDomain

Data type: string

Access type: Read-only

The user-defined alphanumeric ID of the network's routing domain.

Note

This property is only used with multi-tenant deployments.

State

Data type: uint32 array

Access type: Read-only

A flag that indicates the state of route.

Examples: BestPath or Suppressed

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

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