ovsctl

Documentation

Index

• Variables
• func NewClient(bridge string) *ovsCtlClient
• type BadRequestError
  • func (e BadRequestError) Error() string
• type ExecError
  • func (e *ExecError) CommandExecuted() bool
  • func (e *ExecError) GetErrorOutput() string
• type OVSCtlClient
• type TracingRequest

Variables

var (
	IPAndNWProtos = []string{"ip", "icmp", "tcp", "udp", "sctp", "ipv6", "icmp6", "tcp6", "udp6", "sctp6"}
)

Functions

func NewClient

func NewClient(bridge string) *ovsCtlClient

Types

type BadRequestError

type BadRequestError string

func (BadRequestError) Error

func (e BadRequestError) Error() string

type ExecError

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

ExecError is for errors happened in command execution.

func (*ExecError) CommandExecuted

func (e *ExecError) CommandExecuted() bool

CommandExecuted returns whether the OVS command has been executed.

func (*ExecError) GetErrorOutput

func (e *ExecError) GetErrorOutput() string

GetErrorOutput returns the command's output to stderr if it has ben executed and exited with an error.

type OVSCtlClient

type OVSCtlClient interface {
	// DumpFlows returns flows of the bridge.
	DumpFlows(args ...string) ([]string, error)
	// DumpMatchedFlows returns the flow which exactly matches the matchStr.
	DumpMatchedFlow(matchStr string) (string, error)
	// DumpTableFlows returns all flows in the table.
	DumpTableFlows(table uint8) ([]string, error)
	// DumpGroup returns the OpenFlow group if it exists on the bridge.
	DumpGroup(groupID uint32) (string, error)
	// DumpGroups returns OpenFlow groups of the bridge.
	DumpGroups() ([]string, error)
	// DumpPortsDesc returns OpenFlow ports descriptions of the bridge.
	DumpPortsDesc() ([][]string, error)
	// RunOfctlCmd executes "ovs-ofctl" command and returns the outputs.
	RunOfctlCmd(cmd string, args ...string) ([]byte, error)
	// SetPortNoFlood sets the given port with config "no-flood". This configuration must work with OpenFlow10.
	SetPortNoFlood(ofport int) error
	// Trace executes "ovs-appctl ofproto/trace" to perform OVS packet tracing.
	Trace(req *TracingRequest) (string, error)
	// RunAppctlCmd executes "ovs-appctl" command and returns the outputs.
	// Some commands are bridge specific and some are not. Passing a bool to distinguish that.
	RunAppctlCmd(cmd string, needsBridge bool, args ...string) ([]byte, *ExecError)
}

OVSCtlClient is an interface for executing OVS "ovs-ofctl" and "ovs-appctl" commands.

type TracingRequest

type TracingRequest struct {
	InPort string // Input port.
	SrcIP  net.IP
	DstIP  net.IP
	SrcMAC net.HardwareAddr
	DstMAC net.HardwareAddr
	Flow   string
	// Whether in_port field in Flow can override InPort.
	AllowOverrideInPort bool
}

TracingRequest defines tracing request parameters.