flowprobe

package
v0.0.0-...-140e075 Latest Latest
Warning

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

 Go to latest Published: Aug 6, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package flowprobe contains generated bindings for API file flowprobe.api.

Contents: - 4 enums - 12 messages

Index

Constants

View Source 
const (
	APIFile    = "flowprobe"
	APIVersion = "2.1.0"
	VersionCrc = 0x72c9c142
)

Variables

View Source 
var (
	FlowprobeDirection_name = map[uint8]string{
		0: "FLOWPROBE_DIRECTION_RX",
		1: "FLOWPROBE_DIRECTION_TX",
		2: "FLOWPROBE_DIRECTION_BOTH",
	}
	FlowprobeDirection_value = map[string]uint8{
		"FLOWPROBE_DIRECTION_RX":   0,
		"FLOWPROBE_DIRECTION_TX":   1,
		"FLOWPROBE_DIRECTION_BOTH": 2,
	}
)
View Source 
var (
	FlowprobeRecordFlags_name = map[uint8]string{
		1: "FLOWPROBE_RECORD_FLAG_L2",
		2: "FLOWPROBE_RECORD_FLAG_L3",
		4: "FLOWPROBE_RECORD_FLAG_L4",
	}
	FlowprobeRecordFlags_value = map[string]uint8{
		"FLOWPROBE_RECORD_FLAG_L2": 1,
		"FLOWPROBE_RECORD_FLAG_L3": 2,
		"FLOWPROBE_RECORD_FLAG_L4": 4,
	}
)
View Source 
var (
	FlowprobeWhich_name = map[uint8]string{
		0: "FLOWPROBE_WHICH_IP4",
		1: "FLOWPROBE_WHICH_IP6",
		2: "FLOWPROBE_WHICH_L2",
	}
	FlowprobeWhich_value = map[string]uint8{
		"FLOWPROBE_WHICH_IP4": 0,
		"FLOWPROBE_WHICH_IP6": 1,
		"FLOWPROBE_WHICH_L2":  2,
	}
)
View Source 
var (
	FlowprobeWhichFlags_name = map[uint8]string{
		1: "FLOWPROBE_WHICH_FLAG_IP4",
		2: "FLOWPROBE_WHICH_FLAG_L2",
		4: "FLOWPROBE_WHICH_FLAG_IP6",
	}
	FlowprobeWhichFlags_value = map[string]uint8{
		"FLOWPROBE_WHICH_FLAG_IP4": 1,
		"FLOWPROBE_WHICH_FLAG_L2":  2,
		"FLOWPROBE_WHICH_FLAG_IP6": 4,
	}
)

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type FlowprobeDirection 

type FlowprobeDirection uint8

FlowprobeDirection defines enum 'flowprobe_direction'. 

const (
	FLOWPROBE_DIRECTION_RX   FlowprobeDirection = 0
	FLOWPROBE_DIRECTION_TX   FlowprobeDirection = 1
	FLOWPROBE_DIRECTION_BOTH FlowprobeDirection = 2
)

func (FlowprobeDirection) String 

func (x FlowprobeDirection) String() string

type FlowprobeGetParams 

type FlowprobeGetParams struct{}

Get IPFIX flow record generation parameters FlowprobeGetParams defines message 'flowprobe_get_params'. InProgress: the message form may change in the future versions

func (*FlowprobeGetParams) GetCrcString 

func (*FlowprobeGetParams) GetCrcString() string

func (*FlowprobeGetParams) GetMessageName 

func (*FlowprobeGetParams) GetMessageName() string

func (*FlowprobeGetParams) GetMessageType 

func (*FlowprobeGetParams) GetMessageType() api.MessageType

func (*FlowprobeGetParams) Marshal 

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

func (*FlowprobeGetParams) Reset 

func (m *FlowprobeGetParams) Reset()

func (*FlowprobeGetParams) Size 

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

func (*FlowprobeGetParams) Unmarshal 

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

type FlowprobeGetParamsReply 

type FlowprobeGetParamsReply struct {
	Retval       int32                `binapi:"i32,name=retval" json:"retval,omitempty"`
	RecordFlags  FlowprobeRecordFlags `binapi:"flowprobe_record_flags,name=record_flags" json:"record_flags,omitempty"`
	ActiveTimer  uint32               `binapi:"u32,name=active_timer" json:"active_timer,omitempty"`
	PassiveTimer uint32               `binapi:"u32,name=passive_timer" json:"passive_timer,omitempty"`
}

Reply to get IPFIX flow record generation parameters

  • retval - error (0 is "no error")
  • record_flags - flags indicating what data to record
  • active_timer - time in seconds after which active flow records are to be exported (0 is "off")
  • passive_timer - time in seconds after which passive flow records are to be deleted (0 is "off")

FlowprobeGetParamsReply defines message 'flowprobe_get_params_reply'. InProgress: the message form may change in the future versions

func (*FlowprobeGetParamsReply) GetCrcString 

func (*FlowprobeGetParamsReply) GetCrcString() string

func (*FlowprobeGetParamsReply) GetMessageName 

func (*FlowprobeGetParamsReply) GetMessageName() string

func (*FlowprobeGetParamsReply) GetMessageType 

func (*FlowprobeGetParamsReply) GetMessageType() api.MessageType

func (*FlowprobeGetParamsReply) Marshal 

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

func (*FlowprobeGetParamsReply) Reset 

func (m *FlowprobeGetParamsReply) Reset()

func (*FlowprobeGetParamsReply) Size 

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

func (*FlowprobeGetParamsReply) Unmarshal 

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

type FlowprobeInterfaceAddDel 

type FlowprobeInterfaceAddDel struct {
	IsAdd     bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	Which     FlowprobeWhich                 `binapi:"flowprobe_which,name=which" json:"which,omitempty"`
	Direction FlowprobeDirection             `binapi:"flowprobe_direction,name=direction" json:"direction,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Enable or disable IPFIX flow record generation on an interface

  • is_add - add interface if non-zero, else delete
  • which - datapath on which to record flows
  • direction - direction of recorded flows
  • sw_if_index - index of the interface

FlowprobeInterfaceAddDel defines message 'flowprobe_interface_add_del'. InProgress: the message form may change in the future versions

func (*FlowprobeInterfaceAddDel) GetCrcString 

func (*FlowprobeInterfaceAddDel) GetCrcString() string

func (*FlowprobeInterfaceAddDel) GetMessageName 

func (*FlowprobeInterfaceAddDel) GetMessageName() string

func (*FlowprobeInterfaceAddDel) GetMessageType 

func (*FlowprobeInterfaceAddDel) GetMessageType() api.MessageType

func (*FlowprobeInterfaceAddDel) Marshal 

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

func (*FlowprobeInterfaceAddDel) Reset 

func (m *FlowprobeInterfaceAddDel) Reset()

func (*FlowprobeInterfaceAddDel) Size 

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

func (*FlowprobeInterfaceAddDel) Unmarshal 

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

type FlowprobeInterfaceAddDelReply 

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

FlowprobeInterfaceAddDelReply defines message 'flowprobe_interface_add_del_reply'. InProgress: the message form may change in the future versions

func (*FlowprobeInterfaceAddDelReply) GetCrcString 

func (*FlowprobeInterfaceAddDelReply) GetCrcString() string

func (*FlowprobeInterfaceAddDelReply) GetMessageName 

func (*FlowprobeInterfaceAddDelReply) GetMessageName() string

func (*FlowprobeInterfaceAddDelReply) GetMessageType 

func (*FlowprobeInterfaceAddDelReply) GetMessageType() api.MessageType

func (*FlowprobeInterfaceAddDelReply) Marshal 

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

func (*FlowprobeInterfaceAddDelReply) Reset 

func (m *FlowprobeInterfaceAddDelReply) Reset()

func (*FlowprobeInterfaceAddDelReply) Size 

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

func (*FlowprobeInterfaceAddDelReply) Unmarshal 

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

type FlowprobeInterfaceDetails 

type FlowprobeInterfaceDetails struct {
	Which     FlowprobeWhich                 `binapi:"flowprobe_which,name=which" json:"which,omitempty"`
	Direction FlowprobeDirection             `binapi:"flowprobe_direction,name=direction" json:"direction,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Details about IPFIX flow record generation enabled on interface

  • which - datapath on which to record flows
  • direction - direction of recorded flows
  • sw_if_index - index of the interface

FlowprobeInterfaceDetails defines message 'flowprobe_interface_details'. InProgress: the message form may change in the future versions

func (*FlowprobeInterfaceDetails) GetCrcString 

func (*FlowprobeInterfaceDetails) GetCrcString() string

func (*FlowprobeInterfaceDetails) GetMessageName 

func (*FlowprobeInterfaceDetails) GetMessageName() string

func (*FlowprobeInterfaceDetails) GetMessageType 

func (*FlowprobeInterfaceDetails) GetMessageType() api.MessageType

func (*FlowprobeInterfaceDetails) Marshal 

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

func (*FlowprobeInterfaceDetails) Reset 

func (m *FlowprobeInterfaceDetails) Reset()

func (*FlowprobeInterfaceDetails) Size 

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

func (*FlowprobeInterfaceDetails) Unmarshal 

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

type FlowprobeInterfaceDump 

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

Dump interfaces for which IPFIX flow record generation is enabled

  • sw_if_index - interface index to use as filter (0xffffffff is "all")

FlowprobeInterfaceDump defines message 'flowprobe_interface_dump'. InProgress: the message form may change in the future versions

func (*FlowprobeInterfaceDump) GetCrcString 

func (*FlowprobeInterfaceDump) GetCrcString() string

func (*FlowprobeInterfaceDump) GetMessageName 

func (*FlowprobeInterfaceDump) GetMessageName() string

func (*FlowprobeInterfaceDump) GetMessageType 

func (*FlowprobeInterfaceDump) GetMessageType() api.MessageType

func (*FlowprobeInterfaceDump) Marshal 

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

func (*FlowprobeInterfaceDump) Reset 

func (m *FlowprobeInterfaceDump) Reset()

func (*FlowprobeInterfaceDump) Size 

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

func (*FlowprobeInterfaceDump) Unmarshal 

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

type FlowprobeParams 

type FlowprobeParams struct {
	RecordFlags  FlowprobeRecordFlags `binapi:"flowprobe_record_flags,name=record_flags" json:"record_flags,omitempty"`
	ActiveTimer  uint32               `binapi:"u32,name=active_timer" json:"active_timer,omitempty"`
	PassiveTimer uint32               `binapi:"u32,name=passive_timer" json:"passive_timer,omitempty"`
}

FlowprobeParams defines message 'flowprobe_params'.

func (*FlowprobeParams) GetCrcString 

func (*FlowprobeParams) GetCrcString() string

func (*FlowprobeParams) GetMessageName 

func (*FlowprobeParams) GetMessageName() string

func (*FlowprobeParams) GetMessageType 

func (*FlowprobeParams) GetMessageType() api.MessageType

func (*FlowprobeParams) Marshal 

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

func (*FlowprobeParams) Reset 

func (m *FlowprobeParams) Reset()

func (*FlowprobeParams) Size 

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

func (*FlowprobeParams) Unmarshal 

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

type FlowprobeParamsReply 

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

FlowprobeParamsReply defines message 'flowprobe_params_reply'.

func (*FlowprobeParamsReply) GetCrcString 

func (*FlowprobeParamsReply) GetCrcString() string

func (*FlowprobeParamsReply) GetMessageName 

func (*FlowprobeParamsReply) GetMessageName() string

func (*FlowprobeParamsReply) GetMessageType 

func (*FlowprobeParamsReply) GetMessageType() api.MessageType

func (*FlowprobeParamsReply) Marshal 

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

func (*FlowprobeParamsReply) Reset 

func (m *FlowprobeParamsReply) Reset()

func (*FlowprobeParamsReply) Size 

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

func (*FlowprobeParamsReply) Unmarshal 

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

type FlowprobeRecordFlags 

type FlowprobeRecordFlags uint8

FlowprobeRecordFlags defines enum 'flowprobe_record_flags'. 

const (
	FLOWPROBE_RECORD_FLAG_L2 FlowprobeRecordFlags = 1
	FLOWPROBE_RECORD_FLAG_L3 FlowprobeRecordFlags = 2
	FLOWPROBE_RECORD_FLAG_L4 FlowprobeRecordFlags = 4
)

func (FlowprobeRecordFlags) String 

func (x FlowprobeRecordFlags) String() string

type FlowprobeSetParams 

type FlowprobeSetParams struct {
	RecordFlags  FlowprobeRecordFlags `binapi:"flowprobe_record_flags,name=record_flags" json:"record_flags,omitempty"`
	ActiveTimer  uint32               `binapi:"u32,name=active_timer,default=4294967295" json:"active_timer,omitempty"`
	PassiveTimer uint32               `binapi:"u32,name=passive_timer,default=4294967295" json:"passive_timer,omitempty"`
}

Set IPFIX flow record generation parameters

  • record_flags - flags indicating what data to record
  • active_timer - time in seconds after which active flow records are to be exported (0 is "off", 0xffffffff is "use default value")
  • passive_timer - time in seconds after which passive flow records are to be deleted (0 is "off", 0xffffffff is "use default value")

FlowprobeSetParams defines message 'flowprobe_set_params'. InProgress: the message form may change in the future versions

func (*FlowprobeSetParams) GetCrcString 

func (*FlowprobeSetParams) GetCrcString() string

func (*FlowprobeSetParams) GetMessageName 

func (*FlowprobeSetParams) GetMessageName() string

func (*FlowprobeSetParams) GetMessageType 

func (*FlowprobeSetParams) GetMessageType() api.MessageType

func (*FlowprobeSetParams) Marshal 

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

func (*FlowprobeSetParams) Reset 

func (m *FlowprobeSetParams) Reset()

func (*FlowprobeSetParams) Size 

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

func (*FlowprobeSetParams) Unmarshal 

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

type FlowprobeSetParamsReply 

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

FlowprobeSetParamsReply defines message 'flowprobe_set_params_reply'. InProgress: the message form may change in the future versions

func (*FlowprobeSetParamsReply) GetCrcString 

func (*FlowprobeSetParamsReply) GetCrcString() string

func (*FlowprobeSetParamsReply) GetMessageName 

func (*FlowprobeSetParamsReply) GetMessageName() string

func (*FlowprobeSetParamsReply) GetMessageType 

func (*FlowprobeSetParamsReply) GetMessageType() api.MessageType

func (*FlowprobeSetParamsReply) Marshal 

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

func (*FlowprobeSetParamsReply) Reset 

func (m *FlowprobeSetParamsReply) Reset()

func (*FlowprobeSetParamsReply) Size 

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

func (*FlowprobeSetParamsReply) Unmarshal 

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

type FlowprobeTxInterfaceAddDel 

type FlowprobeTxInterfaceAddDel struct {
	IsAdd     bool                           `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	Which     FlowprobeWhichFlags            `binapi:"flowprobe_which_flags,name=which" json:"which,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Enable / disable per-packet IPFIX recording on an interface

  • is_add - add address if non-zero, else delete
  • which - flags indicating forwarding path
  • sw_if_index - index of the interface

FlowprobeTxInterfaceAddDel defines message 'flowprobe_tx_interface_add_del'.

func (*FlowprobeTxInterfaceAddDel) GetCrcString 

func (*FlowprobeTxInterfaceAddDel) GetCrcString() string

func (*FlowprobeTxInterfaceAddDel) GetMessageName 

func (*FlowprobeTxInterfaceAddDel) GetMessageName() string

func (*FlowprobeTxInterfaceAddDel) GetMessageType 

func (*FlowprobeTxInterfaceAddDel) GetMessageType() api.MessageType

func (*FlowprobeTxInterfaceAddDel) Marshal 

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

func (*FlowprobeTxInterfaceAddDel) Reset 

func (m *FlowprobeTxInterfaceAddDel) Reset()

func (*FlowprobeTxInterfaceAddDel) Size 

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

func (*FlowprobeTxInterfaceAddDel) Unmarshal 

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

type FlowprobeTxInterfaceAddDelReply 

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

FlowprobeTxInterfaceAddDelReply defines message 'flowprobe_tx_interface_add_del_reply'.

func (*FlowprobeTxInterfaceAddDelReply) GetCrcString 

func (*FlowprobeTxInterfaceAddDelReply) GetCrcString() string

func (*FlowprobeTxInterfaceAddDelReply) GetMessageName 

func (*FlowprobeTxInterfaceAddDelReply) GetMessageName() string

func (*FlowprobeTxInterfaceAddDelReply) GetMessageType 

func (*FlowprobeTxInterfaceAddDelReply) GetMessageType() api.MessageType

func (*FlowprobeTxInterfaceAddDelReply) Marshal 

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

func (*FlowprobeTxInterfaceAddDelReply) Reset 

func (m *FlowprobeTxInterfaceAddDelReply) Reset()

func (*FlowprobeTxInterfaceAddDelReply) Size 

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

func (*FlowprobeTxInterfaceAddDelReply) Unmarshal 

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

type FlowprobeWhich 

type FlowprobeWhich uint8

FlowprobeWhich defines enum 'flowprobe_which'. 

const (
	FLOWPROBE_WHICH_IP4 FlowprobeWhich = 0
	FLOWPROBE_WHICH_IP6 FlowprobeWhich = 1
	FLOWPROBE_WHICH_L2  FlowprobeWhich = 2
)

func (FlowprobeWhich) String 

func (x FlowprobeWhich) String() string

type FlowprobeWhichFlags 

type FlowprobeWhichFlags uint8

FlowprobeWhichFlags defines enum 'flowprobe_which_flags'. 

const (
	FLOWPROBE_WHICH_FLAG_IP4 FlowprobeWhichFlags = 1
	FLOWPROBE_WHICH_FLAG_L2  FlowprobeWhichFlags = 2
	FLOWPROBE_WHICH_FLAG_IP6 FlowprobeWhichFlags = 4
)

func (FlowprobeWhichFlags) String 

func (x FlowprobeWhichFlags) String() string

type RPCService 

type RPCService interface {
	FlowprobeGetParams(ctx context.Context, in *FlowprobeGetParams) (*FlowprobeGetParamsReply, error)
	FlowprobeInterfaceAddDel(ctx context.Context, in *FlowprobeInterfaceAddDel) (*FlowprobeInterfaceAddDelReply, error)
	FlowprobeInterfaceDump(ctx context.Context, in *FlowprobeInterfaceDump) (RPCService_FlowprobeInterfaceDumpClient, error)
	FlowprobeParams(ctx context.Context, in *FlowprobeParams) (*FlowprobeParamsReply, error)
	FlowprobeSetParams(ctx context.Context, in *FlowprobeSetParams) (*FlowprobeSetParamsReply, error)
	FlowprobeTxInterfaceAddDel(ctx context.Context, in *FlowprobeTxInterfaceAddDel) (*FlowprobeTxInterfaceAddDelReply, error)
}

RPCService defines RPC service flowprobe.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_FlowprobeInterfaceDumpClient 

type RPCService_FlowprobeInterfaceDumpClient interface {
	Recv() (*FlowprobeInterfaceDetails, error)
	api.Stream
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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