1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* Copyright (c) 2015-2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
option version = "2.0.0";
/** \brief DHCP Proxy config add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param rx_vrf_id - Rx/interface vrf id
@param server_vrf_id - server vrf id
@param if_ipv6 - ipv6 if non-zero, else ipv4
@param is_add - add the config if non-zero, else delete
@param insert_circuit_id - option82 suboption 1 fib number
@param dhcp_server[] - server address
@param dhcp_src_address[] - <fix this, need details>
*/
autoreply define dhcp_proxy_config
{
u32 client_index;
u32 context;
u32 rx_vrf_id;
u32 server_vrf_id;
u8 is_ipv6;
u8 is_add;
u8 dhcp_server[16];
u8 dhcp_src_address[16];
};
/** \brief DHCP Proxy set / unset vss request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param tbl_id - table id
@vss_type - 0: use ASCI vpn_id; 1: use oui/vpn_index; 255: global vpn
@vpn_ascii - null terminated ASCII VPN ID up to 128 characters
@param oui - first part of rfc2685 vpn id, 3 bytes oui
@param vpn_index - second part of rfc2685 vpn id, 4 bytes vpn index
@param is_ipv6 - ip6 if non-zero, else ip4
@param is_add - set vss if non-zero, else delete
*/
autoreply define dhcp_proxy_set_vss
{
u32 client_index;
u32 context;
u32 tbl_id;
u8 vss_type;
u8 vpn_ascii_id[129];
u32 oui;
u32 vpn_index;
u8 is_ipv6;
u8 is_add;
};
/** \brief DHCP Client config data
@param sw_if_index - index of the interface for DHCP client
@param hostname - hostname
@param id - Client ID - option 61
@param want_dhcp_event - DHCP event sent to the sender
via dhcp_compl_event API message if non-zero
@param set_broadcast_flag - in the DHCP Discover to control
how the resulting OFFER is addressed.
@param pid - sender's pid
*/
typeonly define dhcp_client
{
u32 sw_if_index;
u8 hostname[64];
u8 id[64];
u8 want_dhcp_event;
u8 set_broadcast_flag;
u32 pid;
};
/** \brief DHCP Client config add / del request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - add the config if non-zero, else delete
@param client - client configuration data
*/
autoreply define dhcp_client_config
{
u32 client_index;
u32 context;
u8 is_add;
vl_api_dhcp_client_t client;
};
/** \brief Data learned by the client during the DHCP process
@param sw_if_index - the interface on which the client is configured
@param state - the state of the lease (see dhcp_client_state_t)
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param mask_width - The length of the subnet mask assigned
@param host_address - Host IP address
@param router_address - Router IP address
@param host_mac - Host MAC address
*/
typeonly define dhcp_lease
{
u32 sw_if_index;
u8 state;
u8 hostname[64];
u8 is_ipv6;
u8 mask_width;
u8 host_address[16];
u8 router_address[16];
u8 host_mac[6];
};
/** \brief Tell client about a DHCP completion event
@param client_index - opaque cookie to identify the sender
@param pid - client pid registered to receive notification
@param lease - Data learned during the DHCP process;
*/
define dhcp_compl_event
{
u32 client_index;
u32 pid;
vl_api_dhcp_lease_t lease;
};
service {
rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
};
/** \brief Dump the DHCP client configurations
*/
define dhcp_client_dump
{
u32 client_index;
u32 context;
};
/** \brief DHCP Client details returned from dump
* @param client - The configured client
* @param lease - The learned lease data
*/
define dhcp_client_details
{
u32 context;
vl_api_dhcp_client_t client;
vl_api_dhcp_lease_t lease;
};
/** \brief Dump DHCP proxy table
@param client_index - opaque cookie to identify the sender
@param True for IPv6 proxy table
*/
define dhcp_proxy_dump
{
u32 client_index;
u32 context;
u8 is_ip6;
};
typeonly manual_print manual_endian define dhcp_server
{
u32 server_vrf_id;
u8 dhcp_server[16];
};
/** \brief Tell client about a DHCP completion event
@param client_index - opaque cookie to identify the sender
*/
manual_endian manual_print define dhcp_proxy_details
{
u32 context;
u32 rx_vrf_id;
u32 vss_oui;
u32 vss_fib_id;
u8 vss_type;
u8 vss_vpn_ascii_id[129];
u8 is_ipv6;
u8 dhcp_src_address[16];
u8 count;
vl_api_dhcp_server_t servers[count];
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
