Cisco System Model: Classcloud:BgpPeerPDef

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class cloud:BgpPeerPDef (CONCRETE)

Class ID:14394
Class Label: BGP Peer Connectivity Profile Def
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, fabric-connectivity-l3, fabric-connectivity-mgmt, tenant-connectivity-l3, tenant-ext-connectivity-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

NO COMMENTS

Naming Rules

RN FORMAT: bgppeerpd-{[addr]}

    [1] PREFIX=bgppeerpd- PROPERTY = addr




DN FORMAT: 

[0] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/bgppeerpd-{[addr]}

[1] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/intnetworkpd-{name}/hostifpd-{nicId}/l3tunnelifpd-{name}/l3ifpd/bgppeerpd-{[addr]}

[2] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/lbifpd-{name}/l3ifpd/bgppeerpd-{[addr]}

[3] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/extnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/bgppeerpd-{[addr]}

[4] ctxdefcont/ctxProfileDef-{[ctxProfileDn]}/regionloc-{[regionDn]}/routerpd-{name}/intnetworkpd-{name}/hostifpd-{nicId}/l3ifpd/bgppeerpd-{[addr]}

Diagram
Super Mo: cloud:ABgpPeerP, Container Mos: cloud:L3IfPDef (deletable:yes),

Containers Hierarchies

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

├

├

├

├

├

├

├

cloud:BgpPeerPDef

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

├

├

├

├

├

├

├

cloud:BgpPeerPDef

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

├

├

├

├

├

├

cloud:BgpPeerPDef

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

├

├

├

├

├

├

cloud:BgpPeerPDef

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

├

├

├

├

├

├

cloud:BgpPeerPDef

Contained Hierarchy

cloud:BgpPeerPDef

├

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.

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.

├

pol:Obj Represents a generic policy object.

├

pol:Def Represents self-contained policy document.

├

cloud:ABgpPeerP

├

cloud:BgpPeerPDef

Events

Faults

Fsms

Properties Summary

Defined in: cloud:BgpPeerPDef
address:Ip	addr (cloud:BgpPeerPDef:addr) Overrides:cloud:ABgpPeerP:addr The peer IP address.

Defined in: cloud:ABgpPeerP
hcbgp:AfT scalar:Enum8	af (cloud:ABgpPeerP:af) NO COMMENTS
rtcom:AS scalar:Uint32	asn (cloud:ABgpPeerP:asn) A number that uniquely identifies an autonomous system.
hcbgp:PeerAfControl scalar:Bitmask32	ctrl (cloud:ABgpPeerP:ctrl) The control state.
string:Password	password (cloud:ABgpPeerP:password) The administrative password.
hcbgp:TtlVal scalar:Uint16	ttl (cloud:ABgpPeerP:ttl) Specifies time to live (TTL).

Defined in: pol:Def
naming:Descr string:Basic	descr (pol:Def:descr) Specifies a description of the policy definition.
naming:Descr string:Basic	ownerKey (pol:Def:ownerKey) The key for enabling clients to own their data for entity correlation.
naming:Descr string:Basic	ownerTag (pol:Def:ownerTag) A tag for enabling clients to add their own data. For example, to indicate who created this object.

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

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.

Properties Detail

addr

Type: address:Ip

Overrides:cloud:ABgpPeerP:addr

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

Comments:

The peer IP address.

af

Type: hcbgp:AfT
Primitive Type: scalar:Enum8

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

Comments:

NO COMMENTS

Constants
ipv4-ucast	1	IPv4 unicast address family	ipv4 unicast
vpnv4-ucast	2	Vpnv4 unicast address family	vpnv4 unicast
ipv6-ucast	3	IPv6 unicast address family	ipv6 unicast
vpnv6-ucast	4	Vpnv6 unicast address family	vpnv6 unicast
l2vpn-evpn	5	L2Vpn EVpn address family	l2vpn evpn
rtfilter-ucast	6	Route target filter address family	rtfilter unicast
DEFAULT	ipv4-ucast(1)	IPv4 unicast address family	ipv4 unicast

asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Like: hcbgp:APeer:asn
Units: null
Encrypted: false
Access: admin
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

ctrl

Type: hcbgp:PeerAfControl
Primitive Type: scalar:Bitmask32

Like: hcbgp:PeerAf:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Comments:

The control state.

Constants
activate	128u	Activate	Activate
dis-peer-as-check	16u	Disable Peer AS Check	Disable checking of peer AS number while advertising
send-com	1u	Send Community	Send community
soft-reconfig-inbound	256u	Soft Reconfig Inbound	Soft Reconfig Inbound
send-ext-com	2u	Send Extended Community	Send extended community
allow-self-as	32u	Allow Self AS	Allows local AS number in the AS path
rr-client	4u	Route Reflector Client	Router reflector client
nh-unchanged	512u	Next Hop Unchanged	Next Hop Unchanged
as-override	64u	As Override	Overrides AS number of originating router to that of sending BGP router
nh-self	8u	Next-hop Self	Nexthop self
DEFAULT	0	---	Peer Address Family Control

descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Comments:

Specifies a description of the policy definition.

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.

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

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

ownerKey

Type: naming:Descr
Primitive Type: string:Basic

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

Comments:

The key for enabling clients to own their data for entity correlation.

ownerTag

Type: naming:Descr
Primitive Type: string:Basic

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

Comments:

A tag for enabling clients to add their own data. For example, to indicate who created this object.

password

Type: string:Password

Like: hcbgp:APeer:password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular

Comments:

The administrative password.

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.

ttl

Type: hcbgp:TtlVal
Primitive Type: scalar:Uint16

Like: hcbgp:Peer:ttl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

Comments:

Specifies time to live (TTL).

Constants
defaultValue	1	---	NO COMMENTS

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail