FD.io VPP
v19.01.3-6-g70449b9b9
Vector Packet Processing
pppoe.api
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2017 Intel and/or its affiliates.
3
* Licensed under the Apache License, Version 2.0 (the "License");
4
* you may not use this file except in compliance with the License.
5
* You may obtain a copy of the License at:
6
*
7
* http://www.apache.org/licenses/LICENSE-2.0
8
*
9
* Unless required by applicable law or agreed to in writing, software
10
* distributed under the License is distributed on an "AS IS" BASIS,
11
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
* See the License for the specific language governing permissions and
13
* limitations under the License.
14
*/
15
16
option
version
=
"1.0.0"
;
17
18
/** \brief Set or delete an PPPOE session
19
@param client_index - opaque cookie to identify the sender
20
@param context - sender context, to match reply w/ request
21
@param is_add - add address if non-zero, else delete
22
@param is_ipv6 - client_ip and dst_address is ipv6 or not
23
@param session_id - PPPoE session ID
24
@param client_ip - PPPOE session's client address.
25
@param decap_vrf_id - the vrf index for pppoe decaped packet
26
@param client_mac - the client ethernet address
27
*/
28
define pppoe_add_del_session
29
{
30
u32
client_index
;
31
u32
context
;
32
u8
is_add
;
33
u8
is_ipv6
;
34
u16
session_id
;
35
u8
client_ip[16];
36
u32
decap_vrf_id
;
37
u8
client_mac[6];
38
};
39
40
/** \brief reply for set or delete an PPPOE session
41
@param context - sender context, to match reply w/ request
42
@param retval - return code
43
@param sw_if_index - software index of the interface
44
*/
45
define pppoe_add_del_session_reply
46
{
47
u32
context
;
48
i32
retval
;
49
u32
sw_if_index
;
50
};
51
52
/** \brief Dump PPPOE session
53
@param client_index - opaque cookie to identify the sender
54
@param context - sender context, to match reply w/ request
55
@param sw_if_index - software index of the interface
56
*/
57
define pppoe_session_dump
58
{
59
u32
client_index
;
60
u32
context
;
61
u32
sw_if_index
;
62
};
63
64
/** \brief dump details of an PPPOE session
65
@param context - sender context, to match reply w/ request
66
@param sw_if_index - software index of the interface
67
@param is_ipv6 - client_ip and dst_address is ipv6 or not
68
@param session_id - PPPoE session ID
69
@param client_ip - PPPOE session's client address.
70
@param encap_if_index - the index of tx interface for pppoe encaped packet
71
@param decap_vrf_id - the vrf index for pppoe decaped packet
72
@param local_mac - the local ethernet address
73
@param client_mac - the client ethernet address
74
*/
75
define pppoe_session_details
76
{
77
u32
context
;
78
u32
sw_if_index
;
79
u8
is_ipv6
;
80
u16
session_id
;
81
u8
client_ip[16];
82
u32
encap_if_index
;
83
u32
decap_vrf_id
;
84
u8
local_mac[6];
85
u8
client_mac[6];
86
};
87
88
/*
89
* Local Variables:
90
* eval: (c-set-style "gnu")
91
* End:
92
*/
vl_api_pppoe_add_del_session_t::is_ipv6
u8 is_ipv6
Definition:
pppoe.api:33
vl_api_pppoe_add_del_session_t::client_index
u32 client_index
Definition:
pppoe.api:30
vl_api_pppoe_session_dump_t::sw_if_index
u32 sw_if_index
Definition:
pppoe.api:61
vl_api_pppoe_add_del_session_reply_t::retval
i32 retval
Definition:
pppoe.api:48
version
option version
Definition:
pppoe.api:16
vl_api_pppoe_session_details_t::encap_if_index
u32 encap_if_index
Definition:
pppoe.api:82
u8
unsigned char u8
Definition:
types.h:56
u32
unsigned int u32
Definition:
types.h:88
vl_api_pppoe_add_del_session_t::is_add
u8 is_add
Definition:
pppoe.api:32
u16
unsigned short u16
Definition:
types.h:57
vl_api_pppoe_add_del_session_reply_t::context
u32 context
Definition:
pppoe.api:47
vl_api_pppoe_session_details_t::decap_vrf_id
u32 decap_vrf_id
Definition:
pppoe.api:83
vl_api_pppoe_add_del_session_t::session_id
u16 session_id
Definition:
pppoe.api:34
vl_api_pppoe_session_details_t::sw_if_index
u32 sw_if_index
Definition:
pppoe.api:78
vl_api_pppoe_session_dump_t::context
u32 context
Definition:
pppoe.api:60
vl_api_pppoe_add_del_session_t::decap_vrf_id
u32 decap_vrf_id
Definition:
pppoe.api:36
vl_api_pppoe_session_details_t::session_id
u16 session_id
Definition:
pppoe.api:80
i32
signed int i32
Definition:
types.h:77
vl_api_pppoe_add_del_session_reply_t::sw_if_index
u32 sw_if_index
Definition:
pppoe.api:49
vl_api_pppoe_session_details_t::context
u32 context
Definition:
pppoe.api:77
vl_api_pppoe_session_dump_t::client_index
u32 client_index
Definition:
pppoe.api:59
vl_api_pppoe_add_del_session_t::context
u32 context
Definition:
pppoe.api:31
vl_api_pppoe_session_details_t::is_ipv6
u8 is_ipv6
Definition:
pppoe.api:79
src
plugins
pppoe
pppoe.api
Generated on Mon Nov 25 2019 16:00:28 for FD.io VPP by
1.8.13