Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class bgp:APeerDef (ABSTRACT)

Class ID:7224
Class Label: Abstract Peer Connectivity Profile Definition
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-ext-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Peer connectivity definition

Naming Rules 


DN FORMAT: 

        Too Many Containers: 416


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 		 
 		 ├
 		[V] fabric:ProtoComp A base class for protocol policies.
 
 		 
 		 
 		 ├
 		[V] fabric:L3ProtoComp A base class for layer 3 protocol policies.
 
 		 
 		 
 		 
 		 ├
 		[V] bgp:APeerP The profile for connecting with a BGP peer.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:APeerDef  Peer connectivity definition
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:InfraPeerDef  Infra Peer connectivity definition
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] bgp:PeerDef An internal object for the BGP peer connectivity definition.


Events


Faults


Fsms


Properties Summary
Defined in: bgp:APeerDef
bgp:MaxPfxAct
          scalar:Enum8 		action  (bgp:APeerDef:action)
           The action required when the condition is met.
bgp:MaxPfx
          scalar:Uint32 		maxPfx  (bgp:APeerDef:maxPfx)
           The maximum number of prefixes allowed from the peer.
bgp:PasswdSet
          scalar:Enum8 		passwdSet  (bgp:APeerDef:passwdSet)
           A value to indicate if a password is set.
bgp:MaxPfxDuration
          scalar:Uint16 		restartTime  (bgp:APeerDef:restartTime)
           The period of time (minutes) before restarting the peer when the prefix limit is reached.
bgp:MaxPfxThresh
          scalar:UByte 		thresh  (bgp:APeerDef:thresh)
           The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
Defined in: bgp:APeerP
bgp:ConfigIssues
          scalar:Bitmask32 		ConfigIssues  (bgp:APeerP:ConfigIssues)
           We raise faults on this !
address:Ip addr  (bgp:APeerP:addr)
           The IP address of the BGP peer.
bgp:AddrTControl
          scalar:Bitmask8 		addrTCtrl  (bgp:APeerP:addrTCtrl)
           Ucast/Mcast Addr Type AF Control
bgp:AllowedSelfAsCnt
          scalar:Uint16 		allowedSelfAsCnt  (bgp:APeerP:allowedSelfAsCnt)
           The number of occurrences of a local Autonomous System Number (ASN).
bgp:PeerControlPol
          scalar:Bitmask8 		ctrl  (bgp:APeerP:ctrl)
           The peer controls specify which Border Gateway Protocol (BGP) attributes are sent to a peer.
string:Password password  (bgp:APeerP:password)
           Administrative state
bgp:PeerPControlType
          scalar:Bitmask8 		peerCtrl  (bgp:APeerP:peerCtrl)
           The peer controls.
bgp:PrivateASControl
          scalar:Bitmask8 		privateASctrl  (bgp:APeerP:privateASctrl)
           Remove private AS
bgp:SessionT
          scalar:Bitmask8 		sessionT  (bgp:APeerP:sessionT)
           Peer Session Type
bgp:TtlVal
          scalar:Uint16 		ttl  (bgp:APeerP:ttl)
           Specifies time to live (TTL).
rtmap:Weight
          scalar:Uint16 		weight  (bgp:APeerP:weight)
           The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.
Defined in: pol:Comp
naming:Descr
          string:Basic 		descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

ConfigIssues

Type: bgp:ConfigIssues
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
We raise faults on this !
Constants
none 0x0u None NO COMMENTS
no-loopback-configured 0x1u No loopback configured under node profile NO COMMENTS
DEFAULT none(0x0u) None NO COMMENTS




action

Type: bgp:MaxPfxAct
Primitive Type: scalar:Enum8

Like: bgp:MaxPfxP:action
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The action required when the condition is met.
Constants
reject 0 Reject Reject prefixes beyond the configured limit
log 1 Log Log a warning
shut 2 Shutdown Shut the peer
restart 3 Restart Restart the peer
DEFAULT reject(0) Reject Reject prefixes beyond the configured limit




addr

Type: address:Ip

Like: bgp:Peer:addr
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The IP address of the BGP peer.


addrTCtrl

Type: bgp:AddrTControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Ucast/Mcast Addr Type AF Control
Constants
af-ucast 1 AF Ucast AF Ucast
af-mcast 2 AF Mcast Af Mcast
DEFAULT af-ucast(1) AF Ucast AF Ucast




allowedSelfAsCnt

Type: bgp:AllowedSelfAsCnt
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The number of occurrences of a local Autonomous System Number (ASN).
Constants
defaultValue 3 --- NO 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




ctrl

Type: bgp:PeerControlPol
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The peer controls specify which Border Gateway Protocol (BGP) attributes are sent to a peer.
Constants
send-com 1 Send Community Send community
send-ext-com 2 Send Extended Community Send extended community
nh-self 8 Next-hop Self Nexthop self
dis-peer-as-check 16 Disable Peer AS Check Disable checking of peer AS number while advertising
allow-self-as 32 Allow Self AS Allows local AS number in the AS path
as-override 64 AS override Overrides AS number of the original route
defaultValue 0 --- NO COMMENTS




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies the description of a policy component.


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.


maxPfx

Type: bgp:MaxPfx
Primitive Type: scalar:Uint32

Like: bgp:MaxPfxP:maxPfx
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The maximum number of prefixes allowed from the peer.
Constants
defaultValue 20000u --- NO COMMENTS




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

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


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


passwdSet

Type: bgp:PasswdSet
Primitive Type: scalar:Enum8

Like: bgp:PeerEntry:passwdSet
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
A value to indicate if a password is set.
Constants
disabled 0 --- NO COMMENTS
enabled 1 Enabled NO COMMENTS
DEFAULT disabled(0) --- NO COMMENTS




password

Type: string:Password

Like: bgp:Peer:password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
    Comments:
Administrative state


peerCtrl

Type: bgp:PeerPControlType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The peer controls.
Constants
bfd 1 Bidirectional Forwarding Detection Bidirectional Forwarding Detection
dis-conn-check 2 Disable Connected Check Disable checking whether single-hop eBGP peer is directly connected
defaultValue 0 --- NO COMMENTS




privateASctrl

Type: bgp:PrivateASControl
Primitive Type: scalar:Bitmask8

Like: bgp:Peer:privateASctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Remove private AS
Constants
remove-exclusive 1 Remove private AS Enable removal of private AS exclusively if no public AS exist
remove-all 2 Remove all private AS Remove private AS even if public AS's exist
replace-as 4 Replace private AS with local AS Replace private AS with local AS
defaultValue 0 --- Default is disabled




restartTime

Type: bgp:MaxPfxDuration
Primitive Type: scalar:Uint16

Like: bgp:MaxPfxP:restartTime
Units: min
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The period of time (minutes) before restarting the peer when the prefix limit is reached.
Constants
infinite 0xffff Infinite NO COMMENTS
DEFAULT infinite(0xffff) Infinite 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.


sessionT

Type: bgp:SessionT
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Peer Session Type
Constants
peer 1 Peer Instantiate a normal session with the peer
client 2 Client Instantiate a client session with the peer
DEFAULT peer(1) Peer Instantiate a normal session with the peer




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.





thresh

Type: bgp:MaxPfxThresh
Primitive Type: scalar:UByte

Like: bgp:MaxPfxP:thresh
Units: percentage
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
Constants
defaultValue 75 --- NO COMMENTS




ttl

Type: bgp:TtlVal
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies time to live (TTL).
Constants
defaultValue 1 --- NO COMMENTS




weight

Type: rtmap:Weight
Primitive Type: scalar:Uint16

Like: bgp:PeerAf:weight
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail