cisco_rf_mib

package
v0.0.0-...-fac1166 Latest Latest
Warning

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

Go to latest
Published: Oct 17, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

This MIB provides configuration control and status for the Redundancy Framework (RF) subsystem. RF provides a mechanism for logical redundancy of software functionality and is designed to support 1:1 redundancy on processor cards. RF is not intended to solve all redundancy schemes. Nor is RF designed to support redundant hardware, such as power supplies.

Redundancy is concerned with the duplication of data elements and software functions to provide an alternative in case of failure. It is a key component to meeting 99.999% availability requirements for Class 5 carrier solutions.

In the scope of this MIB definition, peer software elements are redundant and redundant software elements are peers.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCORFMIB

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

	CRFStatus CISCORFMIB_CRFStatus

	CRFCfg CISCORFMIB_CRFCfg

	CRFHistory CISCORFMIB_CRFHistory

	// This table containing a list of redundancy modes that can be supported on
	// the device.
	CRFStatusRFModeCapsTable CISCORFMIB_CRFStatusRFModeCapsTable

	// A table that tracks the history of all switchovers that have occurred since
	// system initialization. The maximum number of entries permissible in this
	// table is defined by cRFHistoryTableMaxLength. When the number of entries in
	// the table reaches the maximum limit, the next entry would replace the
	// oldest existing entry in the table.
	CRFHistorySwitchOverTable CISCORFMIB_CRFHistorySwitchOverTable

	// This table contains a list of RF clients that are registered on the device.
	// RF clients are applications that have registered with  the Redundancy
	// Facility (RF) to receive RF events and  notifications. The purpose of RF
	// clients is to synchronize  any relevant data with the standby unit.
	CRFStatusRFClientTable CISCORFMIB_CRFStatusRFClientTable
}

CISCORFMIB

func (*CISCORFMIB) GetEntityData

func (cISCORFMIB *CISCORFMIB) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFCfg

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

	// Indicates whether redundant units may communicate synchronization messages
	// with each other. If communication is not permitted, this object is set to
	// true. If communication is permitted, this object is set to false.  In split
	// mode (true), the active unit will not communicate with the standby unit.
	// The standby unit progression will not occur. When split mode is disabled
	// (false), the standby unit is reset to recover.  Split mode (true) is useful
	// for maintenance operations. The type is bool.
	CRFCfgSplitMode interface{}

	// On platforms that support keep-alives, the keep-alive threshold value
	// designates the number of lost keep-alives tolerated before a failure
	// condition is declared. If this occurs, a SWACT notification is sent.  On
	// platforms that do not support keep-alives, this object has no purpose or
	// effect. The type is interface{} with range: 0..4294967295.
	CRFCfgKeepaliveThresh interface{}

	// The minimum acceptable value for the cRFCfgKeepaliveThresh object. The type
	// is interface{} with range: 0..4294967295.
	CRFCfgKeepaliveThreshMin interface{}

	// The maximum acceptable value for the cRFCfgKeepaliveThresh object. The type
	// is interface{} with range: 0..4294967295.
	CRFCfgKeepaliveThreshMax interface{}

	// On platforms that support keep-alives, the keep-alive timer value is used
	// to guard against lost keep-alives. The RF subsystem expects to receive a
	// keep-alive within this period. If a keep-alive is not received within this
	// time period, a SWACT notification is sent.  On platforms that do not
	// support keep-alives, this object has no purpose or effect. The type is
	// interface{} with range: 0..4294967295. Units are milliseconds.
	CRFCfgKeepaliveTimer interface{}

	// The minimum acceptable value for the cRFCfgKeepaliveTimer object. The type
	// is interface{} with range: 0..4294967295. Units are milliseconds.
	CRFCfgKeepaliveTimerMin interface{}

	// The maximum acceptable value for the cRFCfgKeepaliveTimer object. The type
	// is interface{} with range: 0..4294967295. Units are milliseconds.
	CRFCfgKeepaliveTimerMax interface{}

	// Note that the term 'notification' here refers to an RF notification and not
	// an SNMP notification.  As the standby unit progresses to the 'standbyHot'
	// state, asynchronous messages are sent from the active unit to the standby
	// unit which must then be acknowledged by the standby unit. If the active
	// unit receives the acknowledgement during the time period specified by this
	// object, progression proceeds as normal. If the timer expires and an
	// acknowledgement was not received by the active unit, a switch of activity
	// occurs. The type is interface{} with range: 0..4294967295. Units are
	// milliseconds.
	CRFCfgNotifTimer interface{}

	// The minimum acceptable value for the cRFCfgNotifTimer object. The type is
	// interface{} with range: 0..4294967295. Units are milliseconds.
	CRFCfgNotifTimerMin interface{}

	// The maximum acceptable value for the cRFCfgNotifTimer object. The type is
	// interface{} with range: 0..4294967295. Units are milliseconds.
	CRFCfgNotifTimerMax interface{}

	// This variable is set to invoke RF subsystem action commands. The commands
	// are useful for maintenance and software upgrade activities. The type is
	// RFAction.
	CRFCfgAdminAction interface{}

	// Allows enabling/disabling of RF subsystem notifications. The type is bool.
	CRFCfgNotifsEnabled interface{}

	// Indicates whether redundant units may communicate synchronization messages
	// with each other. If communication is not permitted, this object is set to
	// 'true'. If communication is permitted, this object is set to 'false'.  If
	// the value of this object is 'true', the redundant system is considered to
	// be in a maintenance mode of operation. If the value of this object is
	// 'false', the redundant system is considered to be in a normal
	// (non-maintenance) mode of operation.  In maintenance mode (true), the
	// active unit will not communicate with the standby unit. The standby unit
	// progression will not occur. When maintenance mode is disabled (false), the
	// standby unit is reset to recover.  Maintenance mode (true) is useful for
	// maintenance-type operations. The type is bool.
	CRFCfgMaintenanceMode interface{}

	// Indicates the redundancy mode configured on the device. The type is RFMode.
	CRFCfgRedundancyMode interface{}

	// Further clarifies or describes the redundancy mode indicated by
	// cRFCfgRedundancyMode. Implementation-specific terminology associated with
	// the current redundancy mode may be presented here. The type is string.
	CRFCfgRedundancyModeDescr interface{}

	// Indicate the operational redundancy mode of the device. The type is RFMode.
	CRFCfgRedundancyOperMode interface{}
}

CISCORFMIB_CRFCfg

func (*CISCORFMIB_CRFCfg) GetEntityData

func (cRFCfg *CISCORFMIB_CRFCfg) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFHistory

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

	// Maximum number of entries permissible in the history table. A value of 0
	// will result in no history being maintained. The type is interface{} with
	// range: 0..50.
	CRFHistoryTableMaxLength interface{}

	// Indicates the number of system cold starts. This includes the number of
	// system cold starts due to switchover failure and the number of manual
	// restarts. The type is interface{} with range: 0..4294967295.
	CRFHistoryColdStarts interface{}

	// Indicates the cumulative time that a standby redundant unit has been
	// available since last system initialization. The type is interface{} with
	// range: 0..2147483647.
	CRFHistoryStandByAvailTime interface{}
}

CISCORFMIB_CRFHistory

func (*CISCORFMIB_CRFHistory) GetEntityData

func (cRFHistory *CISCORFMIB_CRFHistory) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFHistorySwitchOverTable

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

	// The entries in this table contain the switchover information. Each entry in
	// the table is indexed by cRFHistorySwitchOverIndex. The index wraps around
	// to 1 after reaching the maximum value. The type is slice of
	// CISCORFMIB_CRFHistorySwitchOverTable_CRFHistorySwitchOverEntry.
	CRFHistorySwitchOverEntry []*CISCORFMIB_CRFHistorySwitchOverTable_CRFHistorySwitchOverEntry
}

CISCORFMIB_CRFHistorySwitchOverTable A table that tracks the history of all switchovers that have occurred since system initialization. The maximum number of entries permissible in this table is defined by cRFHistoryTableMaxLength. When the number of entries in the table reaches the maximum limit, the next entry would replace the oldest existing entry in the table.

func (*CISCORFMIB_CRFHistorySwitchOverTable) GetEntityData

func (cRFHistorySwitchOverTable *CISCORFMIB_CRFHistorySwitchOverTable) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFHistorySwitchOverTable_CRFHistorySwitchOverEntry

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

	// This attribute is a key. A monotonically increasing integer for the purpose
	// of indexing history table. After reaching maximum value, it wraps around to
	// 1. The type is interface{} with range: 1..4294967295.
	CRFHistorySwitchOverIndex interface{}

	// Indicates the primary redundant unit that went down. The type is
	// interface{} with range: 0..2147483647.
	CRFHistoryPrevActiveUnitId interface{}

	// Indicates the secondary redundant unit that took over as active. The type
	// is interface{} with range: 0..2147483647.
	CRFHistoryCurrActiveUnitId interface{}

	// Indicates the reason for the switchover. The type is RFSwactReasonType.
	CRFHistorySwitchOverReason interface{}

	// Indicates the Date & Time when switchover occurred. The type is string.
	CRFHistorySwactTime interface{}
}

CISCORFMIB_CRFHistorySwitchOverTable_CRFHistorySwitchOverEntry The entries in this table contain the switchover information. Each entry in the table is indexed by cRFHistorySwitchOverIndex. The index wraps around to 1 after reaching the maximum value.

func (*CISCORFMIB_CRFHistorySwitchOverTable_CRFHistorySwitchOverEntry) GetEntityData

type CISCORFMIB_CRFStatus

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

	// A unique identifier for this redundant unit. This identifier is
	// implementation-specific but the method for selecting the id must remain
	// consistent throughout the redundant system.  Some example identifiers
	// include: slot id, physical or logical entity id, or a unique id assigned
	// internally by the RF subsystem. The type is interface{} with range:
	// 0..2147483647.
	CRFStatusUnitId interface{}

	// The current state of RF on this unit. The type is RFState.
	CRFStatusUnitState interface{}

	// A unique identifier for the redundant peer unit. This identifier is
	// implementation-specific but the method for selecting the id must remain
	// consistent throughout the redundant system.  Some example identifiers
	// include: slot id, physical or logical entity id, or a unique id assigned
	// internally by the RF subsystem. The type is interface{} with range:
	// 0..2147483647.
	CRFStatusPeerUnitId interface{}

	// The current state of RF on the peer unit. The type is RFState.
	CRFStatusPeerUnitState interface{}

	// Indicates whether this is the primary redundant unit or not. If this unit
	// is the primary unit, this object is true. If this unit is the secondary
	// unit, this object is false.  Note that the terms 'primary/secondary' are
	// not synonymous with the terms 'active/standby'. At any given time, the
	// primary unit may be the active unit, or the primary unit may be the standby
	// unit. Likewise,   the secondary unit, at any given time, may be the active
	// unit, or the secondary unit may be the standby unit.  The primary unit is
	// given a higher priority or precedence over the secondary unit. In a race
	// condition (usually at initialization time) or any situation where the
	// redundant units are unable to successfully negotiate activity between
	// themselves, the primary unit will always become the active unit and the
	// secondary unit will fall back to standby. Only one redundant unit can be
	// the primary unit at any given time.  The algorithm for determining the
	// primary unit is system dependent, such as 'the redundant unit with the
	// lower numeric unit id is always the primary unit.'. The type is bool.
	CRFStatusPrimaryMode interface{}

	// Indicates whether the redundant peer unit has been detected or not. If the
	// redundant peer unit is detected, this object is true. If the redundant peer
	// unit is not detected, this object is false. The type is bool.
	CRFStatusDuplexMode interface{}

	// Indicates whether a manual switch of activity is permitted. If a manual
	// switch of activity is allowed, this object is false. If a manual switch of
	// activity is not allowed, this object is true. Note that the value of this
	// object is the inverse of the status of manual SWACTs.  This object does not
	// indicate whether a switch of activity is or has occurred. This object only
	// indicates if the user-controllable capability is enabled or not.  A switch
	// of activity is the event in which the standby redundant unit becomes active
	// and the previously active unit becomes standby. The type is bool.
	CRFStatusManualSwactInhibit interface{}

	// The reason for the last switch of activity. The type is RFSwactReasonType.
	CRFStatusLastSwactReasonCode interface{}

	// The value of sysUpTime when the primary redundant unit took over as active.
	// The value of this object will be 0 till the first switchover. The type is
	// interface{} with range: 0..4294967295.
	CRFStatusFailoverTime interface{}

	// The value of sysUpTime when the peer redundant unit entered the standbyHot
	// state. The value will be 0 on system initialization. The type is
	// interface{} with range: 0..4294967295.
	CRFStatusPeerStandByEntryTime interface{}

	// The current ISSU state of the system. The type is RFIssuState.
	CRFStatusIssuState interface{}

	// The current ISSU state of the system. The type is RFIssuStateRev1.
	CRFStatusIssuStateRev1 interface{}

	// The IOS version from with the user is upgrading. The type is string.
	CRFStatusIssuFromVersion interface{}

	// The IOS version to with the user is upgrading. The type is string.
	CRFStatusIssuToVersion interface{}
}

CISCORFMIB_CRFStatus

func (*CISCORFMIB_CRFStatus) GetEntityData

func (cRFStatus *CISCORFMIB_CRFStatus) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFStatusRFClientTable

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

	// An entry containing information on various clients registered with the
	// Redundancy Facility (RF). Entries in this table are always created by the
	// system.  An entry is created in this table when a redundancy aware
	// application registers with the Redundancy Facility. The entry  is destroyed
	// when that application deregisters from the  Redundancy Facility. The type
	// is slice of CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry.
	CRFStatusRFClientEntry []*CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry
}

CISCORFMIB_CRFStatusRFClientTable This table contains a list of RF clients that are registered on the device.

RF clients are applications that have registered with the Redundancy Facility (RF) to receive RF events and notifications. The purpose of RF clients is to synchronize any relevant data with the standby unit.

func (*CISCORFMIB_CRFStatusRFClientTable) GetEntityData

func (cRFStatusRFClientTable *CISCORFMIB_CRFStatusRFClientTable) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry

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

	// This attribute is a key. A unique identifier for the client which
	// registered with the Redundancy Facility. The type is interface{} with
	// range: 1..4294967295.
	CRFStatusRFClientID interface{}

	// The description of the client which has registered with the Redundancy
	// Facility. The type is string.
	CRFStatusRFClientDescr interface{}

	// The sequence number of the client. The system assigns the sequence numbers
	// based on the order of registration of the Redundancy Facility clients.
	// This is used for deciding order of RF events sent to clients. The type is
	// interface{} with range: 0..4294967295.
	CRFStatusRFClientSeq interface{}

	// Time taken for this client to become Redundant. This value is meaningful
	// when the value of cRFStatusRFClientStatus is not 'noStatus'. The type is
	// interface{} with range: 0..4294967295. Units are milliseconds.
	CRFStatusRFClientRedTime interface{}

	// This object provides the status of the Redundancy Facility client. The type
	// is RFClientStatus.
	CRFStatusRFClientStatus interface{}
}

CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry An entry containing information on various clients registered with the Redundancy Facility (RF). Entries in this table are always created by the system.

An entry is created in this table when a redundancy aware application registers with the Redundancy Facility. The entry is destroyed when that application deregisters from the Redundancy Facility.

func (*CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry) GetEntityData

func (cRFStatusRFClientEntry *CISCORFMIB_CRFStatusRFClientTable_CRFStatusRFClientEntry) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFStatusRFModeCapsTable

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

	// An entry containing the device implementation specific terminology
	// associated with the redundancy mode that can be supported on the device.
	// The type is slice of
	// CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry.
	CRFStatusRFModeCapsEntry []*CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry
}

CISCORFMIB_CRFStatusRFModeCapsTable This table containing a list of redundancy modes that can be supported on the device.

func (*CISCORFMIB_CRFStatusRFModeCapsTable) GetEntityData

func (cRFStatusRFModeCapsTable *CISCORFMIB_CRFStatusRFModeCapsTable) GetEntityData() *types.CommonEntityData

type CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry

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

	// This attribute is a key. The redundancy mode that can be supported on the
	// device. The type is RFMode.
	CRFStatusRFModeCapsMode interface{}

	// The description of the device implementation specific terminology
	// associated with its supported redundancy mode. The type is string.
	CRFStatusRFModeCapsModeDescr interface{}
}

CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry An entry containing the device implementation specific terminology associated with the redundancy mode that can be supported on the device.

func (*CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry) GetEntityData

func (cRFStatusRFModeCapsEntry *CISCORFMIB_CRFStatusRFModeCapsTable_CRFStatusRFModeCapsEntry) GetEntityData() *types.CommonEntityData

type RFAction

type RFAction string

RFAction represents When read, the value 'noAction' is always returned.

const (
	RFAction_noAction RFAction = "noAction"

	RFAction_reloadPeer RFAction = "reloadPeer"

	RFAction_reloadShelf RFAction = "reloadShelf"

	RFAction_switchActivity RFAction = "switchActivity"

	RFAction_forceSwitchActivity RFAction = "forceSwitchActivity"
)

type RFClientStatus

type RFClientStatus string

RFClientStatus represents loss if there is a switchover.

const (
	RFClientStatus_noStatus RFClientStatus = "noStatus"

	RFClientStatus_clientNotRedundant RFClientStatus = "clientNotRedundant"

	RFClientStatus_clientRedundancyInProgress RFClientStatus = "clientRedundancyInProgress"

	RFClientStatus_clientRedundant RFClientStatus = "clientRedundant"
)

type RFIssuState

type RFIssuState string

RFIssuState represents commitVersion state.

const (
	RFIssuState_unset RFIssuState = "unset"

	RFIssuState_init RFIssuState = "init"

	RFIssuState_loadVersion RFIssuState = "loadVersion"

	RFIssuState_runVersion RFIssuState = "runVersion"

	RFIssuState_commitVersion RFIssuState = "commitVersion"
)

type RFIssuStateRev1

type RFIssuStateRev1 string

RFIssuStateRev1 represents commitVersion.

const (
	RFIssuStateRev1_init RFIssuStateRev1 = "init"

	RFIssuStateRev1_systemReset RFIssuStateRev1 = "systemReset"

	RFIssuStateRev1_loadVersion RFIssuStateRev1 = "loadVersion"

	RFIssuStateRev1_loadVersionSwitchover RFIssuStateRev1 = "loadVersionSwitchover"

	RFIssuStateRev1_runVersion RFIssuStateRev1 = "runVersion"

	RFIssuStateRev1_runVersionSwitchover RFIssuStateRev1 = "runVersionSwitchover"

	RFIssuStateRev1_commitVersion RFIssuStateRev1 = "commitVersion"
)

type RFMode

type RFMode string

RFMode represents immediately able to handle new calls.

const (
	RFMode_nonRedundant RFMode = "nonRedundant"

	RFMode_staticLoadShareNonRedundant RFMode = "staticLoadShareNonRedundant"

	RFMode_dynamicLoadShareNonRedundant RFMode = "dynamicLoadShareNonRedundant"

	RFMode_staticLoadShareRedundant RFMode = "staticLoadShareRedundant"

	RFMode_dynamicLoadShareRedundant RFMode = "dynamicLoadShareRedundant"

	RFMode_coldStandbyRedundant RFMode = "coldStandbyRedundant"

	RFMode_warmStandbyRedundant RFMode = "warmStandbyRedundant"

	RFMode_hotStandbyRedundant RFMode = "hotStandbyRedundant"
)

type RFState

type RFState string

RFState represents * Sub-state of 'standbyCold'

const (
	RFState_notKnown RFState = "notKnown"

	RFState_disabled RFState = "disabled"

	RFState_initialization RFState = "initialization"

	RFState_negotiation RFState = "negotiation"

	RFState_standbyCold RFState = "standbyCold"

	RFState_standbyColdConfig RFState = "standbyColdConfig"

	RFState_standbyColdFileSys RFState = "standbyColdFileSys"

	RFState_standbyColdBulk RFState = "standbyColdBulk"

	RFState_standbyHot RFState = "standbyHot"

	RFState_activeFast RFState = "activeFast"

	RFState_activeDrain RFState = "activeDrain"

	RFState_activePreconfig RFState = "activePreconfig"

	RFState_activePostconfig RFState = "activePostconfig"

	RFState_active RFState = "active"

	RFState_activeExtraload RFState = "activeExtraload"

	RFState_activeHandback RFState = "activeHandback"
)

type RFSwactReasonType

type RFSwactReasonType string

RFSwactReasonType represents - active unit removal caused an auto SWACT

const (
	RFSwactReasonType_unsupported RFSwactReasonType = "unsupported"

	RFSwactReasonType_none RFSwactReasonType = "none"

	RFSwactReasonType_notKnown RFSwactReasonType = "notKnown"

	RFSwactReasonType_userInitiated RFSwactReasonType = "userInitiated"

	RFSwactReasonType_userForced RFSwactReasonType = "userForced"

	RFSwactReasonType_activeUnitFailed RFSwactReasonType = "activeUnitFailed"

	RFSwactReasonType_activeUnitRemoved RFSwactReasonType = "activeUnitRemoved"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL