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_handle	Client handle from registration API
[out]	tacacsKeyMaxLen	Maximum length of the TACACS+ key.

Return values

OPEN_E_NONE	if maximum length of TACACS+ key is returned.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of TACACS+ server

Return values

OPEN_E_NONE	if TACACS+ server is added.
OPEN_E_FAIL	if maximum TACACS+ servers are reached.
OPEN_E_EXISTS	if the TACACS+ server is already configured.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server

Return values

OPEN_E_NONE	if TACACS+ server key is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server

Return values

OPEN_E_NONE	if TACACS+ server port is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server

Return values

OPEN_E_NONE	if TACACS+ server priority is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of TACACS+ server

Return values

OPEN_E_NONE	if TACACS+ server is removed.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[out]	tacacsServer	First TACACS+ server.

Return values

OPEN_E_NONE	if first TACACS+ server is returned.
OPEN_E_FAIL	if the TACACS+ server does not exist.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if 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_handle

Client handle from registration API

Return values

OPEN_E_NONE	if TACACS+ global key is set.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	keyString	TACACS+ global key.

Return values

OPEN_E_NONE	if TACACS+ global key is set.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[out]	globalTimeout	TACACS+ server global timeout value

Return values

OPEN_E_NONE	if TACACS+ server global timeout value is returned.
OPEN_E_FAIL	if failed to get TACACS+ server global timeout.
OPEN_E_PARAM	error 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_handle	Client handle from registration API
[in]	globalTimeout	TACACS+ server global timeout value
	-	Minimum value OPENAPI_TACACS_TIMEOUT_MIN
	-	Maximum value OPENAPI_TACACS_TIMEOUT_MAX

Return values

OPEN_E_NONE	if TACACS+ server global timeout value is set.
OPEN_E_FAIL	if failed to get TACACS+ server global timeout.
OPEN_E_PARAM	error 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[in]	keyString	TACACS+ server key

Return values

OPEN_E_NONE	if TACACS+ server key is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[out]	tacacsServerMaxLen	Maximum length of TACACS+ server address.

Return values

OPEN_E_NONE	if TACACS+ server maximum address length is returned.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	tacacsServer	Current TACACS+ server
[out]	nextTacacsServer	Next TACACS+ server

Return values

OPEN_E_NONE	if the next TACACS+ server is returned.
OPEN_E_FAIL	if current/next TACACS+ server does not exist.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of TACACS+ server
[out]	port	TACACS+ server port number

Return values

OPEN_E_NONE	if TACACS+ server port is returned.
OPEN_E_FAIL	if TACACS+ server does not exist.
OPEN_E_PARAM	error 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[in]	port	TACACS+ server port
	-	Minimum value OPENAPI_TACACS_PORT_NUM_MIN
	-	Maximum value OPENAPI_TACACS_PORT_NUM_MAX

Return values

OPEN_E_NONE	if TACACS+ server port is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[out]	priority	TACACS+ server priority

Return values

OPEN_E_NONE	if TACACS+ server priority is returned.
OPEN_E_FAIL	if TACACS+ server does not exist.
OPEN_E_PARAM	error 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[in]	priority	TACACS+ server priority
	-	Minimum value OPENAPI_TACACS_PRIORITY_MIN
	-	Maximum value OPENAPI_TACACS_PRIORITY_MAX

Return values

OPEN_E_NONE	if TACACS+ server priority is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[out]	tacacsSrvMax	Maximum number of TACACS+ servers supported

Return values

OPEN_E_NONE	if maximum number of TACACS+ servers supported is returned.
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[out]	timeout	TACACS+ server timeout

Return values

OPEN_E_NONE	if TACACS+ server timeout is returned.
OPEN_E_FAIL	if TACACS+ server does not exist.
OPEN_E_PARAM	error 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_handle	Client handle from registration API
[in]	serverAddr	DNS name/IP address of the TACACS+ server
[in]	timeout	TACACS+ server timeout value
	-	Minimum value OPENAPI_TACACS_TIMEOUT_MIN
	-	Maximum value OPENAPI_TACACS_TIMEOUT_MAX

Return values

OPEN_E_NONE	if TACACS+ server timeout is set successfully.
OPEN_E_FAIL	if TACACS+ server is not found.
OPEN_E_PARAM	if 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.