Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_dhcp_snooping.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_dhcp_snooping.h
28 *
29 * @purpose DHCP Snooping API
30 *
31 * @component OpEN
32 *
33 * @note This code must not include any ICOS header files.
34 *
35 * @create 7/9/2018
36 *
37 * @end
38 *
39 **********************************************************************/
40 #ifndef OPENAPI_DHCP_SNOOPING_H_INCLUDED
41 #define OPENAPI_DHCP_SNOOPING_H_INCLUDED
42 
43 #include "openapi_common.h"
44 
45 /*****************************************************************/
62 open_error_t openapiDhcpSnoopingAdminModeGet(openapiClientHandle_t *client_handle,
63  OPEN_AF_t family,
64  OPEN_CONTROL_t *adminMode);
65 
66 /*****************************************************************/
88 open_error_t openapiDhcpSnoopingVerifySourceMacGet(openapiClientHandle_t *client_handle,
89  OPEN_AF_t family,
90  OPEN_CONTROL_t *sourceMacVerify);
91 
92 /*****************************************************************/
115 open_error_t openapiDhcpSnoopingEnabledVlanRangeNextGet(openapiClientHandle_t *client_handle,
116  OPEN_AF_t family,
117  uint32_t *vlanStart,
118  uint32_t *vlanEnd);
119 
120 /*****************************************************************/
140 open_error_t openapiDhcpSnoopingPortEnabledGet(openapiClientHandle_t *client_handle,
141  OPEN_AF_t family,
142  uint32_t ifNum,
143  OPEN_CONTROL_t *enabled);
144 
145 /*****************************************************************/
161 open_error_t openapiDhcpSnoopingIntfTrustedGet(openapiClientHandle_t *client_handle,
162  OPEN_AF_t family,
163  uint32_t ifNum,
164  OPEN_BOOL_t *trusted);
165 
166 /*****************************************************************/
183 open_error_t openapiDhcpSnoopingIntfLoggedGet(openapiClientHandle_t *client_handle,
184  OPEN_AF_t family,
185  uint32_t ifNum,
186  OPEN_BOOL_t *logged);
187 
188 /*****************************************************************/
201 open_error_t openapiDhcpSnoopingDbFileNameMaxLengthGet(openapiClientHandle_t *client_handle, uint32_t *len);
202 
203 /*****************************************************************/
218 open_error_t openapiDhcpSnoopingDbFileNameGet(openapiClientHandle_t *client_handle,
219  OPEN_AF_t family,
220  open_buffdesc *fileName);
221 
222 /*****************************************************************/
236 open_error_t openapiDhcpSnoopingDbIpAddressGet(openapiClientHandle_t *client_handle,
237  OPEN_AF_t family,
238  open_inet_addr_t *addr);
239 
240 /*****************************************************************/
254 open_error_t openapiDhcpSnoopingDbWriteDelayGet(openapiClientHandle_t *client_handle,
255  OPEN_AF_t family,
256  uint32_t *delay);
257 
258 #endif /* OPENAPI_DHCP_SNOOPING_H_INCLUDED */
259