src/vnet/ethernet/p2p_ethernet.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco 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 import "vnet/interface_types.api";
  19 import "vnet/ethernet/ethernet_types.api";
  20
  21 /** \brief Create a point-to-point (p2p) Ethernet sub-interface
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param parent_if_index - index of the parent interface
  25     @param subif_id - subinterface index identifier
  26     @param remote_mac - client MAC address
  27     @retval VNET_API_ERROR_INVALID_SW_IF_INDEX on invalid parent_if_index
  28     @retval VNET_API_ERROR_INVALID_SW_IF_INDEX_2 on invalid subif_id
  29     @retval VNET_API_ERROR_BOND_SLAVE_NOT_ALLOWED
  30     @retval VNET_API_ERROR_SUBIF_ALREADY_EXISTS
  31     @retval VNET_API_ERROR_SUBIF_CREATE_FAILED
  32 */
  33 define p2p_ethernet_add
  34 {
  35   u32 client_index;
  36   u32 context;
  37   vl_api_interface_index_t parent_if_index;
  38   u32 subif_id;
  39   vl_api_mac_address_t remote_mac;
  40 };
  41
  42 define p2p_ethernet_add_reply
  43 {
  44   u32 context;
  45   i32 retval;
  46   vl_api_interface_index_t sw_if_index;
  47 };
  48
  49 /** \brief Delete a point-to-point (p2p) Ethernet sub-interface
  50     @param client_index - opaque cookie to identify the sender
  51     @param context - sender context, to match reply w/ request
  52     @param parent_if_index - index of the parent interface
  53     @param remote_mac - client MAC address
  54     @retval VNET_API_ERROR_SUBIF_DOESNT_EXIST
  55 */
  56 define p2p_ethernet_del
  57 {
  58   u32 client_index;
  59   u32 context;
  60   vl_api_interface_index_t parent_if_index;
  61   vl_api_mac_address_t remote_mac;
  62 };
  63
  64 define p2p_ethernet_del_reply
  65 {
  66   u32 context;
  67   i32 retval;
  68 };
  69
  70 /*
  71  * Local Variables:
  72  * eval: (c-set-style "gnu")
  73  * End:
  74  */