cisco_entity_sensor_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 CISCO-ENTITY-SENSOR-MIB is used to monitor the values of sensors in the Entity-MIB (RFC 2037) entPhysicalTable.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCOENTITYSENSORMIB 

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

	EntSensorGlobalObjects CISCOENTITYSENSORMIB_EntSensorGlobalObjects

	// This table lists the type, scale, and present value of a sensor listed in
	// the Entity-MIB entPhysicalTable.
	EntSensorValueTable CISCOENTITYSENSORMIB_EntSensorValueTable

	// This table lists the threshold severity, relation, and comparison value,
	// for a sensor listed in the Entity-MIB  entPhysicalTable.
	EntSensorThresholdTable CISCOENTITYSENSORMIB_EntSensorThresholdTable
}

CISCOENTITYSENSORMIB

func (*CISCOENTITYSENSORMIB) GetEntityData 

func (cISCOENTITYSENSORMIB *CISCOENTITYSENSORMIB) GetEntityData() *types.CommonEntityData

type CISCOENTITYSENSORMIB_EntSensorGlobalObjects 

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

	// This variable enables the generation of entSensorThresholdNotification
	// globally on the device. If this object value is 'false', then no
	// entSensorThresholdNotification will be generated on this device. If this
	// object value is 'true', then whether a  entSensorThresholdNotification for
	// a threshold will be generated or not depends on the instance value of
	// entSensorThresholdNotificationEnable for that threshold. The type is bool.
	EntSensorThreshNotifGlobalEnable interface{}
}

CISCOENTITYSENSORMIB_EntSensorGlobalObjects

func (*CISCOENTITYSENSORMIB_EntSensorGlobalObjects) GetEntityData 

func (entSensorGlobalObjects *CISCOENTITYSENSORMIB_EntSensorGlobalObjects) GetEntityData() *types.CommonEntityData

type CISCOENTITYSENSORMIB_EntSensorThresholdTable 

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

	// An entSensorThresholdTable entry describes the thresholds for a sensor: the
	// threshold severity, the threshold value, the relation, and the  evaluation
	// of the threshold.  Only entities of type sensor(8) are listed in this
	// table. Only pre-configured thresholds are listed in this table.  Users can
	// create sensor-value monitoring instruments in different ways, such as RMON
	// alarms, Expression-MIB, etc.  Entries are created by the agent at system
	// startup and FRU insertion.  Entries are deleted by the agent at FRU
	// removal. The type is slice of
	// CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry.
	EntSensorThresholdEntry []*CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry
}

CISCOENTITYSENSORMIB_EntSensorThresholdTable This table lists the threshold severity, relation, and comparison value, for a sensor listed in the Entity-MIB entPhysicalTable.

func (*CISCOENTITYSENSORMIB_EntSensorThresholdTable) GetEntityData 

func (entSensorThresholdTable *CISCOENTITYSENSORMIB_EntSensorThresholdTable) GetEntityData() *types.CommonEntityData

type CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry 

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

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to
	// entity_mib.ENTITYMIB_EntPhysicalTable_EntPhysicalEntry_EntPhysicalIndex
	EntPhysicalIndex interface{}

	// This attribute is a key. An index that uniquely identifies an entry in the
	// entSensorThresholdTable. This index permits the same sensor to have several
	// different thresholds. The type is interface{} with range: 1..99999999.
	EntSensorThresholdIndex interface{}

	// This variable indicates the severity of this threshold. The type is
	// SensorThresholdSeverity.
	EntSensorThresholdSeverity interface{}

	// This variable indicates the relation between sensor value (entSensorValue)
	// and threshold value (entSensorThresholdValue),  required to trigger the
	// alarm.  when evaluating the relation,  entSensorValue is on the left of
	// entSensorThresholdRelation,  entSensorThresholdValue is on the right.   in
	// pseudo-code, the evaluation-alarm mechanism is:  ... if (entSensorStatus ==
	// ok) then     if (evaluate(entSensorValue, entSensorThresholdRelation,
	// entSensorThresholdValue))      then         if
	// (entSensorThresholdNotificationEnable == true))          then
	// raise_alarm(sensor's entPhysicalIndex);         endif     endif endif ...
	// The type is SensorThresholdRelation.
	EntSensorThresholdRelation interface{}

	// This variable indicates the value of the threshold.  To correctly display
	// or interpret this variable's value,  you must also know entSensorType,
	// entSensorScale, and  entSensorPrecision.  However, you can directly compare
	// entSensorValue  with the threshold values given in entSensorThresholdTable
	// without any semantic knowledge. The type is interface{} with range:
	// -1000000000..1073741823.
	EntSensorThresholdValue interface{}

	// This variable indicates the result of the most recent evaluation of the
	// threshold.  If the threshold condition is true,
	// entSensorThresholdEvaluation  is true(1).  If the threshold condition is
	// false,  entSensorThresholdEvaluation is false(2).  Thresholds are evaluated
	// at the rate indicated by  entSensorValueUpdateRate. The type is bool.
	EntSensorThresholdEvaluation interface{}

	// This variable controls generation of entSensorThresholdNotification for
	// this threshold.  When this variable is 'true', generation of
	// entSensorThresholdNotification is enabled for this threshold. When this
	// variable is 'false',  generation of entSensorThresholdNotification is
	// disabled for this threshold. The type is bool.
	EntSensorThresholdNotificationEnable interface{}
}

CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry An entSensorThresholdTable entry describes the thresholds for a sensor: the threshold severity, the threshold value, the relation, and the evaluation of the threshold.

Only entities of type sensor(8) are listed in this table. Only pre-configured thresholds are listed in this table.

Users can create sensor-value monitoring instruments in different ways, such as RMON alarms, Expression-MIB, etc.

Entries are created by the agent at system startup and FRU insertion. Entries are deleted by the agent at FRU removal.

func (*CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry) GetEntityData 

func (entSensorThresholdEntry *CISCOENTITYSENSORMIB_EntSensorThresholdTable_EntSensorThresholdEntry) GetEntityData() *types.CommonEntityData

type CISCOENTITYSENSORMIB_EntSensorValueTable 

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

	// An entSensorValueTable entry describes the present reading of a sensor, the
	// measurement units and scale, and sensor operational status. The type is
	// slice of CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry.
	EntSensorValueEntry []*CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry
}

CISCOENTITYSENSORMIB_EntSensorValueTable This table lists the type, scale, and present value of a sensor listed in the Entity-MIB entPhysicalTable.

func (*CISCOENTITYSENSORMIB_EntSensorValueTable) GetEntityData 

func (entSensorValueTable *CISCOENTITYSENSORMIB_EntSensorValueTable) GetEntityData() *types.CommonEntityData

type CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry 

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

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to
	// entity_mib.ENTITYMIB_EntPhysicalTable_EntPhysicalEntry_EntPhysicalIndex
	EntPhysicalIndex interface{}

	// This variable indicates the type of data reported by the entSensorValue.
	// This variable is set by the agent at start-up and the value does not change
	// during operation. The type is SensorDataType.
	EntSensorType interface{}

	// This variable indicates the exponent to apply to sensor values reported by
	// entSensorValue.  This variable is set by the agent at start-up and the
	// value does not change during operation. The type is SensorDataScale.
	EntSensorScale interface{}

	// This variable indicates the number of decimal places of precision in
	// fixed-point sensor values reported by entSensorValue.  This variable is set
	// to 0 when entSensorType is not a fixed-point type: e.g.'percentRH(9)',
	// 'rpm(10)', 'cmm(11)', or 'truthvalue(12)'.  This variable is set by the
	// agent at start-up and the value does not change during operation. The type
	// is interface{} with range: -8..9.
	EntSensorPrecision interface{}

	// This variable reports the most recent measurement seen by the sensor.  To
	// correctly display or interpret this variable's value,  you must also know
	// entSensorType, entSensorScale, and  entSensorPrecision.  However, you can
	// compare entSensorValue with the threshold values given in
	// entSensorThresholdTable without any semantic knowledge. The type is
	// interface{} with range: -1000000000..1073741823.
	EntSensorValue interface{}

	// This variable indicates the present operational status of the sensor. The
	// type is SensorStatus.
	EntSensorStatus interface{}

	// This variable indicates the age of the value reported by entSensorValue.
	// The type is interface{} with range: 0..4294967295.
	EntSensorValueTimeStamp interface{}

	// This variable indicates the rate that the agent updates entSensorValue. The
	// type is interface{} with range: 0..999999999. Units are seconds.
	EntSensorValueUpdateRate interface{}

	// This object identifies the physical entity for which the sensor is taking
	// measurements.  For example, for a sensor measuring the voltage output of a
	// power-supply, this object would be the entPhysicalIndex of that
	// power-supply; for a sensor measuring the temperature inside one chassis of
	// a multi-chassis system, this object would be the enPhysicalIndex of that
	// chassis.  This object has a value of zero when the physical entity for
	// which the sensor is taking measurements can not be represented by any one
	// row in the entPhysicalTable, or that there is no such physical entity. The
	// type is interface{} with range: 0..2147483647.
	EntSensorMeasuredEntity interface{}
}

CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry An entSensorValueTable entry describes the present reading of a sensor, the measurement units and scale, and sensor operational status.

func (*CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry) GetEntityData 

func (entSensorValueEntry *CISCOENTITYSENSORMIB_EntSensorValueTable_EntSensorValueEntry) GetEntityData() *types.CommonEntityData

type SensorDataScale 

type SensorDataScale string

SensorDataScale represents International System of Units (SI) prefixes. 

const (
	SensorDataScale_yocto SensorDataScale = "yocto"

	SensorDataScale_zepto SensorDataScale = "zepto"

	SensorDataScale_atto SensorDataScale = "atto"

	SensorDataScale_femto SensorDataScale = "femto"

	SensorDataScale_pico SensorDataScale = "pico"

	SensorDataScale_nano SensorDataScale = "nano"

	SensorDataScale_micro SensorDataScale = "micro"

	SensorDataScale_milli SensorDataScale = "milli"

	SensorDataScale_units SensorDataScale = "units"

	SensorDataScale_kilo SensorDataScale = "kilo"

	SensorDataScale_mega SensorDataScale = "mega"

	SensorDataScale_giga SensorDataScale = "giga"

	SensorDataScale_tera SensorDataScale = "tera"

	SensorDataScale_exa SensorDataScale = "exa"

	SensorDataScale_peta SensorDataScale = "peta"

	SensorDataScale_zetta SensorDataScale = "zetta"

	SensorDataScale_yotta SensorDataScale = "yotta"
)

type SensorDataType 

type SensorDataType string

SensorDataType represents dBm(14): dB relative to 1mW of power 

const (
	SensorDataType_other SensorDataType = "other"

	SensorDataType_unknown SensorDataType = "unknown"

	SensorDataType_voltsAC SensorDataType = "voltsAC"

	SensorDataType_voltsDC SensorDataType = "voltsDC"

	SensorDataType_amperes SensorDataType = "amperes"

	SensorDataType_watts SensorDataType = "watts"

	SensorDataType_hertz SensorDataType = "hertz"

	SensorDataType_celsius SensorDataType = "celsius"

	SensorDataType_percentRH SensorDataType = "percentRH"

	SensorDataType_rpm SensorDataType = "rpm"

	SensorDataType_cmm SensorDataType = "cmm"

	SensorDataType_truthvalue SensorDataType = "truthvalue"

	SensorDataType_specialEnum SensorDataType = "specialEnum"

	SensorDataType_dBm SensorDataType = "dBm"
)

type SensorStatus 

type SensorStatus string

SensorStatus represents readings. 

const (
	SensorStatus_ok SensorStatus = "ok"

	SensorStatus_unavailable SensorStatus = "unavailable"

	SensorStatus_nonoperational SensorStatus = "nonoperational"
)

type SensorThresholdRelation 

type SensorThresholdRelation string

SensorThresholdRelation represents the threshold value 

const (
	SensorThresholdRelation_lessThan SensorThresholdRelation = "lessThan"

	SensorThresholdRelation_lessOrEqual SensorThresholdRelation = "lessOrEqual"

	SensorThresholdRelation_greaterThan SensorThresholdRelation = "greaterThan"

	SensorThresholdRelation_greaterOrEqual SensorThresholdRelation = "greaterOrEqual"

	SensorThresholdRelation_equalTo SensorThresholdRelation = "equalTo"

	SensorThresholdRelation_notEqualTo SensorThresholdRelation = "notEqualTo"
)

type SensorThresholdSeverity 

type SensorThresholdSeverity string

SensorThresholdSeverity represents threshold. 

const (
	SensorThresholdSeverity_other SensorThresholdSeverity = "other"

	SensorThresholdSeverity_minor SensorThresholdSeverity = "minor"

	SensorThresholdSeverity_major SensorThresholdSeverity = "major"

	SensorThresholdSeverity_critical SensorThresholdSeverity = "critical"
)

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.