Documentation
¶
Overview ¶
Package gre contains generated bindings for API file gre.api.
Contents: - 1 enum - 2 structs - 10 messages
Index ¶
- Constants
- Variables
- func AllMessages() []api.Message
- type GreTunnel
- type GreTunnelAddDel
- func (*GreTunnelAddDel) GetCrcString() string
- func (*GreTunnelAddDel) GetMessageName() string
- func (*GreTunnelAddDel) GetMessageType() api.MessageType
- func (m *GreTunnelAddDel) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelAddDel) Reset()
- func (m *GreTunnelAddDel) Size() (size int)
- func (m *GreTunnelAddDel) Unmarshal(b []byte) error
- type GreTunnelAddDelReply
- func (*GreTunnelAddDelReply) GetCrcString() string
- func (*GreTunnelAddDelReply) GetMessageName() string
- func (*GreTunnelAddDelReply) GetMessageType() api.MessageType
- func (m *GreTunnelAddDelReply) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelAddDelReply) Reset()
- func (m *GreTunnelAddDelReply) Size() (size int)
- func (m *GreTunnelAddDelReply) Unmarshal(b []byte) error
- type GreTunnelAddDelV2
- func (*GreTunnelAddDelV2) GetCrcString() string
- func (*GreTunnelAddDelV2) GetMessageName() string
- func (*GreTunnelAddDelV2) GetMessageType() api.MessageType
- func (m *GreTunnelAddDelV2) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelAddDelV2) Reset()
- func (m *GreTunnelAddDelV2) Size() (size int)
- func (m *GreTunnelAddDelV2) Unmarshal(b []byte) error
- type GreTunnelAddDelV2Reply
- func (*GreTunnelAddDelV2Reply) GetCrcString() string
- func (*GreTunnelAddDelV2Reply) GetMessageName() string
- func (*GreTunnelAddDelV2Reply) GetMessageType() api.MessageType
- func (m *GreTunnelAddDelV2Reply) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelAddDelV2Reply) Reset()
- func (m *GreTunnelAddDelV2Reply) Size() (size int)
- func (m *GreTunnelAddDelV2Reply) Unmarshal(b []byte) error
- type GreTunnelDetails
- func (*GreTunnelDetails) GetCrcString() string
- func (*GreTunnelDetails) GetMessageName() string
- func (*GreTunnelDetails) GetMessageType() api.MessageType
- func (m *GreTunnelDetails) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDetails) Reset()
- func (m *GreTunnelDetails) Size() (size int)
- func (m *GreTunnelDetails) Unmarshal(b []byte) error
- type GreTunnelDetailsV2
- func (*GreTunnelDetailsV2) GetCrcString() string
- func (*GreTunnelDetailsV2) GetMessageName() string
- func (*GreTunnelDetailsV2) GetMessageType() api.MessageType
- func (m *GreTunnelDetailsV2) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDetailsV2) Reset()
- func (m *GreTunnelDetailsV2) Size() (size int)
- func (m *GreTunnelDetailsV2) Unmarshal(b []byte) error
- type GreTunnelDump
- func (*GreTunnelDump) GetCrcString() string
- func (*GreTunnelDump) GetMessageName() string
- func (*GreTunnelDump) GetMessageType() api.MessageType
- func (m *GreTunnelDump) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDump) Reset()
- func (m *GreTunnelDump) Size() (size int)
- func (m *GreTunnelDump) Unmarshal(b []byte) error
- type GreTunnelDumpReply
- func (*GreTunnelDumpReply) GetCrcString() string
- func (*GreTunnelDumpReply) GetMessageName() string
- func (*GreTunnelDumpReply) GetMessageType() api.MessageType
- func (m *GreTunnelDumpReply) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDumpReply) Reset()
- func (m *GreTunnelDumpReply) Size() (size int)
- func (m *GreTunnelDumpReply) Unmarshal(b []byte) error
- type GreTunnelDumpV2
- func (*GreTunnelDumpV2) GetCrcString() string
- func (*GreTunnelDumpV2) GetMessageName() string
- func (*GreTunnelDumpV2) GetMessageType() api.MessageType
- func (m *GreTunnelDumpV2) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDumpV2) Reset()
- func (m *GreTunnelDumpV2) Size() (size int)
- func (m *GreTunnelDumpV2) Unmarshal(b []byte) error
- type GreTunnelDumpV2Reply
- func (*GreTunnelDumpV2Reply) GetCrcString() string
- func (*GreTunnelDumpV2Reply) GetMessageName() string
- func (*GreTunnelDumpV2Reply) GetMessageType() api.MessageType
- func (m *GreTunnelDumpV2Reply) Marshal(b []byte) ([]byte, error)
- func (m *GreTunnelDumpV2Reply) Reset()
- func (m *GreTunnelDumpV2Reply) Size() (size int)
- func (m *GreTunnelDumpV2Reply) Unmarshal(b []byte) error
- type GreTunnelType
- type GreTunnelV2
- type RPCService
Constants ¶
const ( APIFile = "gre" APIVersion = "2.1.1" VersionCrc = 0x3a070f21 )
Variables ¶
var ( GreTunnelType_name = map[uint8]string{ 0: "GRE_API_TUNNEL_TYPE_L3", 1: "GRE_API_TUNNEL_TYPE_TEB", 2: "GRE_API_TUNNEL_TYPE_ERSPAN", } GreTunnelType_value = map[string]uint8{ "GRE_API_TUNNEL_TYPE_L3": 0, "GRE_API_TUNNEL_TYPE_TEB": 1, "GRE_API_TUNNEL_TYPE_ERSPAN": 2, } )
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type GreTunnel ¶
type GreTunnel struct {
Type GreTunnelType `binapi:"gre_tunnel_type,name=type" json:"type,omitempty"`
Mode tunnel_types.TunnelMode `binapi:"tunnel_mode,name=mode" json:"mode,omitempty"`
Flags tunnel_types.TunnelEncapDecapFlags `binapi:"tunnel_encap_decap_flags,name=flags" json:"flags,omitempty"`
SessionID uint16 `binapi:"u16,name=session_id" json:"session_id,omitempty"`
Instance uint32 `binapi:"u32,name=instance" json:"instance,omitempty"`
OuterTableID uint32 `binapi:"u32,name=outer_table_id" json:"outer_table_id,omitempty"`
SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
Src ip_types.Address `binapi:"address,name=src" json:"src,omitempty"`
Dst ip_types.Address `binapi:"address,name=dst" json:"dst,omitempty"`
}
GreTunnel defines type 'gre_tunnel'.
type GreTunnelAddDel ¶
type GreTunnelAddDel struct {
IsAdd bool `binapi:"bool,name=is_add" json:"is_add,omitempty"`
Tunnel GreTunnel `binapi:"gre_tunnel,name=tunnel" json:"tunnel,omitempty"`
}
Add or delete a single GRE tunnel.
- is_add - add if true, delete if false.
- tunnel - tunnel definition to add or delete.
GreTunnelAddDel defines message 'gre_tunnel_add_del'.
func (*GreTunnelAddDel) GetCrcString ¶
func (*GreTunnelAddDel) GetCrcString() string
func (*GreTunnelAddDel) GetMessageName ¶
func (*GreTunnelAddDel) GetMessageName() string
func (*GreTunnelAddDel) GetMessageType ¶
func (*GreTunnelAddDel) GetMessageType() api.MessageType
func (*GreTunnelAddDel) Reset ¶
func (m *GreTunnelAddDel) Reset()
func (*GreTunnelAddDel) Size ¶
func (m *GreTunnelAddDel) Size() (size int)
func (*GreTunnelAddDel) Unmarshal ¶
func (m *GreTunnelAddDel) Unmarshal(b []byte) error
type GreTunnelAddDelReply ¶
type GreTunnelAddDelReply 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"`
}
Add or delete a single GRE tunnel.
- retval - return code for the request.
- sw_if_index - the interface corresponding to the affected tunnel.
GreTunnelAddDelReply defines message 'gre_tunnel_add_del_reply'.
func (*GreTunnelAddDelReply) GetCrcString ¶
func (*GreTunnelAddDelReply) GetCrcString() string
func (*GreTunnelAddDelReply) GetMessageName ¶
func (*GreTunnelAddDelReply) GetMessageName() string
func (*GreTunnelAddDelReply) GetMessageType ¶
func (*GreTunnelAddDelReply) GetMessageType() api.MessageType
func (*GreTunnelAddDelReply) Marshal ¶
func (m *GreTunnelAddDelReply) Marshal(b []byte) ([]byte, error)
func (*GreTunnelAddDelReply) Reset ¶
func (m *GreTunnelAddDelReply) Reset()
func (*GreTunnelAddDelReply) Size ¶
func (m *GreTunnelAddDelReply) Size() (size int)
func (*GreTunnelAddDelReply) Unmarshal ¶
func (m *GreTunnelAddDelReply) Unmarshal(b []byte) error
type GreTunnelAddDelV2 ¶ added in v0.9.0
type GreTunnelAddDelV2 struct {
IsAdd bool `binapi:"bool,name=is_add" json:"is_add,omitempty"`
Tunnel GreTunnelV2 `binapi:"gre_tunnel_v2,name=tunnel" json:"tunnel,omitempty"`
}
Add or delete a single GRE tunnel with key support.
- is_add - add if true, delete if false.
- tunnel - tunnel definition to add or delete (with key field).
GreTunnelAddDelV2 defines message 'gre_tunnel_add_del_v2'.
func (*GreTunnelAddDelV2) GetCrcString ¶ added in v0.9.0
func (*GreTunnelAddDelV2) GetCrcString() string
func (*GreTunnelAddDelV2) GetMessageName ¶ added in v0.9.0
func (*GreTunnelAddDelV2) GetMessageName() string
func (*GreTunnelAddDelV2) GetMessageType ¶ added in v0.9.0
func (*GreTunnelAddDelV2) GetMessageType() api.MessageType
func (*GreTunnelAddDelV2) Marshal ¶ added in v0.9.0
func (m *GreTunnelAddDelV2) Marshal(b []byte) ([]byte, error)
func (*GreTunnelAddDelV2) Reset ¶ added in v0.9.0
func (m *GreTunnelAddDelV2) Reset()
func (*GreTunnelAddDelV2) Size ¶ added in v0.9.0
func (m *GreTunnelAddDelV2) Size() (size int)
func (*GreTunnelAddDelV2) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelAddDelV2) Unmarshal(b []byte) error
type GreTunnelAddDelV2Reply ¶ added in v0.9.0
type GreTunnelAddDelV2Reply 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"`
}
Add or delete a single GRE tunnel with key support.
- retval - return code for the request.
- sw_if_index - the interface corresponding to the affected tunnel.
GreTunnelAddDelV2Reply defines message 'gre_tunnel_add_del_v2_reply'.
func (*GreTunnelAddDelV2Reply) GetCrcString ¶ added in v0.9.0
func (*GreTunnelAddDelV2Reply) GetCrcString() string
func (*GreTunnelAddDelV2Reply) GetMessageName ¶ added in v0.9.0
func (*GreTunnelAddDelV2Reply) GetMessageName() string
func (*GreTunnelAddDelV2Reply) GetMessageType ¶ added in v0.9.0
func (*GreTunnelAddDelV2Reply) GetMessageType() api.MessageType
func (*GreTunnelAddDelV2Reply) Marshal ¶ added in v0.9.0
func (m *GreTunnelAddDelV2Reply) Marshal(b []byte) ([]byte, error)
func (*GreTunnelAddDelV2Reply) Reset ¶ added in v0.9.0
func (m *GreTunnelAddDelV2Reply) Reset()
func (*GreTunnelAddDelV2Reply) Size ¶ added in v0.9.0
func (m *GreTunnelAddDelV2Reply) Size() (size int)
func (*GreTunnelAddDelV2Reply) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelAddDelV2Reply) Unmarshal(b []byte) error
type GreTunnelDetails ¶
type GreTunnelDetails struct {
Tunnel GreTunnel `binapi:"gre_tunnel,name=tunnel" json:"tunnel,omitempty"`
}
Details response for one of the requested GRE tunnels.
- tunnel - definition of the dumped tunnel.
GreTunnelDetails defines message 'gre_tunnel_details'.
func (*GreTunnelDetails) GetCrcString ¶
func (*GreTunnelDetails) GetCrcString() string
func (*GreTunnelDetails) GetMessageName ¶
func (*GreTunnelDetails) GetMessageName() string
func (*GreTunnelDetails) GetMessageType ¶
func (*GreTunnelDetails) GetMessageType() api.MessageType
func (*GreTunnelDetails) Reset ¶
func (m *GreTunnelDetails) Reset()
func (*GreTunnelDetails) Size ¶
func (m *GreTunnelDetails) Size() (size int)
func (*GreTunnelDetails) Unmarshal ¶
func (m *GreTunnelDetails) Unmarshal(b []byte) error
type GreTunnelDetailsV2 ¶ added in v0.9.0
type GreTunnelDetailsV2 struct {
Tunnel GreTunnelV2 `binapi:"gre_tunnel_v2,name=tunnel" json:"tunnel,omitempty"`
}
Details response for one of the requested GRE tunnels with key support.
- tunnel - definition of the dumped tunnel (with key field).
GreTunnelDetailsV2 defines message 'gre_tunnel_details_v2'.
func (*GreTunnelDetailsV2) GetCrcString ¶ added in v0.9.0
func (*GreTunnelDetailsV2) GetCrcString() string
func (*GreTunnelDetailsV2) GetMessageName ¶ added in v0.9.0
func (*GreTunnelDetailsV2) GetMessageName() string
func (*GreTunnelDetailsV2) GetMessageType ¶ added in v0.9.0
func (*GreTunnelDetailsV2) GetMessageType() api.MessageType
func (*GreTunnelDetailsV2) Marshal ¶ added in v0.9.0
func (m *GreTunnelDetailsV2) Marshal(b []byte) ([]byte, error)
func (*GreTunnelDetailsV2) Reset ¶ added in v0.9.0
func (m *GreTunnelDetailsV2) Reset()
func (*GreTunnelDetailsV2) Size ¶ added in v0.9.0
func (m *GreTunnelDetailsV2) Size() (size int)
func (*GreTunnelDetailsV2) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelDetailsV2) Unmarshal(b []byte) error
type GreTunnelDump ¶
type GreTunnelDump struct {
SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}
Dump details of all or just a single GRE tunnel.
- sw_if_index - filter for tunnel of this interface index, ~0 for all.
GreTunnelDump defines message 'gre_tunnel_dump'.
func (*GreTunnelDump) GetCrcString ¶
func (*GreTunnelDump) GetCrcString() string
func (*GreTunnelDump) GetMessageName ¶
func (*GreTunnelDump) GetMessageName() string
func (*GreTunnelDump) GetMessageType ¶
func (*GreTunnelDump) GetMessageType() api.MessageType
func (*GreTunnelDump) Reset ¶
func (m *GreTunnelDump) Reset()
func (*GreTunnelDump) Size ¶
func (m *GreTunnelDump) Size() (size int)
func (*GreTunnelDump) Unmarshal ¶
func (m *GreTunnelDump) Unmarshal(b []byte) error
type GreTunnelDumpReply ¶ added in v0.9.0
type GreTunnelDumpReply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
Reply for gre_tunnel_dump - empty since actual data is sent via gre_tunnel_details.
- retval - return code for the request.
GreTunnelDumpReply defines message 'gre_tunnel_dump_reply'.
func (*GreTunnelDumpReply) GetCrcString ¶ added in v0.9.0
func (*GreTunnelDumpReply) GetCrcString() string
func (*GreTunnelDumpReply) GetMessageName ¶ added in v0.9.0
func (*GreTunnelDumpReply) GetMessageName() string
func (*GreTunnelDumpReply) GetMessageType ¶ added in v0.9.0
func (*GreTunnelDumpReply) GetMessageType() api.MessageType
func (*GreTunnelDumpReply) Marshal ¶ added in v0.9.0
func (m *GreTunnelDumpReply) Marshal(b []byte) ([]byte, error)
func (*GreTunnelDumpReply) Reset ¶ added in v0.9.0
func (m *GreTunnelDumpReply) Reset()
func (*GreTunnelDumpReply) Size ¶ added in v0.9.0
func (m *GreTunnelDumpReply) Size() (size int)
func (*GreTunnelDumpReply) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelDumpReply) Unmarshal(b []byte) error
type GreTunnelDumpV2 ¶ added in v0.9.0
type GreTunnelDumpV2 struct {
SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}
Dump details of all or just a single GRE tunnel with key support.
- sw_if_index - filter for tunnel of this interface index, ~0 for all.
GreTunnelDumpV2 defines message 'gre_tunnel_dump_v2'.
func (*GreTunnelDumpV2) GetCrcString ¶ added in v0.9.0
func (*GreTunnelDumpV2) GetCrcString() string
func (*GreTunnelDumpV2) GetMessageName ¶ added in v0.9.0
func (*GreTunnelDumpV2) GetMessageName() string
func (*GreTunnelDumpV2) GetMessageType ¶ added in v0.9.0
func (*GreTunnelDumpV2) GetMessageType() api.MessageType
func (*GreTunnelDumpV2) Marshal ¶ added in v0.9.0
func (m *GreTunnelDumpV2) Marshal(b []byte) ([]byte, error)
func (*GreTunnelDumpV2) Reset ¶ added in v0.9.0
func (m *GreTunnelDumpV2) Reset()
func (*GreTunnelDumpV2) Size ¶ added in v0.9.0
func (m *GreTunnelDumpV2) Size() (size int)
func (*GreTunnelDumpV2) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelDumpV2) Unmarshal(b []byte) error
type GreTunnelDumpV2Reply ¶ added in v0.9.0
type GreTunnelDumpV2Reply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
GreTunnelDumpV2Reply defines message 'gre_tunnel_dump_v2_reply'.
func (*GreTunnelDumpV2Reply) GetCrcString ¶ added in v0.9.0
func (*GreTunnelDumpV2Reply) GetCrcString() string
func (*GreTunnelDumpV2Reply) GetMessageName ¶ added in v0.9.0
func (*GreTunnelDumpV2Reply) GetMessageName() string
func (*GreTunnelDumpV2Reply) GetMessageType ¶ added in v0.9.0
func (*GreTunnelDumpV2Reply) GetMessageType() api.MessageType
func (*GreTunnelDumpV2Reply) Marshal ¶ added in v0.9.0
func (m *GreTunnelDumpV2Reply) Marshal(b []byte) ([]byte, error)
func (*GreTunnelDumpV2Reply) Reset ¶ added in v0.9.0
func (m *GreTunnelDumpV2Reply) Reset()
func (*GreTunnelDumpV2Reply) Size ¶ added in v0.9.0
func (m *GreTunnelDumpV2Reply) Size() (size int)
func (*GreTunnelDumpV2Reply) Unmarshal ¶ added in v0.9.0
func (m *GreTunnelDumpV2Reply) Unmarshal(b []byte) error
type GreTunnelType ¶
type GreTunnelType uint8
GreTunnelType defines enum 'gre_tunnel_type'.
const ( GRE_API_TUNNEL_TYPE_L3 GreTunnelType = 0 GRE_API_TUNNEL_TYPE_TEB GreTunnelType = 1 GRE_API_TUNNEL_TYPE_ERSPAN GreTunnelType = 2 )
func (GreTunnelType) String ¶
func (x GreTunnelType) String() string
type GreTunnelV2 ¶ added in v0.9.0
type GreTunnelV2 struct {
Type GreTunnelType `binapi:"gre_tunnel_type,name=type" json:"type,omitempty"`
Mode tunnel_types.TunnelMode `binapi:"tunnel_mode,name=mode" json:"mode,omitempty"`
Flags tunnel_types.TunnelEncapDecapFlags `binapi:"tunnel_encap_decap_flags,name=flags" json:"flags,omitempty"`
SessionID uint16 `binapi:"u16,name=session_id" json:"session_id,omitempty"`
Instance uint32 `binapi:"u32,name=instance" json:"instance,omitempty"`
OuterTableID uint32 `binapi:"u32,name=outer_table_id" json:"outer_table_id,omitempty"`
SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
Src ip_types.Address `binapi:"address,name=src" json:"src,omitempty"`
Dst ip_types.Address `binapi:"address,name=dst" json:"dst,omitempty"`
Key uint32 `binapi:"u32,name=key" json:"key,omitempty"`
}
GreTunnelV2 defines type 'gre_tunnel_v2'.
type RPCService ¶
type RPCService interface {
GreTunnelAddDel(ctx context.Context, in *GreTunnelAddDel) (*GreTunnelAddDelReply, error)
GreTunnelAddDelV2(ctx context.Context, in *GreTunnelAddDelV2) (*GreTunnelAddDelV2Reply, error)
GreTunnelDump(ctx context.Context, in *GreTunnelDump) (*GreTunnelDumpReply, error)
GreTunnelDumpV2(ctx context.Context, in *GreTunnelDumpV2) (*GreTunnelDumpV2Reply, error)
}
RPCService defines RPC service gre.
func NewServiceClient ¶
func NewServiceClient(conn api.Connection) RPCService