common

package
v0.9.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// CIStateMaster - HA Master state
	CIStateMaster = 1 + iota
	// CIStateBackup - HA Backup/Slave state
	CIStateBackup
	// CIStateConflict - HA Fault/Conflict State
	CIStateConflict
	// CIStateNotDefined - HA State not enabled or stopped
	CIStateNotDefined
)
View Source 
const (
	// HighLocalPref - High local preference for advertising BGP route(Default or Master)
	HighLocalPref = 5000
	// LowLocalPref - Low local preference for advertising BGP route(Backup)
	LowLocalPref = 100
	// HighMed - Low metric means higher probability for selection outside AS
	HighMed = 10
	// LowMed - High metric means lower probability for selection outside AS
	LowMed = 20
)
View Source 
const (
	// CertPath - SSL certificates path
	CertPath = "/opt/loxilb/cert/"

	// CACertFileName - loxilb CA cert file
	CACertFileName = "rootCA.crt"

	// PrivateCertName - loxilb private certificate name
	PrivateCertName = "server.crt"

	// PrivateKeyName - loxilb private key name
	PrivateKeyName = "server.key"
)
View Source 
const (
	// AuWorkqLen - Address worker channel depth
	AuWorkqLen = 2048
	// LuWorkQLen - Link worker channel depth
	LuWorkQLen = 2048
	// NuWorkQLen - Neigh worker channel depth
	NuWorkQLen = 2048
	// RuWorkQLen - Route worker channel depth
	RuWorkQLen = 40827
)
View Source 
const (
	// PortReal - Base port type
	PortReal = 1 << iota
	// PortBondSif - Bond slave port type
	PortBondSif
	// PortBond - Bond port type
	PortBond
	// PortVlanSif - Vlan slave port type
	PortVlanSif
	// PortVlanBr - Vlan Br port type
	PortVlanBr
	// PortVxlanSif - Vxlan slave port type
	PortVxlanSif
	// PortVxlanBr - Vxlan br port type
	PortVxlanBr
	// PortWg - Wireguard port type
	PortWg
	// PortVti - Vti port type
	PortVti
	// PortIPTun - IPInIP port type
	PortIPTun
	// PortGre - GRE port type
	PortGre
)
View Source 
const (
	// FdbPhy - fdb of a real dev
	FdbPhy = 0
	// FdbTun - fdb of a tun dev
	FdbTun = 1
	// FdbVlan - fdb of a vlan dev
	FdbVlan = 2
)
View Source 
const (
	// PolTypeTrtcm - Policer type trtcm
	PolTypeTrtcm = 0 // Default
	// PolTypeSrtcm - Policer type srtcm
	PolTypeSrtcm = 1
)
View Source 
const (
	// MirrTypeSpan - simple SPAN
	MirrTypeSpan = 0 // Default
	// MirrTypeRspan - type RSPAN
	MirrTypeRspan = 1
	// MirrTypeErspan - type ERSPAN
	MirrTypeErspan = 2
)
View Source 
const BFDDefRetryCount = 3
View Source 
const BFDPort = 3784
View Source 
const (
	// CIDefault - Default CI Instance name
	CIDefault = "default"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Actions added in v0.9.4 

type Actions struct {
	RouteDisposition string     `json:"routeDisposition"`
	BGPActions       BGPActions `json:"bgpActions,omitempty"`
}

type BFDMod added in v0.9.2 

type BFDMod struct {
	// Instance - Cluster Instance
	Instance string `json:"instance"`
	// RemoteIP - Remote IP for BFD session
	RemoteIP net.IP `json:"remoteIp"`
	// Interval - Tx Interval between BFD packets
	SourceIP net.IP `json:"sourceIp"`
	// Port - BFD session port
	Port uint16 `json:"port"`
	// Interval - Tx Interval between BFD packets
	Interval uint64 `json:"interval"`
	// RetryCount - Retry Count for detecting failure
	RetryCount uint8 `json:"retryCount"`
	// State - BFD session state
	State string `json:"state"`
}

BFDMod - information related to a BFD session

type BGPActions added in v0.9.4 

type BGPActions struct {
	SetMed            string           `json:"setMed,omitempty"`
	SetCommunity      SetCommunity     `json:"setCommunity,omitempty"`
	SetExtCommunity   SetCommunity     `json:"setExtCommunity,omitempty"`
	SetLargeCommunity SetCommunity     `json:"setLargeCommunity,omitempty"`
	SetNextHop        string           `json:"setNextHop,omitempty"`
	SetLocalPerf      int              `json:"setLocalPerf,omitempty"`
	SetAsPathPrepend  SetAsPathPrepend `json:"setAsPathPrepend,omitempty"`
}

type BGPAsPathLength added in v0.9.4 

type BGPAsPathLength struct {
	Operator string `json:"Operator,omitempty"`
	Value    int    `json:"Value,omitempty"`
}

type BGPAsPathSet added in v0.9.4 

type BGPAsPathSet struct {
	AsPathSet       string `json:"asPathSet,omitempty"`
	MatchSetOptions string `json:"matchSetOptions,omitempty"`
}

type BGPCommunitySet added in v0.9.4 

type BGPCommunitySet struct {
	CommunitySet    string `json:"communitySet,omitempty"`
	MatchSetOptions string `json:"matchSetOptions,omitempty"`
}

type BGPConditions added in v0.9.4 

type BGPConditions struct {
	AfiSafiIn         []string        `json:"afiSafiIn,omitempty"`
	AsPathSet         BGPAsPathSet    `json:"matchAsPathSet,omitempty"`
	AsPathLength      BGPAsPathLength `json:"asPathLength,omitempty"`
	CommunitySet      BGPCommunitySet `json:"matchCommunitySet,omitempty"`
	ExtCommunitySet   BGPCommunitySet `json:"matchExtCommunitySet,omitempty"`
	LargeCommunitySet BGPCommunitySet `json:"largeCommunitySet,omitempty"`
	RouteType         string          `json:"routeType,omitempty"`
	NextHopInList     []string        `json:"nextHopInList,omitempty"`
	Rpki              string          `json:"rpki,omitempty"`
}

type ClusterNodeMod added in v0.9.0 

type ClusterNodeMod struct {
	// Instance - Cluster Instance
	Addr net.IP `json:"Addr"`
}

ClusterNodeMod - information related to a cluster node instance

type Conditions added in v0.9.4 

type Conditions struct {
	PrefixSet     MatchPrefixSet   `json:"matchPrefixSet,omitempty"`
	NeighborSet   MatchNeighborSet `json:"matchNeighborSet,omitempty"`
	BGPConditions BGPConditions    `json:"bgpconditions"`
}

type CtInfo 

type CtInfo struct {
	// Dip - destination ip address
	Dip net.IP `json:"destinationIP"`
	// Sip - source ip address
	Sip net.IP `json:"sourceIP"`
	// Dport - destination port information
	Dport uint16 `json:"destinationPort"`
	// Sport - source port information
	Sport uint16 `json:"sourcePort"`
	// Proto - IP protocol information
	Proto string `json:"protocol"`
	// CState - current state of conntrack
	CState string `json:"conntrackState"`
	// CAct - any related action
	CAct string `json:"conntrackAct"`
	// Pkts - packets tracked by ct entry
	Pkts uint64 `json:"packets"`
	// Bytes - bytes tracked by ct entry
	Bytes uint64 `json:"bytes"`
	// ServiceName - Connection's service name
	ServiceName string `json:"servName"`
}

CtInfo - Conntrack Information

type DpStatusT 

type DpStatusT uint8

DpStatusT - Generic status of operation

type EndPointMod added in v0.8.0 

type EndPointMod struct {
	// HostName - hostname in CIDR
	HostName string `json:"hostName"`
	//  Name - Endpoint Identifier
	Name string `json:"name"`
	// InActTries - No. of inactive probes to mark
	// an end-point inactive
	InActTries int `json:"inactiveReTries"`
	// ProbeType - Type of probe : "icmp","connect-tcp", "connect-udp", "connect-sctp", "http", "https"
	ProbeType string `json:"probeType"`
	// ProbeReq - Request string in case of http probe
	ProbeReq string `json:"probeReq"`
	// ProbeResp - Response string in case of http probe
	ProbeResp string `json:"probeResp"`
	// ProbeDuration - How frequently (in seconds) to check activity
	ProbeDuration uint32 `json:"probeDuration"`
	// ProbePort - Port to probe for connect type
	ProbePort uint16 `json:"probePort"`
	// MinDelay - Minimum delay in this end-point
	MinDelay string `json:"minDelay"`
	// AvgDelay - Average delay in this end-point
	AvgDelay string `json:"avgDelay"`
	// MaxDelay - Max delay in this end-point
	MaxDelay string `json:"maxDelay"`
	// CurrState - Current state of this end-point
	CurrState string `json:"currState"`
}

EndPointMod - Info related to a end-point entry

type EpSelect 

type EpSelect uint

EpSelect - Selection method of load-balancer end-point 

const (
	// LbSelRr - select the lb end-points based on round-robin
	LbSelRr EpSelect = iota
	// LbSelHash - select the lb end-points based on hashing
	LbSelHash
	// LbSelPrio - select the lb based on weighted round-robin
	LbSelPrio
	// LbSelRrPersist - persist connections from same client
	LbSelRrPersist
	// LbSelLeastConnections - select client based on least connections
	LbSelLeastConnections
	// LbSelN2 - select client based on N2 SCTP interface
	LbSelN2
)

type FdbMod 

type FdbMod struct {
	// MacAddr - mac address
	MacAddr [6]byte
	// BridgeID - bridge domain-id
	BridgeID int
	// Dev - name of the related device
	Dev string
	// Dst - ip addr related to fdb
	Dst net.IP
	// Type - One of FdbPhy/FdbTun/FdbVlan
	Type int
}

FdbMod - Info about a forwarding data-base

type FwOptArg added in v0.8.0 

type FwOptArg struct {
	// Drop - Drop any matching rule
	Drop bool `json:"drop"`
	// Trap - Trap anything matching rule
	Trap bool `json:"trap"`
	// Record - Record packets matching rule
	Record bool `json:"record"`
	// Redirect - Redirect any matching rule
	Rdr     bool   `json:"redirect"`
	RdrPort string `json:"redirectPortName"`
	// Allow - Allow any matching rule
	Allow bool `json:"allow"`
	// Mark - Mark the matching rule
	Mark uint32 `json:"fwMark"`
	// DoSnat - Do snat on matching rule
	DoSnat bool   `json:"doSnat"`
	ToIP   string `json:"toIP"`
	ToPort uint16 `json:"toPort"`
	// Counter - Traffic counter
	Counter string `json:"counter"`
}

FwOptArg - Information related to Firewall options

type FwRuleArg added in v0.8.0 

type FwRuleArg struct {
	// SrcIP - Source IP in CIDR notation
	SrcIP string `json:"sourceIP"`
	// DstIP - Destination IP in CIDR notation
	DstIP string `json:"destinationIP"`
	// SrcPortMin - Minimum source port range
	SrcPortMin uint16 `json:"minSourcePort"`
	// SrcPortMax - Maximum source port range
	SrcPortMax uint16 `json:"maxSourcePort"`
	// DstPortMin - Minimum destination port range
	DstPortMin uint16 `json:"minDestinationPort"`
	// SrcPortMax - Maximum source port range
	DstPortMax uint16 `json:"maxDestinationPort"`
	// Proto - the protocol
	Proto uint8 `json:"protocol"`
	// InPort - the incoming port
	InPort string `json:"portName"`
	// Pref - User preference for ordering
	Pref uint16 `json:"preference"`
}

FwRuleArg - Information related to firewall rule

type FwRuleMod added in v0.8.0 

type FwRuleMod struct {
	// Rule - service argument of type FwRuleArg
	Rule FwRuleArg `json:"ruleArguments"`
	// Opts - firewall options
	Opts FwOptArg `json:"opts"`
}

FwRuleMod - Info related to a firewall entry

type GWInfo added in v0.9.5 

type GWInfo struct {
	// Gw - gateway information if any
	Gw net.IP
	// LinkIndex - OS allocated index
	LinkIndex int
}

GWInfo - Info about gateway

type GoBGPGlobalConfig added in v0.9.0 

type GoBGPGlobalConfig struct {
	// Local AS number
	LocalAs int64 `json:"localAs,omitempty"`
	// BGP Router ID
	RouterID   string `json:"routerId,omitempty"`
	SetNHSelf  bool   `json:"setNextHopSelf,omitempty"`
	ListenPort uint16 `json:"listenPort,omitempty"`
}

GoBGPGlobalConfig - Info related to goBGP global config

type GoBGPNeighGetMod added in v0.9.1 

type GoBGPNeighGetMod struct {
	Addr     string `json:"neighIP"`
	RemoteAS uint32 `json:"remoteAS"`
	State    string `json:"state"`
	Uptime   string `json:"uptime"`
}

GoBGPNeighGetMod - Info related to goBGP neigh

type GoBGPNeighMod added in v0.9.0 

type GoBGPNeighMod struct {
	Addr       net.IP `json:"neighIP"`
	RemoteAS   uint32 `json:"remoteAS"`
	RemotePort uint16 `json:"remotePort"`
	MultiHop   bool   `json:"multiHop"`
}

GoBGPNeighMod - Info related to goBGP neigh

type GoBGPPolicyApply added in v0.9.4 

type GoBGPPolicyApply struct {
	NeighIPAddress string   `json:"ipAddress,omitempty"`
	PolicyType     string   `json:"policyType,omitempty"`
	Polices        []string `json:"polices,omitempty"`
	RouteAction    string   `json:"routeAction,omitempty"`
}

type GoBGPPolicyAsPathMod added in v0.9.4 

type GoBGPPolicyAsPathMod struct {
	Name       string   `json:"name"`
	AsPathList []string `json:"asPathList"`
}

GoBGPPolicyAsPAthMod - Info related to goBGP policy about neigh

type GoBGPPolicyCommunityMod added in v0.9.4 

type GoBGPPolicyCommunityMod struct {
	Name          string   `json:"name"`
	CommunityList []string `json:"communityList"`
}

GoBGPPolicyCommunityMod - Info related to goBGP policy about neigh

type GoBGPPolicyDefinedSetMod added in v0.9.4 

type GoBGPPolicyDefinedSetMod struct {
	Name              string   `json:"name"`
	DefinedTypeString string   `json:"definedTypeString"`
	List              []string `json:"list,omitempty"`
	PrefixList        []Prefix `json:"prefixList,omitempty"`
}

type GoBGPPolicyDefinitionsMod added in v0.9.4 

type GoBGPPolicyDefinitionsMod struct {
	Name      string      `json:"name"`
	Statement []Statement `json:"prefixList"`
}

GoBGPPolicyDefineSetMod -

type GoBGPPolicyExtCommunityMod added in v0.9.4 

type GoBGPPolicyExtCommunityMod struct {
	Name             string   `json:"name"`
	ExtCommunityList []string `json:"extCommunityList"`
}

GoBGPPolicyExtCommunityListMod - Info related to goBGP policy about neigh

type GoBGPPolicyLargeCommunityMod added in v0.9.4 

type GoBGPPolicyLargeCommunityMod struct {
	Name               string   `json:"name"`
	LargeCommunityList []string `json:"largeCommunityList"`
}

GoBGPPolicyLargeCommunityMod - Info related to goBGP policy about neigh

type GoBGPPolicyNeighMod added in v0.9.4 

type GoBGPPolicyNeighMod struct {
	Name             string   `json:"name"`
	NeighborInfoList []string `json:"neighborInfoList"`
}

GoBGPPolicyNeighMod - Info related to goBGP policy about neigh

type GoBGPPolicyPrefixSetMod added in v0.9.4 

type GoBGPPolicyPrefixSetMod struct {
	Name       string   `json:"name"`
	PrefixList []Prefix `json:"prefixList"`
}

GoBGPPolicyPrefixSetMod - Info related to goBGP Policy prefix

type HASMod added in v0.8.0 

type HASMod struct {
	// Instance - Cluster Instance
	Instance string `json:"instance"`
	// State - current HA state
	State string `json:"haState"`
	// Vip - Instance virtual IP address
	Vip net.IP `json:"Addr"`
}

HASMod - information related to a cluster HA instance

type IPAddrGet added in v0.9.0 

type IPAddrGet struct {
	// Dev - name of the related device
	Dev string
	// IP - Actual IP address
	IP []string
	// Sync - sync state
	Sync DpStatusT
}

IPAddrGet - Info about an ip addresses

type IPAddrMod added in v0.9.0 

type IPAddrMod struct {
	// Dev - name of the related device
	Dev string
	// IP - Actual IP address
	IP string
}

IPAddrMod - Info about an ip address

type LBMode added in v0.8.0 

type LBMode int32

LBMode - Variable to define LB mode 

const (
	// LBModeDefault - Default Mode(DNAT)
	LBModeDefault LBMode = iota
	// LBModeOneArm - One Arm Mode
	LBModeOneArm
	// LBModeFullNAT - Full NAT Mode
	LBModeFullNAT
	// LBModeDSR - DSR Mode
	LBModeDSR
	// LBModeFullProxy
	LBModeFullProxy
	// LBModeHostOneArm
	LBModeHostOneArm
)

type LBOp added in v0.9.5 

type LBOp int32

LBOp - Variable to LB operation 

const (
	// LBOPAdd - Add the LB rule (replace if existing)
	LBOPAdd LBOp = iota
	// LBOPAttach - Attach End-Points
	LBOPAttach
	// LBOPDetach - Detach End-Points
	LBOPDetach
)

type LBSec added in v0.9.5 

type LBSec int32

LBSec - Variable to define LB front-end security 

const (
	// LBServPlain - Plain mode
	LBServPlain LBSec = iota
	// LBServHTTPS - HTTPS termination
	LBServHTTPS
	// LBServE2EHTTPS - HTTPS proxy
	LBServE2EHTTPS
)

type LbEndPointArg 

type LbEndPointArg struct {
	// EpIP - endpoint IP address
	EpIP string `json:"endpointIP"`
	// EpPort - endpoint Port
	EpPort uint16 `json:"targetPort"`
	// Weight - weight associated with end-point
	// Only valid for weighted round-robin selection
	Weight uint8 `json:"weight"`
	// State - current state of the end-point
	State string `json:"state"`
	// Counters -  traffic counters of the end-point
	Counters string `json:"counters"`
}

LbEndPointArg - Information related to load-balancer end-point

type LbRuleMod 

type LbRuleMod struct {
	// Serv - service argument of type LbServiceArg
	Serv LbServiceArg `json:"serviceArguments"`
	// SecIPs - Secondary IPs for SCTP multi-homed service
	SecIPs []LbSecIPArg `json:"secondaryIPs"`
	// Eps - slice containing LbEndPointArg
	Eps []LbEndPointArg `json:"endpoints"`
}

LbRuleMod - Info related to a load-balancer entry

type LbSecIPArg added in v0.9.0 

type LbSecIPArg struct {
	// SecIP - Secondary IP address
	SecIP string `json:"secondaryIP"`
}

LbSecIPArg - Secondary IP

type LbServiceArg 

type LbServiceArg struct {
	// ServIP - the service ip or vip  of the load-balancer rule
	ServIP string `json:"externalIP"`
	// PrivateIP - the private service ip or vip of the load-balancer rule
	PrivateIP string `json:"privateIP"`
	// ServPort - the service port of the load-balancer rule
	ServPort uint16 `json:"port"`
	// Proto - the service protocol of the load-balancer rule
	Proto string `json:"protocol"`
	// BlockNum - An arbitrary block num to further segregate a service
	BlockNum uint16 `json:"block"`
	// Sel - one of LbSelRr,LbSelHash, or LbSelHash
	Sel EpSelect `json:"sel"`
	// Bgp - export this rule with goBGP
	Bgp bool `json:"bgp"`
	// Monitor - monitor end-points of this rule
	Monitor bool `json:"monitor"`
	// Oper - Attach/Detach if the LB already exists
	Oper LBOp `json:"oper"`
	// Security - Security mode if any
	Security LBSec `json:"lbsec"`
	// Mode - NAT mode
	Mode LBMode `json:"mode"`
	// InactiveTimeout - Forced session reset after inactive timeout
	InactiveTimeout uint32 `json:"inactiveTimeout"`
	// Managed - This rule is managed by external entity e.g k8s
	Managed bool `json:"managed"`
	// ProbeType - Liveness check type for this rule : ping, tcp, udp, sctp, none, http(s)
	ProbeType string `json:"probetype"`
	// ProbePort - Liveness check port number. Only valid for tcp, udp, sctp, http(s)
	ProbePort uint16 `json:"probeport"`
	// ProbeReq - Request string for liveness check
	ProbeReq string `json:"probereq"`
	// ProbeResp - Response string for liveness check
	ProbeResp string `json:"proberesp"`
	// ProbeTimeout - Probe Timeout
	ProbeTimeout uint32 `json:"probeTimeout"`
	// ProbeRetries - Probe Retries
	ProbeRetries int `json:"probeRetries"`
	// Name - Service name
	Name string `json:"name"`
	// PersistTimeout - Persistence timeout in seconds
	PersistTimeout uint32 `json:"persistTimeout"`
	// Snat - Do SNAT
	Snat bool `json:"snat"`
	// HostUrl - Ingress Specific URL path
	HostUrl string `json:"path"`
}

LbServiceArg - Information related to load-balancer service

type MatchNeighborSet added in v0.9.4 

type MatchNeighborSet struct {
	MatchSetOption string `json:"matchSetOption,omitempty"`
	NeighborSet    string `json:"NeighborSet,omitempty"`
}

type MatchPrefixSet added in v0.9.4 

type MatchPrefixSet struct {
	MatchSetOption string `json:"matchSetOption,omitempty"`
	PrefixSet      string `json:"prefixSet,omitempty"`
}

type MirrGetMod added in v0.8.0 

type MirrGetMod struct {
	// Ident - unique identifier for the mirror
	Ident string
	// Info - information about the mirror
	Info MirrInfo
	// Target - information about object to which mirror needs to be attached
	Target MirrObj
	// Sync - sync state
	Sync DpStatusT
}

MirrGetMod - information related to Get a mirror entry

type MirrInfo 

type MirrInfo struct {
	// MirrType - one of MirrTypeSpan, MirrTypeRspan or MirrTypeErspan
	MirrType int
	// MirrPort - port where mirrored traffic needs to be sent
	MirrPort string
	// MirrVlan - for RSPAN we may need to send tagged mirror traffic
	MirrVlan int
	// MirrRip - RemoteIP. For ERSPAN we may need to send tunnelled mirror traffic
	MirrRip net.IP
	// MirrRip - SourceIP. For ERSPAN we may need to send tunnelled mirror traffic
	MirrSip net.IP
	// MirrTid - mirror tunnel-id. For ERSPAN we may need to send tunnelled mirror traffic
	MirrTid uint32
}

MirrInfo - information related to a mirror entry

type MirrMod 

type MirrMod struct {
	// Ident - unique identifier for the mirror
	Ident string
	// Info - information about the mirror
	Info MirrInfo
	// Target - information about object to which mirror needs to be attached
	Target MirrObj
}

MirrMod - information related to a mirror entry

type MirrObj 

type MirrObj struct {
	// MirrObjName - object name to be attached to mirror
	MirrObjName string
	// AttachMent - one of MirrAttachPort or MirrAttachRule
	AttachMent MirrObjType
}

MirrObj - information of object attached to mirror

type MirrObjType 

type MirrObjType uint

MirrObjType - type of mirror attachment 

const (
	// MirrAttachPort - mirror attachment to a port
	MirrAttachPort MirrObjType = 1 << iota
	// MirrAttachRule - mirror attachment to a lb rule
	MirrAttachRule
)

type NeighMod added in v0.8.0 

type NeighMod struct {
	// IP - The IP address
	IP net.IP
	// LinkIndex - OS allocated index
	LinkIndex int
	// State - active or inactive
	State int
	// HardwareAddr - resolved hardware address if any
	HardwareAddr net.HardwareAddr
}

NeighMod - Info about an neighbor

type NetHookInterface 

type NetHookInterface interface {
	NetMirrorGet() ([]MirrGetMod, error)
	NetMirrorAdd(*MirrMod) (int, error)
	NetMirrorDel(*MirrMod) (int, error)
	NetPortGet() ([]PortDump, error)
	NetPortAdd(*PortMod) (int, error)
	NetPortDel(*PortMod) (int, error)
	NetVlanGet() ([]VlanGet, error)
	NetVlanAdd(*VlanMod) (int, error)
	NetVlanDel(*VlanMod) (int, error)
	NetVlanPortAdd(*VlanPortMod) (int, error)
	NetVlanPortDel(*VlanPortMod) (int, error)
	NetFdbAdd(*FdbMod) (int, error)
	NetFdbDel(*FdbMod) (int, error)
	NetAddrGet() ([]IPAddrGet, error)
	NetAddrAdd(*IPAddrMod) (int, error)
	NetAddrDel(*IPAddrMod) (int, error)
	NetNeighGet() ([]NeighMod, error)
	NetNeighAdd(*NeighMod) (int, error)
	NetNeighDel(*NeighMod) (int, error)
	NetRouteGet() ([]RouteGet, error)
	NetRouteAdd(*RouteMod) (int, error)
	NetRouteDel(*RouteMod) (int, error)
	NetLbRuleAdd(*LbRuleMod) (int, error)
	NetLbRuleDel(*LbRuleMod) (int, error)
	NetLbRuleGet() ([]LbRuleMod, error)
	NetCtInfoGet() ([]CtInfo, error)
	NetSessionGet() ([]SessionMod, error)
	NetSessionUlClGet() ([]SessionUlClMod, error)
	NetSessionAdd(*SessionMod) (int, error)
	NetSessionDel(*SessionMod) (int, error)
	NetSessionUlClAdd(*SessionUlClMod) (int, error)
	NetSessionUlClDel(*SessionUlClMod) (int, error)
	NetPolicerGet() ([]PolMod, error)
	NetPolicerAdd(*PolMod) (int, error)
	NetPolicerDel(*PolMod) (int, error)
	NetCIStateMod(*HASMod) (int, error)
	NetCIStateGet() ([]HASMod, error)
	NetFwRuleAdd(*FwRuleMod) (int, error)
	NetFwRuleDel(*FwRuleMod) (int, error)
	NetFwRuleGet() ([]FwRuleMod, error)
	NetEpHostAdd(fm *EndPointMod) (int, error)
	NetEpHostDel(fm *EndPointMod) (int, error)
	NetEpHostGet() ([]EndPointMod, error)
	NetParamSet(param ParamMod) (int, error)
	NetParamGet(param *ParamMod) (int, error)
	NetGoBGPNeighGet() ([]GoBGPNeighGetMod, error)
	NetGoBGPNeighAdd(nm *GoBGPNeighMod) (int, error)
	NetGoBGPNeighDel(nm *GoBGPNeighMod) (int, error)

	NetGoBGPPolicyDefinedSetGet(string, string) ([]GoBGPPolicyDefinedSetMod, error)
	NetGoBGPPolicyDefinedSetAdd(nm *GoBGPPolicyDefinedSetMod) (int, error)
	NetGoBGPPolicyDefinedSetDel(nm *GoBGPPolicyDefinedSetMod) (int, error)

	NetGoBGPPolicyDefinitionsGet() ([]GoBGPPolicyDefinitionsMod, error)
	NetGoBGPPolicyDefinitionAdd(nm *GoBGPPolicyDefinitionsMod) (int, error)
	NetGoBGPPolicyDefinitionDel(nm *GoBGPPolicyDefinitionsMod) (int, error)

	NetGoBGPPolicyApplyAdd(nm *GoBGPPolicyApply) (int, error)

	NetGoBGPPolicyApplyDel(nm *GoBGPPolicyApply) (int, error)
	NetGoBGPGCAdd(gc *GoBGPGlobalConfig) (int, error)
	NetBFDGet() ([]BFDMod, error)
	NetBFDAdd(bm *BFDMod) (int, error)
	NetBFDDel(bm *BFDMod) (int, error)
	NetHandlePanic()
}

NetHookInterface - Go interface which needs to be implemented to talk to loxinet module

type ParamMod added in v0.8.0 

type ParamMod struct {
	// LogLevel - log level of loxilb
	LogLevel string `json:"logLevel"`
}

ParamMod - Info related to a operational parameters

type PolInfo 

type PolInfo struct {
	// PolType - one of PolTypeTrtcm or PolTypeSrtcm
	PolType int
	// ColorAware - color aware or not
	ColorAware bool
	// CommittedInfoRate - CIR in Mbps
	CommittedInfoRate uint64
	// PeakInfoRate - PIR in Mbps
	PeakInfoRate uint64
	// CommittedBlkSize -  CBS in bytes
	// 0 for default selection
	CommittedBlkSize uint64
	// ExcessBlkSize - EBS in bytes
	// 0 for default selection
	ExcessBlkSize uint64
}

PolInfo - information related to a policer

type PolMod 

type PolMod struct {
	// Ident - identifier
	Ident string
	// Info - policer info of type PolInfo
	Info PolInfo
	// Target - target object information
	Target PolObj
}

PolMod - Information related to policer entry

type PolObj 

type PolObj struct {
	// PolObjName - name of the object
	PolObjName string
	// AttachMent - attach point type of the object
	AttachMent PolObjType
}

PolObj - Information related to policer attachment point

type PolObjType 

type PolObjType uint

PolObjType - type of a policer attachment object 

const (
	// PolAttachPort - attach policer to port
	PolAttachPort PolObjType = 1 << iota
	// PolAttachLbRule - attach policer to a rule
	PolAttachLbRule
)

type PortDump 

type PortDump struct {
	// Name - name of the port
	Name string `json:"portName"`
	// PortNo - port number
	PortNo int `json:"portNo"`
	// Zone - security zone info
	Zone string `json:"zone"`
	// SInfo - software specific port information
	SInfo PortSwInfo `json:"portSoftwareInformation"`
	// HInfo - hardware specific port information
	HInfo PortHwInfo `json:"portHardwareInformation"`
	// Stats - port statistics related information
	Stats PortStatsInfo `json:"portStatisticInformation"`
	// L3 - layer3 info related to port
	L3 PortLayer3Info `json:"portL3Information"`
	// L2 - layer2 info related to port
	L2 PortLayer2Info `json:"portL2Information"`
	// Sync - sync state
	Sync DpStatusT `json:"DataplaneSync"`
}

PortDump - Generic dump info of a port

type PortHwInfo 

type PortHwInfo struct {
	// MacAddr - mac address as byte array
	MacAddr [6]byte `json:"rawMacAddress"`
	// MacAddrStr - mac address in string format
	MacAddrStr string `json:"macAddress"`
	// Link - lowerlayer state
	Link bool `json:"link"`
	// State - administrative state
	State bool `json:"state"`
	// Mtu - maximum transfer unit
	Mtu int `json:"mtu"`
	// Master - master of this port if any
	Master string `json:"master"`
	// Real - underlying real dev info if any
	Real string `json:"real"`
	// TunID - tunnel info if any
	TunID uint32 `json:"tunnelId"`
}

PortHwInfo - hw info of a port

type PortLayer2Info 

type PortLayer2Info struct {
	// IsPvid - this vid is Pvid or not
	IsPvid bool `json:"isPvid"`
	// Vid - vid related to prot
	Vid int `json:"vid"`
}

PortLayer2Info - layer2 info of a port

type PortLayer3Info 

type PortLayer3Info struct {
	// Routed - routed mode or not
	Routed bool `json:"routed"`
	// Ipv4Addrs - ipv4 address set
	Ipv4Addrs []string `json:"IPv4Address"`
	// Ipv6Addrs - ipv6 address set
	Ipv6Addrs []string `json:"IPv6Address"`
}

PortLayer3Info - layer3 info of a port

type PortMod 

type PortMod struct {
	// Dev - name of port
	Dev string
	// LinkIndex - OS allocated index
	LinkIndex int
	// Ptype - port type
	Ptype int
	// MacAddr - mac address
	MacAddr [6]byte
	// Link - lowerlayer state
	Link bool
	// State - administrative state
	State bool
	// Mtu - maximum transfer unit
	Mtu int
	// Master - master of this port if any
	Master string
	// Real - underlying real dev info if any
	Real string
	// TunID - tunnel info if any
	TunID int
	// TunSrc - tunnel source
	TunSrc net.IP
	// TunDst - tunnel dest
	TunDst net.IP
}

PortMod - port modification info

type PortProp 

type PortProp uint8

PortProp - Defines auxiliary port properties 

const (
	// PortPropUpp - User-plane processing enabled
	PortPropUpp PortProp = 1 << iota
	// PortPropSpan - SPAN is enabled
	PortPropSpan
	// PortPropPol - Policer is active
	PortPropPol
)

type PortStatsInfo 

type PortStatsInfo struct {
	// RxBytes - rx Byte count
	RxBytes uint64 `json:"rxBytes"`
	// TxBytes - tx Byte count
	TxBytes uint64 `json:"txBytes"`
	// RxPackets - tx Packets count
	RxPackets uint64 `json:"rxPackets"`
	// TxPackets - tx Packets count
	TxPackets uint64 `json:"txPackets"`
	// RxError - rx error count
	RxError uint64 `json:"rxErrors"`
	// TxError - tx error count
	TxError uint64 `json:"txErrors"`
}

PortStatsInfo - stats information of port

type PortSwInfo 

type PortSwInfo struct {
	// OsID - interface id of an OS
	OsID int `json:"osId"`
	// PortType - type of port
	PortType int `json:"portType"`
	// PortProp - port property
	PortProp PortProp `json:"portProp"`
	// PortActive - port enabled/disabled
	PortActive bool `json:"portActive"`
	// PortReal - pointer to real port if any
	PortReal *PortDump `json:"portReal"`
	// PortOvl - pointer to ovl port if any
	PortOvl *PortDump `json:"portOvl"`
	// BpfLoaded - eBPF loaded or not flag
	BpfLoaded bool `json:"bpfLoaded"`
}

PortSwInfo - software specific info of a port

type Prefix added in v0.9.4 

type Prefix struct {
	IpPrefix        string `json:"ipPrefix"`
	MasklengthRange string `json:"masklengthRange"`
}

Prefix - Info related to goBGP Policy Prefix

type RouteGet added in v0.8.0 

type RouteGet struct {
	// Protocol - Protocol type
	Protocol int
	// Flags - flag type
	Flags string
	// Gw - gateway information if any
	Gw string
	// LinkIndex - OS allocated index
	LinkIndex int
	// Dst - ip addr
	Dst string
	// index of the route
	HardwareMark int
	// statistic
	Statistic RouteGetEntryStatistic
	// sync
	Sync DpStatusT
}

RouteGet - Info about an route

type RouteGetEntryStatistic added in v0.8.0 

type RouteGetEntryStatistic struct {
	// Statistic of the ingress port bytes.
	Bytes int
	// Statistic of the egress port bytes.
	Packets int
}

RouteGetEntryStatistic - Info about an route statistic

type RouteMod added in v0.8.0 

type RouteMod struct {
	// Protocol - Protocol type
	Protocol int
	// Flags - flag type
	Flags int
	// GWs - gateway information if any
	GWs []GWInfo
	// Dst - ip addr
	Dst net.IPNet
}

RouteMod - Info about a route

type SessTun 

type SessTun struct {
	// TeID - tunnel-id
	TeID uint32 `json:"TeID"`
	// Addr - tunnel ip addr of remote-end
	Addr net.IP `json:"tunnelIP"`
}

SessTun - session tunnel(l3) information

func (*SessTun) Equal 

func (ut *SessTun) Equal(ut1 *SessTun) bool

Equal - check if two session tunnel entries are equal

type SessionMod 

type SessionMod struct {
	// Ident - unique identifier for this session
	Ident string `json:"ident"`
	// IP - ip address of the end-user of this session
	IP net.IP `json:"sessionIP"`
	// AnTun - access tunnel network information
	AnTun SessTun `json:"accessNetworkTunnel"`
	// CnTun - core tunnel network information
	CnTun SessTun `json:"coreNetworkTunnel"`
}

SessionMod - information related to a user-session

type SessionUlClMod 

type SessionUlClMod struct {
	// Ident - identifier of the session for this filter
	Ident string `json:"ulclIdent"`
	// Args - ulcl filter information
	Args UlClArg `json:"ulclArgument"`
}

SessionUlClMod - information related to a ulcl filter

type SetAsPathPrepend added in v0.9.4 

type SetAsPathPrepend struct {
	ASN     string `json:"as,omitempty"`
	RepeatN int    `json:"repeatN,omitempty"`
}

type SetCommunity added in v0.9.4 

type SetCommunity struct {
	Options            string   `json:"options,omitempty"`
	SetCommunityMethod []string `json:"setCommunityMethod,omitempty"`
}

type Statement added in v0.9.4 

type Statement struct {
	Name       string     `json:"name,omitempty"`
	Conditions Conditions `json:"conditions,omitempty"`
	Actions    Actions    `json:"actions,omitempty"`
}

type UlClArg 

type UlClArg struct {
	// Addr - filter ip addr
	Addr net.IP `json:"ulclIP"`
	// Qfi - qfi id related to this filter
	Qfi uint8 `json:"qfi"`
}

UlClArg - ulcl argument information

type VlanGet added in v0.8.0 

type VlanGet struct {
	// Vid - vlan identifier
	Vid int `json:"vid"`
	// Dev - name of port
	Dev string `json:"dev"`
	// Slaves - name of slave ports
	Member []VlanPortMod `json:"member"`
	// Stat Vlan traffic statistics
	Stat VlanStat `json:"vlanStatistic"`
}

VlanGet - Info for vlan interface to get

type VlanMod 

type VlanMod struct {
	// Vid - vlan identifier
	Vid int `json:"vid"`
	// Dev - name of the related device
	Dev string `json:"dev"`
	// LinkIndex - OS allocated index
	LinkIndex int
	// MacAddr - mac address
	MacAddr [6]byte
	// Link - lowerlayer state
	Link bool
	// State - administrative state
	State bool
	// Mtu - maximum transfer unit
	Mtu int
	// TunID - tunnel info if any
	TunID uint32
}

VlanMod - Info about a vlan

type VlanPortMod 

type VlanPortMod struct {
	// Vid - vlan identifier
	Vid int `json:"vid"`
	// Dev - name of the related device
	Dev string `json:"dev"`
	// Tagged - tagged or not
	Tagged bool `json:"tagged"`
}

VlanPortMod - Info about a port attached to a vlan

type VlanStat added in v0.8.0 

type VlanStat struct {
	InBytes    uint64
	InPackets  uint64
	OutBytes   uint64
	OutPackets uint64
}

VlanStat - statistics for vlan interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.