Class hsrp:GroupV1 (CONCRETE)

Class ID:8377
Class Label: HSRP Group
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

Object represents HSRP group for HSRP version 1.

Naming Rules
RN FORMAT: grpv1-{id}

    [1] PREFIX=grpv1- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/hsrp/inst-{name}/dom-{name}/if-{[id]}/grpv1-{id}

[1] sys/hsrp/inst-{name}/dom-{name}/if-{[id]}/grpv1-{id}

                


Diagram

Super Mo: hsrp:Group,
Container Mos: hsrp:If (deletable:yes),
Contained Mos: hsrp:Addr, hsrp:AuthP, hsrp:GroupStats, hsrp:Peer,


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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] hsrp:Entity  Holds HSRP control plane entity information
 
 
 
 
 
 ├
[V] hsrp:Inst  This objects holds HSRP instance information. There is
 
 
 
 
 
 
 ├
[V] hsrp:Dom  This object holds per hsrp domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] hsrp:If  This object holds interface information
 
 
 
 
 
 
 
 
 ├
[V] hsrp:GroupV1  Object represents HSRP group for HSRP version 1.
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] hsrp:Entity  Holds HSRP control plane entity information
 
 
 ├
[V] hsrp:Inst  This objects holds HSRP instance information. There is
 
 
 
 ├
[V] hsrp:Dom  This object holds per hsrp domain (vrf) information
 
 
 
 
 ├
[V] hsrp:If  This object holds interface information
 
 
 
 
 
 ├
[V] hsrp:GroupV1  Object represents HSRP group for HSRP version 1.


Contained Hierarchy
[V] hsrp:GroupV1  Object represents HSRP group for HSRP version 1.
 ├
[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] hsrp:Addr  Class for HSRP secondary vips
 
 ├
[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] hsrp:AuthP 
 
 ├
[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] hsrp:GroupStats  Object representing HSRP Groups stats data
 ├
[V] hsrp:Peer  Class for HSRP Peers Active/Standby


Inheritance
[V] hsrp:Group  This is an Abstract class for HSRP group
 ├
[V] hsrp:GroupV1  Object represents HSRP group for HSRP version 1.


Events
                hsrp:Group:hsrp_Group_operStChangeUp


Faults
                hsrp:Group:operStDown


Fsms
                


Properties Summary
Defined in: hsrp:GroupV1
scalar:Bitmask64 hsrpCfgFailedBmp  (hsrp:GroupV1:hsrpCfgFailedBmp)
           NO COMMENTS
scalar:Time hsrpCfgFailedTs  (hsrp:GroupV1:hsrpCfgFailedTs)
           NO COMMENTS
scalar:UByte hsrpCfgState  (hsrp:GroupV1:hsrpCfgState)
           NO COMMENTS
hsrp:GroupIdV1
          scalar:Uint16
id  (hsrp:GroupV1:id)
           HSRP Group ID
reference:BinRef monPolDn  (hsrp:GroupV1:monPolDn)
           Monitoring policy attached to this observable object
Defined in: hsrp:Group
hsrp:GrpBfdOperSt
          scalar:Enum8
bfdOperSt  (hsrp:Group:bfdOperSt)
           BFD Operational state
hsrp:GrpControl
          scalar:Bitmask8
ctrl  (hsrp:Group:ctrl)
           Control Bits
hsrp:GrpOperFlags
          scalar:Bitmask16
flags  (hsrp:Group:flags)
           Flags representing various group attributes
hsrp:HelloIntvl
          scalar:Uint32
helloIntvl  (hsrp:Group:helloIntvl)
           HSRP Hello packet interval
hsrp:HoldIntvl
          scalar:Uint32
holdIntvl  (hsrp:Group:holdIntvl)
           HSRP Hold interval
address:Ip ip  (hsrp:Group:ip)
           HSRP primary IP address
hsrp:GrpIpObtainMode
          scalar:Enum8
ipObtainMode  (hsrp:Group:ipObtainMode)
           HSRP primary IP Obtain Mode
scalar:Date lastStateChgTs  (hsrp:Group:lastStateChgTs)
           Time of last state transition
address:MAC mac  (hsrp:Group:mac)
           HSRP VMAC for the group
hsrp:GrpName
          string:Basic
name  (hsrp:Group:name)
           Redundancy name string
hsrp:HelloIntvl
          scalar:Uint32
operHelloIntvl  (hsrp:Group:operHelloIntvl)
           Current hello interval
hsrp:HoldIntvl
          scalar:Uint32
operHoldIntvl  (hsrp:Group:operHoldIntvl)
           Current hold interval
address:Ip operIp  (hsrp:Group:operIp)
           Groups virtual IP if not configured
address:MAC operMac  (hsrp:Group:operMac)
           Groups MAC address
hsrp:GrpName
          string:Basic
operName  (hsrp:Group:operName)
           Group name in case not configured
hsrp:GrpPrio
          scalar:Uint16
operPrio  (hsrp:Group:operPrio)
           Current group priority
hsrp:GrpOperSt
          scalar:Enum8
operSt  (hsrp:Group:operSt)
           Operational state
hsrp:GrpOperStQual
          scalar:Enum8
operStQual  (hsrp:Group:operStQual)
           Operational state qualifier
hsrp:PreemptDelay
          scalar:Uint16
preemptDelayMin  (hsrp:Group:preemptDelayMin)
           Minimum Preemption delay before this group can preempt
hsrp:PreemptDelay
          scalar:Uint16
preemptDelayReload  (hsrp:Group:preemptDelayReload)
           Preemption delay after a switch reboot before this group
hsrp:PreemptDelay
          scalar:Uint16
preemptDelaySync  (hsrp:Group:preemptDelaySync)
           Maximum number of seconds to allow IP
hsrp:GrpPrio
          scalar:Uint16
prio  (hsrp:Group:prio)
           Grouph Priority
nw:Counter32
          scalar:Uint32
stateChgs  (hsrp:Group:stateChgs)
           No of state transitions
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

bfdOperSt

Type: hsrp:GrpBfdOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
BFD Operational state
Constants
disabled 0 BFD Disabled NO COMMENTS
inactive 1 Inactive NO COMMENTS
deleted 2 Deleted NO COMMENTS
active 3 Active NO COMMENTS
DEFAULT disabled(0) BFD Disabled 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





ctrl

Type: hsrp:GrpControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Control Bits
Constants
preempt 1 Enable preemption for the group Enable preemtion for the Group
DEFAULT 0 --- Control bits of HSRP Group





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.



flags

Type: hsrp:GrpOperFlags
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Flags representing various group attributes
Constants
peer-link-redirect 1 Redirect the traffic over the peer link NO COMMENTS
preempt-sync-delay-active 2 Preempt sync delay active NO COMMENTS
preempt-min-delay-active 4 Preempt min delay active NO COMMENTS
preempt-reload-delay-active 8 Preempt reload delay active NO COMMENTS
DEFAULT 0 --- group oper flags





helloIntvl

Type: hsrp:HelloIntvl
Primitive Type: scalar:Uint32

Units: msec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
HSRP Hello packet interval
Constants
defaultValue 3000u --- NO COMMENTS





holdIntvl

Type: hsrp:HoldIntvl
Primitive Type: scalar:Uint32

Units: msec
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
HSRP Hold interval
Constants
defaultValue 10000u --- NO COMMENTS





hsrpCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
hsrp:GroupV1lcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
hsrp:GroupV1preemptDelaySync_failed_flag 1048576ull --- NO COMMENTS
hsrp:GroupV1monPolDn_failed_flag 134217728ull --- NO COMMENTS
hsrp:GroupV1holdIntvl_failed_flag 16ull --- NO COMMENTS
hsrp:GroupV1prio_failed_flag 2097152ull --- NO COMMENTS
hsrp:GroupV1modTs_failed_flag 2305843009213693952ull --- NO COMMENTS
hsrp:GroupV1mac_failed_flag 256ull --- NO COMMENTS
hsrp:GroupV1preemptDelayMin_failed_flag 262144ull --- NO COMMENTS
hsrp:GroupV1ctrl_failed_flag 2ull --- NO COMMENTS
hsrp:GroupV1ip_failed_flag 32ull --- NO COMMENTS
hsrp:GroupV1name_failed_flag 512ull --- NO COMMENTS
hsrp:GroupV1preemptDelayReload_failed_flag 524288ull --- NO COMMENTS
hsrp:GroupV1ipObtainMode_failed_flag 64ull --- NO COMMENTS
hsrp:GroupV1id_failed_flag 67108864ull --- NO COMMENTS
hsrp:GroupV1helloIntvl_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





hsrpCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
NO COMMENTS



hsrpCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
NO COMMENTS



id

Type: hsrp:GroupIdV1
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
HSRP Group ID
Constants
defaultValue 0 --- NO COMMENTS





ip

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
HSRP primary IP address



ipObtainMode

Type: hsrp:GrpIpObtainMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
HSRP primary 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





lastStateChgTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Time of last state transition



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

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
HSRP VMAC for the group



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:
Monitoring policy attached to this observable object



name

Type: hsrp:GrpName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Redundancy name string



operHelloIntvl

Type: hsrp:HelloIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Current hello interval
Constants
defaultValue 3000u --- NO COMMENTS





operHoldIntvl

Type: hsrp:HoldIntvl
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Current hold interval
Constants
defaultValue 10000u --- NO COMMENTS





operIp

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Groups virtual IP if not configured



operMac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Groups MAC address



operName

Type: hsrp:GrpName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Group name in case not configured



operPrio

Type: hsrp:GrpPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Current group priority
Constants
defaultValue 100 --- NO COMMENTS





operSt

Type: hsrp:GrpOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state
Constants
init 0 Initializing NO COMMENTS
learn 1 Learn NO COMMENTS
listen 2 Listen NO COMMENTS
speak 3 Speak NO COMMENTS
standby 4 Standby NO COMMENTS
active 5 Active NO COMMENTS
DEFAULT init(0) Initializing NO COMMENTS





operStQual

Type: hsrp:GrpOperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state qualifier
Constants
down 0 Down NO COMMENTS
invalid-sec-ip 1 Sec IP subnet mismatch NO COMMENTS
if-down 2 Interface Down NO COMMENTS
no-ip 3 If IP not cfged NO COMMENTS
internal-err 4 Internal Error NO COMMENTS
no-vip 5 Group Vip not configured NO COMMENTS
subnet-mismatch 6 Mismatch with interface subnet NO COMMENTS
vmac-not-ready 7 VMAC not ready NO COMMENTS
no-master 8 No Master for Slave NO COMMENTS
master-down 9 Master group down NO COMMENTS
ver-mismatch 10 Master Slave Ver Mismatch NO COMMENTS
addr-type-mismatch 11 Master Slave Addr Type Mismatch NO COMMENTS
vip-mismatch 12 VIP and Interface IP clash NO COMMENTS
bcast-vip 13 Broadcast address not allowed NO COMMENTS
net-directed-bcast 14 Net Directed Broadcast address not allowed NO COMMENTS
mcast-vip 15 Multicast address not allowed NO COMMENTS
lb-vip 16 Loopback address not allowed NO COMMENTS
dup-vip 17 Duplicate Virtual IP NO COMMENTS
invalid-vip 18 Invalid Virtual IP NO COMMENTS
vip-type-mismatch 19 Af and Virtual IP type mismatch NO COMMENTS
invalid-autocfg 20 Autoconfig on IPv4 address not allowed NO COMMENTS
dup-name 21 Duplicate name NO COMMENTS
invalid-hold-intvl 22 Invalid Hold Interval NO COMMENTS
invalid-mac-cfg 23 MAC configuration not allowed when BIA flag is enabled on Interface NO COMMENTS
invalid-mac-addr 24 Invalid MAC Address NO COMMENTS
invalid-bcast-mac-addr 25 Broadcast MAC Address not allowed NO COMMENTS
invalid-mcast-mac-addr 26 Multicast MAC Address not allowed NO COMMENTS
invalid-rsvd-mac-addr 27 Reserved MAC Address for protocols NO COMMENTS
dup-mac-addr 28 Duplicate MAC Address NO COMMENTS
invalid-site-local-ip 29 Site Local IP not allowed NO COMMENTS
unsupported-ip 30 Unsupported IP Address NO COMMENTS
up 31 Up Do not touch the up value its being referred by events model
vmac-add-failed 32 VMAC Add to Hardware failed NO COMMENTS
DEFAULT down(0) Down NO COMMENTS





preemptDelayMin

Type: hsrp:PreemptDelay
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum Preemption delay before this group can preempt
Constants
defaultValue 0 --- NO COMMENTS





preemptDelayReload

Type: hsrp:PreemptDelay
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Preemption delay after a switch reboot before this group
Constants
defaultValue 0 --- NO COMMENTS





preemptDelaySync

Type: hsrp:PreemptDelay
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Maximum number of seconds to allow IP
Constants
defaultValue 0 --- NO COMMENTS





prio

Type: hsrp:GrpPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Grouph Priority
Constants
defaultValue 100 --- 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.



stateChgs

Type: nw:Counter32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
No of state transitions



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.