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 option version = "1.0.0";
  17
  18 /** \brief configure global parameter for LLDP
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param system_name - VPP system name
  22     @param tx_hold - multiplier for tx_interval when setting time-to-live (TTL)
  23                      value in the LLDP packets
  24     @param tx_interval - time interval, in seconds, between each LLDP frames
  25 */
  26 autoreply define lldp_config
  27 {
  28   u32 client_index;
  29   u32 context;
  30   u8 system_name[256];
  31   u32 tx_hold;
  32   u32 tx_interval;
  33 };
  34
  35 /** \brief Interface set LLDP request
  36     @param client_index - opaque cookie to identify the sender
  37     @param context - sender context, to match reply w/ request
  38     @param sw_if_index - interface for which to enable/disable LLDP
  39     @param port_desc - local port description
  40     @param mgmt_ip4_addr - management ip4 address of the interface
  41     @param mgmt_ip6_addr - management ip6 address of the interface
  42     @param mgmt_oid - OID(Object Identifier) of the interface
  43     @param enable - if non-zero enable, else disable
  44 */
  45 autoreply define sw_interface_set_lldp
  46 {
  47   u32 client_index;
  48   u32 context;
  49   u32 sw_if_index;
  50   u8 port_desc[256];
  51   u8 mgmt_ip4[4];
  52   u8 mgmt_ip6[16];
  53   u8 mgmt_oid[128];
  54   u8 enable;
  55 };