src/plugins/lacp/lacp.api

   1 /*
   2  * Copyright (c) 2017 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 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the bonding device driver
  20 */
  21
  22 option version = "2.0.0";
  23 import "vnet/ethernet/ethernet_types.api";
  24 import "vnet/interface_types.api";
  25
  26 /** \brief Dump lacp interfaces request */
  27 define sw_interface_lacp_dump
  28 {
  29   u32 client_index;
  30   u32 context;
  31 };
  32
  33 /** \brief Reply for lacp dump request
  34     @param sw_if_index - software index of member interface
  35     @param interface_name - name of member interface
  36     @param rx_state - rx machine state
  37     @param tx_state - tx machine state
  38     @param mux_state - mux machine state
  39     @param ptx_state - ptx machine state
  40     @param bond_interface_name - name of bond interface
  41     @param actor_system_priority - actor system priority
  42     @param actor_system - actor system
  43     @param actor_key - actor key
  44     @param actor_port_priority - actor port priority
  45     @param actor_port_number - actor port number
  46     @param actor_state - actor state
  47     @param partner_system_priority - partner system priority
  48     @param partner_system - partner system
  49     @param partner_key - partner key
  50     @param partner_port_priority - partner port priority
  51     @param partner_port_number - partner port number
  52     @param partner_state - partner state
  53 */
  54 define sw_interface_lacp_details
  55 {
  56   u32 context;
  57   vl_api_interface_index_t sw_if_index;
  58   string interface_name[64];
  59   u32 rx_state;
  60   u32 tx_state;
  61   u32 mux_state;
  62   u32 ptx_state;
  63   string bond_interface_name[64];
  64   u16 actor_system_priority;
  65   vl_api_mac_address_t actor_system;
  66   u16 actor_key;
  67   u16 actor_port_priority;
  68   u16 actor_port_number;
  69   u8 actor_state;
  70   u16 partner_system_priority;
  71   vl_api_mac_address_t partner_system;
  72   u16 partner_key;
  73   u16 partner_port_priority;
  74   u16 partner_port_number;
  75   u8 partner_state;
  76 };
  77
  78 /*
  79  * Local Variables:
  80  * eval: (c-set-style "gnu")
  81  * End:
  82  */