Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_ip6map.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2023 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_ip6map.h
28 *
29 * @purpose This code implements the OpEN IP6MAP API
30 *
31 * @component OPEN
32 *
33 * @create 01/10/2023
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_IP6MAP_H_INCLUDED
39 #define OPENAPI_IP6MAP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_VRF_MAX_NAME_LEN 15
44 
45 /*************************************************************************/
62 open_error_t openapiIp6VrRtrAdminModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);
63 
64 /*************************************************************************/
80 open_error_t openapiIp6VrRtrAdminModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);
81 
82 /*************************************************************************/
98 open_error_t openapiIp6VrNbrsDynRenewGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);
99 
100 /*************************************************************************/
116 open_error_t openapiIp6VrNbrsDynRenewSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);
117 
118 /*************************************************************************/
134 open_error_t openapiIp6VrNudBackoffMultipleGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);
135 
136 /*************************************************************************/
152 open_error_t openapiIp6VrNudBackoffMultipleSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);
153 
154 /*************************************************************************/
170 open_error_t openapiIp6VrNudMaxUnicastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);
171 
172 /*************************************************************************/
188 open_error_t openapiIp6VrNudMaxUnicastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);
189 
190 /*************************************************************************/
206 open_error_t openapiIp6VrNudMaxMcastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);
207 
208 /*************************************************************************/
224 open_error_t openapiIp6VrNudMaxMcastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);
225 
226 /*************************************************************************/
241 open_error_t openapiIp6UnresolvedRateLimitGet(openapiClientHandle_t *client_handle, uint32_t *val);
242 
243 /*************************************************************************/
258 open_error_t openapiIp6UnresolvedRateLimitSet(openapiClientHandle_t *client_handle, uint32_t val);
259 
260 /*************************************************************************/
277 open_error_t openapiIp6VrRtrDefaultTTLGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);
278 
279 /*************************************************************************/
296 open_error_t openapiIp6VrRtrDefaultTTLSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);
297 
298 /*************************************************************************/
314 open_error_t openapiIp6RtrIntfModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);
315 
316 /*************************************************************************/
332 open_error_t openapiIp6RtrIntfOperModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);
333 
334 /*************************************************************************/
350 open_error_t openapiIp6RtrIntfModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode);
351 
352 /*************************************************************************/
368 open_error_t openapiIp6RtrIntfAutoStateModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);
369 
370 /*************************************************************************/
386 open_error_t openapiIp6RtrIntfAutoStateModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode);
387 
388 /*************************************************************************/
402 OPEN_BOOL_t openapiIp6IntfExists(openapiClientHandle_t *client_handle, uint32_t ifNum);
403 
404 /*************************************************************************/
418 OPEN_BOOL_t openapiIp6MapIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum);
419 
420 /*************************************************************************/
434 OPEN_BOOL_t openapiIp6MapNbrIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum);
435 
436 /*************************************************************************/
452 open_error_t openapiIp6RtrIntfIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
453 
454 /*************************************************************************/
471 open_error_t openapiIp6RtrIntfIpv6EffectiveMtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
472 
473 /*************************************************************************/
493 open_error_t openapiIp6RtrIntfMaxIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
494 
495 /*************************************************************************/
511 open_error_t openapiIp6RtrIntfIpv6MtuSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
512 
513 /*************************************************************************/
529 open_error_t openapiIp6RtrIntfBandwidthGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
530 
531 /*************************************************************************/
546 open_error_t openapiIp6MapIntfValidFirstGet(openapiClientHandle_t *client_handle, uint32_t *ifNum);
547 
548 /*************************************************************************/
564 open_error_t openapiIp6MapIntfValidNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum);
565 
566 #endif /* OPENAPI_IP6MAP_H_INCLUDED */
567 
openapiIp6VrNudMaxMcastSolicitsSet
open_error_t openapiIp6VrNudMaxMcastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
Set the maximum multicast neighbor solicitations sent during NUD for a given VRF. ...
openapiIp6VrNudMaxMcastSolicitsGet
open_error_t openapiIp6VrNudMaxMcastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
Get the maximum multicast neighbor solicitations sent during NUD for a given VRF. ...
openapiIp6RtrIntfMaxIpv6MtuGet
open_error_t openapiIp6RtrIntfMaxIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the maximum IPv6 MTU that may be set on an interface.
openapiIp6MapIntfValidFirstGet
open_error_t openapiIp6MapIntfValidFirstGet(openapiClientHandle_t *client_handle, uint32_t *ifNum)
Get the first valid interface for participation in IPv6 component.
openapiIp6MapIntfIsValid
OPEN_BOOL_t openapiIp6MapIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum)
Determine if the interface is valid for participation in the IPv6 component.
openapiIp6VrNudBackoffMultipleGet
open_error_t openapiIp6VrNudBackoffMultipleGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
Get the NUD backoff-multiple value set for calculation of timeouts for NS transmissions during NUD fo...
openapiIp6VrRtrDefaultTTLSet
open_error_t openapiIp6VrRtrDefaultTTLSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
Set the default IPv6 router TTL value for a given VRF.
openapiIp6VrNudMaxUnicastSolicitsGet
open_error_t openapiIp6VrNudMaxUnicastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
Get the maximum unicast neighbor solicitations sent during NUD for a given VRF.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiIp6VrNbrsDynRenewSet
open_error_t openapiIp6VrNbrsDynRenewSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
Set the dynamic renewal mode of IPv6 neighbors in a given VRF.
openapiIp6MapNbrIntfIsValid
OPEN_BOOL_t openapiIp6MapNbrIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum)
Determine if the interface is valid to be configured with an IPv6 neighbor.
open_buffdesc
Definition: openapi_common.h:137
openapiClientHandle_s
Definition: openapi_common.h:130
openapiIp6MapIntfValidNextGet
open_error_t openapiIp6MapIntfValidNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum)
Get the next valid interface for participation in IPv6 component.
openapiIp6RtrIntfModeSet
open_error_t openapiIp6RtrIntfModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
Set the administrative state of a given interface.
openapiIp6VrRtrDefaultTTLGet
open_error_t openapiIp6VrRtrDefaultTTLGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
Get the default IPv6 router TTL value for a given VRF.
openapiIp6RtrIntfAutoStateModeSet
open_error_t openapiIp6RtrIntfAutoStateModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
Set the IPv6 AutoState mode of a given interface.
openapiIp6VrNbrsDynRenewGet
open_error_t openapiIp6VrNbrsDynRenewGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
Get the dynamic renewal mode of IPv6 neighbors in a given VRF.
openapiIp6RtrIntfModeGet
open_error_t openapiIp6RtrIntfModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Get the administrative state of a given interface.
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:162
openapiIp6UnresolvedRateLimitSet
open_error_t openapiIp6UnresolvedRateLimitSet(openapiClientHandle_t *client_handle, uint32_t val)
Set the rate limit value for the unresolved IPv6 data packets coming to CPU.
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:178
openapiIp6RtrIntfAutoStateModeGet
open_error_t openapiIp6RtrIntfAutoStateModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Get the IPv6 AutoState mode of a given interface.
openapiIp6VrRtrAdminModeSet
open_error_t openapiIp6VrRtrAdminModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
Set the IPv6 administrative mode of the router for given VRF.
openapiIp6RtrIntfIpv6MtuGet
open_error_t openapiIp6RtrIntfIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the IPv6 MTU of a given interface.
openapiIp6RtrIntfIpv6MtuSet
open_error_t openapiIp6RtrIntfIpv6MtuSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set the IPv6 MTU of a given interface.
openapiIp6RtrIntfOperModeGet
open_error_t openapiIp6RtrIntfOperModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Get the operational state of a given interface.
openapiIp6VrNudBackoffMultipleSet
open_error_t openapiIp6VrNudBackoffMultipleSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
Set the NUD backoff-multiple value for calculation of timeouts for NS transmissions during NUD for a ...
openapi_common.h
openapiIp6RtrIntfIpv6EffectiveMtuGet
open_error_t openapiIp6RtrIntfIpv6EffectiveMtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the IPv6 effective MTU of a given interface.
openapiIp6VrRtrAdminModeGet
open_error_t openapiIp6VrRtrAdminModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
Get the IPv6 administrative mode of the router for given VRF.
openapiIp6IntfExists
OPEN_BOOL_t openapiIp6IntfExists(openapiClientHandle_t *client_handle, uint32_t ifNum)
Determine if IPv6 interface exists.
openapiIp6VrNudMaxUnicastSolicitsSet
open_error_t openapiIp6VrNudMaxUnicastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
Set the maximum unicast neighbor solicitations sent during NUD for a given VRF.
openapiIp6RtrIntfBandwidthGet
open_error_t openapiIp6RtrIntfBandwidthGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the interface bandwidth of a given interface.
openapiIp6UnresolvedRateLimitGet
open_error_t openapiIp6UnresolvedRateLimitGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get the rate limit value set for the unresolved IPv6 data packets coming to CPU.