src/vnet/lldp/lldp.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 /** \brief configure global parameter for LLDP
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param system_name - VPP system name
  20     @param tx_hold - multiplier for tx_interval when setting time-to-live (TTL)
  21                      value in the LLDP packets
  22     @param tx_interval - time interval, in seconds, between each LLDP frames
  23 */
  24 autoreply define lldp_config
  25 {
  26   u32 client_index;
  27   u32 context;
  28   u8 system_name[256];
  29   u32 tx_hold;
  30   u32 tx_interval;
  31 };
  32
  33 /** \brief Interface set LLDP request
  34     @param client_index - opaque cookie to identify the sender
  35     @param context - sender context, to match reply w/ request
  36     @param sw_if_index - interface for which to enable/disable LLDP
  37     @param port_desc - local port description
  38     @param enable - if non-zero enable, else disable
  39 */
  40 autoreply define sw_interface_set_lldp
  41 {
  42   u32 client_index;
  43   u32 context;
  44   u32 sw_if_index;
  45   u8 port_desc[256];
  46   u8 enable;
  47 };