vpp1908

Documentation

Overview

Package vppcalls contains wrappers over VPP binary APIs for ARPs, proxy ARPs, L3 FIBs and helpers for dumping them.

Index

• Constants
• type ArpVppHandler
  • func NewArpVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex, ...) *ArpVppHandler
  • func (h *ArpVppHandler) DumpArpEntries() ([]*vppcalls.ArpDetails, error)
  • func (h *ArpVppHandler) VppAddArp(entry *l3.ARPEntry) error
  • func (h *ArpVppHandler) VppDelArp(entry *l3.ARPEntry) error
• type DHCPProxyHandler
  • func NewDHCPProxyHandler(callsChan govppapi.Channel, log logging.Logger) *DHCPProxyHandler
  • func (h *DHCPProxyHandler) CreateDHCPProxy(entry *vpp_l3.DHCPProxy) error
  • func (h *DHCPProxyHandler) DeleteDHCPProxy(entry *vpp_l3.DHCPProxy) error
  • func (h *DHCPProxyHandler) DumpDHCPProxy() ([]*vppcalls.DHCPProxyDetails, error)
• type IPNeighHandler
  • func NewIPNeighVppHandler(callsChan govppapi.Channel, log logging.Logger) *IPNeighHandler
  • func (h *IPNeighHandler) GetIPScanNeighbor() (*l3.IPScanNeighbor, error)
  • func (h *IPNeighHandler) SetIPScanNeighbor(data *l3.IPScanNeighbor) error
• type L3VppHandler
  • func NewL3VppHandler(ch govppapi.Channel, ifIdx ifaceidx.IfaceMetadataIndex, ...) *L3VppHandler
• type ProxyArpVppHandler
  • func NewProxyArpVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex, ...) *ProxyArpVppHandler
  • func (h *ProxyArpVppHandler) AddProxyArpRange(firstIP, lastIP []byte) error
  • func (h *ProxyArpVppHandler) DeleteProxyArpRange(firstIP, lastIP []byte) error
  • func (h *ProxyArpVppHandler) DisableProxyArpInterface(ifName string) error
  • func (h *ProxyArpVppHandler) DumpProxyArpInterfaces() (pArpIfs []*vppcalls.ProxyArpInterfaceDetails, err error)
  • func (h *ProxyArpVppHandler) DumpProxyArpRanges() (pArpRngs []*vppcalls.ProxyArpRangesDetails, err error)
  • func (h *ProxyArpVppHandler) EnableProxyArpInterface(ifName string) error
• type RouteHandler
  • func NewRouteVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex, ...) *RouteHandler
  • func (h *RouteHandler) DumpRoutes() (routes []*vppcalls.RouteDetails, err error)
  • func (h *RouteHandler) VppAddRoute(route *vpp_l3.Route) error
  • func (h *RouteHandler) VppDelRoute(route *vpp_l3.Route) error
• type VrfTableHandler
  • func NewVrfTableVppHandler(callsChan govppapi.Channel, log logging.Logger) *VrfTableHandler
  • func (h *VrfTableHandler) AddVrfTable(table *l3.VrfTable) error
  • func (h *VrfTableHandler) DelVrfTable(table *l3.VrfTable) error
  • func (h *VrfTableHandler) DumpVrfTables() (tables []*l3.VrfTable, err error)

Constants

const (
	// NextHopViaLabelUnset constant has to be assigned into the field next hop
	// via label in ip_add_del_route binary message if next hop via label is not defined.
	// Equals to MPLS_LABEL_INVALID defined in VPP
	NextHopViaLabelUnset uint32 = 0xfffff + 1

	// ClassifyTableIndexUnset is a default value for field classify_table_index in ip_add_del_route binary message.
	ClassifyTableIndexUnset = ^uint32(0)

	// NextHopOutgoingIfUnset constant has to be assigned into the field next_hop_outgoing_interface
	// in ip_add_del_route binary message if outgoing interface for next hop is not defined.
	NextHopOutgoingIfUnset = ^uint32(0)
)

Types

type ArpVppHandler

type ArpVppHandler struct {
	// contains filtered or unexported fields
}

ArpVppHandler is accessor for ARP-related vppcalls methods

func NewArpVppHandler

func NewArpVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex, log logging.Logger) *ArpVppHandler

NewArpVppHandler creates new instance of IPsec vppcalls handler

func (*ArpVppHandler) DumpArpEntries

func (h *ArpVppHandler) DumpArpEntries() ([]*vppcalls.ArpDetails, error)

DumpArpEntries implements arp handler.

func (*ArpVppHandler) VppAddArp

func (h *ArpVppHandler) VppAddArp(entry *l3.ARPEntry) error

VppAddArp implements arp handler.

func (*ArpVppHandler) VppDelArp

func (h *ArpVppHandler) VppDelArp(entry *l3.ARPEntry) error

VppDelArp implements arp handler.

type DHCPProxyHandler

type DHCPProxyHandler struct {
	// contains filtered or unexported fields
}

DHCPProxyHandler is accessor for DHCP proxy-related vppcalls methods

func NewDHCPProxyHandler

func NewDHCPProxyHandler(callsChan govppapi.Channel, log logging.Logger) *DHCPProxyHandler

NewVrfTableVppHandler creates new instance of vrf-table vppcalls handler

func (*DHCPProxyHandler) CreateDHCPProxy

func (h *DHCPProxyHandler) CreateDHCPProxy(entry *vpp_l3.DHCPProxy) error

func (*DHCPProxyHandler) DeleteDHCPProxy

func (h *DHCPProxyHandler) DeleteDHCPProxy(entry *vpp_l3.DHCPProxy) error

func (*DHCPProxyHandler) DumpDHCPProxy

func (h *DHCPProxyHandler) DumpDHCPProxy() ([]*vppcalls.DHCPProxyDetails, error)

type IPNeighHandler

type IPNeighHandler struct {
	vpevppcalls.VpeVppAPI
	// contains filtered or unexported fields
}

IPNeighHandler is accessor for ip-neighbor-related vppcalls methods

func NewIPNeighVppHandler

func NewIPNeighVppHandler(callsChan govppapi.Channel, log logging.Logger) *IPNeighHandler

NewIPNeighVppHandler creates new instance of ip neighbor vppcalls handler

func (*IPNeighHandler) GetIPScanNeighbor

func (h *IPNeighHandler) GetIPScanNeighbor() (*l3.IPScanNeighbor, error)

GetIPScanNeighbor dumps current IP Scan Neighbor configuration.

func (*IPNeighHandler) SetIPScanNeighbor

func (h *IPNeighHandler) SetIPScanNeighbor(data *l3.IPScanNeighbor) error

SetIPScanNeighbor implements ip neigh handler.

type L3VppHandler

type L3VppHandler struct {
	*ArpVppHandler
	*ProxyArpVppHandler
	*RouteHandler
	*IPNeighHandler
	*VrfTableHandler
	*DHCPProxyHandler
}

func NewL3VppHandler

func NewL3VppHandler(
	ch govppapi.Channel, ifIdx ifaceidx.IfaceMetadataIndex, vrfIdx vrfidx.VRFMetadataIndex,
	addrAlloc netalloc.AddressAllocator, log logging.Logger,
) *L3VppHandler

type ProxyArpVppHandler

type ProxyArpVppHandler struct {
	// contains filtered or unexported fields
}

ProxyArpVppHandler is accessor for proxy ARP-related vppcalls methods

func NewProxyArpVppHandler

func NewProxyArpVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex, log logging.Logger) *ProxyArpVppHandler

NewProxyArpVppHandler creates new instance of proxy ARP vppcalls handler

func (*ProxyArpVppHandler) AddProxyArpRange

func (h *ProxyArpVppHandler) AddProxyArpRange(firstIP, lastIP []byte) error

AddProxyArpRange implements proxy arp handler.

func (*ProxyArpVppHandler) DeleteProxyArpRange

func (h *ProxyArpVppHandler) DeleteProxyArpRange(firstIP, lastIP []byte) error

DeleteProxyArpRange implements proxy arp handler.

func (*ProxyArpVppHandler) DisableProxyArpInterface

func (h *ProxyArpVppHandler) DisableProxyArpInterface(ifName string) error

DisableProxyArpInterface implements proxy arp handler.

func (*ProxyArpVppHandler) DumpProxyArpInterfaces

func (h *ProxyArpVppHandler) DumpProxyArpInterfaces() (pArpIfs []*vppcalls.ProxyArpInterfaceDetails, err error)

DumpProxyArpInterfaces implements proxy arp handler.

func (*ProxyArpVppHandler) DumpProxyArpRanges

func (h *ProxyArpVppHandler) DumpProxyArpRanges() (pArpRngs []*vppcalls.ProxyArpRangesDetails, err error)

DumpProxyArpRanges implements proxy arp handler.

func (*ProxyArpVppHandler) EnableProxyArpInterface

func (h *ProxyArpVppHandler) EnableProxyArpInterface(ifName string) error

EnableProxyArpInterface implements proxy arp handler.

type RouteHandler

type RouteHandler struct {
	// contains filtered or unexported fields
}

RouteHandler is accessor for route-related vppcalls methods

func NewRouteVppHandler

func NewRouteVppHandler(callsChan govppapi.Channel, ifIndexes ifaceidx.IfaceMetadataIndex,
	vrfIdx vrfidx.VRFMetadataIndex, addrAlloc netalloc.AddressAllocator, log logging.Logger) *RouteHandler

NewRouteVppHandler creates new instance of route vppcalls handler

func (*RouteHandler) DumpRoutes

func (h *RouteHandler) DumpRoutes() (routes []*vppcalls.RouteDetails, err error)

DumpRoutes implements route handler.

func (*RouteHandler) VppAddRoute

func (h *RouteHandler) VppAddRoute(route *vpp_l3.Route) error

VppAddRoute implements route handler.

func (*RouteHandler) VppDelRoute

func (h *RouteHandler) VppDelRoute(route *vpp_l3.Route) error

VppDelRoute implements route handler.

type VrfTableHandler

type VrfTableHandler struct {
	// contains filtered or unexported fields
}

VrfTableHandler is accessor for vrf-related vppcalls methods

func NewVrfTableVppHandler

func NewVrfTableVppHandler(callsChan govppapi.Channel, log logging.Logger) *VrfTableHandler

NewVrfTableVppHandler creates new instance of vrf-table vppcalls handler

func (*VrfTableHandler) AddVrfTable

func (h *VrfTableHandler) AddVrfTable(table *l3.VrfTable) error

AddVrfTable adds new VRF table.

func (*VrfTableHandler) DelVrfTable

func (h *VrfTableHandler) DelVrfTable(table *l3.VrfTable) error

DelVrfTable deletes existing VRF table.

func (*VrfTableHandler) DumpVrfTables

func (h *VrfTableHandler) DumpVrfTables() (tables []*l3.VrfTable, err error)

DumpVrfTables dumps all configured VRF tables.