Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_tacacs.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 **********************************************************************
26 *
27 * @filename openapi_tacacs.h
28 *
29 * @purpose TACACS+ Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 30/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_TACACS_H_INCLUDED
39 #define OPENAPI_TACACS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /*****************************************************************/
63  open_buffdesc *serverAddr);
64 
65 /*****************************************************************/
83  open_buffdesc *tacacsServer);
84 
85 /*****************************************************************/
104  open_buffdesc *tacacsServer,
105  open_buffdesc *nextTacacsServer);
106 
107 /*****************************************************************/
125  open_buffdesc *serverAddr);
126 
127 /*****************************************************************/
149  open_buffdesc *serverAddr,
150  open_buffdesc *keyString);
151 
152 /*****************************************************************/
171  open_buffdesc *serverAddr);
172 
173 /*****************************************************************/
194  open_buffdesc *serverAddr,
195  uint32_t port);
196 
197 /*****************************************************************/
215  open_buffdesc *serverAddr);
216 
217 /*****************************************************************/
235  open_buffdesc *serverAddr,
236  uint16_t *port);
237 
238 /*****************************************************************/
259  open_buffdesc *serverAddr,
260  uint32_t priority);
261 
262 /*****************************************************************/
280  open_buffdesc *serverAddr);
281 
282 /*****************************************************************/
300  open_buffdesc *serverAddr,
301  uint16_t *priority);
302 
303 /*****************************************************************/
326  open_buffdesc *serverAddr,
327  uint32_t timeout);
328 
329 /*****************************************************************/
348  open_buffdesc *serverAddr,
349  uint32_t *timeout);
350 
351 /*****************************************************************/
369  open_buffdesc *keyString);
370 
371 /*****************************************************************/
385 
386 /*****************************************************************/
405  uint32_t globalTimeout);
406 
407 /*****************************************************************/
421  uint32_t *globalTimeout);
422 
423 /*****************************************************************/
436  uint32_t *tacacsServerMaxLen);
437 
438 /*****************************************************************/
451  uint32_t *tacacsKeyMaxLen);
452 
453 /*****************************************************************/
466  uint32_t *tacacsSrvMax);
467 
468 #endif
469 
open_error_t openapiTacacsServerPortSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t port)
Set the TACACS+ server port.
open_error_t openapiTacacsServerDelete(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
Delete TACACS+ server.
open_error_t openapiTacacsServerKeySet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, open_buffdesc *keyString)
Set the TACACS+ server key.
open_error_t openapiTacacsServerDefaultPortSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
Set the TACACS+ server port to default.
open_error_t openapiTacacsServerGlobalKeySet(openapiClientHandle_t *client_handle, open_buffdesc *keyString)
Set TACACS+ global key.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiTacacsServerPriorityGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint16_t *priority)
Get the TACACS+ server priority.
open_error_t openapiTacacsServerFirstGet(openapiClientHandle_t *client_handle, open_buffdesc *tacacsServer)
Get the first TACACS+ server configured.
open_error_t openapiTacacsServerMaxLengthGet(openapiClientHandle_t *client_handle, uint32_t *tacacsServerMaxLen)
Get the maximum length of TACACS+ server address.
open_error_t openapiTacacsServerTimeoutSet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t timeout)
Set the TACACS+ server timeout.
open_error_t openapiTacacsServerDefaultPrioritySet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
Set the TACACS+ server priority to default.
open_error_t openapiTacacsServerDefaultKeySet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
Set the TACACS+ server key to default.
open_error_t openapiTacacsServersMaxSupportedGet(openapiClientHandle_t *client_handle, uint32_t *tacacsSrvMax)
Get the maximum TACACS+ servers supported.
open_error_t openapiTacacsServerNextGet(openapiClientHandle_t *client_handle, open_buffdesc *tacacsServer, open_buffdesc *nextTacacsServer)
Get next TACACS+ server configured.
open_error_t openapiTacacsServerGlobalTimeoutGet(openapiClientHandle_t *client_handle, uint32_t *globalTimeout)
Get TACACS+ server global timeout.
open_error_t openapiTacacsServerTimeoutGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t *timeout)
Get the TACACS+ server timeout.
open_error_t openapiTacacsServerGlobalKeyDelete(openapiClientHandle_t *client_handle)
Delete TACACS+ global key.
open_error_t openapiTacacsServerPortGet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint16_t *port)
Get the TACACS+ server port number.
open_error_t openapiTacacsServerPrioritySet(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t priority)
Set the TACACS+ server priority.
open_error_t openapiTacacsServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
Add TACACS+ server.
open_error_t openapiTacacsKeyMaxLengthGet(openapiClientHandle_t *client_handle, uint32_t *tacacsKeyMaxLen)
Get the maximum length of TACACS+ key.
open_error_t openapiTacacsServerGlobalTimeoutSet(openapiClientHandle_t *client_handle, uint32_t globalTimeout)
Set TACACS+ server global timeout.