Class hsrp:GroupP (CONCRETE)

Class ID:9182
Class Label: HSRP Group Profile
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-ext-connectivity-l3, tenant-ext-protocol-l3]
Read Access: [admin, tenant-ext-connectivity-l3, tenant-ext-protocol-l3]
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 ]

Hsrp Group Profile

Naming Rules
RN FORMAT: hsrpGroupP-{name}

    [1] PREFIX=hsrpGroupP- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/out-{name}/lnodep-{name}/lifp-{name}/hsrpIfP/hsrpGroupP-{name}

                


Diagram

Super Mo: hsrp:AGroupP,
Container Mos: hsrp:IfP (deletable:yes),
Contained Mos: aaa:RbacAnnotation, hsrp:SecVip, tag:Annotation, tag:Tag,
Relations To: hsrp:GroupPol,
Relations: hsrp:RsGroupPol,


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] l3ext:Out The L3 outside policy controls connectivity to the outside.
 
 
 
 
 
 
 
 
 ├
[V] l3ext:LNodeP The logical node profile defines a common configuration that can be applied to one or more leaf nodes.
 
 
 
 
 
 
 
 
 
 ├
[V] l3ext:LIfP The logical interface profile, which defines a common configuration that can be applied to one or more interfaces.
 
 
 
 
 
 
 
 
 
 
 ├
[V] hsrp:IfP 
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] hsrp:GroupP  Hsrp Group Profile
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] l3ext:Out The L3 outside policy controls connectivity to the outside.
 
 
 
 ├
[V] l3ext:LNodeP The logical node profile defines a common configuration that can be applied to one or more leaf nodes.
 
 
 
 
 ├
[V] l3ext:LIfP The logical interface profile, which defines a common configuration that can be applied to one or more interfaces.
 
 
 
 
 
 ├
[V] hsrp:IfP 
 
 
 
 
 
 
 ├
[V] hsrp:GroupP  Hsrp Group Profile


Contained Hierarchy
[V] hsrp:GroupP  Hsrp Group Profile
 ├
[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: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:RsGroupPol  Relationship to the HSRP Group policy
 
 ├
[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 
 ├
[V] hsrp:SecVip  Secondary Address Policy
 
 ├
[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: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] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


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:AGroupP  Hsrp Group Profile
 
 
 
 
 
 ├
[V] hsrp:GroupP  Hsrp Group Profile


Events
                hsrp:GroupP:creation__hsrp_GroupP
hsrp:GroupP:modification__hsrp_GroupP
hsrp:GroupP:deletion__hsrp_GroupP


Faults
                hsrp:GroupP:GroupVipSubnetMismatch


Fsms
                


Properties Summary
Defined in: hsrp:GroupP
mo:Annotation
          string:Basic
annotation  (hsrp:GroupP:annotation)
           NO COMMENTS
hsrp:ConfigIssues
          scalar:Bitmask64
configIssues  (hsrp:GroupP:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (hsrp:GroupP:extMngdBy)
           NO COMMENTS
reference:BinRef monPolDn  (hsrp:GroupP:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (hsrp:GroupP:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
Defined in: hsrp:AGroupP
hsrp:GroupAf
          scalar:Enum8
groupAf  (hsrp:AGroupP:groupAf)
           HSRP Group Type
hsrp:GroupId
          scalar:Uint16
groupId  (hsrp:AGroupP:groupId)
           HSRP Group ID
hsrp:GrpName
          string:Basic
groupName  (hsrp:AGroupP:groupName)
           Redundancy name string
address:Ip ip  (hsrp:AGroupP:ip)
           The IP address.
hsrp:GrpIpObtainMode
          scalar:Enum8
ipObtainMode  (hsrp:AGroupP:ipObtainMode)
           HSRP primary Virtual IP Obtain Mode
address:MAC mac  (hsrp:AGroupP:mac)
           The MAC address.
Defined in: pol:Comp
naming:Descr
          string:Basic
descr  (pol:Comp:descr)
           Specifies the description of a policy component.
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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





configIssues

Type: hsrp:ConfigIssues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    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.



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





groupAf

Type: hsrp:GroupAf
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
HSRP Group Type
Constants
ipv4 1 IPv4 address family ipv4
ipv6 2 IPv6 address family ipv6
DEFAULT ipv4(1) IPv4 address family ipv4





groupId

Type: hsrp:GroupId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 4095
    Comments:
HSRP Group ID
Constants
defaultValue 0 --- NO COMMENTS





groupName

Type: hsrp:GrpName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Redundancy name string



ip

Type: address:Ip

Like: hsrp:Group:ip
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The IP address.



ipObtainMode

Type: hsrp:GrpIpObtainMode
Primitive Type: scalar:Enum8

Like: hsrp:Group:ipObtainMode
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
HSRP primary Virtual IP Obtain Mode
Constants
admin 0 Address is configured NO COMMENTS
auto 1 Auto configure ipv6 address NO COMMENTS
learn 2 learn IP from HSRP peer NO COMMENTS
DEFAULT admin(0) Address is configured 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





mac

Type: address:MAC

Like: hsrp:Group:mac
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The MAC address.



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:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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






uid

Type: scalar:Uint16

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