snmpproxy

Documentation

Index

• Constants
• type ApiListener
  • func NewApiListener(validator *RequestValidator, requester Requester, logger *zap.SugaredLogger, ...) *ApiListener
  • func (l *ApiListener) Close()
  • func (l *ApiListener) ServeHTTP(writer http.ResponseWriter, request *http.Request)
  • func (l *ApiListener) Start() error
• type ApiRequest
  • func (r *ApiRequest) UnmarshalJSON(data []byte) error
• type GosnmpRequester
  • func NewGosnmpRequester(valueFormatter *ValueFormatter) *GosnmpRequester
  • func (r *GosnmpRequester) ExecuteRequest(apiRequest *ApiRequest) ([][]any, error)
• type Request
  • func (r *Request) UnmarshalJSON(data []byte) error
• type RequestType
  • func (t *RequestType) UnmarshalJSON(data []byte) error
• type RequestValidator
  • func NewRequestValidator(maxTimeoutSeconds uint, maxRetries uint8) *RequestValidator
  • func (v *RequestValidator) Validate(apiRequest *ApiRequest) error
• type Requester
• type Response
  • func (r *Response) Bytes() []byte
• type SnmpVersion
  • func (v *SnmpVersion) UnmarshalJSON(data []byte) error
• type ValueFormatter
  • func NewValueFormatter(mibDataProvider *mib.DataProvider) *ValueFormatter
  • func (f *ValueFormatter) Format(dataUnit gosnmp.SnmpPDU) any

Constants

const (
	Get     = RequestType("get")
	GetNext = RequestType("getNext")
	Walk    = RequestType("walk")
)

Types

type ApiListener

type ApiListener struct {
	// contains filtered or unexported fields
}

func NewApiListener

func NewApiListener(
	validator *RequestValidator,
	requester Requester,
	logger *zap.SugaredLogger,
	listen string,
	socketPermissions os.FileMode,
) *ApiListener

func (*ApiListener) Close

func (l *ApiListener) Close()

func (*ApiListener) ServeHTTP

func (l *ApiListener) ServeHTTP(writer http.ResponseWriter, request *http.Request)

func (*ApiListener) Start

func (l *ApiListener) Start() error

type ApiRequest

type ApiRequest struct {
	Host      string        `json:"host"`
	Community string        `json:"community"`
	Version   SnmpVersion   `json:"version"`
	Retries   uint8         `json:"retries"`
	Timeout   time.Duration `json:"timeout"`
	Requests  []Request     `json:"requests"`
}

func (*ApiRequest) UnmarshalJSON

func (r *ApiRequest) UnmarshalJSON(data []byte) error

type GosnmpRequester

type GosnmpRequester struct {
	// contains filtered or unexported fields
}

func NewGosnmpRequester

func NewGosnmpRequester(valueFormatter *ValueFormatter) *GosnmpRequester

func (*GosnmpRequester) ExecuteRequest

func (r *GosnmpRequester) ExecuteRequest(apiRequest *ApiRequest) ([][]any, error)

type Request

type Request struct {
	RequestType    RequestType `json:"request_type"`
	Oids           []string    `json:"oids"`
	MaxRepetitions uint32      `json:"max_repetitions"`
}

func (*Request) UnmarshalJSON

func (r *Request) UnmarshalJSON(data []byte) error

type RequestType

type RequestType string

func (*RequestType) UnmarshalJSON

func (t *RequestType) UnmarshalJSON(data []byte) error

type RequestValidator

type RequestValidator struct {
	// contains filtered or unexported fields
}

func NewRequestValidator

func NewRequestValidator(maxTimeoutSeconds uint, maxRetries uint8) *RequestValidator

func (*RequestValidator) Validate

func (v *RequestValidator) Validate(apiRequest *ApiRequest) error

type Requester

type Requester interface {
	ExecuteRequest(apiRequest *ApiRequest) ([][]any, error)
}

type Response

type Response struct {
	Error  string  `json:"error,omitempty"`
	Result [][]any `json:"result,omitempty"`
}

func (*Response) Bytes

func (r *Response) Bytes() []byte

type SnmpVersion

type SnmpVersion gosnmp.SnmpVersion

func (*SnmpVersion) UnmarshalJSON

func (v *SnmpVersion) UnmarshalJSON(data []byte) error

type ValueFormatter

type ValueFormatter struct {
	// contains filtered or unexported fields
}

func NewValueFormatter

func NewValueFormatter(mibDataProvider *mib.DataProvider) *ValueFormatter

func (*ValueFormatter) Format

func (f *ValueFormatter) Format(dataUnit gosnmp.SnmpPDU) any