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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "1.0.0";
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
28 define pppoe_add_del_session
38 option vat_help = "client-addr <client-addr> session-id <nn> [encap-if-index <nn>] [decap-next [ip4|ip6|node <name>]] local-mac <local-mac> client-mac <client-mac> [del]";
41 /** \brief reply for set or delete an PPPOE session
42 @param context - sender context, to match reply w/ request
43 @param retval - return code
44 @param sw_if_index - software index of the interface
46 define pppoe_add_del_session_reply
53 /** \brief Dump PPPOE session
54 @param client_index - opaque cookie to identify the sender
55 @param context - sender context, to match reply w/ request
56 @param sw_if_index - software index of the interface
58 define pppoe_session_dump
63 option vat_help = "[<intfc> | sw_if_index <nn>]";
66 /** \brief dump details of an PPPOE session
67 @param context - sender context, to match reply w/ request
68 @param sw_if_index - software index of the interface
69 @param is_ipv6 - client_ip and dst_address is ipv6 or not
70 @param session_id - PPPoE session ID
71 @param client_ip - PPPOE session's client address.
72 @param encap_if_index - the index of tx interface for pppoe encaped packet
73 @param decap_vrf_id - the vrf index for pppoe decaped packet
74 @param local_mac - the local ethernet address
75 @param client_mac - the client ethernet address
77 define pppoe_session_details
92 * eval: (c-set-style "gnu")