Class bgp:VpnRoute (CONCRETE)

Class ID:2618
Class Label: VPN Route
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (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 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.

Naming Rules
RN FORMAT: vpnrt-{[pfx]}-{rd}

    [1] PREFIX=vpnrt- PROPERTY = pfx


    [2] PREFIX=- PROPERTY = rd




DN FORMAT: 

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

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

                


Diagram

Super Mo: bgp:PfxRoute,
Container Mos: bgp:DomAf (deletable:no),
Contained Mos: bgp:Path,


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] 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.


Contained Hierarchy
[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] 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] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:Db An abstraction of the database.
 
 
 
 ├
[V] l3:Db A database abstraction.
 
 
 
 
 ├
[V] bgp:ARoute The abstract class for a BGP route.
 
 
 
 
 
 ├
[V] bgp:PfxRoute  Abstract class for a bgp route
 
 
 
 
 
 
 ├
[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.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:VpnRoute
address:Ip pfx  (bgp:VpnRoute:pfx)
           Overrides:bgp:PfxRoute:pfx
           Route prefix.
base:Community rd  (bgp:VpnRoute:rd)
           Overrides:bgp:ARoute:rd
           A unique value that extends the formal network address for all routes in a particular VRF, making the route unique within the entire BGP table.
Defined in: bgp:ARoute
bgp:RtFlags
          scalar:Bitmask32
rtFlags  (bgp:ARoute:rtFlags)
           Condition indicators for the route.
bgp:RtVer
          scalar:Uint32
ver  (bgp:ARoute:ver)
           The version of the route.
Defined in: nw:Db
naming:Name
          string:Basic
name  (nw:Db:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Properties Detail

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.



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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of the object.



pfx

Type: address:Ip

Overrides:bgp:PfxRoute:pfx
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
Route prefix.



rd

Type: base:Community

Overrides:bgp:ARoute:rd
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
A unique value that extends the formal network address for all routes in a particular VRF, making the route unique within the entire BGP table.



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.



rtFlags

Type: bgp:RtFlags
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Condition indicators for the route.
Constants
vpn 128u VPN route VPN route
suppressed 16u Suppressed Suppressed
new 1u On new list On new list
xmit 2u On transmit list On transmit list
exported 32u Exported Exported
rib 4u Programmed in the RIB Programmed in the RIB
locked 64u Locked Locked
best 8u Best route in RIB The route is the best route in the RIB
DEFAULT 0 --- Route flags





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.






ver

Type: bgp:RtVer
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The version of the route.