Documentation ¶
Overview ¶
Package dhcp is a generated VPP binary API for 'dhcp' module.
It consists of:
5 types 25 messages 11 services
Index ¶
- Constants
- func AllMessages() []api.Message
- type DHCP6AddressInfo
- type DHCP6ClientsEnableDisable
- type DHCP6ClientsEnableDisableReply
- type DHCP6DuidLlSet
- type DHCP6DuidLlSetReply
- type DHCP6PdPrefixInfo
- type DHCP6PdReplyEvent
- type DHCP6PdSendClientMessage
- type DHCP6PdSendClientMessageReply
- type DHCP6ReplyEvent
- type DHCP6SendClientMessage
- type DHCP6SendClientMessageReply
- type DHCPClient
- type DHCPClientConfig
- type DHCPClientConfigReply
- type DHCPClientDetails
- type DHCPClientDump
- type DHCPComplEvent
- type DHCPLease
- type DHCPProxyConfig
- type DHCPProxyConfigReply
- type DHCPProxyDetails
- type DHCPProxyDump
- type DHCPProxySetVss
- type DHCPProxySetVssReply
- type DHCPServer
- type RPCService
- type RPCService_DumpDHCPClientClient
- type RPCService_DumpDHCPProxyClient
- type WantDHCP6PdReplyEvents
- type WantDHCP6PdReplyEventsReply
- type WantDHCP6ReplyEvents
- type WantDHCP6ReplyEventsReply
Constants ¶
const ( // ModuleName is the name of this module. ModuleName = "dhcp" // APIVersion is the API version of this module. APIVersion = "2.0.1" // VersionCrc is the CRC of this module. VersionCrc = 0x8c76d62a )
Variables ¶
This section is empty.
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type DHCP6AddressInfo ¶
type DHCP6AddressInfo struct { Address []byte `struc:"[16]byte"` ValidTime uint32 PreferredTime uint32 }
DHCP6AddressInfo represents VPP binary API type 'dhcp6_address_info'.
func (*DHCP6AddressInfo) GetCrcString ¶
func (*DHCP6AddressInfo) GetCrcString() string
func (*DHCP6AddressInfo) GetTypeName ¶
func (*DHCP6AddressInfo) GetTypeName() string
type DHCP6ClientsEnableDisable ¶
type DHCP6ClientsEnableDisable struct {
Enable uint8
}
DHCP6ClientsEnableDisable represents VPP binary API message 'dhcp6_clients_enable_disable'.
func (*DHCP6ClientsEnableDisable) GetCrcString ¶
func (*DHCP6ClientsEnableDisable) GetCrcString() string
func (*DHCP6ClientsEnableDisable) GetMessageName ¶
func (*DHCP6ClientsEnableDisable) GetMessageName() string
func (*DHCP6ClientsEnableDisable) GetMessageType ¶
func (*DHCP6ClientsEnableDisable) GetMessageType() api.MessageType
type DHCP6ClientsEnableDisableReply ¶
type DHCP6ClientsEnableDisableReply struct {
Retval int32
}
DHCP6ClientsEnableDisableReply represents VPP binary API message 'dhcp6_clients_enable_disable_reply'.
func (*DHCP6ClientsEnableDisableReply) GetCrcString ¶
func (*DHCP6ClientsEnableDisableReply) GetCrcString() string
func (*DHCP6ClientsEnableDisableReply) GetMessageName ¶
func (*DHCP6ClientsEnableDisableReply) GetMessageName() string
func (*DHCP6ClientsEnableDisableReply) GetMessageType ¶
func (*DHCP6ClientsEnableDisableReply) GetMessageType() api.MessageType
type DHCP6DuidLlSet ¶
type DHCP6DuidLlSet struct {
DuidLl []byte `struc:"[10]byte"`
}
DHCP6DuidLlSet represents VPP binary API message 'dhcp6_duid_ll_set'.
func (*DHCP6DuidLlSet) GetCrcString ¶
func (*DHCP6DuidLlSet) GetCrcString() string
func (*DHCP6DuidLlSet) GetMessageName ¶
func (*DHCP6DuidLlSet) GetMessageName() string
func (*DHCP6DuidLlSet) GetMessageType ¶
func (*DHCP6DuidLlSet) GetMessageType() api.MessageType
type DHCP6DuidLlSetReply ¶
type DHCP6DuidLlSetReply struct {
Retval int32
}
DHCP6DuidLlSetReply represents VPP binary API message 'dhcp6_duid_ll_set_reply'.
func (*DHCP6DuidLlSetReply) GetCrcString ¶
func (*DHCP6DuidLlSetReply) GetCrcString() string
func (*DHCP6DuidLlSetReply) GetMessageName ¶
func (*DHCP6DuidLlSetReply) GetMessageName() string
func (*DHCP6DuidLlSetReply) GetMessageType ¶
func (*DHCP6DuidLlSetReply) GetMessageType() api.MessageType
type DHCP6PdPrefixInfo ¶
type DHCP6PdPrefixInfo struct { Prefix []byte `struc:"[16]byte"` PrefixLength uint8 ValidTime uint32 PreferredTime uint32 }
DHCP6PdPrefixInfo represents VPP binary API type 'dhcp6_pd_prefix_info'.
func (*DHCP6PdPrefixInfo) GetCrcString ¶
func (*DHCP6PdPrefixInfo) GetCrcString() string
func (*DHCP6PdPrefixInfo) GetTypeName ¶
func (*DHCP6PdPrefixInfo) GetTypeName() string
type DHCP6PdReplyEvent ¶
type DHCP6PdReplyEvent struct { PID uint32 SwIfIndex uint32 ServerIndex uint32 MsgType uint8 T1 uint32 T2 uint32 InnerStatusCode uint16 StatusCode uint16 Preference uint8 NPrefixes uint32 `struc:"sizeof=Prefixes"` Prefixes []DHCP6PdPrefixInfo }
DHCP6PdReplyEvent represents VPP binary API message 'dhcp6_pd_reply_event'.
func (*DHCP6PdReplyEvent) GetCrcString ¶
func (*DHCP6PdReplyEvent) GetCrcString() string
func (*DHCP6PdReplyEvent) GetMessageName ¶
func (*DHCP6PdReplyEvent) GetMessageName() string
func (*DHCP6PdReplyEvent) GetMessageType ¶
func (*DHCP6PdReplyEvent) GetMessageType() api.MessageType
type DHCP6PdSendClientMessage ¶
type DHCP6PdSendClientMessage struct { SwIfIndex uint32 ServerIndex uint32 Irt uint32 Mrt uint32 Mrc uint32 Mrd uint32 Stop uint8 MsgType uint8 T1 uint32 T2 uint32 NPrefixes uint32 `struc:"sizeof=Prefixes"` Prefixes []DHCP6PdPrefixInfo }
DHCP6PdSendClientMessage represents VPP binary API message 'dhcp6_pd_send_client_message'.
func (*DHCP6PdSendClientMessage) GetCrcString ¶
func (*DHCP6PdSendClientMessage) GetCrcString() string
func (*DHCP6PdSendClientMessage) GetMessageName ¶
func (*DHCP6PdSendClientMessage) GetMessageName() string
func (*DHCP6PdSendClientMessage) GetMessageType ¶
func (*DHCP6PdSendClientMessage) GetMessageType() api.MessageType
type DHCP6PdSendClientMessageReply ¶
type DHCP6PdSendClientMessageReply struct {
Retval int32
}
DHCP6PdSendClientMessageReply represents VPP binary API message 'dhcp6_pd_send_client_message_reply'.
func (*DHCP6PdSendClientMessageReply) GetCrcString ¶
func (*DHCP6PdSendClientMessageReply) GetCrcString() string
func (*DHCP6PdSendClientMessageReply) GetMessageName ¶
func (*DHCP6PdSendClientMessageReply) GetMessageName() string
func (*DHCP6PdSendClientMessageReply) GetMessageType ¶
func (*DHCP6PdSendClientMessageReply) GetMessageType() api.MessageType
type DHCP6ReplyEvent ¶
type DHCP6ReplyEvent struct { PID uint32 SwIfIndex uint32 ServerIndex uint32 MsgType uint8 T1 uint32 T2 uint32 InnerStatusCode uint16 StatusCode uint16 Preference uint8 NAddresses uint32 `struc:"sizeof=Addresses"` Addresses []DHCP6AddressInfo }
DHCP6ReplyEvent represents VPP binary API message 'dhcp6_reply_event'.
func (*DHCP6ReplyEvent) GetCrcString ¶
func (*DHCP6ReplyEvent) GetCrcString() string
func (*DHCP6ReplyEvent) GetMessageName ¶
func (*DHCP6ReplyEvent) GetMessageName() string
func (*DHCP6ReplyEvent) GetMessageType ¶
func (*DHCP6ReplyEvent) GetMessageType() api.MessageType
type DHCP6SendClientMessage ¶
type DHCP6SendClientMessage struct { SwIfIndex uint32 ServerIndex uint32 Irt uint32 Mrt uint32 Mrc uint32 Mrd uint32 Stop uint8 MsgType uint8 T1 uint32 T2 uint32 NAddresses uint32 `struc:"sizeof=Addresses"` Addresses []DHCP6AddressInfo }
DHCP6SendClientMessage represents VPP binary API message 'dhcp6_send_client_message'.
func (*DHCP6SendClientMessage) GetCrcString ¶
func (*DHCP6SendClientMessage) GetCrcString() string
func (*DHCP6SendClientMessage) GetMessageName ¶
func (*DHCP6SendClientMessage) GetMessageName() string
func (*DHCP6SendClientMessage) GetMessageType ¶
func (*DHCP6SendClientMessage) GetMessageType() api.MessageType
type DHCP6SendClientMessageReply ¶
type DHCP6SendClientMessageReply struct {
Retval int32
}
DHCP6SendClientMessageReply represents VPP binary API message 'dhcp6_send_client_message_reply'.
func (*DHCP6SendClientMessageReply) GetCrcString ¶
func (*DHCP6SendClientMessageReply) GetCrcString() string
func (*DHCP6SendClientMessageReply) GetMessageName ¶
func (*DHCP6SendClientMessageReply) GetMessageName() string
func (*DHCP6SendClientMessageReply) GetMessageType ¶
func (*DHCP6SendClientMessageReply) GetMessageType() api.MessageType
type DHCPClient ¶
type DHCPClient struct { SwIfIndex uint32 Hostname []byte `struc:"[64]byte"` ID []byte `struc:"[64]byte"` WantDHCPEvent uint8 SetBroadcastFlag uint8 PID uint32 }
DHCPClient represents VPP binary API type 'dhcp_client'.
func (*DHCPClient) GetCrcString ¶
func (*DHCPClient) GetCrcString() string
func (*DHCPClient) GetTypeName ¶
func (*DHCPClient) GetTypeName() string
type DHCPClientConfig ¶
type DHCPClientConfig struct { IsAdd uint8 Client DHCPClient }
DHCPClientConfig represents VPP binary API message 'dhcp_client_config'.
func (*DHCPClientConfig) GetCrcString ¶
func (*DHCPClientConfig) GetCrcString() string
func (*DHCPClientConfig) GetMessageName ¶
func (*DHCPClientConfig) GetMessageName() string
func (*DHCPClientConfig) GetMessageType ¶
func (*DHCPClientConfig) GetMessageType() api.MessageType
type DHCPClientConfigReply ¶
type DHCPClientConfigReply struct {
Retval int32
}
DHCPClientConfigReply represents VPP binary API message 'dhcp_client_config_reply'.
func (*DHCPClientConfigReply) GetCrcString ¶
func (*DHCPClientConfigReply) GetCrcString() string
func (*DHCPClientConfigReply) GetMessageName ¶
func (*DHCPClientConfigReply) GetMessageName() string
func (*DHCPClientConfigReply) GetMessageType ¶
func (*DHCPClientConfigReply) GetMessageType() api.MessageType
type DHCPClientDetails ¶
type DHCPClientDetails struct { Client DHCPClient Lease DHCPLease }
DHCPClientDetails represents VPP binary API message 'dhcp_client_details'.
func (*DHCPClientDetails) GetCrcString ¶
func (*DHCPClientDetails) GetCrcString() string
func (*DHCPClientDetails) GetMessageName ¶
func (*DHCPClientDetails) GetMessageName() string
func (*DHCPClientDetails) GetMessageType ¶
func (*DHCPClientDetails) GetMessageType() api.MessageType
type DHCPClientDump ¶
type DHCPClientDump struct{}
DHCPClientDump represents VPP binary API message 'dhcp_client_dump'.
func (*DHCPClientDump) GetCrcString ¶
func (*DHCPClientDump) GetCrcString() string
func (*DHCPClientDump) GetMessageName ¶
func (*DHCPClientDump) GetMessageName() string
func (*DHCPClientDump) GetMessageType ¶
func (*DHCPClientDump) GetMessageType() api.MessageType
type DHCPComplEvent ¶
DHCPComplEvent represents VPP binary API message 'dhcp_compl_event'.
func (*DHCPComplEvent) GetCrcString ¶
func (*DHCPComplEvent) GetCrcString() string
func (*DHCPComplEvent) GetMessageName ¶
func (*DHCPComplEvent) GetMessageName() string
func (*DHCPComplEvent) GetMessageType ¶
func (*DHCPComplEvent) GetMessageType() api.MessageType
type DHCPLease ¶
type DHCPLease struct { SwIfIndex uint32 State uint8 Hostname []byte `struc:"[64]byte"` IsIPv6 uint8 MaskWidth uint8 HostAddress []byte `struc:"[16]byte"` RouterAddress []byte `struc:"[16]byte"` HostMac []byte `struc:"[6]byte"` }
DHCPLease represents VPP binary API type 'dhcp_lease'.
func (*DHCPLease) GetCrcString ¶
func (*DHCPLease) GetTypeName ¶
type DHCPProxyConfig ¶
type DHCPProxyConfig struct { RxVrfID uint32 ServerVrfID uint32 IsIPv6 uint8 IsAdd uint8 DHCPServer []byte `struc:"[16]byte"` DHCPSrcAddress []byte `struc:"[16]byte"` }
DHCPProxyConfig represents VPP binary API message 'dhcp_proxy_config'.
func (*DHCPProxyConfig) GetCrcString ¶
func (*DHCPProxyConfig) GetCrcString() string
func (*DHCPProxyConfig) GetMessageName ¶
func (*DHCPProxyConfig) GetMessageName() string
func (*DHCPProxyConfig) GetMessageType ¶
func (*DHCPProxyConfig) GetMessageType() api.MessageType
type DHCPProxyConfigReply ¶
type DHCPProxyConfigReply struct {
Retval int32
}
DHCPProxyConfigReply represents VPP binary API message 'dhcp_proxy_config_reply'.
func (*DHCPProxyConfigReply) GetCrcString ¶
func (*DHCPProxyConfigReply) GetCrcString() string
func (*DHCPProxyConfigReply) GetMessageName ¶
func (*DHCPProxyConfigReply) GetMessageName() string
func (*DHCPProxyConfigReply) GetMessageType ¶
func (*DHCPProxyConfigReply) GetMessageType() api.MessageType
type DHCPProxyDetails ¶
type DHCPProxyDetails struct { RxVrfID uint32 VssOui uint32 VssFibID uint32 VssType uint8 VssVPNAsciiID []byte `struc:"[129]byte"` IsIPv6 uint8 DHCPSrcAddress []byte `struc:"[16]byte"` Count uint8 `struc:"sizeof=Servers"` Servers []DHCPServer }
DHCPProxyDetails represents VPP binary API message 'dhcp_proxy_details'.
func (*DHCPProxyDetails) GetCrcString ¶
func (*DHCPProxyDetails) GetCrcString() string
func (*DHCPProxyDetails) GetMessageName ¶
func (*DHCPProxyDetails) GetMessageName() string
func (*DHCPProxyDetails) GetMessageType ¶
func (*DHCPProxyDetails) GetMessageType() api.MessageType
type DHCPProxyDump ¶
type DHCPProxyDump struct {
IsIP6 uint8
}
DHCPProxyDump represents VPP binary API message 'dhcp_proxy_dump'.
func (*DHCPProxyDump) GetCrcString ¶
func (*DHCPProxyDump) GetCrcString() string
func (*DHCPProxyDump) GetMessageName ¶
func (*DHCPProxyDump) GetMessageName() string
func (*DHCPProxyDump) GetMessageType ¶
func (*DHCPProxyDump) GetMessageType() api.MessageType
type DHCPProxySetVss ¶
type DHCPProxySetVss struct { TblID uint32 VssType uint8 VPNAsciiID []byte `struc:"[129]byte"` Oui uint32 VPNIndex uint32 IsIPv6 uint8 IsAdd uint8 }
DHCPProxySetVss represents VPP binary API message 'dhcp_proxy_set_vss'.
func (*DHCPProxySetVss) GetCrcString ¶
func (*DHCPProxySetVss) GetCrcString() string
func (*DHCPProxySetVss) GetMessageName ¶
func (*DHCPProxySetVss) GetMessageName() string
func (*DHCPProxySetVss) GetMessageType ¶
func (*DHCPProxySetVss) GetMessageType() api.MessageType
type DHCPProxySetVssReply ¶
type DHCPProxySetVssReply struct {
Retval int32
}
DHCPProxySetVssReply represents VPP binary API message 'dhcp_proxy_set_vss_reply'.
func (*DHCPProxySetVssReply) GetCrcString ¶
func (*DHCPProxySetVssReply) GetCrcString() string
func (*DHCPProxySetVssReply) GetMessageName ¶
func (*DHCPProxySetVssReply) GetMessageName() string
func (*DHCPProxySetVssReply) GetMessageType ¶
func (*DHCPProxySetVssReply) GetMessageType() api.MessageType
type DHCPServer ¶
DHCPServer represents VPP binary API type 'dhcp_server'.
func (*DHCPServer) GetCrcString ¶
func (*DHCPServer) GetCrcString() string
func (*DHCPServer) GetTypeName ¶
func (*DHCPServer) GetTypeName() string
type RPCService ¶
type RPCService interface { DumpDHCPClient(ctx context.Context, in *DHCPClientDump) (RPCService_DumpDHCPClientClient, error) DumpDHCPProxy(ctx context.Context, in *DHCPProxyDump) (RPCService_DumpDHCPProxyClient, error) DHCP6ClientsEnableDisable(ctx context.Context, in *DHCP6ClientsEnableDisable) (*DHCP6ClientsEnableDisableReply, error) DHCP6DuidLlSet(ctx context.Context, in *DHCP6DuidLlSet) (*DHCP6DuidLlSetReply, error) DHCP6PdSendClientMessage(ctx context.Context, in *DHCP6PdSendClientMessage) (*DHCP6PdSendClientMessageReply, error) DHCP6SendClientMessage(ctx context.Context, in *DHCP6SendClientMessage) (*DHCP6SendClientMessageReply, error) DHCPClientConfig(ctx context.Context, in *DHCPClientConfig) (*DHCPClientConfigReply, error) DHCPProxyConfig(ctx context.Context, in *DHCPProxyConfig) (*DHCPProxyConfigReply, error) DHCPProxySetVss(ctx context.Context, in *DHCPProxySetVss) (*DHCPProxySetVssReply, error) WantDHCP6PdReplyEvents(ctx context.Context, in *WantDHCP6PdReplyEvents) (*WantDHCP6PdReplyEventsReply, error) WantDHCP6ReplyEvents(ctx context.Context, in *WantDHCP6ReplyEvents) (*WantDHCP6ReplyEventsReply, error) }
RPCService represents RPC service API for dhcp module.
func NewServiceClient ¶
func NewServiceClient(ch api.Channel) RPCService
type RPCService_DumpDHCPClientClient ¶
type RPCService_DumpDHCPClientClient interface {
Recv() (*DHCPClientDetails, error)
}
type RPCService_DumpDHCPProxyClient ¶
type RPCService_DumpDHCPProxyClient interface {
Recv() (*DHCPProxyDetails, error)
}
type WantDHCP6PdReplyEvents ¶
WantDHCP6PdReplyEvents represents VPP binary API message 'want_dhcp6_pd_reply_events'.
func (*WantDHCP6PdReplyEvents) GetCrcString ¶
func (*WantDHCP6PdReplyEvents) GetCrcString() string
func (*WantDHCP6PdReplyEvents) GetMessageName ¶
func (*WantDHCP6PdReplyEvents) GetMessageName() string
func (*WantDHCP6PdReplyEvents) GetMessageType ¶
func (*WantDHCP6PdReplyEvents) GetMessageType() api.MessageType
type WantDHCP6PdReplyEventsReply ¶
type WantDHCP6PdReplyEventsReply struct {
Retval int32
}
WantDHCP6PdReplyEventsReply represents VPP binary API message 'want_dhcp6_pd_reply_events_reply'.
func (*WantDHCP6PdReplyEventsReply) GetCrcString ¶
func (*WantDHCP6PdReplyEventsReply) GetCrcString() string
func (*WantDHCP6PdReplyEventsReply) GetMessageName ¶
func (*WantDHCP6PdReplyEventsReply) GetMessageName() string
func (*WantDHCP6PdReplyEventsReply) GetMessageType ¶
func (*WantDHCP6PdReplyEventsReply) GetMessageType() api.MessageType
type WantDHCP6ReplyEvents ¶
WantDHCP6ReplyEvents represents VPP binary API message 'want_dhcp6_reply_events'.
func (*WantDHCP6ReplyEvents) GetCrcString ¶
func (*WantDHCP6ReplyEvents) GetCrcString() string
func (*WantDHCP6ReplyEvents) GetMessageName ¶
func (*WantDHCP6ReplyEvents) GetMessageName() string
func (*WantDHCP6ReplyEvents) GetMessageType ¶
func (*WantDHCP6ReplyEvents) GetMessageType() api.MessageType
type WantDHCP6ReplyEventsReply ¶
type WantDHCP6ReplyEventsReply struct {
Retval int32
}
WantDHCP6ReplyEventsReply represents VPP binary API message 'want_dhcp6_reply_events_reply'.
func (*WantDHCP6ReplyEventsReply) GetCrcString ¶
func (*WantDHCP6ReplyEventsReply) GetCrcString() string
func (*WantDHCP6ReplyEventsReply) GetMessageName ¶
func (*WantDHCP6ReplyEventsReply) GetMessageName() string
func (*WantDHCP6ReplyEventsReply) GetMessageType ¶
func (*WantDHCP6ReplyEventsReply) GetMessageType() api.MessageType