device

package
v0.5.3 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2022 License: BSD-2-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewContextWithDeviceProperties 

func NewContextWithDeviceProperties(ctx context.Context, properties Device) context.Context

NewContextWithDeviceProperties returns a new context with the device properties.

Types

type CPU added in v0.5.0 

type CPU struct {
	Label *string  `yaml:"label" json:"label" xml:"label" mapstructure:"label"`
	Load  *float64 `yaml:"load" json:"load" xml:"load" mapstructure:"load"`
}

CPU

CPU contains information per CPU.

swagger:model

type CPUComponent 

type CPUComponent struct {
	CPUs []CPU `yaml:"cpus" json:"cpus" xml:"cpus" mapstructure:"cpus"`
}

CPUComponent

CPUComponent represents a CPU component.

swagger:model

type DWDMInterface 

type DWDMInterface struct {
	RXPower        *float64         `yaml:"rx_power" json:"rx_power" xml:"rx_power" mapstructure:"rx_power"`
	TXPower        *float64         `yaml:"tx_power" json:"tx_power" xml:"tx_power" mapstructure:"tx_power"`
	CorrectedFEC   []Rate           `yaml:"corrected_fec" json:"corrected_fec" xml:"corrected_fec" mapstructure:"corrected_fec"`
	UncorrectedFEC []Rate           `yaml:"uncorrected_fec" json:"uncorrected_fec" xml:"uncorrected_fec" mapstructure:"uncorrected_fec"`
	Channels       []OpticalChannel `yaml:"channels" json:"channels" xml:"channels" mapstructure:"channels"`
}

DWDMInterface

DWDMInterface represents a DWDM interface.

swagger:model

type Device 

type Device struct {
	// Class of the device.
	//
	// example: routerOS
	Class string `yaml:"class" json:"class" xml:"class"`
	// Properties of the device.
	Properties Properties `yaml:"properties" json:"properties" xml:"properties"`
}

Device

Device represents a device and has the same structure as Response. Response can possibly be removed and replaced by Device.

swagger:model

func DevicePropertiesFromContext 

func DevicePropertiesFromContext(ctx context.Context) (Device, bool)

DevicePropertiesFromContext returns the device properties from the context.

type DiskComponent 

type DiskComponent struct {
	Storages []DiskComponentStorage `yaml:"storages" json:"storages" xml:"storages" mapstructure:"storages"`
}

DiskComponent

DiskComponent represents a disk component.

swagger:model

type DiskComponentStorage 

type DiskComponentStorage struct {
	Type        *string `yaml:"type" json:"type" xml:"type" mapstructure:"type"`
	Description *string `yaml:"description" json:"description" xml:"description" mapstructure:"description"`
	Available   *uint64 `yaml:"available" json:"available" xml:"available" mapstructure:"available"`
	Used        *uint64 `yaml:"used" json:"used" xml:"used" mapstructure:"used"`
}

DiskComponentStorage

DiskComponentStorage contains information per storage.

swagger:model

type EthernetLikeInterface 

type EthernetLikeInterface struct {
	Dot3StatsAlignmentErrors             *uint64 `` /* 134-byte string literal not displayed */
	Dot3StatsFCSErrors                   *uint64 `yaml:"dot3StatsFCSErrors" json:"dot3StatsFCSErrors" xml:"dot3StatsFCSErrors" mapstructure:"dot3StatsFCSErrors"`
	Dot3StatsSingleCollisionFrames       *uint64 `` /* 158-byte string literal not displayed */
	Dot3StatsMultipleCollisionFrames     *uint64 `` /* 166-byte string literal not displayed */
	Dot3StatsSQETestErrors               *uint64 `` /* 126-byte string literal not displayed */
	Dot3StatsDeferredTransmissions       *uint64 `` /* 158-byte string literal not displayed */
	Dot3StatsLateCollisions              *uint64 `` /* 130-byte string literal not displayed */
	Dot3StatsExcessiveCollisions         *uint64 `` /* 150-byte string literal not displayed */
	Dot3StatsInternalMacTransmitErrors   *uint64 `` /* 174-byte string literal not displayed */
	Dot3StatsCarrierSenseErrors          *uint64 `` /* 146-byte string literal not displayed */
	Dot3StatsFrameTooLongs               *uint64 `` /* 126-byte string literal not displayed */
	Dot3StatsInternalMacReceiveErrors    *uint64 `` /* 170-byte string literal not displayed */
	Dot3HCStatsAlignmentErrors           *uint64 `` /* 142-byte string literal not displayed */
	Dot3HCStatsFCSErrors                 *uint64 `yaml:"dot3HCStatsFCSErrors" json:"dot3HCStatsFCSErrors" xml:"dot3HCStatsFCSErrors" mapstructure:"dot3HCStatsFCSErrors"`
	Dot3HCStatsInternalMacTransmitErrors *uint64 `` /* 182-byte string literal not displayed */
	Dot3HCStatsFrameTooLongs             *uint64 `` /* 134-byte string literal not displayed */
	Dot3HCStatsInternalMacReceiveErrors  *uint64 `` /* 178-byte string literal not displayed */
	EtherStatsCRCAlignErrors             *uint64 `` /* 134-byte string literal not displayed */
}

EthernetLikeInterface

EthernetLikeInterface represents an ethernet like interface.

swagger:model

type HardwareHealthComponent 

type HardwareHealthComponent struct {
	EnvironmentMonitorState *HardwareHealthComponentState        `` /* 138-byte string literal not displayed */
	Fans                    []HardwareHealthComponentFan         `yaml:"fans" json:"fans" xml:"fans" mapstructure:"fans"`
	PowerSupply             []HardwareHealthComponentPowerSupply `yaml:"power_supply" json:"power_supply" xml:"power_supply" mapstructure:"power_supply"`
	Temperature             []HardwareHealthComponentTemperature `yaml:"temperature" json:"temperature" xml:"temperature" mapstructure:"temperature"`
	Voltage                 []HardwareHealthComponentVoltage     `yaml:"voltage" json:"voltage" xml:"voltage" mapstructure:"voltage"`
}

HardwareHealthComponent

HardwareHealthComponent represents hardware health information of a device.

swagger:model

type HardwareHealthComponentFan 

type HardwareHealthComponentFan struct {
	Description *string                       `yaml:"description" json:"description" xml:"description" mapstructure:"description"`
	State       *HardwareHealthComponentState `yaml:"state" json:"state" xml:"state" mapstructure:"state"`
}

HardwareHealthComponentFan

HardwareHealthComponentFan represents one fan of a device.

swagger:model

type HardwareHealthComponentPowerSupply 

type HardwareHealthComponentPowerSupply struct {
	Description *string                       `yaml:"description" json:"description" xml:"description" mapstructure:"description"`
	State       *HardwareHealthComponentState `yaml:"state" json:"state" xml:"state" mapstructure:"state"`
}

HardwareHealthComponentPowerSupply

HardwareHealthComponentPowerSupply represents one power supply of a device.

swagger:model

type HardwareHealthComponentState added in v0.5.0 

type HardwareHealthComponentState string
const (
	HardwareHealthComponentStateInitial        HardwareHealthComponentState = "initial"
	HardwareHealthComponentStateNormal         HardwareHealthComponentState = "normal"
	HardwareHealthComponentStateWarning        HardwareHealthComponentState = "warning"
	HardwareHealthComponentStateCritical       HardwareHealthComponentState = "critical"
	HardwareHealthComponentStateShutdown       HardwareHealthComponentState = "shutdown"
	HardwareHealthComponentStateNotPresent     HardwareHealthComponentState = "not_present"
	HardwareHealthComponentStateNotFunctioning HardwareHealthComponentState = "not_functioning"
	HardwareHealthComponentStateUnknown        HardwareHealthComponentState = "unknown"
)

func (HardwareHealthComponentState) GetInt added in v0.5.0 

func (h HardwareHealthComponentState) GetInt() (int, error)

type HardwareHealthComponentTemperature added in v0.5.0 

type HardwareHealthComponentTemperature struct {
	Description *string                       `yaml:"description" json:"description" xml:"description" mapstructure:"description"`
	Temperature *float64                      `yaml:"temperature" json:"temperature" xml:"temperature" mapstructure:"temperature"`
	State       *HardwareHealthComponentState `yaml:"state" json:"state" xml:"state" mapstructure:"state"`
}

HardwareHealthComponentTemperature

HardwareHealthComponentTemperature represents one fan of a device.

swagger:model

type HardwareHealthComponentVoltage added in v0.5.0 

type HardwareHealthComponentVoltage struct {
	Description *string                       `yaml:"description" json:"description" xml:"description" mapstructure:"description"`
	Voltage     *float64                      `yaml:"voltage" json:"voltage" xml:"voltage" mapstructure:"voltage"`
	State       *HardwareHealthComponentState `yaml:"state" json:"state" xml:"state" mapstructure:"state"`
}

HardwareHealthComponentVoltage

HardwareHealthComponentVoltage represents the voltage of a device.

swagger:model

type HighAvailabilityComponent added in v0.5.3 

type HighAvailabilityComponent struct {
	State *HighAvailabilityComponentState `yaml:"state" json:"state" xml:"state" mapstructure:"state"`
	Role  *string                         `yaml:"role" json:"role" xml:"role" mapstructure:"role"`
	Nodes *int                            `yaml:"nodes" json:"nodes" xml:"nodes" mapstructure:"nodes"`
}

HighAvailabilityComponent

HighAvailabilityComponent represents high availability information of a device.

swagger:model

type HighAvailabilityComponentState added in v0.5.3 

type HighAvailabilityComponentState string
const (
	HighAvailabilityComponentStateUnsynchronized HighAvailabilityComponentState = "unsynchronized"
	HighAvailabilityComponentStateSynchronized   HighAvailabilityComponentState = "synchronized"
	HighAvailabilityComponentStateStandalone     HighAvailabilityComponentState = "standalone"
)

func (HighAvailabilityComponentState) GetInt added in v0.5.3 

func (h HighAvailabilityComponentState) GetInt() (int, error)

type Interface 

type Interface struct {
	IfIndex              *uint64 `yaml:"ifIndex" json:"ifIndex" xml:"ifIndex" mapstructure:"ifIndex"`
	IfDescr              *string `yaml:"ifDescr" json:"ifDescr" xml:"ifDescr" mapstructure:"ifDescr"`
	IfType               *string `yaml:"ifType" json:"ifType" xml:"ifType" mapstructure:"ifType"`
	IfMtu                *uint64 `yaml:"ifMtu" json:"ifMtu" xml:"ifMtu" mapstructure:"ifMtu"`
	IfSpeed              *uint64 `yaml:"ifSpeed" json:"ifSpeed" xml:"ifSpeed" mapstructure:"ifSpeed"`
	IfPhysAddress        *string `yaml:"ifPhysAddress" json:"ifPhysAddress" xml:"ifPhysAddress" mapstructure:"ifPhysAddress"`
	IfAdminStatus        *Status `yaml:"ifAdminStatus" json:"ifAdminStatus" xml:"ifAdminStatus" mapstructure:"ifAdminStatus"`
	IfOperStatus         *Status `yaml:"ifOperStatus" json:"ifOperStatus" xml:"ifOperStatus" mapstructure:"ifOperStatus"`
	IfLastChange         *uint64 `yaml:"ifLastChange" json:"ifLastChange" xml:"ifLastChange" mapstructure:"ifLastChange"`
	IfInOctets           *uint64 `yaml:"ifInOctets" json:"ifInOctets" xml:"ifInOctets" mapstructure:"ifInOctets"`
	IfInUcastPkts        *uint64 `yaml:"ifInUcastPkts" json:"ifInUcastPkts" xml:"ifInUcastPkts" mapstructure:"ifInUcastPkts"`
	IfInNUcastPkts       *uint64 `yaml:"ifInNUcastPkts" json:"ifInNUcastPkts" xml:"ifInNUcastPkts" mapstructure:"ifInNUcastPkts"`
	IfInDiscards         *uint64 `yaml:"ifInDiscards" json:"ifInDiscards" xml:"ifInDiscards" mapstructure:"ifInDiscards"`
	IfInErrors           *uint64 `yaml:"ifInErrors" json:"ifInErrors" xml:"ifInErrors" mapstructure:"ifInErrors"`
	IfInUnknownProtos    *uint64 `yaml:"ifInUnknownProtos" json:"ifInUnknownProtos" xml:"ifInUnknownProtos" mapstructure:"ifInUnknownProtos"`
	IfOutOctets          *uint64 `yaml:"ifOutOctets" json:"ifOutOctets" xml:"ifOutOctets" mapstructure:"ifOutOctets"`
	IfOutUcastPkts       *uint64 `yaml:"ifOutUcastPkts" json:"ifOutUcastPkts" xml:"ifOutUcastPkts" mapstructure:"ifOutUcastPkts"`
	IfOutNUcastPkts      *uint64 `yaml:"ifOutNUcastPkts" json:"ifOutNUcastPkts" xml:"ifOutNUcastPkts" mapstructure:"ifOutNUcastPkts"`
	IfOutDiscards        *uint64 `yaml:"ifOutDiscards" json:"ifOutDiscards" xml:"ifOutDiscards" mapstructure:"ifOutDiscards"`
	IfOutErrors          *uint64 `yaml:"ifOutErrors" json:"ifOutErrors" xml:"ifOutErrors" mapstructure:"ifOutErrors"`
	IfOutQLen            *uint64 `yaml:"ifOutQLen" json:"ifOutQLen" xml:"ifOutQLen" mapstructure:"ifOutQLen"`
	IfSpecific           *string `yaml:"ifSpecific" json:"ifSpecific" xml:"ifSpecific" mapstructure:"ifSpecific"`
	IfName               *string `yaml:"ifName" json:"ifName" xml:"ifName" mapstructure:"ifName"`
	IfInMulticastPkts    *uint64 `yaml:"ifInMulticastPkts" json:"ifInMulticastPkts" xml:"ifInMulticastPkts" mapstructure:"ifInMulticastPkts"`
	IfInBroadcastPkts    *uint64 `yaml:"ifInBroadcastPkts" json:"ifInBroadcastPkts" xml:"ifInBroadcastPkts" mapstructure:"ifInBroadcastPkts"`
	IfOutMulticastPkts   *uint64 `yaml:"ifOutMulticastPkts" json:"ifOutMulticastPkts" xml:"ifOutMulticastPkts" mapstructure:"ifOutMulticastPkts"`
	IfOutBroadcastPkts   *uint64 `yaml:"ifOutBroadcastPkts" json:"ifOutBroadcastPkts" xml:"ifOutBroadcastPkts" mapstructure:"ifOutBroadcastPkts"`
	IfHCInOctets         *uint64 `yaml:"ifHCInOctets" json:"ifHCInOctets" xml:"ifHCInOctets" mapstructure:"ifHCInOctets"`
	IfHCInUcastPkts      *uint64 `yaml:"ifHCInUcastPkts" json:"ifHCInUcastPkts" xml:"ifHCInUcastPkts" mapstructure:"ifHCInUcastPkts"`
	IfHCInMulticastPkts  *uint64 `yaml:"ifHCInMulticastPkts" json:"ifHCInMulticastPkts" xml:"ifHCInMulticastPkts" mapstructure:"ifHCInMulticastPkts"`
	IfHCInBroadcastPkts  *uint64 `yaml:"ifHCInBroadcastPkts" json:"ifHCInBroadcastPkts" xml:"ifHCInBroadcastPkts" mapstructure:"ifHCInBroadcastPkts"`
	IfHCOutOctets        *uint64 `yaml:"ifHCOutOctets" json:"ifHCOutOctets" xml:"ifHCOutOctets" mapstructure:"ifHCOutOctets"`
	IfHCOutUcastPkts     *uint64 `yaml:"ifHCOutUcastPkts" json:"ifHCOutUcastPkts" xml:"ifHCOutUcastPkts" mapstructure:"ifHCOutUcastPkts"`
	IfHCOutMulticastPkts *uint64 `yaml:"ifHCOutMulticastPkts" json:"ifHCOutMulticastPkts" xml:"ifHCOutMulticastPkts" mapstructure:"ifHCOutMulticastPkts"`
	IfHCOutBroadcastPkts *uint64 `yaml:"ifHCOutBroadcastPkts" json:"ifHCOutBroadcastPkts" xml:"ifHCOutBroadcastPkts" mapstructure:"ifHCOutBroadcastPkts"`
	IfHighSpeed          *uint64 `yaml:"ifHighSpeed" json:"ifHighSpeed" xml:"ifHighSpeed" mapstructure:"ifHighSpeed"`
	IfAlias              *string `yaml:"ifAlias" json:"ifAlias" xml:"ifAlias" mapstructure:"ifAlias"`

	// MaxSpeedIn and MaxSpeedOut are set if an interface has different values for max speed in / out
	MaxSpeedIn  *uint64 `yaml:"max_speed_in" json:"max_speed_in" xml:"max_speed_in" mapstructure:"max_speed_in"`
	MaxSpeedOut *uint64 `yaml:"max_speed_out" json:"max_speed_out" xml:"max_speed_out" mapstructure:"max_speed_out"`

	// SubType is not set per default and cannot be read out through a device class.
	// It is used to internally specify a port type, without changing the actual ifType.
	SubType *string `yaml:"-" json:"-" xml:"-"`

	EthernetLike       *EthernetLikeInterface       `` /* 130-byte string literal not displayed */
	Radio              *RadioInterface              `yaml:"radio,omitempty" json:"radio,omitempty" xml:"radio,omitempty" mapstructure:"radio,omitempty"`
	DWDM               *DWDMInterface               `yaml:"dwdm,omitempty" json:"dwdm,omitempty" xml:"dwdm,omitempty" mapstructure:"dwdm,omitempty"`
	OpticalTransponder *OpticalTransponderInterface `` /* 154-byte string literal not displayed */
	OpticalAmplifier   *OpticalAmplifierInterface   `` /* 146-byte string literal not displayed */
	OpticalOPM         *OpticalOPMInterface         `yaml:"optical_opm,omitempty" json:"optical_opm,omitempty" xml:"optical_opm,omitempty" mapstructure:"optical_opm,omitempty"`
	SAP                *SAPInterface                `yaml:"sap,omitempty" json:"sap,omitempty" xml:"sap,omitempty" mapstructure:"sap,omitempty"`
	VLAN               *VLANInformation             `yaml:"vlan,omitempty" json:"vlan,omitempty" xml:"vlan,omitempty" mapstructure:"vlan,omitempty"`
}

Interface

Interface represents all interface values which can be read.

swagger:model

type MemoryComponent added in v0.5.0 

type MemoryComponent struct {
	Pools []MemoryPool `yaml:"pools" json:"pools" xml:"pools" mapstructure:"pools"`
}

MemoryComponent

MemoryComponent represents a Memory component

swagger:model

type MemoryPool added in v0.5.0 

type MemoryPool struct {
	Label                        *string  `yaml:"label" json:"label" xml:"label" mapstructure:"label"`
	Usage                        *float64 `yaml:"usage" json:"usage" xml:"usage" mapstructure:"usage"`
	PerformanceDataPointModifier `yaml:"-" json:"-" xml:"-" human_readable:"-"`
}

MemoryPool

MemoryPool contains information per memory pool.

swagger:model

type OpticalAmplifierInterface 

type OpticalAmplifierInterface struct {
	Identifier *string  `yaml:"identifier" json:"identifier" xml:"identifier" mapstructure:"identifier"`
	Label      *string  `yaml:"label" json:"label" xml:"label" mapstructure:"label"`
	RXPower    *float64 `yaml:"rx_power" json:"rx_power" xml:"rx_power" mapstructure:"rx_power"`
	TXPower    *float64 `yaml:"tx_power" json:"tx_power" xml:"tx_power" mapstructure:"tx_power"`
	Gain       *float64 `yaml:"gain" json:"gain" xml:"gain" mapstructure:"gain"`
}

OpticalAmplifierInterface

OpticalAmplifierInterface represents an optical amplifier interface.

swagger:model

type OpticalChannel 

type OpticalChannel struct {
	Channel *string  `yaml:"channel" json:"channel" xml:"channel" mapstructure:"channel"`
	RXPower *float64 `yaml:"rx_power" json:"rx_power" xml:"rx_power" mapstructure:"rx_power"`
	TXPower *float64 `yaml:"tx_power" json:"tx_power" xml:"tx_power" mapstructure:"tx_power"`
}

OpticalChannel

OpticalChannel represents an optical channel.

swagger:model

type OpticalOPMInterface 

type OpticalOPMInterface struct {
	Identifier *string          `yaml:"identifier" json:"identifier" xml:"identifier" mapstructure:"identifier"`
	Label      *string          `yaml:"label" json:"label" xml:"label" mapstructure:"label"`
	RXPower    *float64         `yaml:"rx_power" json:"rx_power" xml:"rx_power" mapstructure:"rx_power"`
	Channels   []OpticalChannel `yaml:"channels" json:"channels" xml:"channels" mapstructure:"channels"`
}

OpticalOPMInterface

OpticalOPMInterface represents an optical opm interface.

swagger:model

type OpticalTransponderInterface 

type OpticalTransponderInterface struct {
	Identifier     *string  `yaml:"identifier" json:"identifier" xml:"identifier" mapstructure:"identifier"`
	Label          *string  `yaml:"label" json:"label" xml:"label" mapstructure:"label"`
	RXPower        *float64 `yaml:"rx_power" json:"rx_power" xml:"rx_power" mapstructure:"rx_power"`
	TXPower        *float64 `yaml:"tx_power" json:"tx_power" xml:"tx_power" mapstructure:"tx_power"`
	CorrectedFEC   *uint64  `yaml:"corrected_fec" json:"corrected_fec" xml:"corrected_fec" mapstructure:"corrected_fec"`
	UncorrectedFEC *uint64  `yaml:"uncorrected_fec" json:"uncorrected_fec" xml:"uncorrected_fec" mapstructure:"uncorrected_fec"`
}

OpticalTransponderInterface

OpticalTransponderInterface represents an optical transponder interface.

swagger:model

type PerformanceDataPointModifier added in v0.5.0 

type PerformanceDataPointModifier func(p *monitoringplugin.PerformanceDataPoint)

PerformanceDataPointModifier is used to overwrite PerformanceDataPoints

type Properties 

type Properties struct {
	// Vendor of the device.
	//
	// example: Mikrotik
	Vendor *string `yaml:"vendor" json:"vendor" xml:"vendor"`
	// Model of the device.
	//
	// example: CHR
	Model *string `yaml:"model" json:"model" xml:"model"`
	// ModelSeries of the device.
	//
	// example: null
	ModelSeries *string `yaml:"model_series" json:"model_series" xml:"model_series"`
	// SerialNumber of the device.
	//
	// example: null
	SerialNumber *string `yaml:"serial_number" json:"serial_number" xml:"serial_number"`
	// OSVersion of the device.
	//
	// example: 6.44.6
	OSVersion *string `yaml:"os_version" json:"os_version" xml:"os_version"`
}

Properties

Properties are properties that can be determined for a device.

swagger:model

type RadioChannel added in v0.5.3 

type RadioChannel struct {
	Channel       *string  `yaml:"channel" json:"channel" xml:"channel" mapstructure:"channel"`
	LevelIn       *float64 `yaml:"level_in" json:"level_in" xml:"level_in" mapstructure:"level_in"`
	LevelOut      *float64 `yaml:"level_out" json:"level_out" xml:"level_out" mapstructure:"level_out"`
	MaxbitrateIn  *uint64  `yaml:"maxbitrate_in" json:"maxbitrate_in" xml:"maxbitrate_in" mapstructure:"maxbitrate_in"`
	MaxbitrateOut *uint64  `yaml:"maxbitrate_out" json:"maxbitrate_out" xml:"maxbitrate_out" mapstructure:"maxbitrate_out"`
	RXFrequency   *float64 `yaml:"rx_frequency" json:"rx_frequency" xml:"rx_frequency" mapstructure:"rx_frequency"`
	TXFrequency   *float64 `yaml:"tx_frequency" json:"tx_frequency" xml:"tx_frequency" mapstructure:"tx_frequency"`
}

RadioChannel

RadioChannel represents a radio channel.

swagger:model

type RadioInterface 

type RadioInterface struct {
	LevelIn       *float64       `yaml:"level_in" json:"level_in" xml:"level_in" mapstructure:"level_in"`
	LevelOut      *float64       `yaml:"level_out" json:"level_out" xml:"level_out" mapstructure:"level_out"`
	MaxbitrateIn  *uint64        `yaml:"maxbitrate_in" json:"maxbitrate_in" xml:"maxbitrate_in" mapstructure:"maxbitrate_in"`
	MaxbitrateOut *uint64        `yaml:"maxbitrate_out" json:"maxbitrate_out" xml:"maxbitrate_out" mapstructure:"maxbitrate_out"`
	RXFrequency   *float64       `yaml:"rx_frequency" json:"rx_frequency" xml:"rx_frequency" mapstructure:"rx_frequency"`
	TXFrequency   *float64       `yaml:"tx_frequency" json:"tx_frequency" xml:"tx_frequency" mapstructure:"tx_frequency"`
	Channels      []RadioChannel `yaml:"channels" json:"channels" xml:"channels" mapstructure:"channels"`
}

RadioInterface

RadioInterface represents a radio interface.

swagger:model

type Rate 

type Rate struct {
	Time  string  `yaml:"time" json:"time" xml:"time" mapstructure:"time"`
	Value float64 `yaml:"value" json:"value" xml:"value" mapstructure:"value"`
}

Rate

Rate encapsulates values which refer to a time span.

swagger:model

type SAPInterface 

type SAPInterface struct {
	Inbound  *uint64 `yaml:"inbound" json:"inbound" xml:"inbound" mapstructure:"inbound"`
	Outbound *uint64 `yaml:"outbound" json:"outbound" xml:"outbound" mapstructure:"outbound"`
}

SAPInterface

SAPInterface represents a service access point interface.

swagger:model

type SBCComponent 

type SBCComponent struct {
	Agents                   []SBCComponentAgent `yaml:"agents" json:"agents" xml:"agents" mapstructure:"agents"`
	Realms                   []SBCComponentRealm `yaml:"realms" json:"realms" xml:"realms" mapstructure:"realms"`
	GlobalCallPerSecond      *int                `` /* 126-byte string literal not displayed */
	GlobalConcurrentSessions *int                `` /* 144-byte string literal not displayed */
	ActiveLocalContacts      *int                `yaml:"active_local_contacts" json:"active_local_contacts" xml:"active_local_contacts" mapstructure:"active_local_contacts"`
	TranscodingCapacity      *int                `yaml:"transcoding_capacity" json:"transcoding_capacity" xml:"transcoding_capacity" mapstructure:"transcoding_capacity"`
	LicenseCapacity          *int                `yaml:"license_capacity" json:"license_capacity" xml:"license_capacity" mapstructure:"license_capacity"`
	SystemRedundancy         *int                `yaml:"system_redundancy" json:"system_redundancy" xml:"system_redundancy" mapstructure:"system_redundancy"`
	SystemHealthScore        *int                `yaml:"system_health_score" json:"system_health_score" xml:"system_health_score" mapstructure:"system_health_score"`
}

SBCComponent

SBCComponent represents a SBC component.

swagger:model

type SBCComponentAgent 

type SBCComponentAgent struct {
	Hostname                      *string `yaml:"hostname" json:"hostname" xml:"hostname" mapstructure:"hostname"`
	CurrentActiveSessionsInbound  *int    `` /* 162-byte string literal not displayed */
	CurrentSessionRateInbound     *int    `` /* 150-byte string literal not displayed */
	CurrentActiveSessionsOutbound *int    `` /* 166-byte string literal not displayed */
	CurrentSessionRateOutbound    *int    `` /* 154-byte string literal not displayed */
	PeriodASR                     *int    `yaml:"period_asr" json:"period_asr" xml:"period_asr" mapstructure:"period_asr"`
	Status                        *int    `yaml:"status" json:"status" xml:"status" mapstructure:"status"`
}

SBCComponentAgent

SBCComponentAgent contains information per agent. (Voice)

swagger:model

type SBCComponentRealm 

type SBCComponentRealm struct {
	Name                          *string `yaml:"name" json:"name" xml:"name"`
	CurrentActiveSessionsInbound  *int    `` /* 162-byte string literal not displayed */
	CurrentSessionRateInbound     *int    `` /* 150-byte string literal not displayed */
	CurrentActiveSessionsOutbound *int    `` /* 166-byte string literal not displayed */
	CurrentSessionRateOutbound    *int    `` /* 154-byte string literal not displayed */
	PeriodASR                     *int    `yaml:"period_asr" json:"period_asr" xml:"period_asr" mapstructure:"d_asr"`
	ActiveLocalContacts           *int    `yaml:"active_local_contacts" json:"active_local_contacts" xml:"active_local_contacts" mapstructure:"active_local_contacts"`
	Status                        *int    `yaml:"status" json:"status" xml:"status" mapstructure:"status"`
}

SBCComponentRealm

SBCComponentRealm contains information per realm. (Voice)

swagger:model

type ServerComponent 

type ServerComponent struct {
	Procs *int `yaml:"procs" json:"procs" xml:"procs" mapstructure:"procs"`
	Users *int `yaml:"users" json:"users" xml:"users" mapstructure:"users"`
}

ServerComponent

ServerComponent represents a server component.

swagger:model

type Status 

type Status string

Status represents an interface status. 

const (
	StatusUp             Status = "up"
	StatusDown           Status = "down"
	StatusTesting        Status = "testing"
	StatusUnknown        Status = "unknown"
	StatusDormant        Status = "dormant"
	StatusNotPresent     Status = "notPresent"
	StatusLowerLayerDown Status = "lowerLayerDown"
)

All status codes with the corresponding label

func GetStatus 

func GetStatus(code int) (Status, error)

GetStatus returns the Status that is encoded by the code integer.

func (Status) ToStatusCode 

func (s Status) ToStatusCode() (int, error)

ToStatusCode returns the status as a code.

type UPSComponent 

type UPSComponent struct {
	AlarmLowVoltageDisconnect *int     `` /* 150-byte string literal not displayed */
	BatteryAmperage           *float64 `yaml:"battery_amperage " json:"battery_amperage " xml:"battery_amperage" mapstructure:"battery_amperage"`
	BatteryCapacity           *float64 `yaml:"battery_capacity" json:"battery_capacity" xml:"battery_capacity" mapstructure:"battery_capacity"`
	BatteryCurrent            *float64 `yaml:"battery_current" json:"battery_current" xml:"battery_current" mapstructure:"battery_current"`
	BatteryRemainingTime      *float64 `` /* 126-byte string literal not displayed */
	BatteryTemperature        *float64 `yaml:"battery_temperature" json:"battery_temperature" xml:"battery_temperature" mapstructure:"battery_temperature"`
	BatteryVoltage            *float64 `yaml:"battery_voltage" json:"battery_voltage" xml:"battery_voltage" mapstructure:"battery_voltage"`
	CurrentLoad               *float64 `yaml:"current_load" json:"current_load" xml:"current_load" mapstructure:"current_load"`
	MainsVoltageApplied       *bool    `yaml:"mains_voltage_applied" json:"mains_voltage_applied" xml:"mains_voltage_applied" mapstructure:"mains_voltage_applied"`
	RectifierCurrent          *float64 `yaml:"rectifier_current" json:"rectifier_current" xml:"rectifier_current" mapstructure:"rectifier_current"`
	SystemVoltage             *float64 `yaml:"system_voltage" json:"system_voltage" xml:"system_voltage" mapstructure:"system_voltage"`
}

UPSComponent

UPSComponent represents a UPS component.

swagger:model

type VLAN 

type VLAN struct {
	Name   *string `yaml:"name" json:"name" xml:"name" mapstructure:"name"`
	Status *string `yaml:"status" json:"status" xml:"status" mapstructure:"status"`
}

VLAN

VLAN includes all information about a VLAN.

swagger:model

type VLANInformation 

type VLANInformation struct {
	VLANs []VLAN `yaml:"vlans" json:"vlans" xml:"vlans" mapstructure:"vlans"`
}

VLANInformation

VLANInformation includes all information regarding the VLANs of the interface.

swagger:model

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.