Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_dynamic_arp_inspection.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-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 * Licensed under the Apache License, Version 2.0 (the "License");
26 * you may not use this file except in compliance with the License.
27 * You may obtain a copy of the License at
28 *
29 * http://www.apache.org/licenses/LICENSE-2.0
30 *
31 * Unless required by applicable law or agreed to in writing, software
32 * distributed under the License is distributed on an "AS IS" BASIS,
33 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 * See the License for the specific language governing permissions and
35 * limitations under the License.
36 *
37 **********************************************************************
38 *
39 * @filename openapi_dynamic_arp_inspection.h
40 *
41 * @purpose Dynamic ARP table configuration and status.
42 *
43 * @component OPEN
44 *
45 * @create 12/16/2016
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED
51 #define OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED
52 
53 #include <stdio.h>
54 #include <stddef.h>
55 #include <sys/un.h>
56 
57 #include "openapi_common.h"
58 
59 #define OPEN_ARP_ACL_NAME_LEN_MIN 1
60 #define OPEN_ARP_ACL_NAME_LEN_MAX 31
63 typedef enum
64 {
68 
69 /*****************************************************************/
83  open_buffdesc *aclName);
84 
85 /*****************************************************************/
106  open_buffdesc *aclName,
107  open_inet_addr_t ipAddr,
108  open_buffdesc *macAddr,
109  open_inet_addr_t *ipAddrNext,
110  open_buffdesc *macAddrNext);
111 
112 /*****************************************************************/
131  open_buffdesc *aclName,
132  uint32_t seqNo,
133  uint32_t *seqNoNext,
134  open_inet_addr_t *ipAddrNext,
135  open_buffdesc *macAddrNext,
136  OPEN_ARP_ACL_RULE_ACTION_t *actionNext);
137 
138 /*****************************************************************/
153  open_buffdesc *aclName,
154  open_buffdesc *aclNameNext);
155 
156 /*****************************************************************/
173  OPEN_CONTROL_t mode);
174 
175 /*****************************************************************/
191  OPEN_CONTROL_t *mode);
192 
193 /*****************************************************************/
210  OPEN_CONTROL_t mode);
211 
212 /*****************************************************************/
228  OPEN_CONTROL_t *mode);
229 
230 /*****************************************************************/
247  OPEN_CONTROL_t mode);
248 
249 /*****************************************************************/
265  OPEN_CONTROL_t *mode);
266 
267 #endif /* OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED */
268 
open_error_t openapiArpAclGet(openapiClientHandle_t *client_handle, open_buffdesc *aclName)
API to Check if an ARP ACL exists.
open_error_t openapiDaiSourceMacValidateModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get the global dynamic ARP inspection source MAC validate mode.
open_error_t openapiArpAclNextGet(openapiClientHandle_t *client_handle, open_buffdesc *aclName, open_buffdesc *aclNameNext)
API to get the next ARP ACL entry.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiArpAclRuleNextGet(openapiClientHandle_t *client_handle, open_buffdesc *aclName, open_inet_addr_t ipAddr, open_buffdesc *macAddr, open_inet_addr_t *ipAddrNext, open_buffdesc *macAddrNext)
API not supported.
open_error_t openapiArpAclRuleNextGetV2(openapiClientHandle_t *client_handle, open_buffdesc *aclName, uint32_t seqNo, uint32_t *seqNoNext, open_inet_addr_t *ipAddrNext, open_buffdesc *macAddrNext, OPEN_ARP_ACL_RULE_ACTION_t *actionNext)
API to get the next ARP ACL Rule in the given ACL.
open_error_t openapiDaiIpAddrValidateModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get the global dynamic ARP inspection IP address validate mode.
open_error_t openapiDaiSourceMacValidateModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set the global dynamic ARP inspection source MAC validate mode.
open_error_t openapiDaiIpAddrValidateModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set the global dynamic ARP inspection IP address validate mode.
open_error_t openapiDaiDestMacValidateModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get the global dynamic ARP inspection destination MAC validate mode.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiDaiDestMacValidateModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set the global dynamic ARP inspection destination MAC validate mode.
OPEN_ARP_ACL_RULE_ACTION_t
OpEN uses this enumeration to define ARP ACL Rule Actions.