Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
TACACS+ Configuration And Status [OPENAPI_TACACS]

Functions

open_error_t openapiTacacsKeyMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *tacacsKeyMaxLen)
 Get the maximum length of TACACS+ key. More...
 
open_error_t openapiTacacsServerAdd (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
 Add TACACS+ server. More...
 
open_error_t openapiTacacsServerDefaultKeySet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
 Set the TACACS+ server key to default. More...
 
open_error_t openapiTacacsServerDefaultPortSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
 Set the TACACS+ server port to default. More...
 
open_error_t openapiTacacsServerDefaultPrioritySet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
 Set the TACACS+ server priority to default. More...
 
open_error_t openapiTacacsServerDelete (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr)
 Delete TACACS+ server. More...
 
open_error_t openapiTacacsServerFirstGet (openapiClientHandle_t *client_handle, open_buffdesc *tacacsServer)
 Get the first TACACS+ server configured. More...
 
open_error_t openapiTacacsServerGlobalKeyDelete (openapiClientHandle_t *client_handle)
 Delete TACACS+ global key. More...
 
open_error_t openapiTacacsServerGlobalKeySet (openapiClientHandle_t *client_handle, open_buffdesc *keyString)
 Set TACACS+ global key. More...
 
open_error_t openapiTacacsServerGlobalTimeoutGet (openapiClientHandle_t *client_handle, uint32_t *globalTimeout)
 Get TACACS+ server global timeout. More...
 
open_error_t openapiTacacsServerGlobalTimeoutSet (openapiClientHandle_t *client_handle, uint32_t globalTimeout)
 Set TACACS+ server global timeout. More...
 
open_error_t openapiTacacsServerKeySet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, open_buffdesc *keyString)
 Set the TACACS+ server key. More...
 
open_error_t openapiTacacsServerMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *tacacsServerMaxLen)
 Get the maximum length of TACACS+ server address. More...
 
open_error_t openapiTacacsServerNextGet (openapiClientHandle_t *client_handle, open_buffdesc *tacacsServer, open_buffdesc *nextTacacsServer)
 Get next TACACS+ server configured. More...
 
open_error_t openapiTacacsServerPortGet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint16_t *port)
 Get the TACACS+ server port number. More...
 
open_error_t openapiTacacsServerPortSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t port)
 Set the TACACS+ server port. More...
 
open_error_t openapiTacacsServerPriorityGet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint16_t *priority)
 Get the TACACS+ server priority. More...
 
open_error_t openapiTacacsServerPrioritySet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t priority)
 Set the TACACS+ server priority. More...
 
open_error_t openapiTacacsServersMaxSupportedGet (openapiClientHandle_t *client_handle, uint32_t *tacacsSrvMax)
 Get the maximum TACACS+ servers supported. More...
 
open_error_t openapiTacacsServerTimeoutGet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t *timeout)
 Get the TACACS+ server timeout. More...
 
open_error_t openapiTacacsServerTimeoutSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddr, uint32_t timeout)
 Set the TACACS+ server timeout. More...
 

Detailed Description

Function Documentation

open_error_t openapiTacacsKeyMaxLengthGet ( openapiClientHandle_t client_handle,
uint32_t *  tacacsKeyMaxLen 
)

Get the maximum length of TACACS+ key.

Parameters
[in]client_handleClient handle from registration API
[out]tacacsKeyMaxLenMaximum length of the TACACS+ key.
Return values
OPEN_E_NONEif maximum length of TACACS+ key is returned.
OPEN_E_PARAMif invalid parameter is passed.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerAdd ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr 
)

Add TACACS+ server.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of TACACS+ server
Return values
OPEN_E_NONEif TACACS+ server is added.
OPEN_E_FAILif maximum TACACS+ servers are reached.
OPEN_E_EXISTSif the TACACS+ server is already configured.
OPEN_E_PARAMif invalid parameter is passed.
OPEN_E_INTERNALif internal error has occurred.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerDefaultKeySet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr 
)

Set the TACACS+ server key to default.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
Return values
OPEN_E_NONEif TACACS+ server key is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
This API sets the key of a TACACS+ server to global key.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerDefaultPortSet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr 
)

Set the TACACS+ server port to default.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
Return values
OPEN_E_NONEif TACACS+ server port is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerDefaultPrioritySet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr 
)

Set the TACACS+ server priority to default.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
Return values
OPEN_E_NONEif TACACS+ server priority is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerDelete ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr 
)

Delete TACACS+ server.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of TACACS+ server
Return values
OPEN_E_NONEif TACACS+ server is removed.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerFirstGet ( openapiClientHandle_t client_handle,
open_buffdesc tacacsServer 
)

Get the first TACACS+ server configured.

Parameters
[in]client_handleClient handle from registration API
[out]tacacsServerFirst TACACS+ server.
Return values
OPEN_E_NONEif first TACACS+ server is returned.
OPEN_E_FAILif the TACACS+ server does not exist.
OPEN_E_PARAMif invalid parameter is passed.
OPEN_E_INTERNALif internal error has occurred.
Note
Maximum size for tacacsServer is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerGlobalKeyDelete ( openapiClientHandle_t client_handle)

Delete TACACS+ global key.

Parameters
[in]client_handleClient handle from registration API
Return values
OPEN_E_NONEif TACACS+ global key is set.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerGlobalKeySet ( openapiClientHandle_t client_handle,
open_buffdesc keyString 
)

Set TACACS+ global key.

Parameters
[in]client_handleClient handle from registration API
[in]keyStringTACACS+ global key.
Return values
OPEN_E_NONEif TACACS+ global key is set.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Key string accepts all the characters.
Initialize keyString pstart and size with the char buffer of size returned by openapiTacacsKeyMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerGlobalTimeoutGet ( openapiClientHandle_t client_handle,
uint32_t *  globalTimeout 
)

Get TACACS+ server global timeout.

Parameters
[in]client_handleClient handle from registration API
[out]globalTimeoutTACACS+ server global timeout value
Return values
OPEN_E_NONEif TACACS+ server global timeout value is returned.
OPEN_E_FAILif failed to get TACACS+ server global timeout.
OPEN_E_PARAMerror in parameter passed.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerGlobalTimeoutSet ( openapiClientHandle_t client_handle,
uint32_t  globalTimeout 
)

Set TACACS+ server global timeout.

Parameters
[in]client_handleClient handle from registration API
[in]globalTimeoutTACACS+ server global timeout value
-Minimum value OPENAPI_TACACS_TIMEOUT_MIN
-Maximum value OPENAPI_TACACS_TIMEOUT_MAX
Return values
OPEN_E_NONEif TACACS+ server global timeout value is set.
OPEN_E_FAILif failed to get TACACS+ server global timeout.
OPEN_E_PARAMerror in parameter passed.
Note
Calling this API will change the running configuration of the switch.
Pass the value as 0 to set the global timeout to default.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerKeySet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
open_buffdesc keyString 
)

Set the TACACS+ server key.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[in]keyStringTACACS+ server key
Return values
OPEN_E_NONEif TACACS+ server key is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Key string accepts all the characters.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().
Maximum size for keyString is determined by calling openapiTacacsKeyMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerMaxLengthGet ( openapiClientHandle_t client_handle,
uint32_t *  tacacsServerMaxLen 
)

Get the maximum length of TACACS+ server address.

Parameters
[in]client_handleClient handle from registration API
[out]tacacsServerMaxLenMaximum length of TACACS+ server address.
Return values
OPEN_E_NONEif TACACS+ server maximum address length is returned.
OPEN_E_PARAMif invalid parameter is passed.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerNextGet ( openapiClientHandle_t client_handle,
open_buffdesc tacacsServer,
open_buffdesc nextTacacsServer 
)

Get next TACACS+ server configured.

Parameters
[in]client_handleClient handle from registration API
[in]tacacsServerCurrent TACACS+ server
[out]nextTacacsServerNext TACACS+ server
Return values
OPEN_E_NONEif the next TACACS+ server is returned.
OPEN_E_FAILif current/next TACACS+ server does not exist.
OPEN_E_PARAMif invalid parameter is passed.
OPEN_E_INTERNALif internal error has occurred.
Note
Maximum size for the servers is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerPortGet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint16_t *  port 
)

Get the TACACS+ server port number.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of TACACS+ server
[out]portTACACS+ server port number
Return values
OPEN_E_NONEif TACACS+ server port is returned.
OPEN_E_FAILif TACACS+ server does not exist.
OPEN_E_PARAMerror in parameter passed.
Note
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerPortSet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint32_t  port 
)

Set the TACACS+ server port.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[in]portTACACS+ server port
-Minimum value OPENAPI_TACACS_PORT_NUM_MIN
-Maximum value OPENAPI_TACACS_PORT_NUM_MAX
Return values
OPEN_E_NONEif TACACS+ server port is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerPriorityGet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint16_t *  priority 
)

Get the TACACS+ server priority.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[out]priorityTACACS+ server priority
Return values
OPEN_E_NONEif TACACS+ server priority is returned.
OPEN_E_FAILif TACACS+ server does not exist.
OPEN_E_PARAMerror in parameter passed.
Note
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerPrioritySet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint32_t  priority 
)

Set the TACACS+ server priority.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[in]priorityTACACS+ server priority
-Minimum value OPENAPI_TACACS_PRIORITY_MIN
-Maximum value OPENAPI_TACACS_PRIORITY_MAX
Return values
OPEN_E_NONEif TACACS+ server priority is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServersMaxSupportedGet ( openapiClientHandle_t client_handle,
uint32_t *  tacacsSrvMax 
)

Get the maximum TACACS+ servers supported.

Parameters
[in]client_handleClient handle from registration API
[out]tacacsSrvMaxMaximum number of TACACS+ servers supported
Return values
OPEN_E_NONEif maximum number of TACACS+ servers supported is returned.
OPEN_E_PARAMif invalid parameter is passed.

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerTimeoutGet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint32_t *  timeout 
)

Get the TACACS+ server timeout.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[out]timeoutTACACS+ server timeout
Return values
OPEN_E_NONEif TACACS+ server timeout is returned.
OPEN_E_FAILif TACACS+ server does not exist.
OPEN_E_PARAMerror in parameter passed.
Note
Timeout will be set to global timeout value if not configured.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.
open_error_t openapiTacacsServerTimeoutSet ( openapiClientHandle_t client_handle,
open_buffdesc serverAddr,
uint32_t  timeout 
)

Set the TACACS+ server timeout.

Parameters
[in]client_handleClient handle from registration API
[in]serverAddrDNS name/IP address of the TACACS+ server
[in]timeoutTACACS+ server timeout value
-Minimum value OPENAPI_TACACS_TIMEOUT_MIN
-Maximum value OPENAPI_TACACS_TIMEOUT_MAX
Return values
OPEN_E_NONEif TACACS+ server timeout is set successfully.
OPEN_E_FAILif TACACS+ server is not found.
OPEN_E_PARAMif invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.
Timeout value of 0 will set it to global timeout value.
Timeout will be set to global timeout value if not configured.
Maximum size for serverAddr is determined by calling openapiTacacsServerMaxLengthGet().

OpEN API Version: 1.1

Examples:
tacacs_example.c.