network

type CommonOIDs struct {
	SysObjectID    *string
	SysDescription *string
}

type ConnectionData struct {
	// Data of the snmp connection to the device
	SNMP *SNMPConnectionData `json:"snmp" xml:"snmp" yaml:"snmp"`
	// Data of the http connection to the device
	HTTP *HTTPConnectionData `json:"http" xml:"http" yaml:"http"`
}

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

type HTTPConnectionData struct {
	// The HTTP port(s) of the device.
	//
	// example: [80]
	HTTPPorts []int `json:"http_ports" xml:"http_ports" yaml:"http_ports"`
	// The HTTPS port(s) of the device.
	//
	// example: [443]
	HTTPSPorts []int `json:"https_ports" xml:"https_ports" yaml:"https_ports"`
	// The username for authorization on the device.
	//
	// example: username
	AuthUsername *string `json:"auth_username" xml:"auth_username" yaml:"auth_username"`
	// The password for authorization on the device.
	//
	// example: password
	AuthPassword *string `json:"auth_password" xml:"auth_password" yaml:"auth_password"`
}

type OID string

type RequestDeviceConnection struct {
	RawConnectionData ConnectionData
	HTTP              *RequestDeviceConnectionHTTP
	SNMP              *RequestDeviceConnectionSNMP
}

type RequestDeviceConnectionHTTP struct {
	HTTPClient     *HTTPClient
	ConnectionData *HTTPConnectionData
}

type RequestDeviceConnectionSNMP struct {
	SnmpClient SNMPClient
	CommonOIDs CommonOIDs
}

type SNMPClient interface {
	Disconnect() error

	SNMPGet(ctx context.Context, oid ...OID) ([]SNMPResponse, error)
	SNMPWalk(ctx context.Context, oid OID) ([]SNMPResponse, error)

	UseCache(b bool)
	HasSuccessfulCachedRequest() bool

	GetCommunity() string
	SetCommunity(community string)
	GetPort() int
	GetVersion() string
	GetMaxRepetitions() uint32

	SetMaxRepetitions(maxRepetitions uint32)
	SetMaxOIDs(maxOIDs int) error

	GetV3Level() *string
	GetV3ContextName() *string
	GetV3User() *string
	GetV3AuthKey() *string
	GetV3AuthProto() *string
	GetV3PrivKey() *string
	GetV3PrivProto() *string
}

type SNMPConnectionData struct {
	// The SNMP community string(s) for the device.
	//
	// example: ["public"]
	Communities []string `json:"communities" xml:"communities" yaml:"communities"`
	// The SNMP version(s) of the device.
	//
	// example: ["2c"]
	Versions []string `json:"versions" xml:"versions" yaml:"versions"`
	// The SNMP port(s) of the device.
	//
	// example: [161]
	Ports []int `json:"ports" xml:"ports" yaml:"ports"`
	// The Max Repetitions of the SNMP connection. Overrides the device class settings if set.
	//
	// example: 20
	MaxRepetitions *uint32 `json:"maxRepetitions" xml:"maxRepetitions" yaml:"maxRepetitions"`
	// The amount of parallel connection requests used while trying to get a valid SNMP connection.
	//
	// example: 5
	DiscoverParallelRequests *int `json:"discoverParallelRequests" xml:"discoverParallelRequests" yaml:"discoverParallelRequests"`
	// The timeout in seconds used while trying to get a valid SNMP connection.
	//
	// example: 2
	DiscoverTimeout *int `json:"discoverTimeout" xml:"discoverTimeout" yaml:"discoverTimeout"`
	// The retries used while trying to get a valid SNMP connection.
	//
	// example: 0
	DiscoverRetries *int `json:"discoverRetries" xml:"discoverRetries" yaml:"discoverRetries"`
	// The data required for an SNMP v3 connection.
	V3Data SNMPv3ConnectionData `json:"v3_data" xml:"v3_data" yaml:"v3_data"`
}

type SNMPCredentials struct {
	Version       string `yaml:"version" json:"version" xml:"version"`
	Community     string `yaml:"community" json:"community" xml:"community"`
	Port          int    `yaml:"port" json:"port" xml:"port"`
	V3Level       string `yaml:"v3Level" json:"v3Level" xml:"v3Level"`
	V3ContextName string `yaml:"v3ContextName" json:"v3ContextName" xml:"v3ContextName"`
}

type SNMPGetConfiguration struct {
	OID          OID  `yaml:"oid" mapstructure:"oid"`
	UseRawResult bool `yaml:"use_raw_result" mapstructure:"use_raw_result"`
}

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

type SNMPv3ConnectionData struct {
	// The security level of the SNMP connection.
	//
	// example: authPriv
	Level *string `json:"level" xml:"level" yaml:"level"`
	// The context name of the SNMP connection.
	//
	// example: bridge1
	ContextName *string `json:"context_name" xml:"context_name" yaml:"context_name"`
	// The user of the SNMP connection.
	//
	// example: user
	User *string `json:"user" xml:"user" yaml:"user"`
	// The authentication protocol passphrase of the SNMP connection.
	//
	// example: passphrase
	AuthKey *string `json:"auth_key" xml:"auth_key" yaml:"auth_key"`
	// The authentication protocol of the SNMP connection.
	//
	// example: MD5
	AuthProtocol *string `json:"auth_protocol" xml:"auth_protocol" yaml:"auth_protocol"`
	// The privacy protocol passphrase of the SNMP connection.
	//
	// example: passphrase
	PrivKey *string `json:"priv_key" xml:"priv_key" yaml:"priv_key"`
	// The privacy protocol of the SNMP connection.
	//
	// example: DES
	PrivProtocol *string `json:"priv_protocol" xml:"priv_protocol" yaml:"priv_protocol"`
}