Class hcbgp:RsBgpPeerTohcl3RoutedIf (CONCRETE)

Class ID:14829
Class Label: relation to routed interface that bgppeer uses
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Non-Regular MO, like stat/health... - APIC NX Processing: Enabled
Relationship Type: explicit
Relationship Cardinality: 1-to-1
Relationship From: hcbgp:Peer
Relationship From Rel: hcbgp:RsBgpPeerTohcl3RoutedIf
Relationship To: hcl3:RoutedIf
Relationship To Rel: hcl3:RtBgpPeerTohcl3RoutedIf
Enforceable: true
Resolvable: true
Write Access: [access-protocol, admin, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Read Access: [access-protocol, admin, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: rsbgpPeerTohcl3RoutedIf

    [1] PREFIX=rsbgpPeerTohcl3RoutedIf


DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}/peer-{[addr]}/rsbgpPeerTohcl3RoutedIf

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}/peer-{[addr]}/rsbgpPeerTohcl3RoutedIf

                


Diagram

Super Mo: reln:To,
Container Mos: hcbgp:Peer (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 
 
 ├
[V] hcbgp:Entity  Holds bgp control plane entity information
 
 
 
 
 
 
 
 ├
[V] hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:Peer  This object holds bgp information pertaining to a peer
 
 
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:RsBgpPeerTohcl3RoutedIf 
[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] hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...
 
 ├
[V] hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:Csr 
 
 
 
 
 ├
[V] hcbgp:Entity  Holds bgp control plane entity information
 
 
 
 
 
 ├
[V] hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp
 
 
 
 
 
 
 ├
[V] hcbgp:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hcbgp:Peer  This object holds bgp information pertaining to a peer
 
 
 
 
 
 
 
 
 ├
[V] hcbgp:RsBgpPeerTohcl3RoutedIf 


Contained Hierarchy
[V] hcbgp:RsBgpPeerTohcl3RoutedIf 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
[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: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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] reln:Inst This is generated and used only by internal processes.
 ├
[V] reln:To This is generated and used only by internal processes.
 
 ├
[V] hcbgp:RsBgpPeerTohcl3RoutedIf 


Events
                hcbgp:RsBgpPeerTohcl3RoutedIf:creation__hcbgp_RsBgpPeerTohcl3RoutedIf
hcbgp:RsBgpPeerTohcl3RoutedIf:modification__hcbgp_RsBgpPeerTohcl3RoutedIf
hcbgp:RsBgpPeerTohcl3RoutedIf:deletion__hcbgp_RsBgpPeerTohcl3RoutedIf


Faults
                hcbgp:RsBgpPeerTohcl3RoutedIf:ResolveFail


Fsms
                


Properties Summary
Defined in: hcbgp:RsBgpPeerTohcl3RoutedIf
mo:Annotation
          string:Basic
annotation  (hcbgp:RsBgpPeerTohcl3RoutedIf:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (hcbgp:RsBgpPeerTohcl3RoutedIf:extMngdBy)
           NO COMMENTS
reln:ClassId
          scalar:Enum16
tCl  (hcbgp:RsBgpPeerTohcl3RoutedIf:tCl)
           Overrides:reln:Inst:tCl
           The class ID of the target object. This property is managed internally and should not be modified by the user.
reln:Dn
          reference:BinRef
tDn  (hcbgp:RsBgpPeerTohcl3RoutedIf:tDn)
           Overrides:reln:Inst:tDn
           The distinguished name of the target.
Defined in: reln:To
scalar:Bool forceResolve  (reln:To:forceResolve)
           Whether the relation should force pull the target.
reln:ResolverType
          scalar:Enum8
rType  (reln:To:rType)
           Represents the type of resolver.
reln:State
          scalar:Enum8
state  (reln:To:state)
           Represents the state of the relationship.
reln:StateQual
          scalar:Enum8
stateQual  (reln:To:stateQual)
           Represents the state qualifier of the relationship.
reln:TargetType
          scalar:Enum8
tType  (reln:To:tType)
           The type of target.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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.
Properties Detail

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
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





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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





forceResolve

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Whether the relation should force pull the target.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- 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





rType

Type: reln:ResolverType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the type of resolver.
Constants
mo 1 mo NO COMMENTS
service 2 service NO COMMENTS
local 3 local NO COMMENTS
DEFAULT mo(1) mo 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.



state

Type: reln:State
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state of the relationship.
Constants
unformed 0 unformed the relationship is not formed
formed 1 formed the relationship is formed with the target object
missing-target 2 missing-target target does not exist
invalid-target 4 invalid-target invalid target DN
cardinality-violation 5 cardinality-violation cardinality violation - When relations are created such that they violate the cardinality, state of the relation would be set to this.
DEFAULT unformed(0) unformed the relationship is not formed





stateQual

Type: reln:StateQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Represents the state qualifier of the relationship.
Constants
none 0 none no issue
mismatch-target 1 mismatch-target target not found, using default
default-target 2 default-target target not specified, using default
DEFAULT none(0) none no issue





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.






tCl

Type: reln:ClassId
Primitive Type: scalar:Enum16

Overrides:reln:Inst:tCl
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The class ID of the target object. This property is managed internally and should not be modified by the user.
Constants
unspecified 0 unspecified NO COMMENTS
hcl3RoutedIf 14861 --- NO COMMENTS
DEFAULT hcl3RoutedIf(14861) --- NO COMMENTS





tDn

Type: reln:Dn
Primitive Type: reference:BinRef

Overrides:reln:Inst:tDn
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The distinguished name of the target.



tType

Type: reln:TargetType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of target.
Constants
name 0 name NO COMMENTS
mo 1 mo NO COMMENTS
all 2 all NO COMMENTS
DEFAULT mo(1) mo NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS