vppdump

Documentation

Overview

Package vppdump provides helpers for dumping all interfaces configured in VPP.

Index

• func DumpInterfaces(log logging.Logger, vppChan govppapi.Channel, stopwatch *measure.Stopwatch) (map[uint32]*Interface, error)
• func DumpMemifSocketDetails(log logging.Logger, vppChan govppapi.Channel, timeLog measure.StopWatchEntry) (map[string]uint32, error)
• func DumpStnRules(vppChan govppapi.Channel, stopwatch *measure.Stopwatch) (rules []*stn.StnRulesDetails, err error)
• func NAT44DNatDump(swIfIndices ifaceidx.SwIfIndex, log logging.Logger, vppChan govppapi.Channel, ...) (*nat.Nat44DNat, error)
• func Nat44GlobalConfigDump(swIfIndices ifaceidx.SwIfIndex, log logging.Logger, vppChan govppapi.Channel, ...) (*nat.Nat44Global, error)
• type Interface

Functions

func DumpInterfaces

func DumpInterfaces(log logging.Logger, vppChan govppapi.Channel, stopwatch *measure.Stopwatch) (map[uint32]*Interface, error)

DumpInterfaces dumps VPP interface data into the northbound API data structure map indexed by software interface index.

LIMITATIONS: - there is no af_packet dump binary API. We relay on naming conventions of the internal VPP interface names - ip.IPAddressDetails has wrong internal structure, as a workaround we need to handle them as notifications

func DumpMemifSocketDetails

func DumpMemifSocketDetails(log logging.Logger, vppChan govppapi.Channel, timeLog measure.StopWatchEntry) (map[string]uint32, error)

DumpMemifSocketDetails dumps memif socket details from the VPP

func DumpStnRules

func DumpStnRules(vppChan govppapi.Channel, stopwatch *measure.Stopwatch) (rules []*stn.StnRulesDetails, err error)

DumpStnRules returns a list of all STN rules configured on the VPP

func NAT44DNatDump

func NAT44DNatDump(swIfIndices ifaceidx.SwIfIndex, log logging.Logger, vppChan govppapi.Channel, stopwatch *measure.Stopwatch) (*nat.Nat44DNat, error)

NAT44NatDump dumps all types of mappings, sorts it according to tag (DNAT label) and creates a set of DNAT configurations

func Nat44GlobalConfigDump

func Nat44GlobalConfigDump(swIfIndices ifaceidx.SwIfIndex, log logging.Logger, vppChan govppapi.Channel,
	stopwatch *measure.Stopwatch) (*nat.Nat44Global, error)

Nat44GlobalConfigDump returns global config in NB format

Types

type Interface

type Interface struct {
	VPPInternalName string `json:"vpp_internal_name"`
	ifnb.Interfaces_Interface
}

Interface is the wrapper structure for the interface northbound API structure.