nsdp

README

Netgear Switch Discovery Protocol Input Plugin

This plugin gathers metrics from devices via the Netgear Switch Discovery Protocol for all available switches and ports.

⭐ Telegraf v1.34.0 🏷️ network 💻 all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Gather Netgear Switch Discovery Protocol status
[[inputs.nsdp]]
  ## The target address to use for status gathering. Either Broadcast (default)
  ## or the address of a single well-known device.
  # address = "255.255.255.255:63322"

  ## The maximum number of device responses to wait for. 0 means no limit.
  ## NSDP works asynchronously. Without a limit (0) the plugin always waits
  ## the amount given in timeout for possible responses. By setting this
  ## option to the known number of devices, the plugin completes
  ## processing as soon as the last device has answered.
  # device_limit = 0

  ## The maximum duration to wait for device responses.
  # timeout = "2s"

Metrics

• nsdp_device_port
  • tags
    • device - The device identifier (MAC/HW address)
    • device_ip - The device's IP address
    • device_name - The device's name
    • device_model - The device's model
    • device_port - The port id the fields are referring to
  • fields
    • bytes_sent (uint) - Number of bytes sent via this port
    • bytes_recv (uint) - Number of bytes received via this port
    • packets_total (uint) - Total number of packets processed on this port
    • broadcasts_total (uint) - Total number of broadcasts processed on this port
    • multicasts_total (uint) - Total number of multicasts processed on this port
    • errors_total (uint) - Total number of errors encountered on this port

Example Output

nsdp_device_port,device=12:34:56:78:9a:bc,device_ip=10.1.0.4,device_model=GS108Ev3,device_name=switch2,device_port=1 broadcasts_total=0u,bytes_recv=3879427866u,bytes_sent=506548796u,errors_total=0u,multicasts_total=0u,packets_total=0u 1737152505014578000

Documentation

Index

• type NSDP
  • func (n *NSDP) Gather(acc telegraf.Accumulator) error
  • func (n *NSDP) Init() error
  • func (*NSDP) SampleConfig() string
  • func (n *NSDP) Start(telegraf.Accumulator) error
  • func (n *NSDP) Stop()

Types

type NSDP

type NSDP struct {
	Address     string          `toml:"address"`
	DeviceLimit uint            `toml:"device_limit"`
	Timeout     config.Duration `toml:"timeout"`
	Log         telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*NSDP) Gather

func (n *NSDP) Gather(acc telegraf.Accumulator) error

func (*NSDP) Init

func (n *NSDP) Init() error

func (*NSDP) SampleConfig

func (*NSDP) SampleConfig() string

func (*NSDP) Start

func (n *NSDP) Start(telegraf.Accumulator) error

func (*NSDP) Stop

func (n *NSDP) Stop()