interfaces

package
v3.27.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package interfaces contains generated bindings for API file interface.api.

Contents: - 74 messages

Index

Constants

View Source
const (
	APIFile    = "interface"
	APIVersion = "3.2.3"
	VersionCrc = 0x2c32eb46
)

Variables

This section is empty.

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type CollectDetailedInterfaceStats

type CollectDetailedInterfaceStats struct {
	SwIfIndex     interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	EnableDisable bool                           `binapi:"bool,name=enable_disable" json:"enable_disable,omitempty"`
}

Enable or disable detailed interface stats

  • sw_if_index - The interface to collect detail stats on. ~0 implies all interfaces.
  • enable_disable - set to 1 to enable, 0 to disable detailed stats

CollectDetailedInterfaceStats defines message 'collect_detailed_interface_stats'.

func (*CollectDetailedInterfaceStats) GetCrcString

func (*CollectDetailedInterfaceStats) GetCrcString() string

func (*CollectDetailedInterfaceStats) GetMessageName

func (*CollectDetailedInterfaceStats) GetMessageName() string

func (*CollectDetailedInterfaceStats) GetMessageType

func (*CollectDetailedInterfaceStats) GetMessageType() api.MessageType

func (*CollectDetailedInterfaceStats) Marshal

func (m *CollectDetailedInterfaceStats) Marshal(b []byte) ([]byte, error)

func (*CollectDetailedInterfaceStats) Reset

func (m *CollectDetailedInterfaceStats) Reset()

func (*CollectDetailedInterfaceStats) Size

func (m *CollectDetailedInterfaceStats) Size() (size int)

func (*CollectDetailedInterfaceStats) Unmarshal

func (m *CollectDetailedInterfaceStats) Unmarshal(b []byte) error

type CollectDetailedInterfaceStatsReply

type CollectDetailedInterfaceStatsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

CollectDetailedInterfaceStatsReply defines message 'collect_detailed_interface_stats_reply'.

func (*CollectDetailedInterfaceStatsReply) GetCrcString

func (*CollectDetailedInterfaceStatsReply) GetMessageName

func (*CollectDetailedInterfaceStatsReply) GetMessageName() string

func (*CollectDetailedInterfaceStatsReply) GetMessageType

func (*CollectDetailedInterfaceStatsReply) Marshal

func (m *CollectDetailedInterfaceStatsReply) Marshal(b []byte) ([]byte, error)

func (*CollectDetailedInterfaceStatsReply) Reset

func (*CollectDetailedInterfaceStatsReply) Size

func (m *CollectDetailedInterfaceStatsReply) Size() (size int)

func (*CollectDetailedInterfaceStatsReply) Unmarshal

func (m *CollectDetailedInterfaceStatsReply) Unmarshal(b []byte) error

type CreateLoopback

type CreateLoopback struct {
	MacAddress ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
}

Create loopback interface request

  • mac_address - mac addr to assign to the interface if none-zero

CreateLoopback defines message 'create_loopback'.

func (*CreateLoopback) GetCrcString

func (*CreateLoopback) GetCrcString() string

func (*CreateLoopback) GetMessageName

func (*CreateLoopback) GetMessageName() string

func (*CreateLoopback) GetMessageType

func (*CreateLoopback) GetMessageType() api.MessageType

func (*CreateLoopback) Marshal

func (m *CreateLoopback) Marshal(b []byte) ([]byte, error)

func (*CreateLoopback) Reset

func (m *CreateLoopback) Reset()

func (*CreateLoopback) Size

func (m *CreateLoopback) Size() (size int)

func (*CreateLoopback) Unmarshal

func (m *CreateLoopback) Unmarshal(b []byte) error

type CreateLoopbackInstance

type CreateLoopbackInstance struct {
	MacAddress   ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	IsSpecified  bool                      `binapi:"bool,name=is_specified" json:"is_specified,omitempty"`
	UserInstance uint32                    `binapi:"u32,name=user_instance" json:"user_instance,omitempty"`
}

Create loopback interface instance request

  • mac_address - mac addr to assign to the interface if none-zero
  • is_specified - if non-0, a specific user_instance is being requested
  • user_instance - requested instance, ~0 => dynamically allocate

CreateLoopbackInstance defines message 'create_loopback_instance'.

func (*CreateLoopbackInstance) GetCrcString

func (*CreateLoopbackInstance) GetCrcString() string

func (*CreateLoopbackInstance) GetMessageName

func (*CreateLoopbackInstance) GetMessageName() string

func (*CreateLoopbackInstance) GetMessageType

func (*CreateLoopbackInstance) GetMessageType() api.MessageType

func (*CreateLoopbackInstance) Marshal

func (m *CreateLoopbackInstance) Marshal(b []byte) ([]byte, error)

func (*CreateLoopbackInstance) Reset

func (m *CreateLoopbackInstance) Reset()

func (*CreateLoopbackInstance) Size

func (m *CreateLoopbackInstance) Size() (size int)

func (*CreateLoopbackInstance) Unmarshal

func (m *CreateLoopbackInstance) Unmarshal(b []byte) error

type CreateLoopbackInstanceReply

type CreateLoopbackInstanceReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Create loopback interface instance response

  • sw_if_index - sw index of the interface that was created
  • retval - return code for the request

CreateLoopbackInstanceReply defines message 'create_loopback_instance_reply'.

func (*CreateLoopbackInstanceReply) GetCrcString

func (*CreateLoopbackInstanceReply) GetCrcString() string

func (*CreateLoopbackInstanceReply) GetMessageName

func (*CreateLoopbackInstanceReply) GetMessageName() string

func (*CreateLoopbackInstanceReply) GetMessageType

func (*CreateLoopbackInstanceReply) GetMessageType() api.MessageType

func (*CreateLoopbackInstanceReply) Marshal

func (m *CreateLoopbackInstanceReply) Marshal(b []byte) ([]byte, error)

func (*CreateLoopbackInstanceReply) Reset

func (m *CreateLoopbackInstanceReply) Reset()

func (*CreateLoopbackInstanceReply) Size

func (m *CreateLoopbackInstanceReply) Size() (size int)

func (*CreateLoopbackInstanceReply) Unmarshal

func (m *CreateLoopbackInstanceReply) Unmarshal(b []byte) error

type CreateLoopbackReply

type CreateLoopbackReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Create loopback interface response

  • sw_if_index - sw index of the interface that was created
  • retval - return code for the request

CreateLoopbackReply defines message 'create_loopback_reply'.

func (*CreateLoopbackReply) GetCrcString

func (*CreateLoopbackReply) GetCrcString() string

func (*CreateLoopbackReply) GetMessageName

func (*CreateLoopbackReply) GetMessageName() string

func (*CreateLoopbackReply) GetMessageType

func (*CreateLoopbackReply) GetMessageType() api.MessageType

func (*CreateLoopbackReply) Marshal

func (m *CreateLoopbackReply) Marshal(b []byte) ([]byte, error)

func (*CreateLoopbackReply) Reset

func (m *CreateLoopbackReply) Reset()

func (*CreateLoopbackReply) Size

func (m *CreateLoopbackReply) Size() (size int)

func (*CreateLoopbackReply) Unmarshal

func (m *CreateLoopbackReply) Unmarshal(b []byte) error

type CreateSubif

type CreateSubif struct {
	SwIfIndex   interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	SubID       uint32                         `binapi:"u32,name=sub_id" json:"sub_id,omitempty"`
	SubIfFlags  interface_types.SubIfFlags     `binapi:"sub_if_flags,name=sub_if_flags" json:"sub_if_flags,omitempty"`
	OuterVlanID uint16                         `binapi:"u16,name=outer_vlan_id" json:"outer_vlan_id,omitempty"`
	InnerVlanID uint16                         `binapi:"u16,name=inner_vlan_id" json:"inner_vlan_id,omitempty"`
}

CreateSubif defines message 'create_subif'.

func (*CreateSubif) GetCrcString

func (*CreateSubif) GetCrcString() string

func (*CreateSubif) GetMessageName

func (*CreateSubif) GetMessageName() string

func (*CreateSubif) GetMessageType

func (*CreateSubif) GetMessageType() api.MessageType

func (*CreateSubif) Marshal

func (m *CreateSubif) Marshal(b []byte) ([]byte, error)

func (*CreateSubif) Reset

func (m *CreateSubif) Reset()

func (*CreateSubif) Size

func (m *CreateSubif) Size() (size int)

func (*CreateSubif) Unmarshal

func (m *CreateSubif) Unmarshal(b []byte) error

type CreateSubifReply

type CreateSubifReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

CreateSubifReply defines message 'create_subif_reply'.

func (*CreateSubifReply) GetCrcString

func (*CreateSubifReply) GetCrcString() string

func (*CreateSubifReply) GetMessageName

func (*CreateSubifReply) GetMessageName() string

func (*CreateSubifReply) GetMessageType

func (*CreateSubifReply) GetMessageType() api.MessageType

func (*CreateSubifReply) Marshal

func (m *CreateSubifReply) Marshal(b []byte) ([]byte, error)

func (*CreateSubifReply) Reset

func (m *CreateSubifReply) Reset()

func (*CreateSubifReply) Size

func (m *CreateSubifReply) Size() (size int)

func (*CreateSubifReply) Unmarshal

func (m *CreateSubifReply) Unmarshal(b []byte) error

type CreateVlanSubif

type CreateVlanSubif struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	VlanID    uint32                         `binapi:"u32,name=vlan_id" json:"vlan_id,omitempty"`
}

Create a new subinterface with the given vlan id

  • sw_if_index - software index of the new vlan's parent interface
  • vlan_id - vlan tag of the new interface

CreateVlanSubif defines message 'create_vlan_subif'.

func (*CreateVlanSubif) GetCrcString

func (*CreateVlanSubif) GetCrcString() string

func (*CreateVlanSubif) GetMessageName

func (*CreateVlanSubif) GetMessageName() string

func (*CreateVlanSubif) GetMessageType

func (*CreateVlanSubif) GetMessageType() api.MessageType

func (*CreateVlanSubif) Marshal

func (m *CreateVlanSubif) Marshal(b []byte) ([]byte, error)

func (*CreateVlanSubif) Reset

func (m *CreateVlanSubif) Reset()

func (*CreateVlanSubif) Size

func (m *CreateVlanSubif) Size() (size int)

func (*CreateVlanSubif) Unmarshal

func (m *CreateVlanSubif) Unmarshal(b []byte) error

type CreateVlanSubifReply

type CreateVlanSubifReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Reply for the vlan subinterface create request

  • retval - return code
  • sw_if_index - software index allocated for the new subinterface

CreateVlanSubifReply defines message 'create_vlan_subif_reply'.

func (*CreateVlanSubifReply) GetCrcString

func (*CreateVlanSubifReply) GetCrcString() string

func (*CreateVlanSubifReply) GetMessageName

func (*CreateVlanSubifReply) GetMessageName() string

func (*CreateVlanSubifReply) GetMessageType

func (*CreateVlanSubifReply) GetMessageType() api.MessageType

func (*CreateVlanSubifReply) Marshal

func (m *CreateVlanSubifReply) Marshal(b []byte) ([]byte, error)

func (*CreateVlanSubifReply) Reset

func (m *CreateVlanSubifReply) Reset()

func (*CreateVlanSubifReply) Size

func (m *CreateVlanSubifReply) Size() (size int)

func (*CreateVlanSubifReply) Unmarshal

func (m *CreateVlanSubifReply) Unmarshal(b []byte) error

type DeleteLoopback

type DeleteLoopback struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Delete loopback interface request

  • sw_if_index - sw index of the interface that was created

DeleteLoopback defines message 'delete_loopback'.

func (*DeleteLoopback) GetCrcString

func (*DeleteLoopback) GetCrcString() string

func (*DeleteLoopback) GetMessageName

func (*DeleteLoopback) GetMessageName() string

func (*DeleteLoopback) GetMessageType

func (*DeleteLoopback) GetMessageType() api.MessageType

func (*DeleteLoopback) Marshal

func (m *DeleteLoopback) Marshal(b []byte) ([]byte, error)

func (*DeleteLoopback) Reset

func (m *DeleteLoopback) Reset()

func (*DeleteLoopback) Size

func (m *DeleteLoopback) Size() (size int)

func (*DeleteLoopback) Unmarshal

func (m *DeleteLoopback) Unmarshal(b []byte) error

type DeleteLoopbackReply

type DeleteLoopbackReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

DeleteLoopbackReply defines message 'delete_loopback_reply'.

func (*DeleteLoopbackReply) GetCrcString

func (*DeleteLoopbackReply) GetCrcString() string

func (*DeleteLoopbackReply) GetMessageName

func (*DeleteLoopbackReply) GetMessageName() string

func (*DeleteLoopbackReply) GetMessageType

func (*DeleteLoopbackReply) GetMessageType() api.MessageType

func (*DeleteLoopbackReply) Marshal

func (m *DeleteLoopbackReply) Marshal(b []byte) ([]byte, error)

func (*DeleteLoopbackReply) Reset

func (m *DeleteLoopbackReply) Reset()

func (*DeleteLoopbackReply) Size

func (m *DeleteLoopbackReply) Size() (size int)

func (*DeleteLoopbackReply) Unmarshal

func (m *DeleteLoopbackReply) Unmarshal(b []byte) error

type DeleteSubif

type DeleteSubif struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Delete sub interface request

  • sw_if_index - sw index of the interface that was created by create_subif

DeleteSubif defines message 'delete_subif'.

func (*DeleteSubif) GetCrcString

func (*DeleteSubif) GetCrcString() string

func (*DeleteSubif) GetMessageName

func (*DeleteSubif) GetMessageName() string

func (*DeleteSubif) GetMessageType

func (*DeleteSubif) GetMessageType() api.MessageType

func (*DeleteSubif) Marshal

func (m *DeleteSubif) Marshal(b []byte) ([]byte, error)

func (*DeleteSubif) Reset

func (m *DeleteSubif) Reset()

func (*DeleteSubif) Size

func (m *DeleteSubif) Size() (size int)

func (*DeleteSubif) Unmarshal

func (m *DeleteSubif) Unmarshal(b []byte) error

type DeleteSubifReply

type DeleteSubifReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

DeleteSubifReply defines message 'delete_subif_reply'.

func (*DeleteSubifReply) GetCrcString

func (*DeleteSubifReply) GetCrcString() string

func (*DeleteSubifReply) GetMessageName

func (*DeleteSubifReply) GetMessageName() string

func (*DeleteSubifReply) GetMessageType

func (*DeleteSubifReply) GetMessageType() api.MessageType

func (*DeleteSubifReply) Marshal

func (m *DeleteSubifReply) Marshal(b []byte) ([]byte, error)

func (*DeleteSubifReply) Reset

func (m *DeleteSubifReply) Reset()

func (*DeleteSubifReply) Size

func (m *DeleteSubifReply) Size() (size int)

func (*DeleteSubifReply) Unmarshal

func (m *DeleteSubifReply) Unmarshal(b []byte) error

type GetBuffersStats

type GetBuffersStats struct {
	BufferIndex uint32 `binapi:"u32,name=buffer_index" json:"buffer_index,omitempty"`
}

Get available, cached and used buffers

  • buffer_index - buffer stat index

GetBuffersStats defines message 'get_buffers_stats'.

func (*GetBuffersStats) GetCrcString

func (*GetBuffersStats) GetCrcString() string

func (*GetBuffersStats) GetMessageName

func (*GetBuffersStats) GetMessageName() string

func (*GetBuffersStats) GetMessageType

func (*GetBuffersStats) GetMessageType() api.MessageType

func (*GetBuffersStats) Marshal

func (m *GetBuffersStats) Marshal(b []byte) ([]byte, error)

func (*GetBuffersStats) Reset

func (m *GetBuffersStats) Reset()

func (*GetBuffersStats) Size

func (m *GetBuffersStats) Size() (size int)

func (*GetBuffersStats) Unmarshal

func (m *GetBuffersStats) Unmarshal(b []byte) error

type GetBuffersStatsReply

type GetBuffersStatsReply struct {
	Retval           int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	AvailableBuffers uint32 `binapi:"u32,name=available_buffers" json:"available_buffers,omitempty"`
	CachedBuffers    uint32 `binapi:"u32,name=cached_buffers" json:"cached_buffers,omitempty"`
	UsedBuffers      uint32 `binapi:"u32,name=used_buffers" json:"used_buffers,omitempty"`
}

GetBuffersStatsReply defines message 'get_buffers_stats_reply'.

func (*GetBuffersStatsReply) GetCrcString

func (*GetBuffersStatsReply) GetCrcString() string

func (*GetBuffersStatsReply) GetMessageName

func (*GetBuffersStatsReply) GetMessageName() string

func (*GetBuffersStatsReply) GetMessageType

func (*GetBuffersStatsReply) GetMessageType() api.MessageType

func (*GetBuffersStatsReply) Marshal

func (m *GetBuffersStatsReply) Marshal(b []byte) ([]byte, error)

func (*GetBuffersStatsReply) Reset

func (m *GetBuffersStatsReply) Reset()

func (*GetBuffersStatsReply) Size

func (m *GetBuffersStatsReply) Size() (size int)

func (*GetBuffersStatsReply) Unmarshal

func (m *GetBuffersStatsReply) Unmarshal(b []byte) error

type HwInterfaceSetMtu

type HwInterfaceSetMtu struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Mtu       uint16                         `binapi:"u16,name=mtu" json:"mtu,omitempty"`
}

Set interface physical MTU

  • sw_if_index - index of the interface to set MTU on
  • mtu - MTU

HwInterfaceSetMtu defines message 'hw_interface_set_mtu'.

func (*HwInterfaceSetMtu) GetCrcString

func (*HwInterfaceSetMtu) GetCrcString() string

func (*HwInterfaceSetMtu) GetMessageName

func (*HwInterfaceSetMtu) GetMessageName() string

func (*HwInterfaceSetMtu) GetMessageType

func (*HwInterfaceSetMtu) GetMessageType() api.MessageType

func (*HwInterfaceSetMtu) Marshal

func (m *HwInterfaceSetMtu) Marshal(b []byte) ([]byte, error)

func (*HwInterfaceSetMtu) Reset

func (m *HwInterfaceSetMtu) Reset()

func (*HwInterfaceSetMtu) Size

func (m *HwInterfaceSetMtu) Size() (size int)

func (*HwInterfaceSetMtu) Unmarshal

func (m *HwInterfaceSetMtu) Unmarshal(b []byte) error

type HwInterfaceSetMtuReply

type HwInterfaceSetMtuReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

HwInterfaceSetMtuReply defines message 'hw_interface_set_mtu_reply'.

func (*HwInterfaceSetMtuReply) GetCrcString

func (*HwInterfaceSetMtuReply) GetCrcString() string

func (*HwInterfaceSetMtuReply) GetMessageName

func (*HwInterfaceSetMtuReply) GetMessageName() string

func (*HwInterfaceSetMtuReply) GetMessageType

func (*HwInterfaceSetMtuReply) GetMessageType() api.MessageType

func (*HwInterfaceSetMtuReply) Marshal

func (m *HwInterfaceSetMtuReply) Marshal(b []byte) ([]byte, error)

func (*HwInterfaceSetMtuReply) Reset

func (m *HwInterfaceSetMtuReply) Reset()

func (*HwInterfaceSetMtuReply) Size

func (m *HwInterfaceSetMtuReply) Size() (size int)

func (*HwInterfaceSetMtuReply) Unmarshal

func (m *HwInterfaceSetMtuReply) Unmarshal(b []byte) error

type InterfaceNameRenumber

type InterfaceNameRenumber struct {
	SwIfIndex          interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	NewShowDevInstance uint32                         `binapi:"u32,name=new_show_dev_instance" json:"new_show_dev_instance,omitempty"`
}

/* Gross kludge, DGMS InterfaceNameRenumber defines message 'interface_name_renumber'.

func (*InterfaceNameRenumber) GetCrcString

func (*InterfaceNameRenumber) GetCrcString() string

func (*InterfaceNameRenumber) GetMessageName

func (*InterfaceNameRenumber) GetMessageName() string

func (*InterfaceNameRenumber) GetMessageType

func (*InterfaceNameRenumber) GetMessageType() api.MessageType

func (*InterfaceNameRenumber) Marshal

func (m *InterfaceNameRenumber) Marshal(b []byte) ([]byte, error)

func (*InterfaceNameRenumber) Reset

func (m *InterfaceNameRenumber) Reset()

func (*InterfaceNameRenumber) Size

func (m *InterfaceNameRenumber) Size() (size int)

func (*InterfaceNameRenumber) Unmarshal

func (m *InterfaceNameRenumber) Unmarshal(b []byte) error

type InterfaceNameRenumberReply

type InterfaceNameRenumberReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

InterfaceNameRenumberReply defines message 'interface_name_renumber_reply'.

func (*InterfaceNameRenumberReply) GetCrcString

func (*InterfaceNameRenumberReply) GetCrcString() string

func (*InterfaceNameRenumberReply) GetMessageName

func (*InterfaceNameRenumberReply) GetMessageName() string

func (*InterfaceNameRenumberReply) GetMessageType

func (*InterfaceNameRenumberReply) GetMessageType() api.MessageType

func (*InterfaceNameRenumberReply) Marshal

func (m *InterfaceNameRenumberReply) Marshal(b []byte) ([]byte, error)

func (*InterfaceNameRenumberReply) Reset

func (m *InterfaceNameRenumberReply) Reset()

func (*InterfaceNameRenumberReply) Size

func (m *InterfaceNameRenumberReply) Size() (size int)

func (*InterfaceNameRenumberReply) Unmarshal

func (m *InterfaceNameRenumberReply) Unmarshal(b []byte) error

type PcapSetFilterFunction added in v3.27.0

type PcapSetFilterFunction struct {
	FilterFunctionName string `binapi:"string[],name=filter_function_name" json:"filter_function_name,omitempty"`
}

pcap_set_filter_function

  • filter_function_name - the name of the filter function to set for pcap capture

PcapSetFilterFunction defines message 'pcap_set_filter_function'.

func (*PcapSetFilterFunction) GetCrcString added in v3.27.0

func (*PcapSetFilterFunction) GetCrcString() string

func (*PcapSetFilterFunction) GetMessageName added in v3.27.0

func (*PcapSetFilterFunction) GetMessageName() string

func (*PcapSetFilterFunction) GetMessageType added in v3.27.0

func (*PcapSetFilterFunction) GetMessageType() api.MessageType

func (*PcapSetFilterFunction) Marshal added in v3.27.0

func (m *PcapSetFilterFunction) Marshal(b []byte) ([]byte, error)

func (*PcapSetFilterFunction) Reset added in v3.27.0

func (m *PcapSetFilterFunction) Reset()

func (*PcapSetFilterFunction) Size added in v3.27.0

func (m *PcapSetFilterFunction) Size() (size int)

func (*PcapSetFilterFunction) Unmarshal added in v3.27.0

func (m *PcapSetFilterFunction) Unmarshal(b []byte) error

type PcapSetFilterFunctionReply added in v3.27.0

type PcapSetFilterFunctionReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

PcapSetFilterFunctionReply defines message 'pcap_set_filter_function_reply'.

func (*PcapSetFilterFunctionReply) GetCrcString added in v3.27.0

func (*PcapSetFilterFunctionReply) GetCrcString() string

func (*PcapSetFilterFunctionReply) GetMessageName added in v3.27.0

func (*PcapSetFilterFunctionReply) GetMessageName() string

func (*PcapSetFilterFunctionReply) GetMessageType added in v3.27.0

func (*PcapSetFilterFunctionReply) GetMessageType() api.MessageType

func (*PcapSetFilterFunctionReply) Marshal added in v3.27.0

func (m *PcapSetFilterFunctionReply) Marshal(b []byte) ([]byte, error)

func (*PcapSetFilterFunctionReply) Reset added in v3.27.0

func (m *PcapSetFilterFunctionReply) Reset()

func (*PcapSetFilterFunctionReply) Size added in v3.27.0

func (m *PcapSetFilterFunctionReply) Size() (size int)

func (*PcapSetFilterFunctionReply) Unmarshal added in v3.27.0

func (m *PcapSetFilterFunctionReply) Unmarshal(b []byte) error

type PcapTraceOff

type PcapTraceOff struct{}

PcapTraceOff defines message 'pcap_trace_off'.

func (*PcapTraceOff) GetCrcString

func (*PcapTraceOff) GetCrcString() string

func (*PcapTraceOff) GetMessageName

func (*PcapTraceOff) GetMessageName() string

func (*PcapTraceOff) GetMessageType

func (*PcapTraceOff) GetMessageType() api.MessageType

func (*PcapTraceOff) Marshal

func (m *PcapTraceOff) Marshal(b []byte) ([]byte, error)

func (*PcapTraceOff) Reset

func (m *PcapTraceOff) Reset()

func (*PcapTraceOff) Size

func (m *PcapTraceOff) Size() (size int)

func (*PcapTraceOff) Unmarshal

func (m *PcapTraceOff) Unmarshal(b []byte) error

type PcapTraceOffReply

type PcapTraceOffReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

PcapTraceOffReply defines message 'pcap_trace_off_reply'.

func (*PcapTraceOffReply) GetCrcString

func (*PcapTraceOffReply) GetCrcString() string

func (*PcapTraceOffReply) GetMessageName

func (*PcapTraceOffReply) GetMessageName() string

func (*PcapTraceOffReply) GetMessageType

func (*PcapTraceOffReply) GetMessageType() api.MessageType

func (*PcapTraceOffReply) Marshal

func (m *PcapTraceOffReply) Marshal(b []byte) ([]byte, error)

func (*PcapTraceOffReply) Reset

func (m *PcapTraceOffReply) Reset()

func (*PcapTraceOffReply) Size

func (m *PcapTraceOffReply) Size() (size int)

func (*PcapTraceOffReply) Unmarshal

func (m *PcapTraceOffReply) Unmarshal(b []byte) error

type PcapTraceOn

type PcapTraceOn struct {
	CaptureRx         bool                           `binapi:"bool,name=capture_rx" json:"capture_rx,omitempty"`
	CaptureTx         bool                           `binapi:"bool,name=capture_tx" json:"capture_tx,omitempty"`
	CaptureDrop       bool                           `binapi:"bool,name=capture_drop" json:"capture_drop,omitempty"`
	Filter            bool                           `binapi:"bool,name=filter" json:"filter,omitempty"`
	PreallocateData   bool                           `binapi:"bool,name=preallocate_data" json:"preallocate_data,omitempty"`
	FreeData          bool                           `binapi:"bool,name=free_data" json:"free_data,omitempty"`
	MaxPackets        uint32                         `binapi:"u32,name=max_packets,default=1000" json:"max_packets,omitempty"`
	MaxBytesPerPacket uint32                         `binapi:"u32,name=max_bytes_per_packet,default=512" json:"max_bytes_per_packet,omitempty"`
	SwIfIndex         interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Error             string                         `binapi:"string[128],name=error" json:"error,omitempty"`
	Filename          string                         `binapi:"string[64],name=filename" json:"filename,omitempty"`
}

pcap_trace_on

  • capture_rx - capture received packets
  • capture_tx - capture transmitted packets
  • capture_drop - capture dropped packets
  • filter - is a filter is being used on this capture
  • preallocate_data - preallocate the data buffer
  • free_data - free the data buffer
  • max_packets - depth of local buffer
  • max_bytes_per_packet - maximum number of bytes to capture for each packet
  • sw_if_index - specify a given interface, or 0 for any
  • error - filter packets based on a specific error.
  • filename - output filename, will be placed in /tmp

PcapTraceOn defines message 'pcap_trace_on'.

func (*PcapTraceOn) GetCrcString

func (*PcapTraceOn) GetCrcString() string

func (*PcapTraceOn) GetMessageName

func (*PcapTraceOn) GetMessageName() string

func (*PcapTraceOn) GetMessageType

func (*PcapTraceOn) GetMessageType() api.MessageType

func (*PcapTraceOn) Marshal

func (m *PcapTraceOn) Marshal(b []byte) ([]byte, error)

func (*PcapTraceOn) Reset

func (m *PcapTraceOn) Reset()

func (*PcapTraceOn) Size

func (m *PcapTraceOn) Size() (size int)

func (*PcapTraceOn) Unmarshal

func (m *PcapTraceOn) Unmarshal(b []byte) error

type PcapTraceOnReply

type PcapTraceOnReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

PcapTraceOnReply defines message 'pcap_trace_on_reply'.

func (*PcapTraceOnReply) GetCrcString

func (*PcapTraceOnReply) GetCrcString() string

func (*PcapTraceOnReply) GetMessageName

func (*PcapTraceOnReply) GetMessageName() string

func (*PcapTraceOnReply) GetMessageType

func (*PcapTraceOnReply) GetMessageType() api.MessageType

func (*PcapTraceOnReply) Marshal

func (m *PcapTraceOnReply) Marshal(b []byte) ([]byte, error)

func (*PcapTraceOnReply) Reset

func (m *PcapTraceOnReply) Reset()

func (*PcapTraceOnReply) Size

func (m *PcapTraceOnReply) Size() (size int)

func (*PcapTraceOnReply) Unmarshal

func (m *PcapTraceOnReply) Unmarshal(b []byte) error

type RPCService

type RPCService interface {
	CollectDetailedInterfaceStats(ctx context.Context, in *CollectDetailedInterfaceStats) (*CollectDetailedInterfaceStatsReply, error)
	CreateLoopback(ctx context.Context, in *CreateLoopback) (*CreateLoopbackReply, error)
	CreateLoopbackInstance(ctx context.Context, in *CreateLoopbackInstance) (*CreateLoopbackInstanceReply, error)
	CreateSubif(ctx context.Context, in *CreateSubif) (*CreateSubifReply, error)
	CreateVlanSubif(ctx context.Context, in *CreateVlanSubif) (*CreateVlanSubifReply, error)
	DeleteLoopback(ctx context.Context, in *DeleteLoopback) (*DeleteLoopbackReply, error)
	DeleteSubif(ctx context.Context, in *DeleteSubif) (*DeleteSubifReply, error)
	GetBuffersStats(ctx context.Context, in *GetBuffersStats) (*GetBuffersStatsReply, error)
	HwInterfaceSetMtu(ctx context.Context, in *HwInterfaceSetMtu) (*HwInterfaceSetMtuReply, error)
	InterfaceNameRenumber(ctx context.Context, in *InterfaceNameRenumber) (*InterfaceNameRenumberReply, error)
	PcapSetFilterFunction(ctx context.Context, in *PcapSetFilterFunction) (*PcapSetFilterFunctionReply, error)
	PcapTraceOff(ctx context.Context, in *PcapTraceOff) (*PcapTraceOffReply, error)
	PcapTraceOn(ctx context.Context, in *PcapTraceOn) (*PcapTraceOnReply, error)
	SwInterfaceAddDelAddress(ctx context.Context, in *SwInterfaceAddDelAddress) (*SwInterfaceAddDelAddressReply, error)
	SwInterfaceAddDelMacAddress(ctx context.Context, in *SwInterfaceAddDelMacAddress) (*SwInterfaceAddDelMacAddressReply, error)
	SwInterfaceAddressReplaceBegin(ctx context.Context, in *SwInterfaceAddressReplaceBegin) (*SwInterfaceAddressReplaceBeginReply, error)
	SwInterfaceAddressReplaceEnd(ctx context.Context, in *SwInterfaceAddressReplaceEnd) (*SwInterfaceAddressReplaceEndReply, error)
	SwInterfaceClearStats(ctx context.Context, in *SwInterfaceClearStats) (*SwInterfaceClearStatsReply, error)
	SwInterfaceDump(ctx context.Context, in *SwInterfaceDump) (RPCService_SwInterfaceDumpClient, error)
	SwInterfaceGetMacAddress(ctx context.Context, in *SwInterfaceGetMacAddress) (*SwInterfaceGetMacAddressReply, error)
	SwInterfaceGetTable(ctx context.Context, in *SwInterfaceGetTable) (*SwInterfaceGetTableReply, error)
	SwInterfaceRxPlacementDump(ctx context.Context, in *SwInterfaceRxPlacementDump) (RPCService_SwInterfaceRxPlacementDumpClient, error)
	SwInterfaceSetFlags(ctx context.Context, in *SwInterfaceSetFlags) (*SwInterfaceSetFlagsReply, error)
	SwInterfaceSetInterfaceName(ctx context.Context, in *SwInterfaceSetInterfaceName) (*SwInterfaceSetInterfaceNameReply, error)
	SwInterfaceSetIPDirectedBroadcast(ctx context.Context, in *SwInterfaceSetIPDirectedBroadcast) (*SwInterfaceSetIPDirectedBroadcastReply, error)
	SwInterfaceSetMacAddress(ctx context.Context, in *SwInterfaceSetMacAddress) (*SwInterfaceSetMacAddressReply, error)
	SwInterfaceSetMtu(ctx context.Context, in *SwInterfaceSetMtu) (*SwInterfaceSetMtuReply, error)
	SwInterfaceSetPromisc(ctx context.Context, in *SwInterfaceSetPromisc) (*SwInterfaceSetPromiscReply, error)
	SwInterfaceSetRxMode(ctx context.Context, in *SwInterfaceSetRxMode) (*SwInterfaceSetRxModeReply, error)
	SwInterfaceSetRxPlacement(ctx context.Context, in *SwInterfaceSetRxPlacement) (*SwInterfaceSetRxPlacementReply, error)
	SwInterfaceSetTable(ctx context.Context, in *SwInterfaceSetTable) (*SwInterfaceSetTableReply, error)
	SwInterfaceSetTxPlacement(ctx context.Context, in *SwInterfaceSetTxPlacement) (*SwInterfaceSetTxPlacementReply, error)
	SwInterfaceSetUnnumbered(ctx context.Context, in *SwInterfaceSetUnnumbered) (*SwInterfaceSetUnnumberedReply, error)
	SwInterfaceTagAddDel(ctx context.Context, in *SwInterfaceTagAddDel) (*SwInterfaceTagAddDelReply, error)
	SwInterfaceTxPlacementGet(ctx context.Context, in *SwInterfaceTxPlacementGet) (RPCService_SwInterfaceTxPlacementGetClient, error)
	WantInterfaceEvents(ctx context.Context, in *WantInterfaceEvents) (*WantInterfaceEventsReply, error)
}

RPCService defines RPC service interface.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_SwInterfaceDumpClient

type RPCService_SwInterfaceDumpClient interface {
	Recv() (*SwInterfaceDetails, error)
	api.Stream
}

type RPCService_SwInterfaceRxPlacementDumpClient

type RPCService_SwInterfaceRxPlacementDumpClient interface {
	Recv() (*SwInterfaceRxPlacementDetails, error)
	api.Stream
}

type RPCService_SwInterfaceTxPlacementGetClient

type RPCService_SwInterfaceTxPlacementGetClient interface {
	Recv() (*SwInterfaceTxPlacementDetails, *SwInterfaceTxPlacementGetReply, error)
	api.Stream
}

type SwInterfaceAddDelAddress

type SwInterfaceAddDelAddress struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsAdd     bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	DelAll    bool                           `binapi:"bool,name=del_all" json:"del_all,omitempty"`
	Prefix    ip_types.AddressWithPrefix     `binapi:"address_with_prefix,name=prefix" json:"prefix,omitempty"`
}

Set or delete one or all ip addresses on a specified interface

  • sw_if_index - index of the interface to add/del addresses
  • is_add - add address if non-zero, else delete
  • del_all - if non-zero delete all addresses on the interface
  • prefix - address + a prefix length for the implied connected route

SwInterfaceAddDelAddress defines message 'sw_interface_add_del_address'.

func (*SwInterfaceAddDelAddress) GetCrcString

func (*SwInterfaceAddDelAddress) GetCrcString() string

func (*SwInterfaceAddDelAddress) GetMessageName

func (*SwInterfaceAddDelAddress) GetMessageName() string

func (*SwInterfaceAddDelAddress) GetMessageType

func (*SwInterfaceAddDelAddress) GetMessageType() api.MessageType

func (*SwInterfaceAddDelAddress) Marshal

func (m *SwInterfaceAddDelAddress) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddDelAddress) Reset

func (m *SwInterfaceAddDelAddress) Reset()

func (*SwInterfaceAddDelAddress) Size

func (m *SwInterfaceAddDelAddress) Size() (size int)

func (*SwInterfaceAddDelAddress) Unmarshal

func (m *SwInterfaceAddDelAddress) Unmarshal(b []byte) error

type SwInterfaceAddDelAddressReply

type SwInterfaceAddDelAddressReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceAddDelAddressReply defines message 'sw_interface_add_del_address_reply'.

func (*SwInterfaceAddDelAddressReply) GetCrcString

func (*SwInterfaceAddDelAddressReply) GetCrcString() string

func (*SwInterfaceAddDelAddressReply) GetMessageName

func (*SwInterfaceAddDelAddressReply) GetMessageName() string

func (*SwInterfaceAddDelAddressReply) GetMessageType

func (*SwInterfaceAddDelAddressReply) GetMessageType() api.MessageType

func (*SwInterfaceAddDelAddressReply) Marshal

func (m *SwInterfaceAddDelAddressReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddDelAddressReply) Reset

func (m *SwInterfaceAddDelAddressReply) Reset()

func (*SwInterfaceAddDelAddressReply) Size

func (m *SwInterfaceAddDelAddressReply) Size() (size int)

func (*SwInterfaceAddDelAddressReply) Unmarshal

func (m *SwInterfaceAddDelAddressReply) Unmarshal(b []byte) error

type SwInterfaceAddDelMacAddress

type SwInterfaceAddDelMacAddress struct {
	SwIfIndex uint32                    `binapi:"u32,name=sw_if_index" json:"sw_if_index,omitempty"`
	Addr      ethernet_types.MacAddress `binapi:"mac_address,name=addr" json:"addr,omitempty"`
	IsAdd     uint8                     `binapi:"u8,name=is_add" json:"is_add,omitempty"`
}

Add or delete a secondary MAC address on an interface

  • sw_if_index - the interface whose MAC will be set
  • mac_addr - the new MAC address
  • is_add - 0 to delete, != 0 to add

SwInterfaceAddDelMacAddress defines message 'sw_interface_add_del_mac_address'.

func (*SwInterfaceAddDelMacAddress) GetCrcString

func (*SwInterfaceAddDelMacAddress) GetCrcString() string

func (*SwInterfaceAddDelMacAddress) GetMessageName

func (*SwInterfaceAddDelMacAddress) GetMessageName() string

func (*SwInterfaceAddDelMacAddress) GetMessageType

func (*SwInterfaceAddDelMacAddress) GetMessageType() api.MessageType

func (*SwInterfaceAddDelMacAddress) Marshal

func (m *SwInterfaceAddDelMacAddress) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddDelMacAddress) Reset

func (m *SwInterfaceAddDelMacAddress) Reset()

func (*SwInterfaceAddDelMacAddress) Size

func (m *SwInterfaceAddDelMacAddress) Size() (size int)

func (*SwInterfaceAddDelMacAddress) Unmarshal

func (m *SwInterfaceAddDelMacAddress) Unmarshal(b []byte) error

type SwInterfaceAddDelMacAddressReply

type SwInterfaceAddDelMacAddressReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceAddDelMacAddressReply defines message 'sw_interface_add_del_mac_address_reply'.

func (*SwInterfaceAddDelMacAddressReply) GetCrcString

func (*SwInterfaceAddDelMacAddressReply) GetCrcString() string

func (*SwInterfaceAddDelMacAddressReply) GetMessageName

func (*SwInterfaceAddDelMacAddressReply) GetMessageName() string

func (*SwInterfaceAddDelMacAddressReply) GetMessageType

func (*SwInterfaceAddDelMacAddressReply) Marshal

func (m *SwInterfaceAddDelMacAddressReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddDelMacAddressReply) Reset

func (*SwInterfaceAddDelMacAddressReply) Size

func (m *SwInterfaceAddDelMacAddressReply) Size() (size int)

func (*SwInterfaceAddDelMacAddressReply) Unmarshal

func (m *SwInterfaceAddDelMacAddressReply) Unmarshal(b []byte) error

type SwInterfaceAddressReplaceBegin

type SwInterfaceAddressReplaceBegin struct{}

IP interface address replace begin

The use-case is that, for some unspecified reason, the control plane
has a different set of interface addresses than VPP
currently has. The CP would thus like to 'replace' VPP's set
only by specifying what the new set shall be, i.e. it is not
going to delete anything that already eixts, rather, is wants any
unspecified interface addresses to be deleted implicitly.
The CP declares the start of this procedure with this replace_begin
API Call, and when it has populated all addresses it wants, it calls
the below replace_end API. From this point on it is of course free
to add and delete interface addresses as usual.
The underlying mechanism by which VPP implements this replace is
intentionally left unspecified.

SwInterfaceAddressReplaceBegin defines message 'sw_interface_address_replace_begin'.

func (*SwInterfaceAddressReplaceBegin) GetCrcString

func (*SwInterfaceAddressReplaceBegin) GetCrcString() string

func (*SwInterfaceAddressReplaceBegin) GetMessageName

func (*SwInterfaceAddressReplaceBegin) GetMessageName() string

func (*SwInterfaceAddressReplaceBegin) GetMessageType

func (*SwInterfaceAddressReplaceBegin) Marshal

func (m *SwInterfaceAddressReplaceBegin) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddressReplaceBegin) Reset

func (m *SwInterfaceAddressReplaceBegin) Reset()

func (*SwInterfaceAddressReplaceBegin) Size

func (m *SwInterfaceAddressReplaceBegin) Size() (size int)

func (*SwInterfaceAddressReplaceBegin) Unmarshal

func (m *SwInterfaceAddressReplaceBegin) Unmarshal(b []byte) error

type SwInterfaceAddressReplaceBeginReply

type SwInterfaceAddressReplaceBeginReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceAddressReplaceBeginReply defines message 'sw_interface_address_replace_begin_reply'.

func (*SwInterfaceAddressReplaceBeginReply) GetCrcString

func (*SwInterfaceAddressReplaceBeginReply) GetMessageName

func (*SwInterfaceAddressReplaceBeginReply) GetMessageName() string

func (*SwInterfaceAddressReplaceBeginReply) GetMessageType

func (*SwInterfaceAddressReplaceBeginReply) Marshal

func (m *SwInterfaceAddressReplaceBeginReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddressReplaceBeginReply) Reset

func (*SwInterfaceAddressReplaceBeginReply) Size

func (m *SwInterfaceAddressReplaceBeginReply) Size() (size int)

func (*SwInterfaceAddressReplaceBeginReply) Unmarshal

type SwInterfaceAddressReplaceEnd

type SwInterfaceAddressReplaceEnd struct{}

IP interface address replace end

see ip_interface_address_replace_begin description.

SwInterfaceAddressReplaceEnd defines message 'sw_interface_address_replace_end'.

func (*SwInterfaceAddressReplaceEnd) GetCrcString

func (*SwInterfaceAddressReplaceEnd) GetCrcString() string

func (*SwInterfaceAddressReplaceEnd) GetMessageName

func (*SwInterfaceAddressReplaceEnd) GetMessageName() string

func (*SwInterfaceAddressReplaceEnd) GetMessageType

func (*SwInterfaceAddressReplaceEnd) GetMessageType() api.MessageType

func (*SwInterfaceAddressReplaceEnd) Marshal

func (m *SwInterfaceAddressReplaceEnd) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddressReplaceEnd) Reset

func (m *SwInterfaceAddressReplaceEnd) Reset()

func (*SwInterfaceAddressReplaceEnd) Size

func (m *SwInterfaceAddressReplaceEnd) Size() (size int)

func (*SwInterfaceAddressReplaceEnd) Unmarshal

func (m *SwInterfaceAddressReplaceEnd) Unmarshal(b []byte) error

type SwInterfaceAddressReplaceEndReply

type SwInterfaceAddressReplaceEndReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceAddressReplaceEndReply defines message 'sw_interface_address_replace_end_reply'.

func (*SwInterfaceAddressReplaceEndReply) GetCrcString

func (*SwInterfaceAddressReplaceEndReply) GetCrcString() string

func (*SwInterfaceAddressReplaceEndReply) GetMessageName

func (*SwInterfaceAddressReplaceEndReply) GetMessageName() string

func (*SwInterfaceAddressReplaceEndReply) GetMessageType

func (*SwInterfaceAddressReplaceEndReply) Marshal

func (m *SwInterfaceAddressReplaceEndReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceAddressReplaceEndReply) Reset

func (*SwInterfaceAddressReplaceEndReply) Size

func (m *SwInterfaceAddressReplaceEndReply) Size() (size int)

func (*SwInterfaceAddressReplaceEndReply) Unmarshal

func (m *SwInterfaceAddressReplaceEndReply) Unmarshal(b []byte) error

type SwInterfaceClearStats

type SwInterfaceClearStats struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Clear interface statistics

  • sw_if_index - index of the interface to clear statistics

SwInterfaceClearStats defines message 'sw_interface_clear_stats'.

func (*SwInterfaceClearStats) GetCrcString

func (*SwInterfaceClearStats) GetCrcString() string

func (*SwInterfaceClearStats) GetMessageName

func (*SwInterfaceClearStats) GetMessageName() string

func (*SwInterfaceClearStats) GetMessageType

func (*SwInterfaceClearStats) GetMessageType() api.MessageType

func (*SwInterfaceClearStats) Marshal

func (m *SwInterfaceClearStats) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceClearStats) Reset

func (m *SwInterfaceClearStats) Reset()

func (*SwInterfaceClearStats) Size

func (m *SwInterfaceClearStats) Size() (size int)

func (*SwInterfaceClearStats) Unmarshal

func (m *SwInterfaceClearStats) Unmarshal(b []byte) error

type SwInterfaceClearStatsReply

type SwInterfaceClearStatsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceClearStatsReply defines message 'sw_interface_clear_stats_reply'.

func (*SwInterfaceClearStatsReply) GetCrcString

func (*SwInterfaceClearStatsReply) GetCrcString() string

func (*SwInterfaceClearStatsReply) GetMessageName

func (*SwInterfaceClearStatsReply) GetMessageName() string

func (*SwInterfaceClearStatsReply) GetMessageType

func (*SwInterfaceClearStatsReply) GetMessageType() api.MessageType

func (*SwInterfaceClearStatsReply) Marshal

func (m *SwInterfaceClearStatsReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceClearStatsReply) Reset

func (m *SwInterfaceClearStatsReply) Reset()

func (*SwInterfaceClearStatsReply) Size

func (m *SwInterfaceClearStatsReply) Size() (size int)

func (*SwInterfaceClearStatsReply) Unmarshal

func (m *SwInterfaceClearStatsReply) Unmarshal(b []byte) error

type SwInterfaceDetails

type SwInterfaceDetails struct {
	SwIfIndex        interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	SupSwIfIndex     uint32                         `binapi:"u32,name=sup_sw_if_index" json:"sup_sw_if_index,omitempty"`
	L2Address        ethernet_types.MacAddress      `binapi:"mac_address,name=l2_address" json:"l2_address,omitempty"`
	Flags            interface_types.IfStatusFlags  `binapi:"if_status_flags,name=flags" json:"flags,omitempty"`
	Type             interface_types.IfType         `binapi:"if_type,name=type" json:"type,omitempty"`
	LinkDuplex       interface_types.LinkDuplex     `binapi:"link_duplex,name=link_duplex" json:"link_duplex,omitempty"`
	LinkSpeed        uint32                         `binapi:"u32,name=link_speed" json:"link_speed,omitempty"`
	LinkMtu          uint16                         `binapi:"u16,name=link_mtu" json:"link_mtu,omitempty"`
	Mtu              []uint32                       `binapi:"u32[4],name=mtu" json:"mtu,omitempty"`
	SubID            uint32                         `binapi:"u32,name=sub_id" json:"sub_id,omitempty"`
	SubNumberOfTags  uint8                          `binapi:"u8,name=sub_number_of_tags" json:"sub_number_of_tags,omitempty"`
	SubOuterVlanID   uint16                         `binapi:"u16,name=sub_outer_vlan_id" json:"sub_outer_vlan_id,omitempty"`
	SubInnerVlanID   uint16                         `binapi:"u16,name=sub_inner_vlan_id" json:"sub_inner_vlan_id,omitempty"`
	SubIfFlags       interface_types.SubIfFlags     `binapi:"sub_if_flags,name=sub_if_flags" json:"sub_if_flags,omitempty"`
	VtrOp            uint32                         `binapi:"u32,name=vtr_op" json:"vtr_op,omitempty"`
	VtrPushDot1q     uint32                         `binapi:"u32,name=vtr_push_dot1q" json:"vtr_push_dot1q,omitempty"`
	VtrTag1          uint32                         `binapi:"u32,name=vtr_tag1" json:"vtr_tag1,omitempty"`
	VtrTag2          uint32                         `binapi:"u32,name=vtr_tag2" json:"vtr_tag2,omitempty"`
	OuterTag         uint16                         `binapi:"u16,name=outer_tag" json:"outer_tag,omitempty"`
	BDmac            ethernet_types.MacAddress      `binapi:"mac_address,name=b_dmac" json:"b_dmac,omitempty"`
	BSmac            ethernet_types.MacAddress      `binapi:"mac_address,name=b_smac" json:"b_smac,omitempty"`
	BVlanid          uint16                         `binapi:"u16,name=b_vlanid" json:"b_vlanid,omitempty"`
	ISid             uint32                         `binapi:"u32,name=i_sid" json:"i_sid,omitempty"`
	InterfaceName    string                         `binapi:"string[64],name=interface_name" json:"interface_name,omitempty"`
	InterfaceDevType string                         `binapi:"string[64],name=interface_dev_type" json:"interface_dev_type,omitempty"`
	Tag              string                         `binapi:"string[64],name=tag" json:"tag,omitempty"`
}

Interface details structure (fix this)

  • sw_if_index - index of the interface
  • sup_sw_if_index - index of parent interface if any, else same as sw_if_index
  • l2_address - the interface's l2 address
  • flags - interface_status flags
  • type - interface type
  • link_duplex - 1 if half duplex, 2 if full duplex
  • link_speed - value in kbps
  • link_MTU - max. transmission unit
  • sub_id - A number 0-N to uniquely identify this subif on super if
  • sub_number_of_tags - Number of tags (0 - 2)
  • sub_outer_vlan_id
  • sub_inner_vlan_id
  • sub_if_flags - sub interface flags
  • vtr_op - vlan tag rewrite operation
  • vtr_push_dot1q
  • vtr_tag1
  • vtr_tag2
  • pbb_outer_tag - translate pbb s-tag
  • pbb_b_dmac[6] - B-tag remote mac address
  • pbb_b_smac[6] - B-tag local mac address
  • pbb_b_vlanid - B-tag vlanid
  • pbb_i_sid - I-tag service id
  • interface_name - name of the interface
  • interface_dev_type - device type of the interface
  • tag - an ascii tag

SwInterfaceDetails defines message 'sw_interface_details'.

func (*SwInterfaceDetails) GetCrcString

func (*SwInterfaceDetails) GetCrcString() string

func (*SwInterfaceDetails) GetMessageName

func (*SwInterfaceDetails) GetMessageName() string

func (*SwInterfaceDetails) GetMessageType

func (*SwInterfaceDetails) GetMessageType() api.MessageType

func (*SwInterfaceDetails) Marshal

func (m *SwInterfaceDetails) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceDetails) Reset

func (m *SwInterfaceDetails) Reset()

func (*SwInterfaceDetails) Size

func (m *SwInterfaceDetails) Size() (size int)

func (*SwInterfaceDetails) Unmarshal

func (m *SwInterfaceDetails) Unmarshal(b []byte) error

type SwInterfaceDump

type SwInterfaceDump struct {
	SwIfIndex       interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
	NameFilterValid bool                           `binapi:"bool,name=name_filter_valid" json:"name_filter_valid,omitempty"`
	NameFilter      string                         `binapi:"string[],name=name_filter" json:"name_filter,omitempty"`
}

Request all or filtered subset of sw_interface_details

  • sw_if_index - index of the interface to dump info on, 0 or ~0 if on all TODO: Support selecting only index==0 when CSIT is ready.
  • name_filter_valid - 1 if requesting a filtered subset of records else 0 if name filter is set as valid, sw_if_index value is ignored and all interfaces are examined
  • name_filter - interface name substring filter. Eg. loop1 returns [loop1, loop10]

SwInterfaceDump defines message 'sw_interface_dump'.

func (*SwInterfaceDump) GetCrcString

func (*SwInterfaceDump) GetCrcString() string

func (*SwInterfaceDump) GetMessageName

func (*SwInterfaceDump) GetMessageName() string

func (*SwInterfaceDump) GetMessageType

func (*SwInterfaceDump) GetMessageType() api.MessageType

func (*SwInterfaceDump) Marshal

func (m *SwInterfaceDump) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceDump) Reset

func (m *SwInterfaceDump) Reset()

func (*SwInterfaceDump) Size

func (m *SwInterfaceDump) Size() (size int)

func (*SwInterfaceDump) Unmarshal

func (m *SwInterfaceDump) Unmarshal(b []byte) error

type SwInterfaceEvent

type SwInterfaceEvent struct {
	PID       uint32                         `binapi:"u32,name=pid" json:"pid,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Flags     interface_types.IfStatusFlags  `binapi:"if_status_flags,name=flags" json:"flags,omitempty"`
	Deleted   bool                           `binapi:"bool,name=deleted" json:"deleted,omitempty"`
}

Interface Event generated by want_interface_events

  • pid - client pid registered to receive notification
  • sw_if_index - index of the interface of the event
  • flags - interface_status flags
  • deleted - interface was deleted

SwInterfaceEvent defines message 'sw_interface_event'.

func (*SwInterfaceEvent) GetCrcString

func (*SwInterfaceEvent) GetCrcString() string

func (*SwInterfaceEvent) GetMessageName

func (*SwInterfaceEvent) GetMessageName() string

func (*SwInterfaceEvent) GetMessageType

func (*SwInterfaceEvent) GetMessageType() api.MessageType

func (*SwInterfaceEvent) Marshal

func (m *SwInterfaceEvent) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceEvent) Reset

func (m *SwInterfaceEvent) Reset()

func (*SwInterfaceEvent) Size

func (m *SwInterfaceEvent) Size() (size int)

func (*SwInterfaceEvent) Unmarshal

func (m *SwInterfaceEvent) Unmarshal(b []byte) error

type SwInterfaceGetMacAddress

type SwInterfaceGetMacAddress struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Get interface's MAC address

  • sw_if_index - the interface whose MAC will be returned

SwInterfaceGetMacAddress defines message 'sw_interface_get_mac_address'.

func (*SwInterfaceGetMacAddress) GetCrcString

func (*SwInterfaceGetMacAddress) GetCrcString() string

func (*SwInterfaceGetMacAddress) GetMessageName

func (*SwInterfaceGetMacAddress) GetMessageName() string

func (*SwInterfaceGetMacAddress) GetMessageType

func (*SwInterfaceGetMacAddress) GetMessageType() api.MessageType

func (*SwInterfaceGetMacAddress) Marshal

func (m *SwInterfaceGetMacAddress) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceGetMacAddress) Reset

func (m *SwInterfaceGetMacAddress) Reset()

func (*SwInterfaceGetMacAddress) Size

func (m *SwInterfaceGetMacAddress) Size() (size int)

func (*SwInterfaceGetMacAddress) Unmarshal

func (m *SwInterfaceGetMacAddress) Unmarshal(b []byte) error

type SwInterfaceGetMacAddressReply

type SwInterfaceGetMacAddressReply struct {
	Retval     int32                     `binapi:"i32,name=retval" json:"retval,omitempty"`
	MacAddress ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
}

Reply for get interface's MAC address request

  • retval - return code
  • mac_addr - returned interface's MAC address

SwInterfaceGetMacAddressReply defines message 'sw_interface_get_mac_address_reply'.

func (*SwInterfaceGetMacAddressReply) GetCrcString

func (*SwInterfaceGetMacAddressReply) GetCrcString() string

func (*SwInterfaceGetMacAddressReply) GetMessageName

func (*SwInterfaceGetMacAddressReply) GetMessageName() string

func (*SwInterfaceGetMacAddressReply) GetMessageType

func (*SwInterfaceGetMacAddressReply) GetMessageType() api.MessageType

func (*SwInterfaceGetMacAddressReply) Marshal

func (m *SwInterfaceGetMacAddressReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceGetMacAddressReply) Reset

func (m *SwInterfaceGetMacAddressReply) Reset()

func (*SwInterfaceGetMacAddressReply) Size

func (m *SwInterfaceGetMacAddressReply) Size() (size int)

func (*SwInterfaceGetMacAddressReply) Unmarshal

func (m *SwInterfaceGetMacAddressReply) Unmarshal(b []byte) error

type SwInterfaceGetTable

type SwInterfaceGetTable struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsIPv6    bool                           `binapi:"bool,name=is_ipv6" json:"is_ipv6,omitempty"`
}

Get VRF id assigned to interface

  • sw_if_index - index of the interface

SwInterfaceGetTable defines message 'sw_interface_get_table'.

func (*SwInterfaceGetTable) GetCrcString

func (*SwInterfaceGetTable) GetCrcString() string

func (*SwInterfaceGetTable) GetMessageName

func (*SwInterfaceGetTable) GetMessageName() string

func (*SwInterfaceGetTable) GetMessageType

func (*SwInterfaceGetTable) GetMessageType() api.MessageType

func (*SwInterfaceGetTable) Marshal

func (m *SwInterfaceGetTable) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceGetTable) Reset

func (m *SwInterfaceGetTable) Reset()

func (*SwInterfaceGetTable) Size

func (m *SwInterfaceGetTable) Size() (size int)

func (*SwInterfaceGetTable) Unmarshal

func (m *SwInterfaceGetTable) Unmarshal(b []byte) error

type SwInterfaceGetTableReply

type SwInterfaceGetTableReply struct {
	Retval int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	VrfID  uint32 `binapi:"u32,name=vrf_id" json:"vrf_id,omitempty"`
}

Reply to get_sw_interface_vrf

  • vrf_id - VRF id assigned to the interface

SwInterfaceGetTableReply defines message 'sw_interface_get_table_reply'.

func (*SwInterfaceGetTableReply) GetCrcString

func (*SwInterfaceGetTableReply) GetCrcString() string

func (*SwInterfaceGetTableReply) GetMessageName

func (*SwInterfaceGetTableReply) GetMessageName() string

func (*SwInterfaceGetTableReply) GetMessageType

func (*SwInterfaceGetTableReply) GetMessageType() api.MessageType

func (*SwInterfaceGetTableReply) Marshal

func (m *SwInterfaceGetTableReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceGetTableReply) Reset

func (m *SwInterfaceGetTableReply) Reset()

func (*SwInterfaceGetTableReply) Size

func (m *SwInterfaceGetTableReply) Size() (size int)

func (*SwInterfaceGetTableReply) Unmarshal

func (m *SwInterfaceGetTableReply) Unmarshal(b []byte) error

type SwInterfaceRxPlacementDetails

type SwInterfaceRxPlacementDetails struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	QueueID   uint32                         `binapi:"u32,name=queue_id" json:"queue_id,omitempty"`
	WorkerID  uint32                         `binapi:"u32,name=worker_id" json:"worker_id,omitempty"`
	Mode      interface_types.RxMode         `binapi:"rx_mode,name=mode" json:"mode,omitempty"`
}

show the interface's queue - thread placement

This api is used to display the interface and queue worker
thread placement. One message per rx-queue per interface will
be sent to client.
Each message will contain information about rx-queue id of an
interface, interface index, thread on which this rx-queue is
placed and mode of rx-queue.
- sw_if_index - the interface whose rx-placement will be dumped
- queue_id - the queue id
- worker_id - the worker id on which queue_id is placed,
                   worker_id = 0 means main thread.
- mode - polling=1, interrupt=2, adaptive=3

SwInterfaceRxPlacementDetails defines message 'sw_interface_rx_placement_details'.

func (*SwInterfaceRxPlacementDetails) GetCrcString

func (*SwInterfaceRxPlacementDetails) GetCrcString() string

func (*SwInterfaceRxPlacementDetails) GetMessageName

func (*SwInterfaceRxPlacementDetails) GetMessageName() string

func (*SwInterfaceRxPlacementDetails) GetMessageType

func (*SwInterfaceRxPlacementDetails) GetMessageType() api.MessageType

func (*SwInterfaceRxPlacementDetails) Marshal

func (m *SwInterfaceRxPlacementDetails) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceRxPlacementDetails) Reset

func (m *SwInterfaceRxPlacementDetails) Reset()

func (*SwInterfaceRxPlacementDetails) Size

func (m *SwInterfaceRxPlacementDetails) Size() (size int)

func (*SwInterfaceRxPlacementDetails) Unmarshal

func (m *SwInterfaceRxPlacementDetails) Unmarshal(b []byte) error

type SwInterfaceRxPlacementDump

type SwInterfaceRxPlacementDump struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

dump the rx queue placement of interface(s)

  • sw_if_index - optional interface index for which queue placement to be requested. sw_if_index = ~0 will dump placement information for all interfaces. It will not dump information related to sub-interfaces, p2p and pipe interfaces.

SwInterfaceRxPlacementDump defines message 'sw_interface_rx_placement_dump'.

func (*SwInterfaceRxPlacementDump) GetCrcString

func (*SwInterfaceRxPlacementDump) GetCrcString() string

func (*SwInterfaceRxPlacementDump) GetMessageName

func (*SwInterfaceRxPlacementDump) GetMessageName() string

func (*SwInterfaceRxPlacementDump) GetMessageType

func (*SwInterfaceRxPlacementDump) GetMessageType() api.MessageType

func (*SwInterfaceRxPlacementDump) Marshal

func (m *SwInterfaceRxPlacementDump) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceRxPlacementDump) Reset

func (m *SwInterfaceRxPlacementDump) Reset()

func (*SwInterfaceRxPlacementDump) Size

func (m *SwInterfaceRxPlacementDump) Size() (size int)

func (*SwInterfaceRxPlacementDump) Unmarshal

func (m *SwInterfaceRxPlacementDump) Unmarshal(b []byte) error

type SwInterfaceSetFlags

type SwInterfaceSetFlags struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Flags     interface_types.IfStatusFlags  `binapi:"if_status_flags,name=flags" json:"flags,omitempty"`
}

Set flags on the interface

  • sw_if_index - index of the interface to set flags on
  • flags - interface_status flags (only IF_STATUS_API_FLAG_ADMIN_UP used in config)

SwInterfaceSetFlags defines message 'sw_interface_set_flags'.

func (*SwInterfaceSetFlags) GetCrcString

func (*SwInterfaceSetFlags) GetCrcString() string

func (*SwInterfaceSetFlags) GetMessageName

func (*SwInterfaceSetFlags) GetMessageName() string

func (*SwInterfaceSetFlags) GetMessageType

func (*SwInterfaceSetFlags) GetMessageType() api.MessageType

func (*SwInterfaceSetFlags) Marshal

func (m *SwInterfaceSetFlags) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetFlags) Reset

func (m *SwInterfaceSetFlags) Reset()

func (*SwInterfaceSetFlags) Size

func (m *SwInterfaceSetFlags) Size() (size int)

func (*SwInterfaceSetFlags) Unmarshal

func (m *SwInterfaceSetFlags) Unmarshal(b []byte) error

type SwInterfaceSetFlagsReply

type SwInterfaceSetFlagsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetFlagsReply defines message 'sw_interface_set_flags_reply'.

func (*SwInterfaceSetFlagsReply) GetCrcString

func (*SwInterfaceSetFlagsReply) GetCrcString() string

func (*SwInterfaceSetFlagsReply) GetMessageName

func (*SwInterfaceSetFlagsReply) GetMessageName() string

func (*SwInterfaceSetFlagsReply) GetMessageType

func (*SwInterfaceSetFlagsReply) GetMessageType() api.MessageType

func (*SwInterfaceSetFlagsReply) Marshal

func (m *SwInterfaceSetFlagsReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetFlagsReply) Reset

func (m *SwInterfaceSetFlagsReply) Reset()

func (*SwInterfaceSetFlagsReply) Size

func (m *SwInterfaceSetFlagsReply) Size() (size int)

func (*SwInterfaceSetFlagsReply) Unmarshal

func (m *SwInterfaceSetFlagsReply) Unmarshal(b []byte) error

type SwInterfaceSetIPDirectedBroadcast

type SwInterfaceSetIPDirectedBroadcast struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Enable    bool                           `binapi:"bool,name=enable" json:"enable,omitempty"`
}

Set IP4 directed broadcast

The directed broadcast enabled a packet sent to the interface's
subnet address will be broadcast on the interface
- sw_if_index
- enable

SwInterfaceSetIPDirectedBroadcast defines message 'sw_interface_set_ip_directed_broadcast'.

func (*SwInterfaceSetIPDirectedBroadcast) GetCrcString

func (*SwInterfaceSetIPDirectedBroadcast) GetCrcString() string

func (*SwInterfaceSetIPDirectedBroadcast) GetMessageName

func (*SwInterfaceSetIPDirectedBroadcast) GetMessageName() string

func (*SwInterfaceSetIPDirectedBroadcast) GetMessageType

func (*SwInterfaceSetIPDirectedBroadcast) Marshal

func (m *SwInterfaceSetIPDirectedBroadcast) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetIPDirectedBroadcast) Reset

func (*SwInterfaceSetIPDirectedBroadcast) Size

func (m *SwInterfaceSetIPDirectedBroadcast) Size() (size int)

func (*SwInterfaceSetIPDirectedBroadcast) Unmarshal

func (m *SwInterfaceSetIPDirectedBroadcast) Unmarshal(b []byte) error

type SwInterfaceSetIPDirectedBroadcastReply

type SwInterfaceSetIPDirectedBroadcastReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetIPDirectedBroadcastReply defines message 'sw_interface_set_ip_directed_broadcast_reply'.

func (*SwInterfaceSetIPDirectedBroadcastReply) GetCrcString

func (*SwInterfaceSetIPDirectedBroadcastReply) GetMessageName

func (*SwInterfaceSetIPDirectedBroadcastReply) GetMessageType

func (*SwInterfaceSetIPDirectedBroadcastReply) Marshal

func (*SwInterfaceSetIPDirectedBroadcastReply) Reset

func (*SwInterfaceSetIPDirectedBroadcastReply) Size

func (*SwInterfaceSetIPDirectedBroadcastReply) Unmarshal

type SwInterfaceSetInterfaceName

type SwInterfaceSetInterfaceName struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Name      string                         `binapi:"string[64],name=name" json:"name,omitempty"`
}

Set custom interface name

Set custom interface name for the interface.
- sw_if_index - the interface whose name will be set
- name - the custom interface name to be set

k SwInterfaceSetInterfaceName defines message 'sw_interface_set_interface_name'.

func (*SwInterfaceSetInterfaceName) GetCrcString

func (*SwInterfaceSetInterfaceName) GetCrcString() string

func (*SwInterfaceSetInterfaceName) GetMessageName

func (*SwInterfaceSetInterfaceName) GetMessageName() string

func (*SwInterfaceSetInterfaceName) GetMessageType

func (*SwInterfaceSetInterfaceName) GetMessageType() api.MessageType

func (*SwInterfaceSetInterfaceName) Marshal

func (m *SwInterfaceSetInterfaceName) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetInterfaceName) Reset

func (m *SwInterfaceSetInterfaceName) Reset()

func (*SwInterfaceSetInterfaceName) Size

func (m *SwInterfaceSetInterfaceName) Size() (size int)

func (*SwInterfaceSetInterfaceName) Unmarshal

func (m *SwInterfaceSetInterfaceName) Unmarshal(b []byte) error

type SwInterfaceSetInterfaceNameReply

type SwInterfaceSetInterfaceNameReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetInterfaceNameReply defines message 'sw_interface_set_interface_name_reply'.

func (*SwInterfaceSetInterfaceNameReply) GetCrcString

func (*SwInterfaceSetInterfaceNameReply) GetCrcString() string

func (*SwInterfaceSetInterfaceNameReply) GetMessageName

func (*SwInterfaceSetInterfaceNameReply) GetMessageName() string

func (*SwInterfaceSetInterfaceNameReply) GetMessageType

func (*SwInterfaceSetInterfaceNameReply) Marshal

func (m *SwInterfaceSetInterfaceNameReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetInterfaceNameReply) Reset

func (*SwInterfaceSetInterfaceNameReply) Size

func (m *SwInterfaceSetInterfaceNameReply) Size() (size int)

func (*SwInterfaceSetInterfaceNameReply) Unmarshal

func (m *SwInterfaceSetInterfaceNameReply) Unmarshal(b []byte) error

type SwInterfaceSetMacAddress

type SwInterfaceSetMacAddress struct {
	SwIfIndex  interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	MacAddress ethernet_types.MacAddress      `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
}

Set an interface's MAC address

  • sw_if_index - the interface whose MAC will be set
  • mac_addr - the new MAC address

SwInterfaceSetMacAddress defines message 'sw_interface_set_mac_address'.

func (*SwInterfaceSetMacAddress) GetCrcString

func (*SwInterfaceSetMacAddress) GetCrcString() string

func (*SwInterfaceSetMacAddress) GetMessageName

func (*SwInterfaceSetMacAddress) GetMessageName() string

func (*SwInterfaceSetMacAddress) GetMessageType

func (*SwInterfaceSetMacAddress) GetMessageType() api.MessageType

func (*SwInterfaceSetMacAddress) Marshal

func (m *SwInterfaceSetMacAddress) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetMacAddress) Reset

func (m *SwInterfaceSetMacAddress) Reset()

func (*SwInterfaceSetMacAddress) Size

func (m *SwInterfaceSetMacAddress) Size() (size int)

func (*SwInterfaceSetMacAddress) Unmarshal

func (m *SwInterfaceSetMacAddress) Unmarshal(b []byte) error

type SwInterfaceSetMacAddressReply

type SwInterfaceSetMacAddressReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetMacAddressReply defines message 'sw_interface_set_mac_address_reply'.

func (*SwInterfaceSetMacAddressReply) GetCrcString

func (*SwInterfaceSetMacAddressReply) GetCrcString() string

func (*SwInterfaceSetMacAddressReply) GetMessageName

func (*SwInterfaceSetMacAddressReply) GetMessageName() string

func (*SwInterfaceSetMacAddressReply) GetMessageType

func (*SwInterfaceSetMacAddressReply) GetMessageType() api.MessageType

func (*SwInterfaceSetMacAddressReply) Marshal

func (m *SwInterfaceSetMacAddressReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetMacAddressReply) Reset

func (m *SwInterfaceSetMacAddressReply) Reset()

func (*SwInterfaceSetMacAddressReply) Size

func (m *SwInterfaceSetMacAddressReply) Size() (size int)

func (*SwInterfaceSetMacAddressReply) Unmarshal

func (m *SwInterfaceSetMacAddressReply) Unmarshal(b []byte) error

type SwInterfaceSetMtu

type SwInterfaceSetMtu struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Mtu       []uint32                       `binapi:"u32[4],name=mtu" json:"mtu,omitempty"`
}

Set interface L3 MTU SwInterfaceSetMtu defines message 'sw_interface_set_mtu'.

func (*SwInterfaceSetMtu) GetCrcString

func (*SwInterfaceSetMtu) GetCrcString() string

func (*SwInterfaceSetMtu) GetMessageName

func (*SwInterfaceSetMtu) GetMessageName() string

func (*SwInterfaceSetMtu) GetMessageType

func (*SwInterfaceSetMtu) GetMessageType() api.MessageType

func (*SwInterfaceSetMtu) Marshal

func (m *SwInterfaceSetMtu) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetMtu) Reset

func (m *SwInterfaceSetMtu) Reset()

func (*SwInterfaceSetMtu) Size

func (m *SwInterfaceSetMtu) Size() (size int)

func (*SwInterfaceSetMtu) Unmarshal

func (m *SwInterfaceSetMtu) Unmarshal(b []byte) error

type SwInterfaceSetMtuReply

type SwInterfaceSetMtuReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetMtuReply defines message 'sw_interface_set_mtu_reply'.

func (*SwInterfaceSetMtuReply) GetCrcString

func (*SwInterfaceSetMtuReply) GetCrcString() string

func (*SwInterfaceSetMtuReply) GetMessageName

func (*SwInterfaceSetMtuReply) GetMessageName() string

func (*SwInterfaceSetMtuReply) GetMessageType

func (*SwInterfaceSetMtuReply) GetMessageType() api.MessageType

func (*SwInterfaceSetMtuReply) Marshal

func (m *SwInterfaceSetMtuReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetMtuReply) Reset

func (m *SwInterfaceSetMtuReply) Reset()

func (*SwInterfaceSetMtuReply) Size

func (m *SwInterfaceSetMtuReply) Size() (size int)

func (*SwInterfaceSetMtuReply) Unmarshal

func (m *SwInterfaceSetMtuReply) Unmarshal(b []byte) error

type SwInterfaceSetPromisc

type SwInterfaceSetPromisc struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	PromiscOn bool                           `binapi:"bool,name=promisc_on" json:"promisc_on,omitempty"`
}

Set interface promiscuous mode

  • sw_if_index - index of the interface to set flags on
  • promisc_on - promiscuous mode is on ?

SwInterfaceSetPromisc defines message 'sw_interface_set_promisc'.

func (*SwInterfaceSetPromisc) GetCrcString

func (*SwInterfaceSetPromisc) GetCrcString() string

func (*SwInterfaceSetPromisc) GetMessageName

func (*SwInterfaceSetPromisc) GetMessageName() string

func (*SwInterfaceSetPromisc) GetMessageType

func (*SwInterfaceSetPromisc) GetMessageType() api.MessageType

func (*SwInterfaceSetPromisc) Marshal

func (m *SwInterfaceSetPromisc) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetPromisc) Reset

func (m *SwInterfaceSetPromisc) Reset()

func (*SwInterfaceSetPromisc) Size

func (m *SwInterfaceSetPromisc) Size() (size int)

func (*SwInterfaceSetPromisc) Unmarshal

func (m *SwInterfaceSetPromisc) Unmarshal(b []byte) error

type SwInterfaceSetPromiscReply

type SwInterfaceSetPromiscReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetPromiscReply defines message 'sw_interface_set_promisc_reply'.

func (*SwInterfaceSetPromiscReply) GetCrcString

func (*SwInterfaceSetPromiscReply) GetCrcString() string

func (*SwInterfaceSetPromiscReply) GetMessageName

func (*SwInterfaceSetPromiscReply) GetMessageName() string

func (*SwInterfaceSetPromiscReply) GetMessageType

func (*SwInterfaceSetPromiscReply) GetMessageType() api.MessageType

func (*SwInterfaceSetPromiscReply) Marshal

func (m *SwInterfaceSetPromiscReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetPromiscReply) Reset

func (m *SwInterfaceSetPromiscReply) Reset()

func (*SwInterfaceSetPromiscReply) Size

func (m *SwInterfaceSetPromiscReply) Size() (size int)

func (*SwInterfaceSetPromiscReply) Unmarshal

func (m *SwInterfaceSetPromiscReply) Unmarshal(b []byte) error

type SwInterfaceSetRxMode

type SwInterfaceSetRxMode struct {
	SwIfIndex    interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	QueueIDValid bool                           `binapi:"bool,name=queue_id_valid" json:"queue_id_valid,omitempty"`
	QueueID      uint32                         `binapi:"u32,name=queue_id" json:"queue_id,omitempty"`
	Mode         interface_types.RxMode         `binapi:"rx_mode,name=mode" json:"mode,omitempty"`
}

Set an interface's rx-mode

  • sw_if_index - the interface whose rx-mode will be set
  • queue_id_valid - 1 = the queue_id field is valid. 0 means all queue_id's
  • queue_id - the queue number whose rx-mode will be set. Only valid if queue_id_valid is 1
  • mode - polling=1, interrupt=2, adaptive=3

SwInterfaceSetRxMode defines message 'sw_interface_set_rx_mode'.

func (*SwInterfaceSetRxMode) GetCrcString

func (*SwInterfaceSetRxMode) GetCrcString() string

func (*SwInterfaceSetRxMode) GetMessageName

func (*SwInterfaceSetRxMode) GetMessageName() string

func (*SwInterfaceSetRxMode) GetMessageType

func (*SwInterfaceSetRxMode) GetMessageType() api.MessageType

func (*SwInterfaceSetRxMode) Marshal

func (m *SwInterfaceSetRxMode) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetRxMode) Reset

func (m *SwInterfaceSetRxMode) Reset()

func (*SwInterfaceSetRxMode) Size

func (m *SwInterfaceSetRxMode) Size() (size int)

func (*SwInterfaceSetRxMode) Unmarshal

func (m *SwInterfaceSetRxMode) Unmarshal(b []byte) error

type SwInterfaceSetRxModeReply

type SwInterfaceSetRxModeReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetRxModeReply defines message 'sw_interface_set_rx_mode_reply'.

func (*SwInterfaceSetRxModeReply) GetCrcString

func (*SwInterfaceSetRxModeReply) GetCrcString() string

func (*SwInterfaceSetRxModeReply) GetMessageName

func (*SwInterfaceSetRxModeReply) GetMessageName() string

func (*SwInterfaceSetRxModeReply) GetMessageType

func (*SwInterfaceSetRxModeReply) GetMessageType() api.MessageType

func (*SwInterfaceSetRxModeReply) Marshal

func (m *SwInterfaceSetRxModeReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetRxModeReply) Reset

func (m *SwInterfaceSetRxModeReply) Reset()

func (*SwInterfaceSetRxModeReply) Size

func (m *SwInterfaceSetRxModeReply) Size() (size int)

func (*SwInterfaceSetRxModeReply) Unmarshal

func (m *SwInterfaceSetRxModeReply) Unmarshal(b []byte) error

type SwInterfaceSetRxPlacement

type SwInterfaceSetRxPlacement struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	QueueID   uint32                         `binapi:"u32,name=queue_id" json:"queue_id,omitempty"`
	WorkerID  uint32                         `binapi:"u32,name=worker_id" json:"worker_id,omitempty"`
	IsMain    bool                           `binapi:"bool,name=is_main" json:"is_main,omitempty"`
}

Set an interface's rx-placement

Rx-Queue placement on specific thread is operational for only hardware
interface. It will not set queue - thread placement for sub-interfaces,
p2p and pipe interfaces.
- sw_if_index - the interface whose rx-placement will be set
- queue_id - the queue number whose rx-placement will be set.
- worker_id - the worker number whom rx-placement will be at.
- is_main - flag to set rx-placement to main thread

SwInterfaceSetRxPlacement defines message 'sw_interface_set_rx_placement'.

func (*SwInterfaceSetRxPlacement) GetCrcString

func (*SwInterfaceSetRxPlacement) GetCrcString() string

func (*SwInterfaceSetRxPlacement) GetMessageName

func (*SwInterfaceSetRxPlacement) GetMessageName() string

func (*SwInterfaceSetRxPlacement) GetMessageType

func (*SwInterfaceSetRxPlacement) GetMessageType() api.MessageType

func (*SwInterfaceSetRxPlacement) Marshal

func (m *SwInterfaceSetRxPlacement) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetRxPlacement) Reset

func (m *SwInterfaceSetRxPlacement) Reset()

func (*SwInterfaceSetRxPlacement) Size

func (m *SwInterfaceSetRxPlacement) Size() (size int)

func (*SwInterfaceSetRxPlacement) Unmarshal

func (m *SwInterfaceSetRxPlacement) Unmarshal(b []byte) error

type SwInterfaceSetRxPlacementReply

type SwInterfaceSetRxPlacementReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetRxPlacementReply defines message 'sw_interface_set_rx_placement_reply'.

func (*SwInterfaceSetRxPlacementReply) GetCrcString

func (*SwInterfaceSetRxPlacementReply) GetCrcString() string

func (*SwInterfaceSetRxPlacementReply) GetMessageName

func (*SwInterfaceSetRxPlacementReply) GetMessageName() string

func (*SwInterfaceSetRxPlacementReply) GetMessageType

func (*SwInterfaceSetRxPlacementReply) Marshal

func (m *SwInterfaceSetRxPlacementReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetRxPlacementReply) Reset

func (m *SwInterfaceSetRxPlacementReply) Reset()

func (*SwInterfaceSetRxPlacementReply) Size

func (m *SwInterfaceSetRxPlacementReply) Size() (size int)

func (*SwInterfaceSetRxPlacementReply) Unmarshal

func (m *SwInterfaceSetRxPlacementReply) Unmarshal(b []byte) error

type SwInterfaceSetTable

type SwInterfaceSetTable struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsIPv6    bool                           `binapi:"bool,name=is_ipv6" json:"is_ipv6,omitempty"`
	VrfID     uint32                         `binapi:"u32,name=vrf_id" json:"vrf_id,omitempty"`
}

Associate the specified interface with a fib table

  • sw_if_index - index of the interface
  • is_ipv6 - if non-zero ipv6, else ipv4
  • vrf_id - fib table/vrf id to associate the interface with

SwInterfaceSetTable defines message 'sw_interface_set_table'.

func (*SwInterfaceSetTable) GetCrcString

func (*SwInterfaceSetTable) GetCrcString() string

func (*SwInterfaceSetTable) GetMessageName

func (*SwInterfaceSetTable) GetMessageName() string

func (*SwInterfaceSetTable) GetMessageType

func (*SwInterfaceSetTable) GetMessageType() api.MessageType

func (*SwInterfaceSetTable) Marshal

func (m *SwInterfaceSetTable) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetTable) Reset

func (m *SwInterfaceSetTable) Reset()

func (*SwInterfaceSetTable) Size

func (m *SwInterfaceSetTable) Size() (size int)

func (*SwInterfaceSetTable) Unmarshal

func (m *SwInterfaceSetTable) Unmarshal(b []byte) error

type SwInterfaceSetTableReply

type SwInterfaceSetTableReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetTableReply defines message 'sw_interface_set_table_reply'.

func (*SwInterfaceSetTableReply) GetCrcString

func (*SwInterfaceSetTableReply) GetCrcString() string

func (*SwInterfaceSetTableReply) GetMessageName

func (*SwInterfaceSetTableReply) GetMessageName() string

func (*SwInterfaceSetTableReply) GetMessageType

func (*SwInterfaceSetTableReply) GetMessageType() api.MessageType

func (*SwInterfaceSetTableReply) Marshal

func (m *SwInterfaceSetTableReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetTableReply) Reset

func (m *SwInterfaceSetTableReply) Reset()

func (*SwInterfaceSetTableReply) Size

func (m *SwInterfaceSetTableReply) Size() (size int)

func (*SwInterfaceSetTableReply) Unmarshal

func (m *SwInterfaceSetTableReply) Unmarshal(b []byte) error

type SwInterfaceSetTxPlacement

type SwInterfaceSetTxPlacement struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	QueueID   uint32                         `binapi:"u32,name=queue_id" json:"queue_id,omitempty"`
	ArraySize uint32                         `binapi:"u32,name=array_size" json:"-"`
	Threads   []uint32                       `binapi:"u32[array_size],name=threads" json:"threads,omitempty"`
}

Set an interface's tx-placement

Tx-Queue placement on specific thread is operational for only hardware
interface. It will not set queue - thread placement for sub-interfaces,
p2p and pipe interfaces.
- sw_if_index - the interface whose tx-placement will be set
- queue_id - the queue number whose tx-placement will be set.
- array_size - the size of the thread indexes array
- threads - the thread indexes of main and worker(s) threads
                 whom tx-placement will be at.

SwInterfaceSetTxPlacement defines message 'sw_interface_set_tx_placement'.

func (*SwInterfaceSetTxPlacement) GetCrcString

func (*SwInterfaceSetTxPlacement) GetCrcString() string

func (*SwInterfaceSetTxPlacement) GetMessageName

func (*SwInterfaceSetTxPlacement) GetMessageName() string

func (*SwInterfaceSetTxPlacement) GetMessageType

func (*SwInterfaceSetTxPlacement) GetMessageType() api.MessageType

func (*SwInterfaceSetTxPlacement) Marshal

func (m *SwInterfaceSetTxPlacement) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetTxPlacement) Reset

func (m *SwInterfaceSetTxPlacement) Reset()

func (*SwInterfaceSetTxPlacement) Size

func (m *SwInterfaceSetTxPlacement) Size() (size int)

func (*SwInterfaceSetTxPlacement) Unmarshal

func (m *SwInterfaceSetTxPlacement) Unmarshal(b []byte) error

type SwInterfaceSetTxPlacementReply

type SwInterfaceSetTxPlacementReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetTxPlacementReply defines message 'sw_interface_set_tx_placement_reply'.

func (*SwInterfaceSetTxPlacementReply) GetCrcString

func (*SwInterfaceSetTxPlacementReply) GetCrcString() string

func (*SwInterfaceSetTxPlacementReply) GetMessageName

func (*SwInterfaceSetTxPlacementReply) GetMessageName() string

func (*SwInterfaceSetTxPlacementReply) GetMessageType

func (*SwInterfaceSetTxPlacementReply) Marshal

func (m *SwInterfaceSetTxPlacementReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetTxPlacementReply) Reset

func (m *SwInterfaceSetTxPlacementReply) Reset()

func (*SwInterfaceSetTxPlacementReply) Size

func (m *SwInterfaceSetTxPlacementReply) Size() (size int)

func (*SwInterfaceSetTxPlacementReply) Unmarshal

func (m *SwInterfaceSetTxPlacementReply) Unmarshal(b []byte) error

type SwInterfaceSetUnnumbered

type SwInterfaceSetUnnumbered struct {
	SwIfIndex           interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	UnnumberedSwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=unnumbered_sw_if_index" json:"unnumbered_sw_if_index,omitempty"`
	IsAdd               bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
}

Set unnumbered interface add / del request

  • sw_if_index - interface with an IP address
  • unnumbered_sw_if_index - interface which will use the address
  • is_add - if non-zero set the association, else unset it

SwInterfaceSetUnnumbered defines message 'sw_interface_set_unnumbered'.

func (*SwInterfaceSetUnnumbered) GetCrcString

func (*SwInterfaceSetUnnumbered) GetCrcString() string

func (*SwInterfaceSetUnnumbered) GetMessageName

func (*SwInterfaceSetUnnumbered) GetMessageName() string

func (*SwInterfaceSetUnnumbered) GetMessageType

func (*SwInterfaceSetUnnumbered) GetMessageType() api.MessageType

func (*SwInterfaceSetUnnumbered) Marshal

func (m *SwInterfaceSetUnnumbered) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetUnnumbered) Reset

func (m *SwInterfaceSetUnnumbered) Reset()

func (*SwInterfaceSetUnnumbered) Size

func (m *SwInterfaceSetUnnumbered) Size() (size int)

func (*SwInterfaceSetUnnumbered) Unmarshal

func (m *SwInterfaceSetUnnumbered) Unmarshal(b []byte) error

type SwInterfaceSetUnnumberedReply

type SwInterfaceSetUnnumberedReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceSetUnnumberedReply defines message 'sw_interface_set_unnumbered_reply'.

func (*SwInterfaceSetUnnumberedReply) GetCrcString

func (*SwInterfaceSetUnnumberedReply) GetCrcString() string

func (*SwInterfaceSetUnnumberedReply) GetMessageName

func (*SwInterfaceSetUnnumberedReply) GetMessageName() string

func (*SwInterfaceSetUnnumberedReply) GetMessageType

func (*SwInterfaceSetUnnumberedReply) GetMessageType() api.MessageType

func (*SwInterfaceSetUnnumberedReply) Marshal

func (m *SwInterfaceSetUnnumberedReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceSetUnnumberedReply) Reset

func (m *SwInterfaceSetUnnumberedReply) Reset()

func (*SwInterfaceSetUnnumberedReply) Size

func (m *SwInterfaceSetUnnumberedReply) Size() (size int)

func (*SwInterfaceSetUnnumberedReply) Unmarshal

func (m *SwInterfaceSetUnnumberedReply) Unmarshal(b []byte) error

type SwInterfaceTagAddDel

type SwInterfaceTagAddDel struct {
	IsAdd     bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Tag       string                         `binapi:"string[64],name=tag" json:"tag,omitempty"`
}

Set / clear software interface tag

  • sw_if_index - the interface
  • add_del - 1 = add, 0 = delete
  • tag - an ascii tag

SwInterfaceTagAddDel defines message 'sw_interface_tag_add_del'.

func (*SwInterfaceTagAddDel) GetCrcString

func (*SwInterfaceTagAddDel) GetCrcString() string

func (*SwInterfaceTagAddDel) GetMessageName

func (*SwInterfaceTagAddDel) GetMessageName() string

func (*SwInterfaceTagAddDel) GetMessageType

func (*SwInterfaceTagAddDel) GetMessageType() api.MessageType

func (*SwInterfaceTagAddDel) Marshal

func (m *SwInterfaceTagAddDel) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceTagAddDel) Reset

func (m *SwInterfaceTagAddDel) Reset()

func (*SwInterfaceTagAddDel) Size

func (m *SwInterfaceTagAddDel) Size() (size int)

func (*SwInterfaceTagAddDel) Unmarshal

func (m *SwInterfaceTagAddDel) Unmarshal(b []byte) error

type SwInterfaceTagAddDelReply

type SwInterfaceTagAddDelReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

SwInterfaceTagAddDelReply defines message 'sw_interface_tag_add_del_reply'.

func (*SwInterfaceTagAddDelReply) GetCrcString

func (*SwInterfaceTagAddDelReply) GetCrcString() string

func (*SwInterfaceTagAddDelReply) GetMessageName

func (*SwInterfaceTagAddDelReply) GetMessageName() string

func (*SwInterfaceTagAddDelReply) GetMessageType

func (*SwInterfaceTagAddDelReply) GetMessageType() api.MessageType

func (*SwInterfaceTagAddDelReply) Marshal

func (m *SwInterfaceTagAddDelReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceTagAddDelReply) Reset

func (m *SwInterfaceTagAddDelReply) Reset()

func (*SwInterfaceTagAddDelReply) Size

func (m *SwInterfaceTagAddDelReply) Size() (size int)

func (*SwInterfaceTagAddDelReply) Unmarshal

func (m *SwInterfaceTagAddDelReply) Unmarshal(b []byte) error

type SwInterfaceTxPlacementDetails

type SwInterfaceTxPlacementDetails struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	QueueID   uint32                         `binapi:"u32,name=queue_id" json:"queue_id,omitempty"`
	Shared    uint8                          `binapi:"u8,name=shared" json:"shared,omitempty"`
	ArraySize uint32                         `binapi:"u32,name=array_size" json:"-"`
	Threads   []uint32                       `binapi:"u32[array_size],name=threads" json:"threads,omitempty"`
}

show the interface's queue - thread placement

This api is used to display the interface and queue worker
thread placement. One message per tx-queue per interface will
be sent to client.
Each message will contain information about tx-queue id of an
interface, interface index, thread on which this tx-queue is
placed and mode of tx-queue.
- sw_if_index - the interface whose tx-placement will be dumped
- queue_id - the queue id
- shared - the queue is shared on other threads
- array_size - the size of the threads array
- threads - the main and worker(s) thread index(es) whom tx-placement are at.

SwInterfaceTxPlacementDetails defines message 'sw_interface_tx_placement_details'.

func (*SwInterfaceTxPlacementDetails) GetCrcString

func (*SwInterfaceTxPlacementDetails) GetCrcString() string

func (*SwInterfaceTxPlacementDetails) GetMessageName

func (*SwInterfaceTxPlacementDetails) GetMessageName() string

func (*SwInterfaceTxPlacementDetails) GetMessageType

func (*SwInterfaceTxPlacementDetails) GetMessageType() api.MessageType

func (*SwInterfaceTxPlacementDetails) Marshal

func (m *SwInterfaceTxPlacementDetails) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceTxPlacementDetails) Reset

func (m *SwInterfaceTxPlacementDetails) Reset()

func (*SwInterfaceTxPlacementDetails) Size

func (m *SwInterfaceTxPlacementDetails) Size() (size int)

func (*SwInterfaceTxPlacementDetails) Unmarshal

func (m *SwInterfaceTxPlacementDetails) Unmarshal(b []byte) error

type SwInterfaceTxPlacementGet

type SwInterfaceTxPlacementGet struct {
	Cursor    uint32                         `binapi:"u32,name=cursor" json:"cursor,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

get the tx queue placement of interface(s)

  • cursor - optional, it allows client to continue a dump
  • sw_if_index - optional interface index for which queue placement to be requested. sw_if_index = ~0 will get the placement information for all interfaces. It will not get information related to sub-interfaces, p2p and pipe interfaces.

SwInterfaceTxPlacementGet defines message 'sw_interface_tx_placement_get'.

func (*SwInterfaceTxPlacementGet) GetCrcString

func (*SwInterfaceTxPlacementGet) GetCrcString() string

func (*SwInterfaceTxPlacementGet) GetMessageName

func (*SwInterfaceTxPlacementGet) GetMessageName() string

func (*SwInterfaceTxPlacementGet) GetMessageType

func (*SwInterfaceTxPlacementGet) GetMessageType() api.MessageType

func (*SwInterfaceTxPlacementGet) Marshal

func (m *SwInterfaceTxPlacementGet) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceTxPlacementGet) Reset

func (m *SwInterfaceTxPlacementGet) Reset()

func (*SwInterfaceTxPlacementGet) Size

func (m *SwInterfaceTxPlacementGet) Size() (size int)

func (*SwInterfaceTxPlacementGet) Unmarshal

func (m *SwInterfaceTxPlacementGet) Unmarshal(b []byte) error

type SwInterfaceTxPlacementGetReply

type SwInterfaceTxPlacementGetReply struct {
	Retval int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	Cursor uint32 `binapi:"u32,name=cursor" json:"cursor,omitempty"`
}

SwInterfaceTxPlacementGetReply defines message 'sw_interface_tx_placement_get_reply'.

func (*SwInterfaceTxPlacementGetReply) GetCrcString

func (*SwInterfaceTxPlacementGetReply) GetCrcString() string

func (*SwInterfaceTxPlacementGetReply) GetMessageName

func (*SwInterfaceTxPlacementGetReply) GetMessageName() string

func (*SwInterfaceTxPlacementGetReply) GetMessageType

func (*SwInterfaceTxPlacementGetReply) Marshal

func (m *SwInterfaceTxPlacementGetReply) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceTxPlacementGetReply) Reset

func (m *SwInterfaceTxPlacementGetReply) Reset()

func (*SwInterfaceTxPlacementGetReply) Size

func (m *SwInterfaceTxPlacementGetReply) Size() (size int)

func (*SwInterfaceTxPlacementGetReply) Unmarshal

func (m *SwInterfaceTxPlacementGetReply) Unmarshal(b []byte) error

type WantInterfaceEvents

type WantInterfaceEvents struct {
	EnableDisable uint32 `binapi:"u32,name=enable_disable" json:"enable_disable,omitempty"`
	PID           uint32 `binapi:"u32,name=pid" json:"pid,omitempty"`
}

Register for interface events

  • enable_disable - 1 => register for events, 0 => cancel registration
  • pid - sender's pid

WantInterfaceEvents defines message 'want_interface_events'.

func (*WantInterfaceEvents) GetCrcString

func (*WantInterfaceEvents) GetCrcString() string

func (*WantInterfaceEvents) GetMessageName

func (*WantInterfaceEvents) GetMessageName() string

func (*WantInterfaceEvents) GetMessageType

func (*WantInterfaceEvents) GetMessageType() api.MessageType

func (*WantInterfaceEvents) Marshal

func (m *WantInterfaceEvents) Marshal(b []byte) ([]byte, error)

func (*WantInterfaceEvents) Reset

func (m *WantInterfaceEvents) Reset()

func (*WantInterfaceEvents) Size

func (m *WantInterfaceEvents) Size() (size int)

func (*WantInterfaceEvents) Unmarshal

func (m *WantInterfaceEvents) Unmarshal(b []byte) error

type WantInterfaceEventsReply

type WantInterfaceEventsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WantInterfaceEventsReply defines message 'want_interface_events_reply'.

func (*WantInterfaceEventsReply) GetCrcString

func (*WantInterfaceEventsReply) GetCrcString() string

func (*WantInterfaceEventsReply) GetMessageName

func (*WantInterfaceEventsReply) GetMessageName() string

func (*WantInterfaceEventsReply) GetMessageType

func (*WantInterfaceEventsReply) GetMessageType() api.MessageType

func (*WantInterfaceEventsReply) Marshal

func (m *WantInterfaceEventsReply) Marshal(b []byte) ([]byte, error)

func (*WantInterfaceEventsReply) Reset

func (m *WantInterfaceEventsReply) Reset()

func (*WantInterfaceEventsReply) Size

func (m *WantInterfaceEventsReply) Size() (size int)

func (*WantInterfaceEventsReply) Unmarshal

func (m *WantInterfaceEventsReply) Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL