Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
open_error_t openapiTacacsKeyMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | tacacsKeyMaxLen | ||
) |
Get the maximum length of TACACS+ key.
[in] | client_handle | Client handle from registration API |
[out] | tacacsKeyMaxLen | Maximum length of the TACACS+ key. |
OPEN_E_NONE | if maximum length of TACACS+ key is returned. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerAdd | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr | ||
) |
Add TACACS+ server.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerDefaultKeySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr | ||
) |
Set the TACACS+ server key to default.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerDefaultPortSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr | ||
) |
Set the TACACS+ server port to default.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerDefaultPrioritySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr | ||
) |
Set the TACACS+ server priority to default.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr | ||
) |
Delete TACACS+ server.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerFirstGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | tacacsServer | ||
) |
Get the first TACACS+ server configured.
[in] | client_handle | Client handle from registration API |
[out] | tacacsServer | First TACACS+ server. |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerGlobalKeyDelete | ( | openapiClientHandle_t * | client_handle | ) |
Delete TACACS+ global key.
[in] | client_handle | Client handle from registration API |
OPEN_E_NONE | if TACACS+ global key is set. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerGlobalKeySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | keyString | ||
) |
Set TACACS+ global key.
[in] | client_handle | Client handle from registration API |
[in] | keyString | TACACS+ global key. |
OPEN_E_NONE | if TACACS+ global key is set. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerGlobalTimeoutGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | globalTimeout | ||
) |
Get TACACS+ server global timeout.
[in] | client_handle | Client handle from registration API |
[out] | globalTimeout | TACACS+ server global timeout value |
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
open_error_t openapiTacacsServerGlobalTimeoutSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | globalTimeout | ||
) |
Set TACACS+ server global timeout.
[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 |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerKeySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
open_buffdesc * | keyString | ||
) |
Set the TACACS+ server key.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
[in] | keyString | TACACS+ server key |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | tacacsServerMaxLen | ||
) |
Get the maximum length of TACACS+ server address.
[in] | client_handle | Client handle from registration API |
[out] | tacacsServerMaxLen | Maximum length of TACACS+ server address. |
OPEN_E_NONE | if TACACS+ server maximum address length is returned. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | tacacsServer, | ||
open_buffdesc * | nextTacacsServer | ||
) |
Get next TACACS+ server configured.
[in] | client_handle | Client handle from registration API |
[in] | tacacsServer | Current TACACS+ server |
[out] | nextTacacsServer | Next TACACS+ server |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerPortGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint16_t * | port | ||
) |
Get the TACACS+ server port number.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of TACACS+ server |
[out] | port | TACACS+ server port number |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerPortSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint32_t | port | ||
) |
Set the TACACS+ server port.
[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 |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerPriorityGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint16_t * | priority | ||
) |
Get the TACACS+ server priority.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
[out] | priority | TACACS+ server priority |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerPrioritySet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint32_t | priority | ||
) |
Set the TACACS+ server priority.
[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 |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServersMaxSupportedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | tacacsSrvMax | ||
) |
Get the maximum TACACS+ servers supported.
[in] | client_handle | Client handle from registration API |
[out] | tacacsSrvMax | Maximum number of TACACS+ servers supported |
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
open_error_t openapiTacacsServerTimeoutGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint32_t * | timeout | ||
) |
Get the TACACS+ server timeout.
[in] | client_handle | Client handle from registration API |
[in] | serverAddr | DNS name/IP address of the TACACS+ server |
[out] | timeout | TACACS+ server timeout |
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. |
OpEN API Version: 1.1
open_error_t openapiTacacsServerTimeoutSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | serverAddr, | ||
uint32_t | timeout | ||
) |
Set the TACACS+ server timeout.
[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 |
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. |
OpEN API Version: 1.1