Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_ip6radv.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 * Copyright 2023 Broadcom.
11 *
12 * Licensed under the Apache License, Version 2.0 (the "License");
13 * you may not use this file except in compliance with the License.
14 * You may obtain a copy of the License at
15 *
16 * http://www.apache.org/licenses/LICENSE-2.0
17 *
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS,
20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
23 *
24 ***********************************************************************
25 * @filename openapi_ip6radv.h
26 *
27 * @purpose This code implements the OpEN IP6 RADV API
28 *
29 * @component OPEN
30 *
31 * @create 01/24/2023
32 *
33 * @end
34 *********************************************************************/
35 #ifndef OPENAPI_IP6RADV_H_INCLUDED
36 #define OPENAPI_IP6RADV_H_INCLUDED
37 
38 #include "openapi_common.h"
39 
40 
41 /*************************************************************************/
57 open_error_t openapiIp6RtrRadvMinAdvIntSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
58 
59 /*************************************************************************/
75 open_error_t openapiIp6RtrRadvMinAdvIntGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
76 
77 /*************************************************************************/
93 open_error_t openapiIp6RtrRadvMaxAdvIntSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
94 
95 /*************************************************************************/
111 open_error_t openapiIp6RtrRadvMaxAdvIntGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
112 
113 /*************************************************************************/
129 open_error_t openapiIp6RtrRadvAdvLifetimeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
130 
131 /*************************************************************************/
147 open_error_t openapiIp6RtrRadvAdvLifetimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
148 
149 /*************************************************************************/
165 open_error_t openapiIp6RtrRadvAdvMtuSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
166 
167 /*************************************************************************/
183 open_error_t openapiIp6RtrRadvAdvMtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
184 
185 /*************************************************************************/
201 open_error_t openapiIp6RtrRadvRtrPrefSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);
202 
203 /*************************************************************************/
219 open_error_t openapiIp6RtrRadvRtrPrefGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);
220 
221 /*************************************************************************/
238 
239 /*************************************************************************/
256 
257 /*************************************************************************/
274 
275 /*************************************************************************/
292 
293 /*************************************************************************/
310 
311 /*************************************************************************/
328 
329 /*************************************************************************/
345 open_error_t openapiIp6RtrRadvSuppressSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag);
346 
347 /*************************************************************************/
363 open_error_t openapiIp6RtrRadvSuppressGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag);
364 
365 /*************************************************************************/
387 open_error_t openapiIp6RtrRadvPrefixSet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix,
388  uint32_t plen, uint32_t prefLife, uint32_t validLife,
389  uint16_t lifeDecrFlags, OPEN_BOOL_t onLink, OPEN_BOOL_t autonomous);
390 
391 /*************************************************************************/
412 open_error_t openapiIp6RtrRadvPrefixGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix,
413  uint32_t plen, uint32_t *prefLife, uint32_t *validLife,
414  OPEN_BOOL_t *onLink, OPEN_BOOL_t *autonomous);
415 
416 #endif /* OPENAPI_IP6RADV_H_INCLUDED */
417 
open_error_t openapiIp6RtrRadvHopLimitUnspec(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
Set IPv6 hop limit advertised on the interface to unspecified(0).
open_error_t openapiIp6RtrRadvMaxAdvIntSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set IPv6 router advertise Maximum advertisement interval.
open_error_t openapiIp6RtrRadvAdvMtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get IPv6 router advertise link mtu.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiIp6RtrRadvPrefixGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix, uint32_t plen, uint32_t *prefLife, uint32_t *validLife, OPEN_BOOL_t *onLink, OPEN_BOOL_t *autonomous)
Get IPv6 router as per prefix attributes.
open_error_t openapiIp6RtrRadvMaxAdvIntGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get IPv6 router advertise Maximum advertisement interval.
open_error_t openapiIp6RtrRadvMinAdvIntSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set IPv6 router advertise Minimum advertisement interval.
open_error_t openapiIp6RtrRadvOtherCfgFlagSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
Set IPv6 router advertise other-config flag.
open_error_t openapiIp6RtrRadvAdvMtuSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set IPv6 router advertise link mtu.
open_error_t openapiIp6RtrRadvAdvLifetimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get IPv6 router advertise lifetime.
open_error_t openapiIp6RtrRadvRtrPrefGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get IPv6 router preference.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
open_error_t openapiIp6RtrRadvManagedFlagGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
Get IPv6 router advertise managed flag.
open_error_t openapiIp6RtrRadvAdvLifetimeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set IPv6 router advertise lifetime.
open_error_t openapiIp6RtrRadvMinAdvIntGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get IPv6 router advertise Minimum advertisement interval.
open_error_t openapiIp6RtrRadvPrefixSet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix, uint32_t plen, uint32_t prefLife, uint32_t validLife, uint16_t lifeDecrFlags, OPEN_BOOL_t onLink, OPEN_BOOL_t autonomous)
Set IPv6 router as per prefix attributes.
open_error_t openapiIp6RtrRadvHopLimitUnspecGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
Get whether IPv6 hop limit advertised on the interface to unspecified(0)
open_error_t openapiIp6RtrRadvManagedFlagSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
Set IPv6 router advertise managed flag.
open_error_t openapiIp6RtrRadvSuppressGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
Get IPv6 router advertise suppression.
open_error_t openapiIp6RtrRadvOtherCfgFlagGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
Get IPv6 router advertise other-config flag.
open_error_t openapiIp6RtrRadvRtrPrefSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
Set IPv6 router preference.
open_error_t openapiIp6RtrRadvSuppressSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
Set IPv6 router advertise suppression.