snmp

Documentation

Index

• func ClearCache()
• func GetIndex(oidNum string, mibPrefix string, node gosmi.SmiNode) (col []string, tagOids map[string]struct{}, err error)
• func LoadMibsFromPath(paths []string, log telegraf.Logger, loader MibLoader) error
• func SnmpTranslateCall(oid string) (mibName string, oidNum string, oidText string, conversion string, ...)
• type ClientConfig
• type GosmiMibLoader
• type GosnmpWrapper
  • func NewWrapper(s ClientConfig) (GosnmpWrapper, error)
  • func (gs GosnmpWrapper) Host() string
  • func (gs GosnmpWrapper) Reconnect() error
  • func (gs *GosnmpWrapper) SetAgent(agent string) error
  • func (gs GosnmpWrapper) Walk(oid string, fn gosnmp.WalkFunc) error
• type MibEntry
  • func TrapLookup(oid string) (e MibEntry, err error)
• type MibLoader
• type TranslatorPlugin

Functions

func ClearCache

func ClearCache()

func GetIndex

func GetIndex(oidNum string, mibPrefix string, node gosmi.SmiNode) (col []string, tagOids map[string]struct{}, err error)

func LoadMibsFromPath

func LoadMibsFromPath(paths []string, log telegraf.Logger, loader MibLoader) error

will give all found folders to gosmi and load in all modules found in the folders

func SnmpTranslateCall

func SnmpTranslateCall(oid string) (mibName string, oidNum string, oidText string, conversion string, node gosmi.SmiNode, err error)

Types

type ClientConfig

type ClientConfig struct {
	// Timeout to wait for a response.
	Timeout config.Duration `toml:"timeout"`
	Retries int             `toml:"retries"`
	// Values: 1, 2, 3
	Version              uint8 `toml:"version"`
	UnconnectedUDPSocket bool  `toml:"unconnected_udp_socket"`
	// Path to mib files
	Path []string `toml:"path"`
	// Translator implementation
	Translator string `toml:"-"`

	// Parameters for Version 1 & 2
	Community string `toml:"community"`

	// Parameters for Version 2 & 3
	MaxRepetitions uint32 `toml:"max_repetitions"`

	// Parameters for Version 3
	ContextName string `toml:"context_name"`
	// Values: "noAuthNoPriv", "authNoPriv", "authPriv"
	SecLevel string `toml:"sec_level"`
	SecName  string `toml:"sec_name"`
	// Values: "MD5", "SHA", "". Default: ""
	AuthProtocol string `toml:"auth_protocol"`
	AuthPassword string `toml:"auth_password"`
	// Values: "DES", "AES", "". Default: ""
	PrivProtocol string `toml:"priv_protocol"`
	PrivPassword string `toml:"priv_password"`
	EngineID     string `toml:"-"`
	EngineBoots  uint32 `toml:"-"`
	EngineTime   uint32 `toml:"-"`
}

type GosmiMibLoader

type GosmiMibLoader struct{}

type GosnmpWrapper

type GosnmpWrapper struct {
	*gosnmp.GoSNMP
}

GosnmpWrapper wraps a *gosnmp.GoSNMP object so we can use it as a snmpConnection.

func NewWrapper

func NewWrapper(s ClientConfig) (GosnmpWrapper, error)

func (GosnmpWrapper) Host

func (gs GosnmpWrapper) Host() string

Host returns the value of GoSNMP.Target.

func (GosnmpWrapper) Reconnect

func (gs GosnmpWrapper) Reconnect() error

func (*GosnmpWrapper) SetAgent

func (gs *GosnmpWrapper) SetAgent(agent string) error

SetAgent takes a url (scheme://host:port) and sets the wrapped GoSNMP struct's corresponding fields. This shouldn't be called after using the wrapped GoSNMP struct, for example after connecting.

func (GosnmpWrapper) Walk

func (gs GosnmpWrapper) Walk(oid string, fn gosnmp.WalkFunc) error

Walk wraps GoSNMP.Walk() or GoSNMP.BulkWalk(), depending on whether the connection is using SNMPv1 or newer.

type MibEntry

type MibEntry struct {
	MibName string
	OidText string
}

The following is for snmp_trap

func TrapLookup

func TrapLookup(oid string) (e MibEntry, err error)

type MibLoader

type MibLoader interface {
	// contains filtered or unexported methods
}

type TranslatorPlugin

type TranslatorPlugin interface {
	SetTranslator(name string) // Agent calls this on inputs before Init
}