vppcalls

Documentation

Overview

Package vppcalls contains wrappers over VPP binary APIs for all supported interface types.

Index

• func AddAfPacketInterface(afPacketIntf *intf.Interfaces_Interface_Afpacket, vppChan *govppapi.Channel, ...) (swIndex uint32, err error)
• func AddBfdEchoFunction(bfdInput *bfd.SingleHopBFD_EchoFunction, swIfIndexes ifaceidx.SwIfIndex, ...) (err error)
• func AddBfdUDPSession(bfdSession *bfd.SingleHopBFD_Session, swIfIndexes ifaceidx.SwIfIndex, ...) error
• func AddBfdUDPSessionFromDetails(bfdSession *bfd_api.BfdUDPSessionDetails, bfdKeyIndexes idxvpp.NameToIdx, ...) error
• func AddDelVxlanTunnelReq(vxlanIntf *intf.Interfaces_Interface_Vxlan, add uint8) (req *vxlan.VxlanAddDelTunnel, err error)
• func AddInterfaceIP(ifIdx uint32, addr *net.IPNet, log logging.Logger, vppChan *govppapi.Channel, ...) error
• func AddLoopbackInterface(vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)
• func AddMemifInterface(memIntf *intf.Interfaces_Interface_Memif, vppChan *govppapi.Channel, ...) (swIndex uint32, err error)
• func AddTapInterface(tapIf *interfaces.Interfaces_Interface_Tap, vppChan *govppapi.Channel, ...) (swIndex uint32, err error)
• func AddVxlanTunnel(vxlanIntf *intf.Interfaces_Interface_Vxlan, vppChan *govppapi.Channel, ...) (swIndex uint32, err error)
• func CheckMsgCompatibilityForBfd(log logging.Logger, vppChan *govppapi.Channel) error
• func CheckMsgCompatibilityForInterface(log logging.Logger, vppChan *govppapi.Channel) error
• func DelInterfaceIP(ifIdx uint32, addr *net.IPNet, log logging.Logger, vppChan *govppapi.Channel, ...) error
• func DeleteAfPacketInterface(afPacketIntf *intf.Interfaces_Interface_Afpacket, vppChan *govppapi.Channel, ...) error
• func DeleteBfdEchoFunction(vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)
• func DeleteBfdUDPAuthenticationKey(bfdKey *bfd.SingleHopBFD_Key, vppChannel *govppapi.Channel, ...) (err error)
• func DeleteBfdUDPSession(ifIndex uint32, sourceAddres string, destAddres string, ...) (err error)
• func DeleteLoopbackInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error
• func DeleteMemifInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error
• func DeleteTapInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error
• func DeleteVxlanTunnel(vxlanIntf *intf.Interfaces_Interface_Vxlan, vppChan *govppapi.Channel, ...) error
• func DumpBfdUDPSessionsWithID(authKeyIndex uint32, swIfIndexes ifaceidx.SwIfIndex, ...) ([]*bfd_api.BfdUDPSessionDetails, error)
• func InterfaceAdminDown(ifIdx uint32, vppChan *govppapi.Channel, timeLog *measure.TimeLog) error
• func InterfaceAdminUp(ifIdx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error
• func ModifyBfdUDPSession(bfdSession *bfd.SingleHopBFD_Session, swIfIndexes ifaceidx.SwIfIndex, ...) (err error)
• func SetBfdUDPAuthenticationKey(bfdKey *bfd.SingleHopBFD_Key, log logging.Logger, vppChannel *govppapi.Channel, ...) (err error)
• func SetInterfaceMac(ifIdx uint32, macAddress string, log logging.Logger, vppChan *govppapi.Channel, ...) error
• func SetInterfaceMtu(ifIdx uint32, mtu uint32, log logging.Logger, vppChan *govppapi.Channel, ...) error

Functions

func AddAfPacketInterface

func AddAfPacketInterface(afPacketIntf *intf.Interfaces_Interface_Afpacket, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)

AddAfPacketInterface calls AfPacketCreate VPP binary API.

func AddBfdEchoFunction

func AddBfdEchoFunction(bfdInput *bfd.SingleHopBFD_EchoFunction, swIfIndexes ifaceidx.SwIfIndex, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

AddBfdEchoFunction sets up echo function for interface

func AddBfdUDPSession

func AddBfdUDPSession(bfdSession *bfd.SingleHopBFD_Session, swIfIndexes ifaceidx.SwIfIndex, bfdKeyIndexes idxvpp.NameToIdx,
	log logging.Logger, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) error

AddBfdUDPSession adds new BFD session with authentication if available

func AddBfdUDPSessionFromDetails

func AddBfdUDPSessionFromDetails(bfdSession *bfd_api.BfdUDPSessionDetails, bfdKeyIndexes idxvpp.NameToIdx, log logging.Logger,
	vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) error

AddBfdUDPSessionFromDetails adds new BFD session with authentication if available

func AddDelVxlanTunnelReq

func AddDelVxlanTunnelReq(vxlanIntf *intf.Interfaces_Interface_Vxlan, add uint8) (req *vxlan.VxlanAddDelTunnel, err error)

AddDelVxlanTunnelReq prepare the request for bin API calls

func AddInterfaceIP

func AddInterfaceIP(ifIdx uint32, addr *net.IPNet, log logging.Logger, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

AddInterfaceIP calls SwInterfaceAddDelAddress bin API with IsAdd=1

func AddLoopbackInterface

func AddLoopbackInterface(vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)

AddLoopbackInterface calls CreateLoopback bin API

func AddMemifInterface

func AddMemifInterface(memIntf *intf.Interfaces_Interface_Memif, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)

AddMemifInterface calls MemifCreate bin API

func AddTapInterface

func AddTapInterface(tapIf *interfaces.Interfaces_Interface_Tap, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)

AddTapInterface calls TapConnect bin API

func AddVxlanTunnel

func AddVxlanTunnel(vxlanIntf *intf.Interfaces_Interface_Vxlan, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) (swIndex uint32, err error)

AddVxlanTunnel calls AddDelVxlanTunnelReq with flag add=1

func CheckMsgCompatibilityForBfd

func CheckMsgCompatibilityForBfd(log logging.Logger, vppChan *govppapi.Channel) error

CheckMsgCompatibilityForBfd checks if bfd CRSs are compatible with VPP in runtime

func CheckMsgCompatibilityForInterface

func CheckMsgCompatibilityForInterface(log logging.Logger, vppChan *govppapi.Channel) error

CheckMsgCompatibilityForInterface checks if interface CRSs are compatible with VPP in runtime

func DelInterfaceIP

func DelInterfaceIP(ifIdx uint32, addr *net.IPNet, log logging.Logger, vppChan *govppapi.Channel, timeLog *measure.TimeLog) error

DelInterfaceIP calls SwInterfaceAddDelAddress bin API with IsAdd=00

func DeleteAfPacketInterface

func DeleteAfPacketInterface(afPacketIntf *intf.Interfaces_Interface_Afpacket, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

DeleteAfPacketInterface calls AfPacketDelete VPP binary API.

func DeleteBfdEchoFunction

func DeleteBfdEchoFunction(vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

DeleteBfdEchoFunction removes echo function

func DeleteBfdUDPAuthenticationKey

func DeleteBfdUDPAuthenticationKey(bfdKey *bfd.SingleHopBFD_Key, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

DeleteBfdUDPAuthenticationKey removes authentication key

func DeleteBfdUDPSession

func DeleteBfdUDPSession(ifIndex uint32, sourceAddres string, destAddres string, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

DeleteBfdUDPSession removes existing BFD session

func DeleteLoopbackInterface

func DeleteLoopbackInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

DeleteLoopbackInterface calls DeleteLoopback bin API

func DeleteMemifInterface

func DeleteMemifInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

DeleteMemifInterface calls MemifDelete bin API

func DeleteTapInterface

func DeleteTapInterface(idx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

DeleteTapInterface calls TapDelete bin API

func DeleteVxlanTunnel

func DeleteVxlanTunnel(vxlanIntf *intf.Interfaces_Interface_Vxlan, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

DeleteVxlanTunnel calls AddDelVxlanTunnelReq with flag add=0

func DumpBfdUDPSessionsWithID

func DumpBfdUDPSessionsWithID(authKeyIndex uint32, swIfIndexes ifaceidx.SwIfIndex, bfdSessionIndexes idxvpp.NameToIdx,
	vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) ([]*bfd_api.BfdUDPSessionDetails, error)

DumpBfdUDPSessionsWithID returns a list of BFD session's metadata

func InterfaceAdminDown

func InterfaceAdminDown(ifIdx uint32, vppChan *govppapi.Channel, timeLog *measure.TimeLog) error

InterfaceAdminDown calls binary API SwInterfaceSetFlagsReply with AdminUpDown=0

func InterfaceAdminUp

func InterfaceAdminUp(ifIdx uint32, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

InterfaceAdminUp calls binary API SwInterfaceSetFlagsReply with AdminUpDown=1

func ModifyBfdUDPSession

func ModifyBfdUDPSession(bfdSession *bfd.SingleHopBFD_Session, swIfIndexes ifaceidx.SwIfIndex, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

ModifyBfdUDPSession modifies existing BFD session excluding authentication which cannot be changed this way

func SetBfdUDPAuthenticationKey

func SetBfdUDPAuthenticationKey(bfdKey *bfd.SingleHopBFD_Key, log logging.Logger, vppChannel *govppapi.Channel, timeLog measure.StopWatchEntry) (err error)

SetBfdUDPAuthenticationKey creates configures new authentication key

func SetInterfaceMac

func SetInterfaceMac(ifIdx uint32, macAddress string, log logging.Logger, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

SetInterfaceMac calls SwInterfaceSetMacAddress bin API

func SetInterfaceMtu

func SetInterfaceMtu(ifIdx uint32, mtu uint32, log logging.Logger, vppChan *govppapi.Channel, timeLog measure.StopWatchEntry) error

SetInterfaceMtu calls SwInterfaceSetMtu bin API with desired MTU value