Documentation ¶
Overview ¶
Package interfaces is a generated protocol buffer package.
It is generated from these files:
interfaces.proto
It has these top-level messages:
Interfaces InterfacesState InterfaceErrors
Index ¶
- Constants
- Variables
- func InterfaceErrorKey(ifaceLabel string) string
- func InterfaceErrorPrefix() string
- func InterfaceKey(ifaceLabel string) string
- func InterfaceKeyPrefix() string
- func InterfaceStateKey(ifaceLabel string) string
- func InterfaceStateKeyPrefix() string
- func ParseNameFromKey(key string) (name string, err error)
- type InterfaceErrors
- type InterfaceErrors_Interface
- type InterfaceErrors_Interface_ErrorData
- type InterfaceStateNotification
- type InterfaceStateNotificationType
- type InterfaceType
- type Interfaces
- type InterfacesState
- type InterfacesState_Interface
- type InterfacesState_Interface_Duplex
- type InterfacesState_Interface_Statistics
- type InterfacesState_Interface_Status
- type Interfaces_Interface
- func (m *Interfaces_Interface) GetAfpacket() *Interfaces_Interface_Afpacket
- func (m *Interfaces_Interface) GetMemif() *Interfaces_Interface_Memif
- func (m *Interfaces_Interface) GetRxModeSettings() *Interfaces_Interface_RxModeSettings
- func (m *Interfaces_Interface) GetTap() *Interfaces_Interface_Tap
- func (m *Interfaces_Interface) GetVxlan() *Interfaces_Interface_Vxlan
- func (*Interfaces_Interface) ProtoMessage()
- func (m *Interfaces_Interface) Reset()
- func (m *Interfaces_Interface) String() string
- type Interfaces_Interface_Afpacket
- type Interfaces_Interface_Memif
- type Interfaces_Interface_Memif_MemifMode
- type Interfaces_Interface_RxModeSettings
- type Interfaces_Interface_Tap
- type Interfaces_Interface_Vxlan
- type RxModeType
Constants ¶
const ( // InterfacePrefix vpp/config/v1/interface/ InterfacePrefix = "vpp/config/v1/interface/" // IfStatePrefix vpp/status/v1/interface/ IfStatePrefix = "vpp/status/v1/interface/" // IfErrorPrefix vpp/status/v1/interface/error IfErrorPrefix = "vpp/status/v1/interface/error/" )
Variables ¶
var InterfaceType_name = map[int32]string{
0: "SOFTWARE_LOOPBACK",
1: "ETHERNET_CSMACD",
2: "MEMORY_INTERFACE",
3: "TAP_INTERFACE",
4: "AF_PACKET_INTERFACE",
5: "VXLAN_TUNNEL",
}
var InterfaceType_value = map[string]int32{
"SOFTWARE_LOOPBACK": 0,
"ETHERNET_CSMACD": 1,
"MEMORY_INTERFACE": 2,
"TAP_INTERFACE": 3,
"AF_PACKET_INTERFACE": 4,
"VXLAN_TUNNEL": 5,
}
var InterfacesState_Interface_Duplex_name = map[int32]string{
0: "UNKNOWN_DUPLEX",
1: "HALF",
2: "FULL",
}
var InterfacesState_Interface_Duplex_value = map[string]int32{
"UNKNOWN_DUPLEX": 0,
"HALF": 1,
"FULL": 2,
}
var InterfacesState_Interface_Status_name = map[int32]string{
0: "UNKNOWN_STATUS",
1: "UP",
2: "DOWN",
3: "DELETED",
}
var InterfacesState_Interface_Status_value = map[string]int32{
"UNKNOWN_STATUS": 0,
"UP": 1,
"DOWN": 2,
"DELETED": 3,
}
var Interfaces_Interface_Memif_MemifMode_name = map[int32]string{
0: "ETHERNET",
1: "IP",
2: "PUNT_INJECT",
}
var Interfaces_Interface_Memif_MemifMode_value = map[string]int32{
"ETHERNET": 0,
"IP": 1,
"PUNT_INJECT": 2,
}
var RxModeType_name = map[int32]string{
0: "UNKNOWN",
1: "POLLING",
2: "INTERRUPT",
3: "ADAPTIVE",
4: "DEFAULT",
}
var RxModeType_value = map[string]int32{
"UNKNOWN": 0,
"POLLING": 1,
"INTERRUPT": 2,
"ADAPTIVE": 3,
"DEFAULT": 4,
}
Functions ¶
func InterfaceErrorKey ¶
InterfaceErrorKey returns the key used in ETCD to store the interface errors.
func InterfaceErrorPrefix ¶
func InterfaceErrorPrefix() string
InterfaceErrorPrefix returns the prefix used in ETCD to store the interface errors.
func InterfaceKey ¶
InterfaceKey returns the prefix used in ETCD to store the vpp interface config of a particular interface in selected vpp instance.
func InterfaceKeyPrefix ¶
func InterfaceKeyPrefix() string
InterfaceKeyPrefix returns the prefix used in ETCD to store vpp interfaces config.
func InterfaceStateKey ¶
InterfaceStateKey returns the prefix used in ETCD to store the vpp interface state data of particular interface in selected vpp instance.
func InterfaceStateKeyPrefix ¶
func InterfaceStateKeyPrefix() string
InterfaceStateKeyPrefix returns the prefix used in ETCD to store the vpp interfaces state data.
func ParseNameFromKey ¶
ParseNameFromKey returns suffix of the key.
Types ¶
type InterfaceErrors ¶
type InterfaceErrors struct {
Interface []*InterfaceErrors_Interface `protobuf:"bytes,1,rep,name=interface" json:"interface,omitempty"`
}
func (*InterfaceErrors) GetInterface ¶
func (m *InterfaceErrors) GetInterface() []*InterfaceErrors_Interface
func (*InterfaceErrors) ProtoMessage ¶
func (*InterfaceErrors) ProtoMessage()
func (*InterfaceErrors) Reset ¶
func (m *InterfaceErrors) Reset()
func (*InterfaceErrors) String ¶
func (m *InterfaceErrors) String() string
type InterfaceErrors_Interface ¶
type InterfaceErrors_Interface struct { InterfaceName string `protobuf:"bytes,1,opt,name=interface_name,proto3" json:"interface_name,omitempty"` ErrorData []*InterfaceErrors_Interface_ErrorData `protobuf:"bytes,2,rep,name=error_data" json:"error_data,omitempty"` }
func (*InterfaceErrors_Interface) GetErrorData ¶
func (m *InterfaceErrors_Interface) GetErrorData() []*InterfaceErrors_Interface_ErrorData
func (*InterfaceErrors_Interface) ProtoMessage ¶
func (*InterfaceErrors_Interface) ProtoMessage()
func (*InterfaceErrors_Interface) Reset ¶
func (m *InterfaceErrors_Interface) Reset()
func (*InterfaceErrors_Interface) String ¶
func (m *InterfaceErrors_Interface) String() string
type InterfaceErrors_Interface_ErrorData ¶
type InterfaceErrors_Interface_ErrorData struct { ChangeType string `protobuf:"bytes,1,opt,name=change_type,proto3" json:"change_type,omitempty"` ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,proto3" json:"error_message,omitempty"` LastChange int64 `protobuf:"varint,3,opt,name=last_change,proto3" json:"last_change,omitempty"` }
func (*InterfaceErrors_Interface_ErrorData) ProtoMessage ¶
func (*InterfaceErrors_Interface_ErrorData) ProtoMessage()
func (*InterfaceErrors_Interface_ErrorData) Reset ¶
func (m *InterfaceErrors_Interface_ErrorData) Reset()
func (*InterfaceErrors_Interface_ErrorData) String ¶
func (m *InterfaceErrors_Interface_ErrorData) String() string
type InterfaceStateNotification ¶
type InterfaceStateNotification struct { // Type of the notification Type InterfaceStateNotificationType // State of the network interface State *InterfacesState_Interface }
InterfaceStateNotification aggregates status UP/DOWN/DELETED/UNKNOWN with the details (state) about the interfaces including counters.
type InterfaceStateNotificationType ¶
type InterfaceStateNotificationType int32
InterfaceStateNotificationType is a type of notification.
const ( // UNKNOWN is default type. UNKNOWN InterfaceStateNotificationType = 0 // UPDOWN represents Link UP/DOWN notification. UPDOWN InterfaceStateNotificationType = 1 // COUNTERS represents interface state with updated counters. COUNTERS InterfaceStateNotificationType = 2 // DELETED represents the event when the interface was deleted from the VPP. // Note that some north bound config updates require delete and create the network interface one more time. DELETED InterfaceStateNotificationType = 3 )
type InterfaceType ¶
type InterfaceType int32
const ( InterfaceType_SOFTWARE_LOOPBACK InterfaceType = 0 InterfaceType_ETHERNET_CSMACD InterfaceType = 1 InterfaceType_MEMORY_INTERFACE InterfaceType = 2 InterfaceType_TAP_INTERFACE InterfaceType = 3 InterfaceType_AF_PACKET_INTERFACE InterfaceType = 4 InterfaceType_VXLAN_TUNNEL InterfaceType = 5 )
func (InterfaceType) String ¶
func (x InterfaceType) String() string
type Interfaces ¶
type Interfaces struct {
Interface []*Interfaces_Interface `protobuf:"bytes,1,rep,name=interface" json:"interface,omitempty"`
}
func (*Interfaces) GetInterface ¶
func (m *Interfaces) GetInterface() []*Interfaces_Interface
func (*Interfaces) ProtoMessage ¶
func (*Interfaces) ProtoMessage()
func (*Interfaces) Reset ¶
func (m *Interfaces) Reset()
func (*Interfaces) String ¶
func (m *Interfaces) String() string
type InterfacesState ¶
type InterfacesState struct {
Interface []*InterfacesState_Interface `protobuf:"bytes,1,rep,name=interface" json:"interface,omitempty"`
}
func (*InterfacesState) GetInterface ¶
func (m *InterfacesState) GetInterface() []*InterfacesState_Interface
func (*InterfacesState) ProtoMessage ¶
func (*InterfacesState) ProtoMessage()
func (*InterfacesState) Reset ¶
func (m *InterfacesState) Reset()
func (*InterfacesState) String ¶
func (m *InterfacesState) String() string
type InterfacesState_Interface ¶
type InterfacesState_Interface struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` InternalName string `protobuf:"bytes,2,opt,name=internal_name,proto3" json:"internal_name,omitempty"` Type InterfaceType `protobuf:"varint,3,opt,name=type,proto3,enum=interfaces.InterfaceType" json:"type,omitempty"` IfIndex uint32 `protobuf:"varint,4,opt,name=if_index,proto3" json:"if_index,omitempty"` AdminStatus InterfacesState_Interface_Status `` /* 127-byte string literal not displayed */ OperStatus InterfacesState_Interface_Status `protobuf:"varint,6,opt,name=oper_status,proto3,enum=interfaces.InterfacesState_Interface_Status" json:"oper_status,omitempty"` LastChange int64 `protobuf:"varint,7,opt,name=last_change,proto3" json:"last_change,omitempty"` PhysAddress string `protobuf:"bytes,8,opt,name=phys_address,proto3" json:"phys_address,omitempty"` Speed uint64 `protobuf:"varint,9,opt,name=speed,proto3" json:"speed,omitempty"` Mtu uint32 `protobuf:"varint,10,opt,name=mtu,proto3" json:"mtu,omitempty"` Duplex InterfacesState_Interface_Duplex `protobuf:"varint,11,opt,name=duplex,proto3,enum=interfaces.InterfacesState_Interface_Duplex" json:"duplex,omitempty"` Statistics *InterfacesState_Interface_Statistics `protobuf:"bytes,100,opt,name=statistics" json:"statistics,omitempty"` }
func (*InterfacesState_Interface) GetStatistics ¶
func (m *InterfacesState_Interface) GetStatistics() *InterfacesState_Interface_Statistics
func (*InterfacesState_Interface) ProtoMessage ¶
func (*InterfacesState_Interface) ProtoMessage()
func (*InterfacesState_Interface) Reset ¶
func (m *InterfacesState_Interface) Reset()
func (*InterfacesState_Interface) String ¶
func (m *InterfacesState_Interface) String() string
type InterfacesState_Interface_Duplex ¶
type InterfacesState_Interface_Duplex int32
const ( InterfacesState_Interface_UNKNOWN_DUPLEX InterfacesState_Interface_Duplex = 0 InterfacesState_Interface_HALF InterfacesState_Interface_Duplex = 1 InterfacesState_Interface_FULL InterfacesState_Interface_Duplex = 2 )
func (InterfacesState_Interface_Duplex) String ¶
func (x InterfacesState_Interface_Duplex) String() string
type InterfacesState_Interface_Statistics ¶
type InterfacesState_Interface_Statistics struct { InPackets uint64 `protobuf:"varint,1,opt,name=in_packets,proto3" json:"in_packets,omitempty"` InBytes uint64 `protobuf:"varint,2,opt,name=in_bytes,proto3" json:"in_bytes,omitempty"` OutPackets uint64 `protobuf:"varint,3,opt,name=out_packets,proto3" json:"out_packets,omitempty"` OutBytes uint64 `protobuf:"varint,4,opt,name=out_bytes,proto3" json:"out_bytes,omitempty"` DropPackets uint64 `protobuf:"varint,5,opt,name=drop_packets,proto3" json:"drop_packets,omitempty"` PuntPackets uint64 `protobuf:"varint,6,opt,name=punt_packets,proto3" json:"punt_packets,omitempty"` Ipv4Packets uint64 `protobuf:"varint,7,opt,name=ipv4_packets,proto3" json:"ipv4_packets,omitempty"` Ipv6Packets uint64 `protobuf:"varint,8,opt,name=ipv6_packets,proto3" json:"ipv6_packets,omitempty"` InNobufPackets uint64 `protobuf:"varint,9,opt,name=in_nobuf_packets,proto3" json:"in_nobuf_packets,omitempty"` InMissPackets uint64 `protobuf:"varint,10,opt,name=in_miss_packets,proto3" json:"in_miss_packets,omitempty"` InErrorPackets uint64 `protobuf:"varint,11,opt,name=in_error_packets,proto3" json:"in_error_packets,omitempty"` OutErrorPackets uint64 `protobuf:"varint,12,opt,name=out_error_packets,proto3" json:"out_error_packets,omitempty"` }
func (*InterfacesState_Interface_Statistics) ProtoMessage ¶
func (*InterfacesState_Interface_Statistics) ProtoMessage()
func (*InterfacesState_Interface_Statistics) Reset ¶
func (m *InterfacesState_Interface_Statistics) Reset()
func (*InterfacesState_Interface_Statistics) String ¶
func (m *InterfacesState_Interface_Statistics) String() string
type InterfacesState_Interface_Status ¶
type InterfacesState_Interface_Status int32
const ( InterfacesState_Interface_UNKNOWN_STATUS InterfacesState_Interface_Status = 0 InterfacesState_Interface_UP InterfacesState_Interface_Status = 1 InterfacesState_Interface_DOWN InterfacesState_Interface_Status = 2 InterfacesState_Interface_DELETED InterfacesState_Interface_Status = 3 )
func (InterfacesState_Interface_Status) String ¶
func (x InterfacesState_Interface_Status) String() string
type Interfaces_Interface ¶
type Interfaces_Interface struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Type InterfaceType `protobuf:"varint,3,opt,name=type,proto3,enum=interfaces.InterfaceType" json:"type,omitempty"` Enabled bool `protobuf:"varint,4,opt,name=enabled,proto3" json:"enabled,omitempty"` PhysAddress string `protobuf:"bytes,5,opt,name=phys_address,proto3" json:"phys_address,omitempty"` Mtu uint32 `protobuf:"varint,6,opt,name=mtu,proto3" json:"mtu,omitempty"` Vrf uint32 `protobuf:"varint,7,opt,name=vrf,proto3" json:"vrf,omitempty"` // Required format is "ipAddress/ipPrefix" IpAddresses []string `protobuf:"bytes,10,rep,name=ip_addresses" json:"ip_addresses,omitempty"` RxModeSettings *Interfaces_Interface_RxModeSettings `protobuf:"bytes,11,opt,name=rxModeSettings" json:"rxModeSettings,omitempty"` Memif *Interfaces_Interface_Memif `protobuf:"bytes,101,opt,name=memif" json:"memif,omitempty"` Vxlan *Interfaces_Interface_Vxlan `protobuf:"bytes,102,opt,name=vxlan" json:"vxlan,omitempty"` Afpacket *Interfaces_Interface_Afpacket `protobuf:"bytes,103,opt,name=afpacket" json:"afpacket,omitempty"` Tap *Interfaces_Interface_Tap `protobuf:"bytes,104,opt,name=tap" json:"tap,omitempty"` }
func (*Interfaces_Interface) GetAfpacket ¶
func (m *Interfaces_Interface) GetAfpacket() *Interfaces_Interface_Afpacket
func (*Interfaces_Interface) GetMemif ¶
func (m *Interfaces_Interface) GetMemif() *Interfaces_Interface_Memif
func (*Interfaces_Interface) GetRxModeSettings ¶ added in v1.0.8
func (m *Interfaces_Interface) GetRxModeSettings() *Interfaces_Interface_RxModeSettings
func (*Interfaces_Interface) GetTap ¶
func (m *Interfaces_Interface) GetTap() *Interfaces_Interface_Tap
func (*Interfaces_Interface) GetVxlan ¶
func (m *Interfaces_Interface) GetVxlan() *Interfaces_Interface_Vxlan
func (*Interfaces_Interface) ProtoMessage ¶
func (*Interfaces_Interface) ProtoMessage()
func (*Interfaces_Interface) Reset ¶
func (m *Interfaces_Interface) Reset()
func (*Interfaces_Interface) String ¶
func (m *Interfaces_Interface) String() string
type Interfaces_Interface_Afpacket ¶
type Interfaces_Interface_Afpacket struct {
HostIfName string `protobuf:"bytes,1,opt,name=host_if_name,proto3" json:"host_if_name,omitempty"`
}
func (*Interfaces_Interface_Afpacket) ProtoMessage ¶
func (*Interfaces_Interface_Afpacket) ProtoMessage()
func (*Interfaces_Interface_Afpacket) Reset ¶
func (m *Interfaces_Interface_Afpacket) Reset()
func (*Interfaces_Interface_Afpacket) String ¶
func (m *Interfaces_Interface_Afpacket) String() string
type Interfaces_Interface_Memif ¶
type Interfaces_Interface_Memif struct { Master bool `protobuf:"varint,1,opt,name=master,proto3" json:"master,omitempty"` Mode Interfaces_Interface_Memif_MemifMode `protobuf:"varint,2,opt,name=mode,proto3,enum=interfaces.Interfaces_Interface_Memif_MemifMode" json:"mode,omitempty"` Id uint32 `protobuf:"varint,3,opt,name=id,proto3" json:"id,omitempty"` SocketFilename string `protobuf:"bytes,4,opt,name=socket_filename,proto3" json:"socket_filename,omitempty"` Secret string `protobuf:"bytes,5,opt,name=secret,proto3" json:"secret,omitempty"` RingSize uint32 `protobuf:"varint,6,opt,name=ring_size,proto3" json:"ring_size,omitempty"` BufferSize uint32 `protobuf:"varint,7,opt,name=buffer_size,proto3" json:"buffer_size,omitempty"` RxQueues uint32 `protobuf:"varint,8,opt,name=rx_queues,proto3" json:"rx_queues,omitempty"` TxQueues uint32 `protobuf:"varint,9,opt,name=tx_queues,proto3" json:"tx_queues,omitempty"` }
func (*Interfaces_Interface_Memif) ProtoMessage ¶
func (*Interfaces_Interface_Memif) ProtoMessage()
func (*Interfaces_Interface_Memif) Reset ¶
func (m *Interfaces_Interface_Memif) Reset()
func (*Interfaces_Interface_Memif) String ¶
func (m *Interfaces_Interface_Memif) String() string
type Interfaces_Interface_Memif_MemifMode ¶
type Interfaces_Interface_Memif_MemifMode int32
const ( Interfaces_Interface_Memif_ETHERNET Interfaces_Interface_Memif_MemifMode = 0 Interfaces_Interface_Memif_IP Interfaces_Interface_Memif_MemifMode = 1 Interfaces_Interface_Memif_PUNT_INJECT Interfaces_Interface_Memif_MemifMode = 2 )
func (Interfaces_Interface_Memif_MemifMode) String ¶
func (x Interfaces_Interface_Memif_MemifMode) String() string
type Interfaces_Interface_RxModeSettings ¶ added in v1.0.8
type Interfaces_Interface_RxModeSettings struct { RxMode RxModeType `protobuf:"varint,1,opt,name=rx_mode,proto3,enum=interfaces.RxModeType" json:"rx_mode,omitempty"` QueueID uint32 `protobuf:"varint,2,opt,proto3" json:"QueueID,omitempty"` QueueIDValid uint32 `protobuf:"varint,3,opt,proto3" json:"QueueIDValid,omitempty"` }
func (*Interfaces_Interface_RxModeSettings) ProtoMessage ¶ added in v1.0.8
func (*Interfaces_Interface_RxModeSettings) ProtoMessage()
func (*Interfaces_Interface_RxModeSettings) Reset ¶ added in v1.0.8
func (m *Interfaces_Interface_RxModeSettings) Reset()
func (*Interfaces_Interface_RxModeSettings) String ¶ added in v1.0.8
func (m *Interfaces_Interface_RxModeSettings) String() string
type Interfaces_Interface_Tap ¶
type Interfaces_Interface_Tap struct {
HostIfName string `protobuf:"bytes,1,opt,name=host_if_name,proto3" json:"host_if_name,omitempty"`
}
func (*Interfaces_Interface_Tap) ProtoMessage ¶
func (*Interfaces_Interface_Tap) ProtoMessage()
func (*Interfaces_Interface_Tap) Reset ¶
func (m *Interfaces_Interface_Tap) Reset()
func (*Interfaces_Interface_Tap) String ¶
func (m *Interfaces_Interface_Tap) String() string
type Interfaces_Interface_Vxlan ¶
type Interfaces_Interface_Vxlan struct { SrcAddress string `protobuf:"bytes,1,opt,name=src_address,proto3" json:"src_address,omitempty"` DstAddress string `protobuf:"bytes,2,opt,name=dst_address,proto3" json:"dst_address,omitempty"` Vni uint32 `protobuf:"varint,3,opt,name=vni,proto3" json:"vni,omitempty"` }
func (*Interfaces_Interface_Vxlan) ProtoMessage ¶
func (*Interfaces_Interface_Vxlan) ProtoMessage()
func (*Interfaces_Interface_Vxlan) Reset ¶
func (m *Interfaces_Interface_Vxlan) Reset()
func (*Interfaces_Interface_Vxlan) String ¶
func (m *Interfaces_Interface_Vxlan) String() string
type RxModeType ¶ added in v1.0.8
type RxModeType int32
from vpp/build-root/install-vpp-native/vpp/include/vnet/interface.h
const ( RxModeType_UNKNOWN RxModeType = 0 RxModeType_POLLING RxModeType = 1 RxModeType_INTERRUPT RxModeType = 2 RxModeType_ADAPTIVE RxModeType = 3 RxModeType_DEFAULT RxModeType = 4 )
func (RxModeType) String ¶ added in v1.0.8
func (x RxModeType) String() string