aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/mdata/mdata.api
blob: de1c8e4c9577f92f746134786a7a1b7d2a288014 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
 * mdata.api - binary API skeleton
 *
 * Copyright (c) <current-year> <your-organization>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file mdata.api
 * @brief VPP control-plane API messages.
 *
 * This file defines VPP control-plane binary API messages which are generally
 * called through a shared memory interface.
 */

/* Version and type recitations */

option version = "0.1.0";
import "vnet/interface_types.api";

/** @brief API to enable / disable mdata on an interface
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param enable_disable - 1 to enable, 0 to disable the feature
*/

autoreply define mdata_enable_disable {
  /* Client identifier, set from api_main.my_client_index */
  u32 client_index;

  /* Arbitrary context, so client can match reply to request */
  u32 context;

  /* Enable / disable the feature */
  bool enable_disable;
};
param session_id - PPPoE session ID @param client_ip - PPPOE session's client address. @param decap_vrf_id - the vrf index for pppoe decaped packet @param client_mac - the client ethernet address */ define pppoe_add_del_session { u32 client_index; u32 context; bool is_add; u16 session_id; vl_api_address_t client_ip; u32 decap_vrf_id; vl_api_mac_address_t client_mac; 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]"; }; /** \brief reply for set or delete an PPPOE session @param context - sender context, to match reply w/ request @param retval - return code @param sw_if_index - software index of the interface */ define pppoe_add_del_session_reply { u32 context; i32 retval; vl_api_interface_index_t sw_if_index; }; /** \brief Dump PPPOE session @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - software index of the interface */ define pppoe_session_dump { u32 client_index; u32 context; vl_api_interface_index_t sw_if_index; option vat_help = "[<intfc> | sw_if_index <nn>]"; }; /** \brief dump details of an PPPOE session @param context - sender context, to match reply w/ request @param sw_if_index - software index of the interface @param session_id - PPPoE session ID @param client_ip - PPPOE session's client address. @param encap_if_index - the index of tx interface for pppoe encaped packet @param decap_vrf_id - the vrf index for pppoe decaped packet @param local_mac - the local ethernet address @param client_mac - the client ethernet address */ define pppoe_session_details { u32 context; vl_api_interface_index_t sw_if_index; u16 session_id; vl_api_address_t client_ip; vl_api_interface_index_t encap_if_index; u32 decap_vrf_id; vl_api_mac_address_t local_mac; vl_api_mac_address_t client_mac; }; /* * Local Variables: * eval: (c-set-style "gnu") * End: */