edgemax

type Client ¶

type Client struct {
	UserAgent string
	// contains filtered or unexported fields
}

A Client is a client for a Ubiquiti EdgeMAX device.

Client.Login must be called and return a nil error before any additional actions can be performed with a Client.

func NewClient(addr string, client *http.Client) (*Client, error)

func (c *Client) Login(username string, password string) error

func (c *Client) Stats(stats ...StatType) (statC chan Stat, done func() error, err error)

type DPIStat ¶

type DPIStat struct {
	IP            net.IP
	Type          string
	Category      string
	ReceiveBytes  int
	ReceiveRate   int
	TransmitBytes int
	TransmitRate  int
}

A DPIStat contains Deep Packet Inspection stats from an EdgeMAX device, for an individual client and traffic type.

type DPIStats ¶

type DPIStats []*DPIStat

DPIStats is a slice of DPIStat values, and contains Deep Packet Inspection stats from an EdgeMAX device.

func (d DPIStats) StatType() StatType

func (d *DPIStats) UnmarshalJSON(b []byte) error

type Interface ¶

type Interface struct {
	Name            string
	Up              bool
	Autonegotiation bool
	Duplex          string
	Speed           int
	MAC             net.HardwareAddr
	MTU             int
	Addresses       []net.IP
	Stats           InterfaceStats
}

An Interface is an EdgeMAX network interface.

type InterfaceStats ¶

type InterfaceStats struct {
	ReceivePackets  int
	TransmitPackets int
	ReceiveBytes    int
	TransmitBytes   int
	ReceiveErrors   int
	TransmitErrors  int
	ReceiveDropped  int
	TransmitDropped int
	Multicast       int
	ReceiveBPS      int
	TransmitBPS     int
}

InterfaceStats contains network interface data transmission statistics.

type Interfaces ¶

type Interfaces []*Interface

Interfaces is a slice of Interface values, which contains information about network interfaces for EdgeMAX devices.

func (i Interfaces) StatType() StatType

func (i *Interfaces) UnmarshalJSON(b []byte) error

type Stat ¶

type Stat interface {
	StatType() StatType
}

A Stat is a statistic provided by an EdgeMAX device. Type assertions can be used to determine the specific type of a Stat, and to access a Stat's fields.

type StatType ¶

type StatType string

A StatType is a type of Stat. StatType values can be used to retrieve certain types of Stats from Client.Stats

const (
	// StatTypeDPIStats retrieves EdgeMAX deep packet inspection statistics.
	StatTypeDPIStats StatType = "export"

	// StatTypeSystemStats retrieves EdgeMAX system statistics, including
	// system uptime, CPU utilization, and memory utilization.
	StatTypeSystemStats StatType = "system-stats"

	// StatTypeInterfaces retrieves EdgeMAX network interface statistics.
	StatTypeInterfaces StatType = "interfaces"
)

type SystemStats ¶

type SystemStats struct {
	CPU    int
	Uptime time.Duration
	Memory int
}

SystemStats is a Stat which contains system statistics for an EdgeMAX device.

func (ss *SystemStats) StatType() StatType

func (ss *SystemStats) UnmarshalJSON(b []byte) error