Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_mab.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_authmgr.h
28 *
29 * @purpose MAB Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 02/28/2023
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_MAB_H_INCLUDED
39 #define OPENAPI_MAB_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /* MAB Auth Type */
44 typedef enum
45 {
46  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_INVALID = 0,
47  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_EAP_MD5 = 1,
48  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_PAP = 2,
49  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_CHAP = 3,
50 } OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t;
51 
52 
53 /*****************************************************************/
67 open_error_t openapiMabPortMabEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mabEnabled);
68 
69 /*****************************************************************/
83 open_error_t openapiMabPortMabEnabledSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled);
84 
85 /*****************************************************************/
102  uint32_t ifNum,
103  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t val);
104 
105 /*****************************************************************/
121  uint32_t ifNum,
122  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t *val);
123 
124 /*****************************************************************/
139  uint32_t ifNum, OPEN_CONTROL_t *mode);
140 
141 
142 
143 #endif /* OPENAPI_MAB_H_INCLUDED */
144 
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiMabPortMabEnabledSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled)
Sets the port MAC authentication bypass enable mode.
open_error_t openapiMabPortMABAuthTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t *val)
Gets the authentication host mode for the specified interface.
open_error_t openapiMabPortOperationalMabModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Gets the port operational MAB mode.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
open_error_t openapiMabPortMABAuthTypeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t val)
Sets the authentication type to be used by MAB for the specified interface.
open_error_t openapiMabPortMabEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mabEnabled)
Sets the port MAC authentication bypass enable mode.