bfd

package
v0.9.0-alpha Latest Latest
Warning

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

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

Documentation

Overview

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

Contents: - 1 enum - 31 messages

Index

Constants

View Source
const (
	APIFile    = "bfd"
	APIVersion = "2.0.0"
	VersionCrc = 0xe65443a6
)

Variables

View Source
var (
	BfdState_name = map[uint32]string{
		0: "BFD_STATE_API_ADMIN_DOWN",
		1: "BFD_STATE_API_DOWN",
		2: "BFD_STATE_API_INIT",
		3: "BFD_STATE_API_UP",
	}
	BfdState_value = map[string]uint32{
		"BFD_STATE_API_ADMIN_DOWN": 0,
		"BFD_STATE_API_DOWN":       1,
		"BFD_STATE_API_INIT":       2,
		"BFD_STATE_API_UP":         3,
	}
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type BfdAuthDelKey

type BfdAuthDelKey struct {
	ConfKeyID uint32 `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
}

BFD UDP - delete key from configuration

  • conf_key_id - key ID to add/replace/delete
  • key_len - length of key (must be non-zero)
  • key - key data

BfdAuthDelKey defines message 'bfd_auth_del_key'.

func (*BfdAuthDelKey) GetCrcString

func (*BfdAuthDelKey) GetCrcString() string

func (*BfdAuthDelKey) GetMessageName

func (*BfdAuthDelKey) GetMessageName() string

func (*BfdAuthDelKey) GetMessageType

func (*BfdAuthDelKey) GetMessageType() api.MessageType

func (*BfdAuthDelKey) Marshal

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

func (*BfdAuthDelKey) Reset

func (m *BfdAuthDelKey) Reset()

func (*BfdAuthDelKey) Size

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

func (*BfdAuthDelKey) Unmarshal

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

type BfdAuthDelKeyReply

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

BfdAuthDelKeyReply defines message 'bfd_auth_del_key_reply'.

func (*BfdAuthDelKeyReply) GetCrcString

func (*BfdAuthDelKeyReply) GetCrcString() string

func (*BfdAuthDelKeyReply) GetMessageName

func (*BfdAuthDelKeyReply) GetMessageName() string

func (*BfdAuthDelKeyReply) GetMessageType

func (*BfdAuthDelKeyReply) GetMessageType() api.MessageType

func (*BfdAuthDelKeyReply) Marshal

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

func (*BfdAuthDelKeyReply) Reset

func (m *BfdAuthDelKeyReply) Reset()

func (*BfdAuthDelKeyReply) Size

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

func (*BfdAuthDelKeyReply) Unmarshal

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

type BfdAuthKeysDetails

type BfdAuthKeysDetails struct {
	ConfKeyID uint32 `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
	UseCount  uint32 `binapi:"u32,name=use_count" json:"use_count,omitempty"`
	AuthType  uint8  `binapi:"u8,name=auth_type" json:"auth_type,omitempty"`
}

BFD authentication key details

  • conf_key_id - configured key ID
  • use_count - how many BFD sessions currently use this key
  • auth_type - authentication type (RFC 5880/4.1/Auth Type)

BfdAuthKeysDetails defines message 'bfd_auth_keys_details'.

func (*BfdAuthKeysDetails) GetCrcString

func (*BfdAuthKeysDetails) GetCrcString() string

func (*BfdAuthKeysDetails) GetMessageName

func (*BfdAuthKeysDetails) GetMessageName() string

func (*BfdAuthKeysDetails) GetMessageType

func (*BfdAuthKeysDetails) GetMessageType() api.MessageType

func (*BfdAuthKeysDetails) Marshal

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

func (*BfdAuthKeysDetails) Reset

func (m *BfdAuthKeysDetails) Reset()

func (*BfdAuthKeysDetails) Size

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

func (*BfdAuthKeysDetails) Unmarshal

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

type BfdAuthKeysDump

type BfdAuthKeysDump struct{}

Get a list of configured authentication keys BfdAuthKeysDump defines message 'bfd_auth_keys_dump'.

func (*BfdAuthKeysDump) GetCrcString

func (*BfdAuthKeysDump) GetCrcString() string

func (*BfdAuthKeysDump) GetMessageName

func (*BfdAuthKeysDump) GetMessageName() string

func (*BfdAuthKeysDump) GetMessageType

func (*BfdAuthKeysDump) GetMessageType() api.MessageType

func (*BfdAuthKeysDump) Marshal

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

func (*BfdAuthKeysDump) Reset

func (m *BfdAuthKeysDump) Reset()

func (*BfdAuthKeysDump) Size

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

func (*BfdAuthKeysDump) Unmarshal

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

type BfdAuthSetKey

type BfdAuthSetKey struct {
	ConfKeyID uint32 `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
	KeyLen    uint8  `binapi:"u8,name=key_len" json:"key_len,omitempty"`
	AuthType  uint8  `binapi:"u8,name=auth_type" json:"auth_type,omitempty"`
	Key       []byte `binapi:"u8[20],name=key" json:"key,omitempty"`
}

BFD UDP - add/replace key to configuration

  • conf_key_id - key ID to add/replace/delete
  • key_len - length of key (must be non-zero)
  • auth_type - authentication type (RFC 5880/4.1/Auth Type)
  • key - key data

BfdAuthSetKey defines message 'bfd_auth_set_key'.

func (*BfdAuthSetKey) GetCrcString

func (*BfdAuthSetKey) GetCrcString() string

func (*BfdAuthSetKey) GetMessageName

func (*BfdAuthSetKey) GetMessageName() string

func (*BfdAuthSetKey) GetMessageType

func (*BfdAuthSetKey) GetMessageType() api.MessageType

func (*BfdAuthSetKey) Marshal

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

func (*BfdAuthSetKey) Reset

func (m *BfdAuthSetKey) Reset()

func (*BfdAuthSetKey) Size

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

func (*BfdAuthSetKey) Unmarshal

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

type BfdAuthSetKeyReply

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

BfdAuthSetKeyReply defines message 'bfd_auth_set_key_reply'.

func (*BfdAuthSetKeyReply) GetCrcString

func (*BfdAuthSetKeyReply) GetCrcString() string

func (*BfdAuthSetKeyReply) GetMessageName

func (*BfdAuthSetKeyReply) GetMessageName() string

func (*BfdAuthSetKeyReply) GetMessageType

func (*BfdAuthSetKeyReply) GetMessageType() api.MessageType

func (*BfdAuthSetKeyReply) Marshal

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

func (*BfdAuthSetKeyReply) Reset

func (m *BfdAuthSetKeyReply) Reset()

func (*BfdAuthSetKeyReply) Size

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

func (*BfdAuthSetKeyReply) Unmarshal

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

type BfdState

type BfdState uint32

BfdState defines enum 'bfd_state'.

const (
	BFD_STATE_API_ADMIN_DOWN BfdState = 0
	BFD_STATE_API_DOWN       BfdState = 1
	BFD_STATE_API_INIT       BfdState = 2
	BFD_STATE_API_UP         BfdState = 3
)

func (BfdState) String

func (x BfdState) String() string

type BfdUDPAdd

type BfdUDPAdd struct {
	SwIfIndex       interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	DesiredMinTx    uint32                         `binapi:"u32,name=desired_min_tx" json:"desired_min_tx,omitempty"`
	RequiredMinRx   uint32                         `binapi:"u32,name=required_min_rx" json:"required_min_rx,omitempty"`
	LocalAddr       ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr        ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	DetectMult      uint8                          `binapi:"u8,name=detect_mult" json:"detect_mult,omitempty"`
	IsAuthenticated bool                           `binapi:"bool,name=is_authenticated" json:"is_authenticated,omitempty"`
	BfdKeyID        uint8                          `binapi:"u8,name=bfd_key_id" json:"bfd_key_id,omitempty"`
	ConfKeyID       uint32                         `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
}

Add UDP BFD session on interface

  • sw_if_index - sw index of the interface
  • desired_min_tx - desired min transmit interval (microseconds)
  • required_min_rx - required min receive interval (microseconds)
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • detect_mult - detect multiplier (# of packets missed before connection goes down)
  • is_authenticated - non-zero if authentication is required
  • bfd_key_id - key id sent out in BFD packets (if is_authenticated)
  • conf_key_id - id of already configured key (if is_authenticated)

BfdUDPAdd defines message 'bfd_udp_add'.

func (*BfdUDPAdd) GetCrcString

func (*BfdUDPAdd) GetCrcString() string

func (*BfdUDPAdd) GetMessageName

func (*BfdUDPAdd) GetMessageName() string

func (*BfdUDPAdd) GetMessageType

func (*BfdUDPAdd) GetMessageType() api.MessageType

func (*BfdUDPAdd) Marshal

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

func (*BfdUDPAdd) Reset

func (m *BfdUDPAdd) Reset()

func (*BfdUDPAdd) Size

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

func (*BfdUDPAdd) Unmarshal

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

type BfdUDPAddReply

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

BfdUDPAddReply defines message 'bfd_udp_add_reply'.

func (*BfdUDPAddReply) GetCrcString

func (*BfdUDPAddReply) GetCrcString() string

func (*BfdUDPAddReply) GetMessageName

func (*BfdUDPAddReply) GetMessageName() string

func (*BfdUDPAddReply) GetMessageType

func (*BfdUDPAddReply) GetMessageType() api.MessageType

func (*BfdUDPAddReply) Marshal

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

func (*BfdUDPAddReply) Reset

func (m *BfdUDPAddReply) Reset()

func (*BfdUDPAddReply) Size

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

func (*BfdUDPAddReply) Unmarshal

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

type BfdUDPAuthActivate

type BfdUDPAuthActivate struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	LocalAddr ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr  ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	IsDelayed bool                           `binapi:"bool,name=is_delayed" json:"is_delayed,omitempty"`
	BfdKeyID  uint8                          `binapi:"u8,name=bfd_key_id" json:"bfd_key_id,omitempty"`
	ConfKeyID uint32                         `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
}

BFD UDP - activate/change authentication

  • sw_if_index - sw index of the interface
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • is_delayed - change is applied once peer applies the change (on first received packet with this auth)
  • bfd_key_id - key id sent out in BFD packets
  • conf_key_id - id of already configured key

BfdUDPAuthActivate defines message 'bfd_udp_auth_activate'.

func (*BfdUDPAuthActivate) GetCrcString

func (*BfdUDPAuthActivate) GetCrcString() string

func (*BfdUDPAuthActivate) GetMessageName

func (*BfdUDPAuthActivate) GetMessageName() string

func (*BfdUDPAuthActivate) GetMessageType

func (*BfdUDPAuthActivate) GetMessageType() api.MessageType

func (*BfdUDPAuthActivate) Marshal

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

func (*BfdUDPAuthActivate) Reset

func (m *BfdUDPAuthActivate) Reset()

func (*BfdUDPAuthActivate) Size

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

func (*BfdUDPAuthActivate) Unmarshal

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

type BfdUDPAuthActivateReply

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

BfdUDPAuthActivateReply defines message 'bfd_udp_auth_activate_reply'.

func (*BfdUDPAuthActivateReply) GetCrcString

func (*BfdUDPAuthActivateReply) GetCrcString() string

func (*BfdUDPAuthActivateReply) GetMessageName

func (*BfdUDPAuthActivateReply) GetMessageName() string

func (*BfdUDPAuthActivateReply) GetMessageType

func (*BfdUDPAuthActivateReply) GetMessageType() api.MessageType

func (*BfdUDPAuthActivateReply) Marshal

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

func (*BfdUDPAuthActivateReply) Reset

func (m *BfdUDPAuthActivateReply) Reset()

func (*BfdUDPAuthActivateReply) Size

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

func (*BfdUDPAuthActivateReply) Unmarshal

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

type BfdUDPAuthDeactivate

type BfdUDPAuthDeactivate struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	LocalAddr ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr  ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	IsDelayed bool                           `binapi:"bool,name=is_delayed" json:"is_delayed,omitempty"`
}

BFD UDP - deactivate authentication

  • sw_if_index - sw index of the interface
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)

BfdUDPAuthDeactivate defines message 'bfd_udp_auth_deactivate'.

func (*BfdUDPAuthDeactivate) GetCrcString

func (*BfdUDPAuthDeactivate) GetCrcString() string

func (*BfdUDPAuthDeactivate) GetMessageName

func (*BfdUDPAuthDeactivate) GetMessageName() string

func (*BfdUDPAuthDeactivate) GetMessageType

func (*BfdUDPAuthDeactivate) GetMessageType() api.MessageType

func (*BfdUDPAuthDeactivate) Marshal

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

func (*BfdUDPAuthDeactivate) Reset

func (m *BfdUDPAuthDeactivate) Reset()

func (*BfdUDPAuthDeactivate) Size

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

func (*BfdUDPAuthDeactivate) Unmarshal

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

type BfdUDPAuthDeactivateReply

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

BfdUDPAuthDeactivateReply defines message 'bfd_udp_auth_deactivate_reply'.

func (*BfdUDPAuthDeactivateReply) GetCrcString

func (*BfdUDPAuthDeactivateReply) GetCrcString() string

func (*BfdUDPAuthDeactivateReply) GetMessageName

func (*BfdUDPAuthDeactivateReply) GetMessageName() string

func (*BfdUDPAuthDeactivateReply) GetMessageType

func (*BfdUDPAuthDeactivateReply) GetMessageType() api.MessageType

func (*BfdUDPAuthDeactivateReply) Marshal

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

func (*BfdUDPAuthDeactivateReply) Reset

func (m *BfdUDPAuthDeactivateReply) Reset()

func (*BfdUDPAuthDeactivateReply) Size

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

func (*BfdUDPAuthDeactivateReply) Unmarshal

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

type BfdUDPDel

type BfdUDPDel struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	LocalAddr ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr  ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
}

Delete UDP BFD session on interface

  • sw_if_index - sw index of the interface
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4

BfdUDPDel defines message 'bfd_udp_del'.

func (*BfdUDPDel) GetCrcString

func (*BfdUDPDel) GetCrcString() string

func (*BfdUDPDel) GetMessageName

func (*BfdUDPDel) GetMessageName() string

func (*BfdUDPDel) GetMessageType

func (*BfdUDPDel) GetMessageType() api.MessageType

func (*BfdUDPDel) Marshal

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

func (*BfdUDPDel) Reset

func (m *BfdUDPDel) Reset()

func (*BfdUDPDel) Size

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

func (*BfdUDPDel) Unmarshal

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

type BfdUDPDelEchoSource

type BfdUDPDelEchoSource struct{}

Delete BFD echo source BfdUDPDelEchoSource defines message 'bfd_udp_del_echo_source'.

func (*BfdUDPDelEchoSource) GetCrcString

func (*BfdUDPDelEchoSource) GetCrcString() string

func (*BfdUDPDelEchoSource) GetMessageName

func (*BfdUDPDelEchoSource) GetMessageName() string

func (*BfdUDPDelEchoSource) GetMessageType

func (*BfdUDPDelEchoSource) GetMessageType() api.MessageType

func (*BfdUDPDelEchoSource) Marshal

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

func (*BfdUDPDelEchoSource) Reset

func (m *BfdUDPDelEchoSource) Reset()

func (*BfdUDPDelEchoSource) Size

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

func (*BfdUDPDelEchoSource) Unmarshal

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

type BfdUDPDelEchoSourceReply

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

BfdUDPDelEchoSourceReply defines message 'bfd_udp_del_echo_source_reply'.

func (*BfdUDPDelEchoSourceReply) GetCrcString

func (*BfdUDPDelEchoSourceReply) GetCrcString() string

func (*BfdUDPDelEchoSourceReply) GetMessageName

func (*BfdUDPDelEchoSourceReply) GetMessageName() string

func (*BfdUDPDelEchoSourceReply) GetMessageType

func (*BfdUDPDelEchoSourceReply) GetMessageType() api.MessageType

func (*BfdUDPDelEchoSourceReply) Marshal

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

func (*BfdUDPDelEchoSourceReply) Reset

func (m *BfdUDPDelEchoSourceReply) Reset()

func (*BfdUDPDelEchoSourceReply) Size

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

func (*BfdUDPDelEchoSourceReply) Unmarshal

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

type BfdUDPDelReply

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

BfdUDPDelReply defines message 'bfd_udp_del_reply'.

func (*BfdUDPDelReply) GetCrcString

func (*BfdUDPDelReply) GetCrcString() string

func (*BfdUDPDelReply) GetMessageName

func (*BfdUDPDelReply) GetMessageName() string

func (*BfdUDPDelReply) GetMessageType

func (*BfdUDPDelReply) GetMessageType() api.MessageType

func (*BfdUDPDelReply) Marshal

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

func (*BfdUDPDelReply) Reset

func (m *BfdUDPDelReply) Reset()

func (*BfdUDPDelReply) Size

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

func (*BfdUDPDelReply) Unmarshal

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

type BfdUDPGetEchoSource

type BfdUDPGetEchoSource struct{}

Get BFD echo source BfdUDPGetEchoSource defines message 'bfd_udp_get_echo_source'.

func (*BfdUDPGetEchoSource) GetCrcString

func (*BfdUDPGetEchoSource) GetCrcString() string

func (*BfdUDPGetEchoSource) GetMessageName

func (*BfdUDPGetEchoSource) GetMessageName() string

func (*BfdUDPGetEchoSource) GetMessageType

func (*BfdUDPGetEchoSource) GetMessageType() api.MessageType

func (*BfdUDPGetEchoSource) Marshal

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

func (*BfdUDPGetEchoSource) Reset

func (m *BfdUDPGetEchoSource) Reset()

func (*BfdUDPGetEchoSource) Size

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

func (*BfdUDPGetEchoSource) Unmarshal

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

type BfdUDPGetEchoSourceReply

type BfdUDPGetEchoSourceReply 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"`
	IsSet         bool                           `binapi:"bool,name=is_set" json:"is_set,omitempty"`
	HaveUsableIP4 bool                           `binapi:"bool,name=have_usable_ip4" json:"have_usable_ip4,omitempty"`
	IP4Addr       ip_types.IP4Address            `binapi:"ip4_address,name=ip4_addr" json:"ip4_addr,omitempty"`
	HaveUsableIP6 bool                           `binapi:"bool,name=have_usable_ip6" json:"have_usable_ip6,omitempty"`
	IP6Addr       ip_types.IP6Address            `binapi:"ip6_address,name=ip6_addr" json:"ip6_addr,omitempty"`
}

Get BFD echo source reply

  • retval - return code
  • sw_if_index - interface to use as echo source
  • is_set - non-zero if set
  • have_usable_ip4 - non-zero if have usable IPv4 address
  • ip4_addr - IPv4 address
  • have_usable_ip6 - non-zero if have usable IPv6 address
  • ip6_addr - IPv6 address

BfdUDPGetEchoSourceReply defines message 'bfd_udp_get_echo_source_reply'.

func (*BfdUDPGetEchoSourceReply) GetCrcString

func (*BfdUDPGetEchoSourceReply) GetCrcString() string

func (*BfdUDPGetEchoSourceReply) GetMessageName

func (*BfdUDPGetEchoSourceReply) GetMessageName() string

func (*BfdUDPGetEchoSourceReply) GetMessageType

func (*BfdUDPGetEchoSourceReply) GetMessageType() api.MessageType

func (*BfdUDPGetEchoSourceReply) Marshal

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

func (*BfdUDPGetEchoSourceReply) Reset

func (m *BfdUDPGetEchoSourceReply) Reset()

func (*BfdUDPGetEchoSourceReply) Size

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

func (*BfdUDPGetEchoSourceReply) Unmarshal

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

type BfdUDPMod

type BfdUDPMod struct {
	SwIfIndex     interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	DesiredMinTx  uint32                         `binapi:"u32,name=desired_min_tx" json:"desired_min_tx,omitempty"`
	RequiredMinRx uint32                         `binapi:"u32,name=required_min_rx" json:"required_min_rx,omitempty"`
	LocalAddr     ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr      ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	DetectMult    uint8                          `binapi:"u8,name=detect_mult" json:"detect_mult,omitempty"`
}

Modify UDP BFD session on interface

  • sw_if_index - sw index of the interface
  • desired_min_tx - desired min transmit interval (microseconds)
  • required_min_rx - required min receive interval (microseconds)
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • detect_mult - detect multiplier (# of packets missed before connection goes down)

BfdUDPMod defines message 'bfd_udp_mod'.

func (*BfdUDPMod) GetCrcString

func (*BfdUDPMod) GetCrcString() string

func (*BfdUDPMod) GetMessageName

func (*BfdUDPMod) GetMessageName() string

func (*BfdUDPMod) GetMessageType

func (*BfdUDPMod) GetMessageType() api.MessageType

func (*BfdUDPMod) Marshal

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

func (*BfdUDPMod) Reset

func (m *BfdUDPMod) Reset()

func (*BfdUDPMod) Size

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

func (*BfdUDPMod) Unmarshal

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

type BfdUDPModReply

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

BfdUDPModReply defines message 'bfd_udp_mod_reply'.

func (*BfdUDPModReply) GetCrcString

func (*BfdUDPModReply) GetCrcString() string

func (*BfdUDPModReply) GetMessageName

func (*BfdUDPModReply) GetMessageName() string

func (*BfdUDPModReply) GetMessageType

func (*BfdUDPModReply) GetMessageType() api.MessageType

func (*BfdUDPModReply) Marshal

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

func (*BfdUDPModReply) Reset

func (m *BfdUDPModReply) Reset()

func (*BfdUDPModReply) Size

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

func (*BfdUDPModReply) Unmarshal

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

type BfdUDPSessionDetails

type BfdUDPSessionDetails struct {
	SwIfIndex       interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	LocalAddr       ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr        ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	State           BfdState                       `binapi:"bfd_state,name=state" json:"state,omitempty"`
	IsAuthenticated bool                           `binapi:"bool,name=is_authenticated" json:"is_authenticated,omitempty"`
	BfdKeyID        uint8                          `binapi:"u8,name=bfd_key_id" json:"bfd_key_id,omitempty"`
	ConfKeyID       uint32                         `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
	RequiredMinRx   uint32                         `binapi:"u32,name=required_min_rx" json:"required_min_rx,omitempty"`
	DesiredMinTx    uint32                         `binapi:"u32,name=desired_min_tx" json:"desired_min_tx,omitempty"`
	DetectMult      uint8                          `binapi:"u8,name=detect_mult" json:"detect_mult,omitempty"`
}

BFD session details structure

  • sw_if_index - sw index of the interface
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • state - session state
  • is_authenticated - non-zero if authentication in-use, zero otherwise
  • bfd_key_id - ID of key currently in-use if auth is on
  • conf_key_id - configured key ID for this session
  • required_min_rx - required min receive interval (microseconds)
  • desired_min_tx - desired min transmit interval (microseconds)
  • detect_mult - detect multiplier (# of packets missed before connection goes down)

BfdUDPSessionDetails defines message 'bfd_udp_session_details'.

func (*BfdUDPSessionDetails) GetCrcString

func (*BfdUDPSessionDetails) GetCrcString() string

func (*BfdUDPSessionDetails) GetMessageName

func (*BfdUDPSessionDetails) GetMessageName() string

func (*BfdUDPSessionDetails) GetMessageType

func (*BfdUDPSessionDetails) GetMessageType() api.MessageType

func (*BfdUDPSessionDetails) Marshal

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

func (*BfdUDPSessionDetails) Reset

func (m *BfdUDPSessionDetails) Reset()

func (*BfdUDPSessionDetails) Size

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

func (*BfdUDPSessionDetails) Unmarshal

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

type BfdUDPSessionDump

type BfdUDPSessionDump struct{}

Get all BFD sessions BfdUDPSessionDump defines message 'bfd_udp_session_dump'.

func (*BfdUDPSessionDump) GetCrcString

func (*BfdUDPSessionDump) GetCrcString() string

func (*BfdUDPSessionDump) GetMessageName

func (*BfdUDPSessionDump) GetMessageName() string

func (*BfdUDPSessionDump) GetMessageType

func (*BfdUDPSessionDump) GetMessageType() api.MessageType

func (*BfdUDPSessionDump) Marshal

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

func (*BfdUDPSessionDump) Reset

func (m *BfdUDPSessionDump) Reset()

func (*BfdUDPSessionDump) Size

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

func (*BfdUDPSessionDump) Unmarshal

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

type BfdUDPSessionEvent

type BfdUDPSessionEvent 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"`
	LocalAddr       ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr        ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	State           BfdState                       `binapi:"bfd_state,name=state" json:"state,omitempty"`
	IsAuthenticated bool                           `binapi:"bool,name=is_authenticated" json:"is_authenticated,omitempty"`
	BfdKeyID        uint8                          `binapi:"u8,name=bfd_key_id" json:"bfd_key_id,omitempty"`
	ConfKeyID       uint32                         `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
	RequiredMinRx   uint32                         `binapi:"u32,name=required_min_rx" json:"required_min_rx,omitempty"`
	DesiredMinTx    uint32                         `binapi:"u32,name=desired_min_tx" json:"desired_min_tx,omitempty"`
	DetectMult      uint8                          `binapi:"u8,name=detect_mult" json:"detect_mult,omitempty"`
}

BfdUDPSessionEvent defines message 'bfd_udp_session_event'.

func (*BfdUDPSessionEvent) GetCrcString

func (*BfdUDPSessionEvent) GetCrcString() string

func (*BfdUDPSessionEvent) GetMessageName

func (*BfdUDPSessionEvent) GetMessageName() string

func (*BfdUDPSessionEvent) GetMessageType

func (*BfdUDPSessionEvent) GetMessageType() api.MessageType

func (*BfdUDPSessionEvent) Marshal

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

func (*BfdUDPSessionEvent) Reset

func (m *BfdUDPSessionEvent) Reset()

func (*BfdUDPSessionEvent) Size

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

func (*BfdUDPSessionEvent) Unmarshal

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

type BfdUDPSessionSetFlags

type BfdUDPSessionSetFlags struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	LocalAddr ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr  ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	Flags     interface_types.IfStatusFlags  `binapi:"if_status_flags,name=flags" json:"flags,omitempty"`
}

Set flags of BFD UDP session

  • sw_if_index - sw index of the interface
  • local_addr - local address
  • peer_addr - peer address
  • is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
  • flags - set the admin state, 1 = up, 0 = down

BfdUDPSessionSetFlags defines message 'bfd_udp_session_set_flags'.

func (*BfdUDPSessionSetFlags) GetCrcString

func (*BfdUDPSessionSetFlags) GetCrcString() string

func (*BfdUDPSessionSetFlags) GetMessageName

func (*BfdUDPSessionSetFlags) GetMessageName() string

func (*BfdUDPSessionSetFlags) GetMessageType

func (*BfdUDPSessionSetFlags) GetMessageType() api.MessageType

func (*BfdUDPSessionSetFlags) Marshal

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

func (*BfdUDPSessionSetFlags) Reset

func (m *BfdUDPSessionSetFlags) Reset()

func (*BfdUDPSessionSetFlags) Size

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

func (*BfdUDPSessionSetFlags) Unmarshal

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

type BfdUDPSessionSetFlagsReply

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

BfdUDPSessionSetFlagsReply defines message 'bfd_udp_session_set_flags_reply'.

func (*BfdUDPSessionSetFlagsReply) GetCrcString

func (*BfdUDPSessionSetFlagsReply) GetCrcString() string

func (*BfdUDPSessionSetFlagsReply) GetMessageName

func (*BfdUDPSessionSetFlagsReply) GetMessageName() string

func (*BfdUDPSessionSetFlagsReply) GetMessageType

func (*BfdUDPSessionSetFlagsReply) GetMessageType() api.MessageType

func (*BfdUDPSessionSetFlagsReply) Marshal

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

func (*BfdUDPSessionSetFlagsReply) Reset

func (m *BfdUDPSessionSetFlagsReply) Reset()

func (*BfdUDPSessionSetFlagsReply) Size

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

func (*BfdUDPSessionSetFlagsReply) Unmarshal

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

type BfdUDPSetEchoSource

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

Set BFD echo source

  • sw_if_index - interface to use as echo source

BfdUDPSetEchoSource defines message 'bfd_udp_set_echo_source'.

func (*BfdUDPSetEchoSource) GetCrcString

func (*BfdUDPSetEchoSource) GetCrcString() string

func (*BfdUDPSetEchoSource) GetMessageName

func (*BfdUDPSetEchoSource) GetMessageName() string

func (*BfdUDPSetEchoSource) GetMessageType

func (*BfdUDPSetEchoSource) GetMessageType() api.MessageType

func (*BfdUDPSetEchoSource) Marshal

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

func (*BfdUDPSetEchoSource) Reset

func (m *BfdUDPSetEchoSource) Reset()

func (*BfdUDPSetEchoSource) Size

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

func (*BfdUDPSetEchoSource) Unmarshal

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

type BfdUDPSetEchoSourceReply

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

BfdUDPSetEchoSourceReply defines message 'bfd_udp_set_echo_source_reply'.

func (*BfdUDPSetEchoSourceReply) GetCrcString

func (*BfdUDPSetEchoSourceReply) GetCrcString() string

func (*BfdUDPSetEchoSourceReply) GetMessageName

func (*BfdUDPSetEchoSourceReply) GetMessageName() string

func (*BfdUDPSetEchoSourceReply) GetMessageType

func (*BfdUDPSetEchoSourceReply) GetMessageType() api.MessageType

func (*BfdUDPSetEchoSourceReply) Marshal

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

func (*BfdUDPSetEchoSourceReply) Reset

func (m *BfdUDPSetEchoSourceReply) Reset()

func (*BfdUDPSetEchoSourceReply) Size

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

func (*BfdUDPSetEchoSourceReply) Unmarshal

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

type BfdUDPUpd added in v0.7.0

type BfdUDPUpd struct {
	SwIfIndex       interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	DesiredMinTx    uint32                         `binapi:"u32,name=desired_min_tx" json:"desired_min_tx,omitempty"`
	RequiredMinRx   uint32                         `binapi:"u32,name=required_min_rx" json:"required_min_rx,omitempty"`
	LocalAddr       ip_types.Address               `binapi:"address,name=local_addr" json:"local_addr,omitempty"`
	PeerAddr        ip_types.Address               `binapi:"address,name=peer_addr" json:"peer_addr,omitempty"`
	DetectMult      uint8                          `binapi:"u8,name=detect_mult" json:"detect_mult,omitempty"`
	IsAuthenticated bool                           `binapi:"bool,name=is_authenticated" json:"is_authenticated,omitempty"`
	BfdKeyID        uint8                          `binapi:"u8,name=bfd_key_id" json:"bfd_key_id,omitempty"`
	ConfKeyID       uint32                         `binapi:"u32,name=conf_key_id" json:"conf_key_id,omitempty"`
}

BfdUDPUpd defines message 'bfd_udp_upd'.

func (*BfdUDPUpd) GetCrcString added in v0.7.0

func (*BfdUDPUpd) GetCrcString() string

func (*BfdUDPUpd) GetMessageName added in v0.7.0

func (*BfdUDPUpd) GetMessageName() string

func (*BfdUDPUpd) GetMessageType added in v0.7.0

func (*BfdUDPUpd) GetMessageType() api.MessageType

func (*BfdUDPUpd) Marshal added in v0.7.0

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

func (*BfdUDPUpd) Reset added in v0.7.0

func (m *BfdUDPUpd) Reset()

func (*BfdUDPUpd) Size added in v0.7.0

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

func (*BfdUDPUpd) Unmarshal added in v0.7.0

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

type BfdUDPUpdReply added in v0.7.0

type BfdUDPUpdReply struct {
	Retval     int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	StatsIndex uint32 `binapi:"u32,name=stats_index" json:"stats_index,omitempty"`
}

BfdUDPUpdReply defines message 'bfd_udp_upd_reply'.

func (*BfdUDPUpdReply) GetCrcString added in v0.7.0

func (*BfdUDPUpdReply) GetCrcString() string

func (*BfdUDPUpdReply) GetMessageName added in v0.7.0

func (*BfdUDPUpdReply) GetMessageName() string

func (*BfdUDPUpdReply) GetMessageType added in v0.7.0

func (*BfdUDPUpdReply) GetMessageType() api.MessageType

func (*BfdUDPUpdReply) Marshal added in v0.7.0

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

func (*BfdUDPUpdReply) Reset added in v0.7.0

func (m *BfdUDPUpdReply) Reset()

func (*BfdUDPUpdReply) Size added in v0.7.0

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

func (*BfdUDPUpdReply) Unmarshal added in v0.7.0

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

type RPCService

RPCService defines RPC service bfd.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_BfdAuthKeysDumpClient

type RPCService_BfdAuthKeysDumpClient interface {
	Recv() (*BfdAuthKeysDetails, error)
	api.Stream
}

type RPCService_BfdUDPSessionDumpClient

type RPCService_BfdUDPSessionDumpClient interface {
	Recv() (*BfdUDPSessionDetails, error)
	api.Stream
}

type WantBfdEvents

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

Register for BFD events

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

WantBfdEvents defines message 'want_bfd_events'.

func (*WantBfdEvents) GetCrcString

func (*WantBfdEvents) GetCrcString() string

func (*WantBfdEvents) GetMessageName

func (*WantBfdEvents) GetMessageName() string

func (*WantBfdEvents) GetMessageType

func (*WantBfdEvents) GetMessageType() api.MessageType

func (*WantBfdEvents) Marshal

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

func (*WantBfdEvents) Reset

func (m *WantBfdEvents) Reset()

func (*WantBfdEvents) Size

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

func (*WantBfdEvents) Unmarshal

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

type WantBfdEventsReply

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

WantBfdEventsReply defines message 'want_bfd_events_reply'.

func (*WantBfdEventsReply) GetCrcString

func (*WantBfdEventsReply) GetCrcString() string

func (*WantBfdEventsReply) GetMessageName

func (*WantBfdEventsReply) GetMessageName() string

func (*WantBfdEventsReply) GetMessageType

func (*WantBfdEventsReply) GetMessageType() api.MessageType

func (*WantBfdEventsReply) Marshal

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

func (*WantBfdEventsReply) Reset

func (m *WantBfdEventsReply) Reset()

func (*WantBfdEventsReply) Size

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

func (*WantBfdEventsReply) Unmarshal

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

Jump to

Keyboard shortcuts

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