Class hcospf:RsLoopbackIf (CONCRETE)

Class ID:14998
Class Label: Loopback If Attachment
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Non-Regular MO, like stat/health... - APIC NX Processing: Enabled
Relationship Type: explicit
Relationship Cardinality: 1-to-m
Relationship From: hcospf:Dom
Relationship From Rel: hcospf:RsLoopbackIf
Relationship To: hcl3:LoopbackRoutedIf
Relationship To Rel: hcl3:RtLoopbackIf
Enforceable: true
Resolvable: true
Write Access: [NON CONFIGURABLE]
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: false, HasHealth: true, HasEventRules: false ]

associated Loopback If

Naming Rules
RN FORMAT: rsloopbackIf-{[tDn]}

    [1] PREFIX=rsloopbackIf- PROPERTY = tDn




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ospf/inst-{name}/dom-{name}/rsloopbackIf-{[tDn]}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/ospf/inst-{name}/dom-{name}/rsloopbackIf-{[tDn]}

                


Diagram

Super Mo: hcospf:ARsToIf,
Container Mos: hcospf:Dom (deletable:yes),
Contained Mos: hcospf:OspfLoopbackIfOper,


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] hcospf:Entity  Holds ospf control plane entity information
 
 
 
 
 
 
 
 ├
[V] hcospf:Inst  This objects hold per ospf instance information
 
 
 
 
 
 
 
 
 ├
[V] hcospf:Dom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 
 
 
 
 ├
[V] hcospf:RsLoopbackIf  associated Loopback If
[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] hcospf:Entity  Holds ospf control plane entity information
 
 
 
 
 
 ├
[V] hcospf:Inst  This objects hold per ospf instance information
 
 
 
 
 
 
 ├
[V] hcospf:Dom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hcospf:RsLoopbackIf  associated Loopback If


Contained Hierarchy
[V] hcospf:RsLoopbackIf  associated Loopback If
 ├
[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] hcospf:OspfLoopbackIfOper 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


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] hcospf:ARsToIf  This object holds ospf information that is operated at a interface level
 
 
 ├
[V] hcospf:RsLoopbackIf  associated Loopback If


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcospf:RsLoopbackIf
reln:ClassId
          scalar:Enum16
tCl  (hcospf:RsLoopbackIf: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  (hcospf:RsLoopbackIf:tDn)
           Overrides:reln:Inst:tDn
           The distinguished name of the target.
Defined in: hcospf:ARsToIf
hcospf:AreaId
          address:IPv4
area  (hcospf:ARsToIf:area)
           The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate?by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
hcospf:IfCost
          scalar:Uint16
cost  (hcospf:ARsToIf:cost)
           The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
hcospf:IfControl
          scalar:Bitmask8
ctrl  (hcospf:ARsToIf:ctrl)
           The control state.
hcospf:DeadIntvl
          scalar:Uint16
deadIntvl  (hcospf:ARsToIf:deadIntvl)
           The interval between hello packets from a neighbor before the router declares the neighbor as down. This value must be the same for all networking devices on a specific network. Specifying a smaller dead interval (seconds) will give faster detection of a neighbor being down and improve convergence, but might cause more routing instability.
hcospf:HelloIntvl
          scalar:Uint16
helloIntvl  (hcospf:ARsToIf:helloIntvl)
           The hello interval.
hcospf:NwType
          scalar:Enum8
nwType  (hcospf:ARsToIf:nwType)
           Network type
hcospf:IfPfxSuppress
          scalar:Enum8
pfxSuppress  (hcospf:ARsToIf:pfxSuppress)
           Configure prefix suppression
hcospf:DesigPrio
          scalar:UByte
prio  (hcospf:ARsToIf:prio)
           The QoS priority class ID.
hcospf:RexmitIntvl
          scalar:Uint16
rexmitIntvl  (hcospf:ARsToIf:rexmitIntvl)
           The interval between LSA retransmissions. The retransmit interval occurs while the router is waiting for an acknowledgement from the neighbor router that it received the LSA. If no acknowlegment is received at the end of the interval, then the LSA is resent.
hcospf:XmitDelay
          scalar:Uint16
xmitDelay  (hcospf:ARsToIf:xmitDelay)
           The delay time needed to send an LSA update packet. OSPF increments the LSA age time by the transmit delay amount before transmitting the LSA update. You should take into account the transmission and propagation delays for the interface when you set this value.
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: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

area

Type: hcospf:AreaId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF Area ID. An area is a logical collection of OSPF networks, routers, and links that have the same area identification. A router within an area must maintain a topological database for the area to which it belongs. The router doesn't have detailed information about network topology outside of its area, thereby reducing the size of its database. Areas limit the scope of route information distribution. It is not possible to do route update filtering within an area. The link-state database (LSDB) of routers within the same area must be synchronized and be exactly the same; however, route summarization and filtering is possible between different areas. The main benefit of creating areas is a reduction in the number of routes to propagate?by the filtering and the summarization of routes. Areas are identified by an area ID. Cisco IOS software supports area IDs expressed in IP address format or decimal format, for example, area 0.0.0.0 is equal to area 0.
Constants
backbone 0u Backbone area NO COMMENTS
defaultValue 1u --- 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





cost

Type: hcospf:IfCost
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The OSPF Area cost for the default summary LSAs. The Area cost is used with NSSA and stub area types only.
Constants
unspecified 0 Unspecified NO COMMENTS
DEFAULT unspecified(0) Unspecified NO COMMENTS





ctrl

Type: hcospf:IfControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
unspecified 0 Unspecified Unspecified
passive 1 Passive participation Passive, the interface doesn't participate in OSPF protocol and will not establish adjacencies or send routing updates. However the interface is announced as part of the routing network
mtu-ignore 2 MTU ignore MTU ignore, disables MTU mismatch detection on an interface.
advert-subnet 4 Advertise subnet Advertise ip subnet instead of a host mask in the router LSA
bfd 8 BFD Bidirectional Forwarding Detection
DEFAULT unspecified(0) Unspecified Unspecified





deadIntvl

Type: hcospf:DeadIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interval between hello packets from a neighbor before the router declares the neighbor as down. This value must be the same for all networking devices on a specific network. Specifying a smaller dead interval (seconds) will give faster detection of a neighbor being down and improve convergence, but might cause more routing instability.
Constants
defaultValue 40 --- NO COMMENTS





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.



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





helloIntvl

Type: hcospf:HelloIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hello interval.
Constants
defaultValue 10 --- 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





nwType

Type: hcospf:NwType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Network type
Constants
unspecified 0 Unspecified Unspecified
p2p 1 Point-to-point p2p interface
bcast 2 Broadcast Broadcast interface
DEFAULT unspecified(0) Unspecified Unspecified





pfxSuppress

Type: hcospf:IfPfxSuppress
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Configure prefix suppression
Constants
inherit 0 Inherit Inherit
enable 1 Enable Enable
disable 2 Disable Disable
DEFAULT inherit(0) Inherit Inherit





prio

Type: hcospf:DesigPrio
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The QoS priority class ID.
Constants
defaultValue 1 --- 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





rexmitIntvl

Type: hcospf:RexmitIntvl
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The interval between LSA retransmissions. The retransmit interval occurs while the router is waiting for an acknowledgement from the neighbor router that it received the LSA. If no acknowlegment is received at the end of the interval, then the LSA is resent.
Constants
defaultValue 5 --- 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
hcl3LoopbackRoutedIf 14865 --- NO COMMENTS
DEFAULT hcl3LoopbackRoutedIf(14865) --- NO COMMENTS





tDn

Type: reln:Dn
Primitive Type: reference:BinRef

Overrides:reln:Inst:tDn
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    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





xmitDelay

Type: hcospf:XmitDelay
Primitive Type: scalar:Uint16

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The delay time needed to send an LSA update packet. OSPF increments the LSA age time by the transmit delay amount before transmitting the LSA update. You should take into account the transmission and propagation delays for the interface when you set this value.
Constants
defaultValue 1 --- NO COMMENTS