FD.io VPP  v21.01.1
Vector Packet Processing
lldp.api
Go to the documentation of this file.
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 = "2.0.0";
17 
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
20 
21 /** \brief configure global parameter for LLDP
22  @param client_index - opaque cookie to identify the sender
23  @param context - sender context, to match reply w/ request
24  @param system_name - VPP system name
25  @param tx_hold - multiplier for tx_interval when setting time-to-live (TTL)
26  value in the LLDP packets
27  @param tx_interval - time interval, in seconds, between each LLDP frames
28 */
29 autoreply define lldp_config
30 {
35  string system_name[];
36 };
37 
38 /** \brief Interface set LLDP request
39  @param client_index - opaque cookie to identify the sender
40  @param context - sender context, to match reply w/ request
41  @param sw_if_index - interface for which to enable/disable LLDP
42  @param mgmt_ip4_addr - management ip4 address of the interface
43  @param mgmt_ip6_addr - management ip6 address of the interface
44  @param mgmt_oid - OID(Object Identifier) of the interface
45  @param enable - if non-zero enable, else disable
46  @param port_desc - local port description
47 */
48 autoreply define sw_interface_set_lldp
49 {
52  vl_api_interface_index_t sw_if_index;
53  vl_api_ip4_address_t mgmt_ip4;
54  vl_api_ip6_address_t mgmt_ip6;
55  u8 mgmt_oid[128];
56  bool enable [default=true];
57  string port_desc[];
58 };
option version
Definition: lldp.api:16
unsigned char u8
Definition: types.h:56
vl_api_ip6_address_t mgmt_ip6
Definition: lldp.api:54
vl_api_interface_index_t sw_if_index
Definition: lldp.api:52
unsigned int u32
Definition: types.h:88
vl_api_ip4_address_t mgmt_ip4
Definition: lldp.api:53