discovery

Documentation

Index

• Constants
• Variables
• func BuildAddrScannerFunc(funcs []scanfunc) func(context.Context, model.Addr) (model.EventDeviceDiscovered, error)
• func BuildAddrScanners(cfg *Config) []scanfunc
• func BuildNetworkScanFunc(q chan model.Addr, status *string) func(context.Context, model.Network) (string, error)
• func NetworkRescanFilter(cfg *Config) model.NetworkFilter
• func SetFlags(fs *pflag.FlagSet, cfg *Config)
• func SnmpArpTableRescanFilter(cfg *SNMPConfig) model.DeviceFilter
• func SnmpInterfaceRescanFilter(cfg *SNMPConfig) model.DeviceFilter
• type ArpConfig
• type Config
• type DiscoverDevicesFromSNMPDevice
• type DiscoverNetworksFromSNMPDevice
• type ICMPConfig
• type IPv6ExcludedFromDiscovery
  • func IPv6NetworkExcluded(n model.Network) IPv6ExcludedFromDiscovery
  • func (e IPv6ExcludedFromDiscovery) Error() string
  • func (e IPv6ExcludedFromDiscovery) Is(target error) bool
• type NetworkScannerWorker
  • func NewNetworkScannerWorker(status *string, devin chan model.Addr) *NetworkScannerWorker
  • func (w *NetworkScannerWorker) Close()
  • func (w *NetworkScannerWorker) Run(ctx context.Context)
• type NoDeviceDiscoveredError
  • func NoDeviceDiscovered(addr model.Addr) NoDeviceDiscoveredError
  • func (e NoDeviceDiscoveredError) Error() string
  • func (e NoDeviceDiscoveredError) Is(target error) bool
• type SNMPConfig
• type Worker
  • func NewWorker(cfg *Config) *Worker
  • func (w *Worker) Close()
  • func (w *Worker) Run(ctx context.Context, max int)

Constants

const (
	ArpDiscoverySource     model.DiscoverySource = "ARP"
	PingDiscoverySource    model.DiscoverySource = "PING"
	SNMPDiscoverySource    model.DiscoverySource = "SNMP"
	SNMPArpDiscoverySource model.DiscoverySource = "SNMP_ARP"
)

Variables

var ErrIPv6ExcludedFromDiscovery = IPv6ExcludedFromDiscovery{}

var ErrNoDeviceDiscovered = NoDeviceDiscoveredError{}

Functions

func BuildAddrScannerFunc

func BuildAddrScannerFunc(
	funcs []scanfunc,
) func(context.Context, model.Addr) (model.EventDeviceDiscovered, error)

func BuildAddrScanners

func BuildAddrScanners(cfg *Config) []scanfunc

func BuildNetworkScanFunc

func BuildNetworkScanFunc(
	q chan model.Addr,
	status *string,
) func(context.Context, model.Network) (string, error)

func NetworkRescanFilter

func NetworkRescanFilter(cfg *Config) model.NetworkFilter

func SetFlags

func SetFlags(fs *pflag.FlagSet, cfg *Config)

func SnmpArpTableRescanFilter

func SnmpArpTableRescanFilter(cfg *SNMPConfig) model.DeviceFilter

func SnmpInterfaceRescanFilter

func SnmpInterfaceRescanFilter(cfg *SNMPConfig) model.DeviceFilter

Types

type ArpConfig

type ArpConfig struct {
	Enabled bool
	Timeout time.Duration
}

type Config

type Config struct {
	Enabled                 bool
	BootstrapOnFirstRun     bool
	AutoDiscoverNewNetworks bool
	CheckInterval           time.Duration
	NetworkScanInterval     time.Duration
	MaxWorkers              int
	Arp                     *ArpConfig
	Icmp                    *ICMPConfig
	Snmp                    *SNMPConfig
}

type DiscoverDevicesFromSNMPDevice

type DiscoverDevicesFromSNMPDevice struct {
	model.Device
}

type DiscoverNetworksFromSNMPDevice

type DiscoverNetworksFromSNMPDevice struct {
	model.Device
}

type ICMPConfig

type ICMPConfig struct {
	Enabled      bool
	Privileged   bool
	Timeout      time.Duration
	PingCount    int
	SleepBetween time.Duration
}

type IPv6ExcludedFromDiscovery

type IPv6ExcludedFromDiscovery struct {
	Network model.Network
}

func IPv6NetworkExcluded

func IPv6NetworkExcluded(n model.Network) IPv6ExcludedFromDiscovery

func (IPv6ExcludedFromDiscovery) Error

func (e IPv6ExcludedFromDiscovery) Error() string

func (IPv6ExcludedFromDiscovery) Is

func (e IPv6ExcludedFromDiscovery) Is(target error) bool

type NetworkScannerWorker

type NetworkScannerWorker struct {
	In chan model.Network
	*workerpool.Pool[model.Network, string]
}

func NewNetworkScannerWorker

func NewNetworkScannerWorker(status *string, devin chan model.Addr) *NetworkScannerWorker

func (*NetworkScannerWorker) Close

func (w *NetworkScannerWorker) Close()

func (*NetworkScannerWorker) Run

func (w *NetworkScannerWorker) Run(ctx context.Context)

type NoDeviceDiscoveredError

type NoDeviceDiscoveredError struct {
	Addr model.Addr
}

func NoDeviceDiscovered

func NoDeviceDiscovered(addr model.Addr) NoDeviceDiscoveredError

func (NoDeviceDiscoveredError) Error

func (e NoDeviceDiscoveredError) Error() string

func (NoDeviceDiscoveredError) Is

func (e NoDeviceDiscoveredError) Is(target error) bool

type SNMPConfig

type SNMPConfig struct {
	Enabled                 bool
	Timeout                 time.Duration
	Community               []string
	Ports                   []int
	ArpTableRescanInterval  time.Duration
	InterfaceRescanInterval time.Duration
}

type Worker

type Worker struct {
	In chan model.Addr
	*workerpool.Pool[model.Addr, model.EventDeviceDiscovered]
}

func NewWorker

func NewWorker(cfg *Config) *Worker

func (*Worker) Close

func (w *Worker) Close()

func (*Worker) Run

func (w *Worker) Run(ctx context.Context, max int)