Class hsrp:IfDef (CONCRETE)

Class ID:9192
Class Label: Interface Profile Definition
Encrypted: false - 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]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
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: hsrpIfDef

    [1] PREFIX=hsrpIfDef


DN FORMAT: 

        Too Many Containers: 303
                


Containers Hierarchies
Too Many containers: 303


Contained Hierarchy
[V] hsrp:IfDef 
 ├
[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] 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] hsrp:GroupDef 
 
 ├
[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] 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] hsrp:SecVipDef 
 
 
 ├
[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.


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] hsrp:AIfP 
 
 
 
 
 
 ├
[V] hsrp:AIfDef 
 
 
 
 
 
 
 ├
[V] hsrp:IfDef 


Events
                


Faults
                hsrp:IfDef:config-failed


Fsms
                


Properties Summary
Defined in: hsrp:IfDef
reference:BinRef monPolDn  (hsrp:IfDef:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: hsrp:AIfDef
hsrp:ConfigIssues
          scalar:Bitmask64
configIssues  (hsrp:AIfDef:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
hsrp:IfControl
          scalar:Bitmask8
ctrl  (hsrp:AIfDef:ctrl)
           The control state.
hsrp:IfDelay
          scalar:Uint16
delay  (hsrp:AIfDef:delay)
           The administrative port delay.
reference:BinRef ifPKey  (hsrp:AIfDef:ifPKey)
           The primary key for the interface. Internal use only.
hsrp:IfDelay
          scalar:Uint16
reloadDelay  (hsrp:AIfDef:reloadDelay)
           Reload delay
Defined in: hsrp:AIfP
hsrp:version
          scalar:Enum8
version  (hsrp:AIfP:version)
           The version of the compatibility catalog.
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: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

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





configIssues

Type: hsrp:ConfigIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Bitmask representation of the configuration issues found during the endpoint group deployment.
Constants
none 0x0ull N/A NO COMMENTS
GroupMac-Conflicts-Other-Group 0x10ull GroupMac Conflicts Other Group NO COMMENTS
group-vip-subnet-mismatch 0x1ull hsrpGroupP RsPathL3OutAtt Subnet Misconfiguration NO COMMENTS
group-vip-conflicts-if-ip 0x20ull hsrpGroupP Ip Conflict NO COMMENTS
Secondary-vip-subnet-mismatch 0x2ull SecVip RsPathL3OutAtt Subnet Misconfiguration NO COMMENTS
Secondary-vip-conflicts-if-ip 0x40ull SecVip Conflicts Interface Ip NO COMMENTS
GroupVIP-Conflicts-Other-Group 0x4ull GroupVIP Conflicts Other Group NO COMMENTS
Multiple-Version-On-Interface 0x80ull Multiple hsrp version configured on Interface NO COMMENTS
GroupName-Conflicts-Other-Group 0x8ull GroupName Conflicts Other Group NO COMMENTS
DEFAULT none(0x0ull) N/A NO COMMENTS





ctrl

Type: hsrp:IfControl
Primitive Type: scalar:Bitmask8

Like: hsrp:If:ctrl
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The control state.
Constants
bia 1 Use Burnt-In-MAC Address of the interface Use Burnt in MAC address
bfd 2 Enable Bidirectional Forwarding Detection(BFD) protocol NO COMMENTS
DEFAULT 0 --- Control bits at the Interface





delay

Type: hsrp:IfDelay
Primitive Type: scalar:Uint16

Like: hsrp:If:delay
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The administrative port delay.
Constants
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.



ifPKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The primary key for the interface. Internal use only.



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



reloadDelay

Type: hsrp:IfDelay
Primitive Type: scalar:Uint16

Like: hsrp:If:reloadDelay
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Reload delay
Constants
defaultValue 0 --- 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.



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.






version

Type: hsrp:version
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The version of the compatibility catalog.
Constants
v1 1 version 1 NO COMMENTS
v2 2 version 2 NO COMMENTS
DEFAULT v1(1) version 1 NO COMMENTS