Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class vns:VBgpDevCfg (CONCRETE)

Class ID:5994
Class Label: BGP Configuration
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, nw-svc-device, nw-svc-policy]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]



Naming Rules 
RN FORMAT: bgpDeviceCfg-{name}

    [1] PREFIX=bgpDeviceCfg- PROPERTY = name




DN FORMAT: 

[1] uni/vDev-{[priKey]}-tn-{[tnDn]}-ctx-{ctxName}/vGrp-{[priKey]}/vFunc-{name}/cfgRoot-{cfgType}/bgpDeviceCfg-{name}

[3] uni/vDev-{[priKey]}-tn-{[tnDn]}-ctx-{ctxName}/vGrp-{[priKey]}/cfgRoot-{cfgType}/bgpDeviceCfg-{name}

[5] uni/vDev-{[priKey]}-tn-{[tnDn]}-ctx-{ctxName}/cfgRoot-{cfgType}/bgpDeviceCfg-{name}


Diagram

Super Mo: vns:AVRoutingDeviceCfg,
Container Mos: vns:CfgRoot (deletable:yes),
Contained Mos: vns:AVRoutingNetworks, vns:VBgpPeer,


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] ctx:Local The local Context.
 
 		 
 		 
 		 
 		 ├
 		[V] ctx:Application The context application.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pol:Uni Represents policy definition/resolution universe.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VGrp A grouping of virtual functions in a single graph allows virtual functions on a service device to be combined without traffic egressing from the device.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VFunc A virtual function is a single function on a service device such as a firewall, a load balancer, or an SSL offloading device.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 
[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] pol:Uni Represents policy definition/resolution universe.
 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 ├
 		[V] vns:VGrp A grouping of virtual functions in a single graph allows virtual functions on a service device to be combined without traffic egressing from the device.
 
 		 
 		 
 		 ├
 		[V] vns:VFunc A virtual function is a single function on a service device such as a firewall, a load balancer, or an SSL offloading device.
 
 		 
 		 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 
[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] ctx:Local The local Context.
 
 		 
 		 
 		 
 		 ├
 		[V] ctx:Application The context application.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pol:Uni Represents policy definition/resolution universe.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VGrp A grouping of virtual functions in a single graph allows virtual functions on a service device to be combined without traffic egressing from the device.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 
[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] pol:Uni Represents policy definition/resolution universe.
 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 ├
 		[V] vns:VGrp A grouping of virtual functions in a single graph allows virtual functions on a service device to be combined without traffic egressing from the device.
 
 		 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 
[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] ctx:Local The local Context.
 
 		 
 		 
 		 
 		 ├
 		[V] ctx:Application The context application.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pol:Uni Represents policy definition/resolution universe.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 
[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] pol:Uni Represents policy definition/resolution universe.
 
 		 ├
 		[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 		 
 		 ├
 		[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 		 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 


Contained Hierarchy
[V] vns:VBgpDevCfg 
 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
 		[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
 		[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] vns:AVRoutingNetworks 
 
 		 ├
 		[V] vns:Prefix 
 ├
 		[V] vns:VBgpPeer 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] vns:AL4L7ServiceFault An abstract base class for attaching faults on service managed objects.
 
 		 ├
 		[V] vns:AVRoutingDeviceCfg 
 
 		 
 		 ├
 		[V] vns:VBgpDevCfg 


Events


Faults 
                vns:AL4L7ServiceFault:serviceCriticalFault

                vns:AL4L7ServiceFault:serviceMajorFault

                vns:AL4L7ServiceFault:serviceMinorFault

                vns:AL4L7ServiceFault:serviceWarningFault


Fsms


Properties Summary
Defined in: vns:VBgpDevCfg
rtcom:AS
          scalar:Uint32 		asn  (vns:VBgpDevCfg:asn)
           A number that uniquely identifies an autonomous system.
bgp:HoldIntvl
          scalar:Uint16 		holdIntvl  (vns:VBgpDevCfg:holdIntvl)
           The period of time before declaring that the neighbor is down.
bgp:KaIntvl
          scalar:Uint16 		kaIntvl  (vns:VBgpDevCfg:kaIntvl)
           The period of time between the transmission of keepalive signals.
reference:BinRef monPolDn  (vns:VBgpDevCfg:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic 		name  (vns:VBgpDevCfg:name)
           Overrides:naming:NamedObject:name
           The name of the object.
bgp:GrStaleIntvl
          scalar:Uint16 		staleIntvl  (vns:VBgpDevCfg:staleIntvl)
           Maximum time that BGP keeps stale routes from the restarting BGP peer.
Defined in: vns:AVRoutingDeviceCfg
vns:IpAddressFamily
          scalar:Bitmask8 		addressFamily  (vns:AVRoutingDeviceCfg:addressFamily)
          
string:Basic ctxName  (vns:AVRoutingDeviceCfg:ctxName)
           The L3 context name.
scalar:Bool enable  (vns:AVRoutingDeviceCfg:enable)
           A flag to enable/disable the stats policy for comp objects.
vns:Redistribute
          scalar:Bitmask8 		redistribute  (vns:AVRoutingDeviceCfg:redistribute)
          
address:Ip rtrId  (vns:AVRoutingDeviceCfg:rtrId)
           The BGP router ID.
Defined in: vns:AL4L7ServiceFault
scalar:Uint32 faultCode  (vns:AL4L7ServiceFault:faultCode)
           The code corresponding to a service fault. The code characterizes information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.
string:Basic faultMessage  (vns:AL4L7ServiceFault:faultMessage)
           The message returned with a service fault. The message provides descriptive information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.
condition:Severity
          scalar:Enum8 		faultSeverity  (vns:AL4L7ServiceFault:faultSeverity)
           The severity of a service fault. The fault may be reported while updating a configuration or polling for health or counter values.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8 		lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
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

addressFamily

Type: vns:IpAddressFamily
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
ipv4 1 IPv4 NO COMMENTS
ipv6 2 IPv6 NO COMMENTS
DEFAULT 0 --- Bitmap of supported IP address families




asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A number that uniquely identifies an autonomous system.


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




ctxName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The L3 context name.


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.


enable

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A flag to enable/disable the stats policy for comp objects.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




faultCode

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The code corresponding to a service fault. The code characterizes information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.


faultMessage

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The message returned with a service fault. The message provides descriptive information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.


faultSeverity

Type: condition:Severity
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The severity of a service fault. The fault may be reported while updating a configuration or polling for health or counter values.
Constants
cleared 0 cleared The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).
info 1 info NO COMMENTS
warning 2 warning The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
minor 3 minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
major 4 major The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
critical 5 critical The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
DEFAULT minor(3) minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.




holdIntvl

Type: bgp:HoldIntvl
Primitive Type: scalar:Uint16

Like: bgp:Dom:holdIntvl
Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The period of time before declaring that the neighbor is down.
Constants
defaultValue 180 --- NO COMMENTS




kaIntvl

Type: bgp:KaIntvl
Primitive Type: scalar:Uint16

Like: bgp:Dom:kaIntvl
Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The period of time between the transmission of keepalive signals.
Constants
defaultValue 60 --- NO COMMENTS




lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS




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




monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The name of the object.


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


redistribute

Type: vns:Redistribute
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unspecified 0 unspecified NO COMMENTS
connected 1 connected NO COMMENTS
static 2 static NO COMMENTS
ospf 4 ospf NO COMMENTS
bgp 8 bgp NO COMMENTS
DEFAULT unspecified(0) unspecified NO COMMENTS




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.


rtrId

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP router ID.


staleIntvl

Type: bgp:GrStaleIntvl
Primitive Type: scalar:Uint16

Like: bgp:Gr:staleIntvl
Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum time that BGP keeps stale routes from the restarting BGP peer.
Constants
default 300 Default NO COMMENTS
DEFAULT default(300) Default NO COMMENTS




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.







Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail