api

Documentation

Index

• type BuildInfo
• type IfaceCounter
• type IfaceStats
• type Interface
• type InterfaceCounter
• type InterfaceStats
• type MTU
• type Plugin
• type RuntimeInfo
• type Status
• type Uptime
  • func (uptime Uptime) MarshalText() (text []byte, err error)
  • func (uptime Uptime) String() string
• type VPP
• type VRF
• type VppConfig
• type VppInfo
• type VppStats

Types

type BuildInfo

type BuildInfo struct {
	Version       string
	BuildUser     string    `json:",omitempty"`
	BuildHost     string    `json:",omitempty"`
	BuildDate     time.Time `json:",omitempty"`
	BuildLocation string    `json:",omitempty"`
	Compiler      string    `json:",omitempty"`
}

type IfaceCounter

type IfaceCounter struct {
	Bytes   uint64
	Packets uint64
	Errors  uint64
	Mcast   uint64
}

type IfaceStats

type IfaceStats struct {
	RX *InterfaceCounter `json:"RX,omitempty"`
	TX *InterfaceCounter `json:"TX,omitempty"`
}

type Interface

type Interface struct {
	Index      uint32
	Name       string
	Tag        string
	Type       string
	DeviceType string
	Status     Status

	MAC  string
	MTUs MTU
	IPs  []string
	VRF  VRF
}

type InterfaceCounter

type InterfaceCounter struct {
	Packets uint64
	Bytes   uint64
}

type InterfaceStats

type InterfaceStats struct {
	Rx *InterfaceCounter `json:"RX,omitempty"`
	Tx *InterfaceCounter `json:"TX,omitempty"`

	RxErrors uint64 `json:",omitempty"`
	TxErrors uint64 `json:",omitempty"`

	RxUnicast   *InterfaceCounter `json:",omitempty"`
	RxMulticast *InterfaceCounter `json:",omitempty"`
	RxBroadcast *InterfaceCounter `json:",omitempty"`
	TxUnicast   *InterfaceCounter `json:",omitempty"`
	TxMulticast *InterfaceCounter `json:",omitempty"`
	TxBroadcast *InterfaceCounter `json:",omitempty"`

	Drops   uint64 `json:",omitempty"`
	Punts   uint64 `json:",omitempty"`
	IP4     uint64 `json:",omitempty"`
	IP6     uint64 `json:",omitempty"`
	RxNoBuf uint64 `json:",omitempty"`
	RxMiss  uint64 `json:",omitempty"`
	Mpls    uint64 `json:",omitempty"`
}

type MTU

type MTU struct {
	L3       uint
	IP4, IP6 uint
	MPLS     uint
	Link     uint
}

type Plugin

type Plugin struct {
	Name        string
	Version     string
	Path        string `json:",omitempty"`
	Description string `json:",omitempty"`
}

type RuntimeInfo

type RuntimeInfo struct {
	Pid    int
	Uptime Uptime     `json:",omitempty"`
	Clock  *time.Time `json:",omitempty"`
}

type Status

type Status struct {
	Up   bool
	Link bool
}

type Uptime

type Uptime uint64

Uptime is elapsed time in seconds since VPP started.

func (Uptime) MarshalText

func (uptime Uptime) MarshalText() (text []byte, err error)

func (Uptime) String

func (uptime Uptime) String() string

type VPP

type VPP interface {
	GetBuildInfo() (*BuildInfo, error)
	GetSystemInfo() (*RuntimeInfo, error)

	GetLogs(since time.Time) ([]string, error)
	DumpLogs() ([]string, error)

	ListInterfaces() ([]*Interface, error)

	ListStats() ([]string, error)
	DumpStats() (*VppStats, error)
}

type VRF

type VRF struct {
	IP4, IP6 uint
}

type VppConfig

type VppConfig struct {
	Interfaces []Interface
}

VppConfig contains a configuration settings of VPP.

type VppInfo

type VppInfo struct {
	Build   BuildInfo
	Runtime RuntimeInfo
	Plugins []Plugin `json:",omitempty"`
}

VppInfo contains a generic information from VPP.

type VppStats

type VppStats struct {
	System govppapi.SystemStats
	//govppapi.NodeStats `json:",omitempty"`
	Nodes      []govppapi.NodeCounters `json:",omitempty"`
	Interfaces map[string]InterfaceStats
	Counters   map[string]uint64
}

VppStats contains a statistics data from VPP.