Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hsrp:Group (ABSTRACT)

Class ID:8366
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: [admin, tenant-ext-protocol]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

This is an Abstract class for HSRP group

Naming Rules 


DN FORMAT:


Diagram

Sub Mos: hsrp:GroupV1, hsrp:GroupV2,
Contained Mos: hsrp:Addr, hsrp:AuthP, hsrp:GroupStats, hsrp:Peer,


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


Events 
                hsrp:Group:hsrp_Group_operStChangeUp


Faults 
                hsrp:Group:operStDown


Fsms


Properties Summary
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: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

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




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


mac

Type: address:MAC

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


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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail