cisco_hsrp_ext_mib

package
v0.0.0-...-50def94 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

The Extension MIB module for the CISCO-HSRP-MIB which is based on RFC2281.

This MIB provides an extension to the CISCO-HSRP-MIB which defines Cisco's proprietary Hot Standby Routing Protocol (HSRP), defined in RFC2281. The extensions cover assigning of secondary HSRP ip addresses, modifying an HSRP Group's priority by tracking the operational status of interfaces, etc.

Terminology: HSRP is a protocol used amoung a group of routers for the purpose of selecting an active router and a standby router.

An active router is the router of choice for routing packets.

A standby router is a router that takes over the routing duties when an active router fails, or when preset conditions have been met.

A HSRP group or a standby group is a set of routers which communicate using HSRP. An HSRP group has a group MAC address and a group IP address. These are the designated addresses. The active router assumes (i.e. inherits) these group addresses. An HSRP group is identified by a ( ifIndex, cHsrpGrpNumber ) pair.

BIA stands for Burned In Address.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCOHSRPEXTMIB 

type CISCOHSRPEXTMIB struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// A table containing information about tracked interfaces per HSRP group.
	CHsrpExtIfTrackedTable CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable

	// A table containing information about secondary HSRP IP Addresses per
	// interface and group.
	CHsrpExtSecAddrTable CISCOHSRPEXTMIB_CHsrpExtSecAddrTable

	// A table containing information about standby interfaces per HSRP group.
	CHsrpExtIfStandbyTable CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable

	// HSRP-specific configurations for each physical interface.
	CHsrpExtIfTable CISCOHSRPEXTMIB_CHsrpExtIfTable
}

CISCOHSRPEXTMIB

func (*CISCOHSRPEXTMIB) GetEntityData 

func (cISCOHSRPEXTMIB *CISCOHSRPEXTMIB) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable 

type CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The cHsrpExtIfStandbyEntry allows an HSRP group interface to track one or
	// more standby interfaces.  To create a new cHsrpExtIfStandbyEntry row, a
	// management station should choose the ifIndex of the interface which is to
	// be added as part of an HSRP group. Also, an HSRP group number and a
	// cHsrpExtIfStandbyIndex should be chosen. The type is slice of
	// CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry.
	CHsrpExtIfStandbyEntry []*CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry
}

CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable A table containing information about standby interfaces per HSRP group.

func (*CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable) GetEntityData 

func (cHsrpExtIfStandbyTable *CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry 

type CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// This attribute is a key. The type is string with range: 0..255. Refers to
	// cisco_hsrp_mib.CISCOHSRPMIB_CHsrpGrpTable_CHsrpGrpEntry_CHsrpGrpNumber
	CHsrpGrpNumber interface{}

	// This attribute is a key. This object defines the index of the standby
	// table. The type is interface{} with range: 1..4.
	CHsrpExtIfStandbyIndex interface{}

	// This object specifies the type of Internet address denoted by
	// cHsrpExtIfStandbyDestAddr. The type is InetAddressType.
	CHsrpExtIfStandbyDestAddrType interface{}

	// This object specifies the destination IP address of the standby router. The
	// type is string with length: 0..255.
	CHsrpExtIfStandbyDestAddr interface{}

	// This object specifies the type of Internet address denoted by
	// cHsrpExtIfStandbySourceAddr. The type is InetAddressType.
	CHsrpExtIfStandbySourceAddrType interface{}

	// This object specifies the source IP address of the standby router. The type
	// is string with length: 0..255.
	CHsrpExtIfStandbySourceAddr interface{}

	// The control that allows modification, creation, and deletion of entries.
	// Entries may not be created via SNMP without explicitly setting
	// cHsrpExtIfStandbyRowStatus to either 'createAndGo' or 'createAndWait'. The
	// type is RowStatus.
	CHsrpExtIfStandbyRowStatus interface{}
}

CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry The cHsrpExtIfStandbyEntry allows an HSRP group interface to track one or more standby interfaces.

To create a new cHsrpExtIfStandbyEntry row, a management station should choose the ifIndex of the interface which is to be added as part of an HSRP group. Also, an HSRP group number and a cHsrpExtIfStandbyIndex should be chosen.

func (*CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry) GetEntityData 

func (cHsrpExtIfStandbyEntry *CISCOHSRPEXTMIB_CHsrpExtIfStandbyTable_CHsrpExtIfStandbyEntry) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfTable 

type CISCOHSRPEXTMIB_CHsrpExtIfTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// If HSRP entries on this interface must use the BIA (Burned In Address),
	// there must be an entry for the interface in this  table. Entries of this
	// table are only accessible if HSRP has  been enabled i.e entries can not be
	// created if HSRP is not enabled. Also, the interfaces should be of IEEE 802
	// ones (Ethernet, Token Ring, FDDI,VLAN, LANE, TR-LANE).  Setting
	// cHsrpExtIfRowStatus to active initiates the entry with default value for
	// cHsrpExtIfUseBIA as FALSE. The value of cHsrpExtIfRowStatus may be set to
	// destroy at any time. If the row is not initiated, it is similar to having
	// cHsrpExtIfUseBIA as FALSE.  Entries may not be created via SNMP without
	// explicitly setting cHsrpExtIfRowStatus to either 'createAndGo' or
	// 'createAndWait'.  Entries can be created and modified via the management
	// protocol or by the device's local management interface.  If the row is not
	// active, and a local management interface command modifies that row, the row
	// may transition to active state.  A row which is not in active state will
	// timeout after a configurable period (five minutes by default). This timeout
	// period can be changed by setting cHsrpConfigTimeout. The type is slice of
	// CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry.
	CHsrpExtIfEntry []*CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry
}

CISCOHSRPEXTMIB_CHsrpExtIfTable HSRP-specific configurations for each physical interface.

func (*CISCOHSRPEXTMIB_CHsrpExtIfTable) GetEntityData 

func (cHsrpExtIfTable *CISCOHSRPEXTMIB_CHsrpExtIfTable) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry 

type CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// If set to TRUE, the HSRP Group MAC Address for all groups on this
	// interface will be the burned-in-address. Otherwise, this will be determined
	// by ciscoHsrpGroupNumber. In case of sub-interfaces, UseBIA applies to all
	// sub-interfaces on an  interface and to all groups on those sub-interfaces.
	// The type is bool.
	CHsrpExtIfUseBIA interface{}

	// The control that allows modification, creation, and deletion of entries.
	// For detailed rules see the DESCRIPTION for cHsrpExtIfEntry. The type is
	// RowStatus.
	CHsrpExtIfRowStatus interface{}
}

CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry If HSRP entries on this interface must use the BIA (Burned In Address), there must be an entry for the interface in this table. Entries of this table are only accessible if HSRP has been enabled i.e entries can not be created if HSRP is not enabled. Also, the interfaces should be of IEEE 802 ones (Ethernet, Token Ring, FDDI,VLAN, LANE, TR-LANE).

Setting cHsrpExtIfRowStatus to active initiates the entry with default value for cHsrpExtIfUseBIA as FALSE. The value of cHsrpExtIfRowStatus may be set to destroy at any time. If the row is not initiated, it is similar to having cHsrpExtIfUseBIA as FALSE.

Entries may not be created via SNMP without explicitly setting cHsrpExtIfRowStatus to either 'createAndGo' or 'createAndWait'.

Entries can be created and modified via the management protocol or by the device's local management interface.

If the row is not active, and a local management interface command modifies that row, the row may transition to active state.

A row which is not in active state will timeout after a configurable period (five minutes by default). This timeout period can be changed by setting cHsrpConfigTimeout.

func (*CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry) GetEntityData 

func (cHsrpExtIfEntry *CISCOHSRPEXTMIB_CHsrpExtIfTable_CHsrpExtIfEntry) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable 

type CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Each row of this table allows the tracking of one interface of the HSRP
	// group which is identified by the (ifIndex, cHsrpGrpNumber) values in this
	// table's INDEX clause. Weight(priority) is given to each and every interface
	// tracked.  When a tracked interface is unavailable, the HSRP priority of the
	// router is decreased. i.e cHsrpGrpPriority value assigned  to an HSRP group
	// will reduce by the value assigned to cHsrpExtIfTrackedPriority. This
	// reduces the likelihood  of a router with a failed key interface becoming
	// the  active router.  Setting cHsrpExtIfTrackedRowStatus to active starts
	// the tracking of cHsrpExtIfTracked by the HSRP group.  The value of
	// cHsrpExtIfTrackedRowStatus may be set  to destroy at any time.  Entries may
	// not be created via SNMP without explicitly setting
	// cHsrpExtIfTrackedRowStatus to either 'createAndGo'  or 'createAndWait'.
	// Entries can be created and modified via the management protocol or by the
	// device's local management interface.  If the row is not active, and a local
	// management interface command modifies that row, the row may transition to
	// active state.  A row entry in the cHsrpExtIfTrackedTable can not be created
	// unless the corresponding row in the cHsrpGrpTable has been  created. If
	// that corresponding row in cHsrpGrpTable is  deleted, the interfaces it
	// tracks also get deleted.  A row which is not in active state will timeout
	// after a configurable period (five minutes by default). This timeout period
	// can be changed by setting cHsrpConfigTimeout. The type is slice of
	// CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry.
	CHsrpExtIfTrackedEntry []*CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry
}

CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable A table containing information about tracked interfaces per HSRP group.

func (*CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable) GetEntityData 

func (cHsrpExtIfTrackedTable *CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry 

type CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// This attribute is a key. The type is string with range: 0..255. Refers to
	// cisco_hsrp_mib.CISCOHSRPMIB_CHsrpGrpTable_CHsrpGrpEntry_CHsrpGrpNumber
	CHsrpGrpNumber interface{}

	// This attribute is a key. The ifIndex value of the tracked interface. The
	// type is interface{} with range: 1..2147483647.
	CHsrpExtIfTracked interface{}

	// Priority of the tracked interface for the corresponding { ifIndex,
	// cHsrpGrpNumber } pair. In the range of 0 to 255, 0 is the lowest priority
	// and 255 is the highest. When a tracked  interface is unavailable, the
	// cHsrpGrpPriority of the router  is decreased by the value of this object
	// instance (If the  cHsrpGrpPriority is less than the
	// cHsrpExtIfTrackedPriority, then the HSRP priority  becomes 0). This allows
	// a standby router to be configured  with a priority such that if the
	// currently active router's  priority is lowered because the tracked
	// interface goes down,  the standby router can takeover. The type is
	// interface{} with range: 0..255.
	CHsrpExtIfTrackedPriority interface{}

	// The control that allows modification, creation, and deletion of entries.
	// For detailed rules see the DESCRIPTION for cHsrpExtIfTrackedEntry. The type
	// is RowStatus.
	CHsrpExtIfTrackedRowStatus interface{}

	// This object specifies the disable HSRP IPv4 virtual IP address. The type is
	// bool.
	CHsrpExtIfTrackedIpNone interface{}
}

CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry Each row of this table allows the tracking of one interface of the HSRP group which is identified by the (ifIndex, cHsrpGrpNumber) values in this table's INDEX clause. Weight(priority) is given to each and every interface tracked. When a tracked interface is unavailable, the HSRP priority of the router is decreased. i.e cHsrpGrpPriority value assigned to an HSRP group will reduce by the value assigned to cHsrpExtIfTrackedPriority. This reduces the likelihood of a router with a failed key interface becoming the active router.

Setting cHsrpExtIfTrackedRowStatus to active starts the tracking of cHsrpExtIfTracked by the HSRP group. The value of cHsrpExtIfTrackedRowStatus may be set to destroy at any time.

Entries may not be created via SNMP without explicitly setting cHsrpExtIfTrackedRowStatus to either 'createAndGo' or 'createAndWait'.

Entries can be created and modified via the management protocol or by the device's local management interface.

If the row is not active, and a local management interface command modifies that row, the row may transition to active state.

A row entry in the cHsrpExtIfTrackedTable can not be created unless the corresponding row in the cHsrpGrpTable has been created. If that corresponding row in cHsrpGrpTable is deleted, the interfaces it tracks also get deleted.

A row which is not in active state will timeout after a configurable period (five minutes by default). This timeout period can be changed by setting cHsrpConfigTimeout.

func (*CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry) GetEntityData 

func (cHsrpExtIfTrackedEntry *CISCOHSRPEXTMIB_CHsrpExtIfTrackedTable_CHsrpExtIfTrackedEntry) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtSecAddrTable 

type CISCOHSRPEXTMIB_CHsrpExtSecAddrTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The CHsrpExtSecAddrEntry allows creation of secondary IP Addresses for each
	// cHsrpGrpEntry row.  Secondary addresses can be added by setting
	// cHsrpExtSecAddrRowStatus to be active. The value of
	// cHsrpExtSecAddrRowStatus may be set to destroy at any time.  Entries may
	// not be created via SNMP without explicitly setting cHsrpExtSecAddrRowStatus
	// to either 'createAndGo' or 'createAndWait'.  Entries can be created and
	// modified via the management protocol or by the device's local management
	// interface.  If the row is not active, and a local management interface
	// command modifies that row, the row may transition to active state.  A row
	// which is not in active state will timeout after a configurable period (five
	// minutes by default). This timeout period can be changed by setting
	// cHsrpConfigTimeout.  Before creation of a cHsrpExtSecAddrEntry row, either
	// cHsrpGrpConfiguredVirtualIpAddr or  cHsrpGrpLearnedVirtualIpAddr must have
	// a valid IP Address. This is because a secondary ip address cannot be
	// created unless the primary ip address has already been set.  To create a
	// new cHsrpExtSecAddrEntry row, a management  station should choose the
	// ifIndex of the interface which is to  be added as part of an HSRP group.
	// Also, an HSRP group number  and a cHsrpExtSecAddrAddress should be chosen.
	// Deleting a {ifIndex, cHsrpGrpNumber} row in the cHsrpGrpTable will delete
	// all corresponding rows in the cHsrpExtSecAddrTable. Deleting a primary
	// address value in the cHsrpGrpEntry row will delete all secondary addresses
	// for the same {ifIndex, cHsrpGrpNumber} pair. The type is slice of
	// CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry.
	CHsrpExtSecAddrEntry []*CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry
}

CISCOHSRPEXTMIB_CHsrpExtSecAddrTable A table containing information about secondary HSRP IP Addresses per interface and group.

func (*CISCOHSRPEXTMIB_CHsrpExtSecAddrTable) GetEntityData 

func (cHsrpExtSecAddrTable *CISCOHSRPEXTMIB_CHsrpExtSecAddrTable) GetEntityData() *types.CommonEntityData

type CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry 

type CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// This attribute is a key. The type is string with range: 0..255. Refers to
	// cisco_hsrp_mib.CISCOHSRPMIB_CHsrpGrpTable_CHsrpGrpEntry_CHsrpGrpNumber
	CHsrpGrpNumber interface{}

	// This attribute is a key. A secondary IpAddress for the {ifIndex,
	// cHsrpGrpNumber} pair. As explained in the DESCRIPTION for
	// cHsrpExtSecAddrEntry, a primary address must exist before a secondary
	// address for  the same {ifIndex, cHsrpGrpNumber} pair can be created. The
	// type is string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?.
	CHsrpExtSecAddrAddress interface{}

	// The control that allows modification, creation, and deletion of entries.
	// For detailed rules see the DESCRIPTION for cHsrpExtSecAddrEntry. The type
	// is RowStatus.
	CHsrpExtSecAddrRowStatus interface{}
}

CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry The CHsrpExtSecAddrEntry allows creation of secondary IP Addresses for each cHsrpGrpEntry row.

Secondary addresses can be added by setting cHsrpExtSecAddrRowStatus to be active. The value of cHsrpExtSecAddrRowStatus may be set to destroy at any time.

Entries may not be created via SNMP without explicitly setting cHsrpExtSecAddrRowStatus to either 'createAndGo' or 'createAndWait'.

Entries can be created and modified via the management protocol or by the device's local management interface.

If the row is not active, and a local management interface command modifies that row, the row may transition to active state.

A row which is not in active state will timeout after a configurable period (five minutes by default). This timeout period can be changed by setting cHsrpConfigTimeout.

Before creation of a cHsrpExtSecAddrEntry row, either cHsrpGrpConfiguredVirtualIpAddr or cHsrpGrpLearnedVirtualIpAddr must have a valid IP Address. This is because a secondary ip address cannot be created unless the primary ip address has already been set.

To create a new cHsrpExtSecAddrEntry row, a management station should choose the ifIndex of the interface which is to be added as part of an HSRP group. Also, an HSRP group number and a cHsrpExtSecAddrAddress should be chosen.

Deleting a {ifIndex, cHsrpGrpNumber} row in the cHsrpGrpTable will delete all corresponding rows in the cHsrpExtSecAddrTable. Deleting a primary address value in the cHsrpGrpEntry row will delete all secondary addresses for the same {ifIndex, cHsrpGrpNumber} pair.

func (*CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry) GetEntityData 

func (cHsrpExtSecAddrEntry *CISCOHSRPEXTMIB_CHsrpExtSecAddrTable_CHsrpExtSecAddrEntry) GetEntityData() *types.CommonEntityData

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.