Class bgp:Path (CONCRETE)

Class ID:2622
Class Label: Path
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-protocol-l3, tenant-ext-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The BGP AS path.

Naming Rules
RN FORMAT: path-{[peer]}-id-{id}-nh-{[nh]}

    [1] PREFIX=path- PROPERTY = peer


    [2] PREFIX=-id- PROPERTY = id


    [3] PREFIX=-nh- PROPERTY = nh




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bgp/inst/dom-{name}/af-{type}/vpnrt-{[pfx]}-{rd}/path-{[peer]}-id-{id}-nh-{[nh]}

[1] sys/bgp/inst/dom-{name}/af-{type}/vpnrt-{[pfx]}-{rd}/path-{[peer]}-id-{id}-nh-{[nh]}

[2] topology/pod-{id}/node-{id}/sys/bgp/inst/dom-{name}/af-{type}/rt-{[pfx]}/path-{[peer]}-id-{id}-nh-{[nh]}

[3] sys/bgp/inst/dom-{name}/af-{type}/rt-{[pfx]}/path-{[peer]}-id-{id}-nh-{[nh]}

                


Diagram

Container Mos: bgp:Route (deletable:yes), bgp:VpnRoute (deletable:yes),
Contained Mos: bgp:AsSeg, bgp:ExtComm, bgp:RegComm,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 
 
 
 ├
[V] bgp:VpnRoute The BGP route table for a VPN address family (VPNv4 unicast and VPNv6 unicast). The VPN address family routes are exchanged within the fabric over MP-BGP sessions between spines and leafs. Routes are advertised from border leafs to non-border leafs with spines acting as route reflectors.
 
 
 
 
 
 
 
 
 
 ├
[V] bgp:Path The BGP AS path.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 ├
[V] bgp:VpnRoute The BGP route table for a VPN address family (VPNv4 unicast and VPNv6 unicast). The VPN address family routes are exchanged within the fabric over MP-BGP sessions between spines and leafs. Routes are advertised from border leafs to non-border leafs with spines acting as route reflectors.
 
 
 
 
 
 
 ├
[V] bgp:Path The BGP AS path.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 
 
 
 ├
[V] bgp:Route The BGP route table for a particular address family (IPv4 unicast and IPv6 unicast), which contains all the routes advertised by peers and also redistributed into BGP from other routing protocols. This route table is per tenant context (per VRF).
 
 
 
 
 
 
 
 
 
 ├
[V] bgp:Path The BGP AS path.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 
 ├
[V] bgp:Route The BGP route table for a particular address family (IPv4 unicast and IPv6 unicast), which contains all the routes advertised by peers and also redistributed into BGP from other routing protocols. This route table is per tenant context (per VRF).
 
 
 
 
 
 
 ├
[V] bgp:Path The BGP AS path.


Contained Hierarchy
[V] bgp:Path The BGP AS path.
 ├
[V] bgp:AsSeg The BGP path AS segment information.
 
 ├
[V] bgp:AsItem The Autonomous System segment items.
 ├
[V] bgp:ExtComm An extended community.
 ├
[V] bgp:RegComm The regular community.


Inheritance
[V] bgp:Path The BGP AS path.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:Path
address:Ip aggr  (bgp:Path:aggr)
           Aggregator
rtcom:AS
          scalar:Uint32
aggrAs  (bgp:Path:aggrAs)
           Aggregator AS
string:Basic asPath  (bgp:Path:asPath)
          
string:Basic extComm  (bgp:Path:extComm)
          
bgp:PathFlags
          scalar:Bitmask32
flags  (bgp:Path:flags)
           Path flags
bgp:PathId
          scalar:Uint32
id  (bgp:Path:id)
           Path id
base:Community importedRd  (bgp:Path:importedRd)
           Imported route distinguisher
rtmap:LocalPref
          scalar:Uint32
localPref  (bgp:Path:localPref)
           Local preference
rtmap:Metric
          scalar:Uint32
metric  (bgp:Path:metric)
           Metric
address:Ip nh  (bgp:Path:nh)
           Next hop
bgp:Metric
          scalar:Uint32
nhMetric  (bgp:Path:nhMetric)
           Nexthop metric
bgp:PathSt
          scalar:Enum8
operSt  (bgp:Path:operSt)
           The path status.
bgp:Origin
          scalar:Enum8
origin  (bgp:Path:origin)
           Origin
address:Ip peer  (bgp:Path:peer)
           Peer source of route path
string:Basic regComm  (bgp:Path:regComm)
           The regular community.
bgp:PathT
          scalar:Enum8
type  (bgp:Path:type)
           Path type
string:Basic unknownAttrData  (bgp:Path:unknownAttrData)
          
bgp:UnknownAttrLen
          scalar:Uint32
unknownAttrLen  (bgp:Path:unknownAttrLen)
          
rtmap:Weight
          scalar:Uint16
weight  (bgp:Path:weight)
           Weight
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

aggr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Aggregator



aggrAs

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Aggregator AS



asPath

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



extComm

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



flags

Type: bgp:PathFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Path flags
Constants
atomic-aggr 128u Atomic aggregate Atomic aggregate
multipath 16u Multipath Multipath
max-as-limit 1u Over maximum AS limit Over maximum AS limit
unk-attr 256u Unknown attribute present Unknown attribute present
best-path 2u Best path Best path
imported 32u Imported Imported
rcvd-only 4u Received only Received only
advertise 512u Advertise to peers Advertise to peers
metric 64u Metric Metric
modified 8u Modified Modified from what we received
DEFAULT 0 --- Path flags





id

Type: bgp:PathId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Path id



importedRd

Type: base:Community

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Imported route distinguisher



localPref

Type: rtmap:LocalPref
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local preference



metric

Type: rtmap:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Metric



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





nh

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Next hop



nhMetric

Type: bgp:Metric
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Nexthop metric



operSt

Type: bgp:PathSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The path status.
Constants
deleted 0 Deleted Deleted
staled 1 Staled Staled
valid 2 Valid Valid
DEFAULT 0 --- Path status





origin

Type: bgp:Origin
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Origin
Constants
igp 1 Learned Via IGP IGP
egp 2 Learned Via EGP EGP
incomplete 3 Learned by some other Means Incomplete
DEFAULT igp(1) Learned Via IGP IGP





peer

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Peer source of route path



regComm

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The regular community.



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






type

Type: bgp:PathT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Path type
Constants
internal 1 Internal Internal
external 2 External External
confederation 3 Confederation Confederation
local 4 Local Local
aggregate 5 Aggregate Aggregate
redistribute 6 Redistribute Redistribute
DEFAULT internal(1) Internal Internal





unknownAttrData

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



unknownAttrLen

Type: bgp:UnknownAttrLen
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



weight

Type: rtmap:Weight
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Weight