RADIUS Configuration And Status [OPENAPI_RADIUS]

Enumerations
enum	OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t { OPEN_RADIUSGLOBAL = 0, OPEN_RADIUSLOCAL }
enum	OPEN_RADIUS_SERVER_ENTRY_TYPE_t { OPEN_RADIUS_SERVER_ENTRY_TYPE_PRIMARY = 1, OPEN_RADIUS_SERVER_ENTRY_TYPE_SECONDARY = 2 }
	Designates a server as primary or secondary. More...
enum	OPEN_RADIUS_SERVER_TYPE_t { OPEN_RADIUS_SERVER_TYPE_UNKNOWN = 0, OPEN_RADIUS_SERVER_TYPE_AUTH, OPEN_RADIUS_SERVER_TYPE_ACCT }

Functions
open_error_t	openapiRadiusAccountingHostNameServerPortNumGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t *pPort)
	Get the port number of the accounting server being used. More...
open_error_t	openapiRadiusAccountingHostNameServerPortNumSet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, uint32_t port)
	Sets the port number of the accounting server being used. More...
open_error_t	openapiRadiusAccountingHostNameServerSharedSecretSet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pSharedSecret)
	Set the shared secret being used between the radius client and the accounting server. More...
open_error_t	openapiRadiusAccountingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pAccMode)
	Gets radius-accounting mode parameter. More...
open_error_t	openapiRadiusAccountingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t accntMode)
	Sets radius-accounting mode parameter. More...
open_error_t	openapiRadiusAccountingServerIPHostNameVerify (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, OPEN_BOOL_t *pVerified)
	Verify a RADIUS accounting server is a configured server. More...
open_error_t	openapiRadiusAcctServerFirstIPHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Gets first accounting configured server. More...
open_error_t	openapiRadiusAcctServerNextIPHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pCurServerAddr, open_buffdesc *pNextServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Get the configured accounting server next in the list after the specified server. More...
open_error_t	openapiRadiusAcctServerStatBadAuthGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS accounting-response bad auth packets received from requested server. More...
open_error_t	openapiRadiusAcctServerStatMalformedResponseGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of malformed RADIUS accounting-response packets received from requested server. More...
open_error_t	openapiRadiusAcctServerStatPendingReqGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS accounting-request packets destined for this server that have not yet timed out or received a response from this server received from requested server. More...
open_error_t	openapiRadiusAcctServerStatPktsDroppedGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS packets received from server on the accounting port that were dropped for some other reason. More...
open_error_t	openapiRadiusAcctServerStatReqGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS accounting-request packets sent to requested server. More...
open_error_t	openapiRadiusAcctServerStatResponseGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS accounting-response packets received from requested server. More...
open_error_t	openapiRadiusAcctServerStatRetransGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS accounting-request packets retransmitted to requested server. More...
open_error_t	openapiRadiusAcctServerStatRTTGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pRoundTripTime)
	Get the round trip time. More...
open_error_t	openapiRadiusAcctServerStatTimeoutsGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pTimeout)
	Retrieve the number of accounting time-outs to requested server. More...
open_error_t	openapiRadiusAcctServerStatUnknownTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS packets of unknown type received from requested server on the accounting port. More...
open_error_t	openapiRadiusAuthServerAdd (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, open_buffdesc *serverName)
	Add a RADIUS authentication server. More...
open_error_t	openapiRadiusAuthServerAttribute4Get (openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode, open_inet_addr_t *ipAddr)
	Get the RADIUS authentication server attribute 4 value. More...
open_error_t	openapiRadiusAuthServerAttribute4Set (openapiClientHandle_t *client_handle, OPEN_BOOL_t mode, open_inet_addr_t *ipAddr)
	Set the RADIUS authentication server attribute 4 value. More...
open_error_t	openapiRadiusAuthServerPortNumGet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t *portNumber)
	Get the RADIUS authentication server port number. More...
open_error_t	openapiRadiusAuthServerPortNumSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, uint32_t portNumber)
	Set the RADIUS authentication server port number. More...
open_error_t	openapiRadiusAuthServerRemove (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType)
	Remove a RADIUS authentication server. More...
open_error_t	openapiRadiusAuthServerSharedSecretEncryptedSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, open_buffdesc *encryptedSecret)
	Set the shared secret being used between the RADIUS client and the RADIUS server. More...
open_error_t	openapiRadiusAuthServerTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t *serverType)
	Get the RADIUS authentication server type. More...
open_error_t	openapiRadiusAuthServerTypeSet (openapiClientHandle_t *client_handle, open_buffdesc *serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType, OPEN_RADIUS_SERVER_ENTRY_TYPE_t serverType)
	Set the RADIUS authentication server type. More...
open_error_t	openapiRadiusConfiguredServersCountGet (openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_TYPE_t servType, uint32_t *pCount)
	Gets the number of configured servers of specified type (Auth or Acct). More...
uint32_t	openapiRadiusEncryptedSharedSecretSizeGet (openapiClientHandle_t *client_handle)
	Get the size for an encrypted RADIUS shared secret. More...
open_error_t	openapiRadiusHostNameServerAddrVerify (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, OPEN_BOOL_t *pVerified)
	Verify a RADIUS authentication server is a configured server. More...
open_error_t	openapiRadiusHostNameServerSharedSecretKeyTypeSet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus, OPEN_BOOL_t keyType)
	Set the shared secret being used between the radius client and the radius server. More...
open_error_t	openapiRadiusNamedAcctServerAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerName, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Gets server of specified accounting serverName. More...
open_error_t	openapiRadiusNamedServerAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerName, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Gets server Name of specified radius server. More...
open_error_t	openapiRadiusServerAcctHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
	Gets server name of specified accounting server. More...
uint32_t	openapiRadiusServerAddressMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS servers address parameter. More...
open_error_t	openapiRadiusServerFirstIPHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Gets first configured server. More...
open_error_t	openapiRadiusServerGlobalCurentGet (openapiClientHandle_t *client_handle, OPEN_RADIUS_SERVER_TYPE_t servType, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Gets global selected Radius server address, server type and address type. More...
open_error_t	openapiRadiusServerGlobalSelectedGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t *pServerAddrType)
	Gets global selected radius server address and address type. More...
open_error_t	openapiRadiusServerHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
	Get the server Name of specified radius server. More...
uint32_t	openapiRadiusServerNameMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS servers name parameter. More...
open_error_t	openapiRadiusServerNameSet (openapiClientHandle_t *client_handle, open_buffdesc *pServerAddr, OPEN_IP_ADDRESS_TYPE_t addrType, open_buffdesc *pServerName)
	Sets server name attribute to the Auth server. More...
open_error_t	openapiRadiusServerNextIPHostNameGet (openapiClientHandle_t *client_handle, open_buffdesc *pCurServerAddr, open_buffdesc *pNextServerAddr, OPEN_IP_ADDRESS_TYPE_t *pAddrType)
	Get the configured next server in the list after the specified server. More...
open_error_t	openapiRadiusServerRetransGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pMaxRetransmit, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus)
	Gets the maximum number of retransmissions parameter. More...
open_error_t	openapiRadiusServerRetransSet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t maxRetransmit, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus)
	Sets the maximum number of retransmissions parameter. More...
open_error_t	openapiRadiusServerStatAccessAcceptGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-request packets received from requested server. More...
open_error_t	openapiRadiusServerStatAccessChallengeGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-challenge packets received from requested server. More...
open_error_t	openapiRadiusServerStatAccessRejectGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-reject packets received from requested server. More...
open_error_t	openapiRadiusServerStatAccessReqGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-request packets sent to requested server. More...
open_error_t	openapiRadiusServerStatAccessRetransGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-request packets retransmitted to requested server. More...
open_error_t	openapiRadiusServerStatBadAuthGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-response bad auth packets received from requested server. More...
open_error_t	openapiRadiusServerStatMalformedAccessResponseGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of malformed RADIUS access-response packets received from requested server. More...
open_error_t	openapiRadiusServerStatPendingReqGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS access-request packets destined for this server that have not yet timed out or received a response from this serverreceived from requested server. More...
open_error_t	openapiRadiusServerStatPktsDroppedGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS packets received from server on the authentication port that were dropped for some other reason. More...
open_error_t	openapiRadiusServerStatRTTGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pRoundTripTime)
	Get the round trip time. More...
open_error_t	openapiRadiusServerStatTimeoutsGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of authentication time-outs to requested server. More...
open_error_t	openapiRadiusServerStatUnknownTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pPacketCount)
	Retrieve the number of RADIUS packets of unknown type received from requested server on the authentication port. More...
open_error_t	openapiRadiusServerTimeOutGet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t *pTimeOut, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *pParamStatus)
	Gets the value of time-out duration parameter. More...
open_error_t	openapiRadiusServerTimeOutSet (openapiClientHandle_t *client_handle, open_buffdesc *pHostAddr, uint32_t timeOut, OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t paramStatus)
	Sets the time-out duration parameter. More...
uint32_t	openapiRadiusSharedSecretMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS shared secret. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_RADIUS_SERVER_ENTRY_TYPE_t

Designates a server as primary or secondary.

Definition at line 44 of file openapi_radius.h.

Function Documentation

open_error_t openapiRadiusAccountingHostNameServerPortNumGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		uint32_t *	pPort
	)

Get the port number of the accounting server being used.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Radius server address.
[in]	addrType	Address type[DNS/IP address].
[out]	pPort	port number.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Get the port number of the accounting server being used.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAccountingHostNameServerPortNumSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		uint32_t	port
	)

Sets the port number of the accounting server being used.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Radius server address.
[in]	addrType	Address type[DNS/IP address].
[in]	port	Port number.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets the port number of the accounting server being used.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAccountingHostNameServerSharedSecretSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		open_buffdesc *	pSharedSecret
	)

Set the shared secret being used between the radius client and the accounting server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Server address.
[in]	addrType	Address type[DNS/IP address].
[in]	pSharedSecret	New shared secret.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets the shared secret being used between the radius client and the accounting server.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAccountingModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pAccMode
	)

Gets radius-accounting mode parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[out]	pAccMode	Accounting mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches radius-accounting mode parameter. OPEN_ENABLE - if accounting has been enabled. OPEN_DISABLE - if accounting has been disabled.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAccountingModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	accntMode
	)

Sets radius-accounting mode parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	accntMode	Accounting mode(ENABLE/DISABLE).

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets radius-accounting mode.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAccountingServerIPHostNameVerify	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		OPEN_BOOL_t *	pVerified
	)

Verify a RADIUS accounting server is a configured server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Server address.
[in]	addrType	Address type[DNS/IP address].
[out]	pVerified	Returns TRUE if configured, else FALSE.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API verifies RADIUS accounting server is a configured server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerFirstIPHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Gets first accounting configured server.

Parameters

[in]	client_handle	Client handle from registration API.
[out]	pServerAddr	First configured radius server.
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches first accounting configured radius server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerNextIPHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pCurServerAddr,
		open_buffdesc *	pNextServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Get the configured accounting server next in the list after the specified server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pCurServerAddr	current server information.
[out]	pNextServerAddr	next configured server information.
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches next accounting server after the specified server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatBadAuthGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS accounting-response bad auth packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS accounting-response packets containing invalid authenticators or signature attributes received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatMalformedResponseGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of malformed RADIUS accounting-response packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of malformed RADIUS accounting-response packets received from requested server.

Malformed packets include packets with an invalid length. Bad authenticators, signature attributes, and unknown types are not included.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatPendingReqGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS accounting-request packets destined for this server that have not yet timed out or received a response from this server received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS accounting-request packets destined for this server that have not yet timed out or received a response from this server received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatPktsDroppedGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS packets received from server on the accounting port that were dropped for some other reason.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS packets received from server on the accounting port that were dropped for some other reason.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatReqGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS accounting-request packets sent to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS accounting-request packets sent to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatResponseGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS accounting-response packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS accounting-response packets received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatRetransGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS accounting-request packets retransmitted to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS accounting-request packets retransmitted to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatRTTGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pRoundTripTime
	)

Get the round trip time.

Parameters

[in]	client_handle	Client handle from registration API
[in]	pHostAddr	Host Address of the radius server.
[out]	pRoundTripTime	Round trip time.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the round trip time

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatTimeoutsGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pTimeout
	)

Retrieve the number of accounting time-outs to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pTimeout	Timeout information.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of accounting time-outs to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAcctServerStatUnknownTypeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS packets of unknown type received from requested server on the accounting port.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS packets of unknown type received from requested server on the accounting port.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType,
		open_buffdesc *	serverName
	)

Add a RADIUS authentication server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address
[in]	serverName	name identifying the server in the configuration

Return values

OPEN_E_NONE	server added
OPEN_E_FAIL	adding server failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

Maximum size for serverAddress is determined by calling openapiRadiusServerAddressMaxLengthGet().

Maximum size for serverName is determined by calling openapiRadiusServerNameMaxLengthGet().

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerAttribute4Get	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	mode,
		open_inet_addr_t *	ipAddr
	)

Get the RADIUS authentication server attribute 4 value.

Parameters

[in]	client_handle	Client handle from registration API
[out]	mode	OPEN_FALSE indicates attribute 4 not configured, OPEN_TRUE indicates attribute 4 configured
[out]	ipAddr	the IP address to send, only IPv4 addresses supported

Return values

OPEN_E_NONE	get succeeded
OPEN_E_FAIL	get failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerAttribute4Set	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t	mode,
		open_inet_addr_t *	ipAddr
	)

Set the RADIUS authentication server attribute 4 value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	mode	set to OPEN_FALSE to unconfigure attribute 4, set to OPEN_TRUE to set attribute 4
[in]	ipAddr	the IP address to send, only IPv4 addresses supported

Return values

OPEN_E_NONE	set succeeded
OPEN_E_FAIL	set failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerPortNumGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType,
		uint32_t *	portNumber
	)

Get the RADIUS authentication server port number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address
[out]	portNumber	server's port number

Return values

OPEN_E_NONE	get succeeded
OPEN_E_FAIL	get failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerPortNumSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType,
		uint32_t	portNumber
	)

Set the RADIUS authentication server port number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address
[in]	portNumber	server's port number

Return values

OPEN_E_NONE	set succeeded
OPEN_E_FAIL	set failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerRemove	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType
	)

Remove a RADIUS authentication server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address

Return values

OPEN_E_NONE	server removed
OPEN_E_FAIL	removing server failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

Maximum size for serverAddress is determined by calling openapiRadiusServerAddressMaxLengthGet().

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerSharedSecretEncryptedSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		open_buffdesc *	encryptedSecret
	)

Set the shared secret being used between the RADIUS client and the RADIUS server.

The shared secret is specified in encrypted form.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	encryptedSecret	encrypted secret

Return values

OPEN_E_NONE	set succeeded
OPEN_E_FAIL	set failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerTypeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType,
		OPEN_RADIUS_SERVER_ENTRY_TYPE_t *	serverType
	)

Get the RADIUS authentication server type.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address
[out]	serverType	server's type

Return values

OPEN_E_NONE	get succeeded
OPEN_E_FAIL	get failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusAuthServerTypeSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	serverAddress,
		OPEN_IP_ADDRESS_TYPE_t	addressType,
		OPEN_RADIUS_SERVER_ENTRY_TYPE_t	serverType
	)

Set the RADIUS authentication server type.

Parameters

[in]	client_handle	Client handle from registration API
[in]	serverAddress	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddress contains a DNS name or a IP address
[in]	serverType	server's type

Return values

OPEN_E_NONE	set succeeded
OPEN_E_FAIL	set failed
OPEN_E_PARAM	invalid parameter passed
OPEN_E_INTERNAL	internal error has occurred

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusConfiguredServersCountGet	(	openapiClientHandle_t *	client_handle,
		OPEN_RADIUS_SERVER_TYPE_t	servType,
		uint32_t *	pCount
	)

Gets the number of configured servers of specified type (Auth or Acct).

Parameters

[in]	client_handle	Client handle from registration API.
[in]	servType	Radius server type.
[out]	pCount	Server count.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches configured servers count of a specified type.

OpEN API Version: 1.25

Examples:

radius_example.c.

uint32_t openapiRadiusEncryptedSharedSecretSizeGet

(

openapiClientHandle_t *

client_handle

)

Get the size for an encrypted RADIUS shared secret.

      This is used as the string length including the
      terminating NULL. Encrypted shared secrets are a
      series of hexadecimal digits represented in ASCIIZ
      string format.

Parameters

[in]

client_handle

Client handle from registration API

Returns

size of string

OpEN API Version: 1.14

Examples:

radius_example.c.

open_error_t openapiRadiusHostNameServerAddrVerify	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		OPEN_BOOL_t *	pVerified
	)

Verify a RADIUS authentication server is a configured server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Server address.
[in]	addrType	Address type[DNS/IP address].
[out]	pVerified	Returns TRUE if configured, else FALSE.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API verifies RADIUS authentication server is a configured server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusHostNameServerSharedSecretKeyTypeSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t	paramStatus,
		OPEN_BOOL_t	keyType
	)

Set the shared secret being used between the radius client and the radius server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Server address.
[in]	paramStatus	Radius server config param [Global/local].
[in]	keyType	Key type.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets the shared secret being used between the radius client and the radius server.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusNamedAcctServerAddrGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerName,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Gets server of specified accounting serverName.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerName	Name of the server.
[out]	pServerAddr	Radius server address [Host name/IP address].
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches server name of specified accounting server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusNamedServerAddrGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerName,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Gets server Name of specified radius server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerName	Name of the server.
[out]	pServerAddr	Radius server address[Host name/IP address].
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches server Name of specified radius server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerAcctHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		open_buffdesc *	pServerName
	)

Gets server name of specified accounting server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Configuredserver address [Host name/IP address].
[in]	addrType	Address type[DNS/IP address].
[out]	pServerName	Name of the server.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches server name of specified accounting server.

OpEN API Version: 1.25

Examples:

radius_example.c.

uint32_t openapiRadiusServerAddressMaxLengthGet

(

openapiClientHandle_t *

client_handle

)

Get the maximum size allowed for the RADIUS servers address parameter.

This is used as the string length including the terminating NULL.

Parameters

[in]

client_handle

Client handle from registration API

Returns

size of string

OpEN API Version: 1.14

open_error_t openapiRadiusServerFirstIPHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Gets first configured server.

Parameters

[in]	client_handle	Client handle from registration API.
[out]	pServerAddr	First configured radius server.
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches first configured radius server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerGlobalCurentGet	(	openapiClientHandle_t *	client_handle,
		OPEN_RADIUS_SERVER_TYPE_t	servType,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Gets global selected Radius server address, server type and address type.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	servType	Radius server type[Auth/Acct].
[out]	pServerAddr	Radius server address.
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches global selected Radius server address, server type and address type.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerGlobalSelectedGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pServerAddrType
	)

Gets global selected radius server address and address type.

Parameters

[in]	client_handle	Client handle from registration API.
[out]	pServerAddr	Radius server address.
[out]	pServerAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches selected radius server address and address type.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		open_buffdesc *	pServerName
	)

Get the server Name of specified radius server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pServerAddr	Host name or IP address server.
[in]	addrType	Address type[DNS/IP address].
[out]	pServerName	Name of the server.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches server Name of specified radius server.

OpEN API Version: 1.25

Examples:

radius_example.c.

uint32_t openapiRadiusServerNameMaxLengthGet

(

openapiClientHandle_t *

client_handle

)

Get the maximum size allowed for the RADIUS servers name parameter.

This is used as the string length including the terminating NULL.

Parameters

[in]

client_handle

Client handle from registration API

Returns

size of string

OpEN API Version: 1.14

open_error_t openapiRadiusServerNameSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pServerAddr,
		OPEN_IP_ADDRESS_TYPE_t	addrType,
		open_buffdesc *	pServerName
	)

Sets server name attribute to the Auth server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	pServerAddr	Server host name or IP address.
[in]	addrType	Address type[DNS/IP address].
[in]	pServerName	Name of the server.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets serverName to the Auth server.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerNextIPHostNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pCurServerAddr,
		open_buffdesc *	pNextServerAddr,
		OPEN_IP_ADDRESS_TYPE_t *	pAddrType
	)

Get the configured next server in the list after the specified server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pCurServerAddr	Current server information.
[out]	pNextServerAddr	Next configured server information.
[out]	pAddrType	Address type[DNS/IP address].

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches next configured server after the specified server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerRetransGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pMaxRetransmit,
		OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *	pParamStatus
	)

Gets the maximum number of retransmissions parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Server address(ALL_RADIUS_SERVERS => global).
[out]	pMaxRetransmit	Max retransmit value.
[out]	pParamStatus	Parameter for a specific server is global or local.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches maximum number of retransmissions parameter

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerRetransSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t	maxRetransmit,
		OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t	paramStatus
	)

Sets the maximum number of retransmissions parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Server address(ALL_RADIUS_SERVERS => global).
[in]	maxRetransmit	Max retransmit value.
[in]	paramStatus	Parameter for a specific server is global or local.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets maximum number of retransmissions parameter.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatAccessAcceptGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-request packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-request packets received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatAccessChallengeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-challenge packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-challenge packets received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatAccessRejectGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-reject packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-reject packets received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatAccessReqGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-request packets sent to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-request packets sent to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatAccessRetransGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-request packets retransmitted to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-request packets sent to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatBadAuthGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-response bad auth packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-response packets containing invalid authenticators or signature attributes received received from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatMalformedAccessResponseGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of malformed RADIUS access-response packets received from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of malformed RADIUS access-response packets received from requested server.

Malformed packets include packets with an invalid length. Bad authenticators, signature attributes, and unknown types are not included.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatPendingReqGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS access-request packets destined for this server that have not yet timed out or received a response from this serverreceived from requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS access-request packets destined for this server that have not yet timed out or received a response from this serverreceived from requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatPktsDroppedGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS packets received from server on the authentication port that were dropped for some other reason.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS packets received from server on the authentication port that were dropped for some other reason.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatRTTGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pRoundTripTime
	)

Get the round trip time.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pRoundTripTime	Round trip time.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the round trip time.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatTimeoutsGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of authentication time-outs to requested server.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of authentication time-outs to requested server.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerStatUnknownTypeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pPacketCount
	)

Retrieve the number of RADIUS packets of unknown type received from requested server on the authentication port.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Host Address of the radius server.
[out]	pPacketCount	Number of packets.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches the number of RADIUS packets of unknown type received from requested server on the authentication port.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerTimeOutGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t *	pTimeOut,
		OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t *	pParamStatus
	)

Gets the value of time-out duration parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Server address(ALL_RADIUS_SERVERS => global).
[out]	pTimeOut	Timeout value.
[out]	pParamStatus	Parameter for a specific server is global or local.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches time-out duration information.

OpEN API Version: 1.25

Examples:

radius_example.c.

open_error_t openapiRadiusServerTimeOutSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	pHostAddr,
		uint32_t	timeOut,
		OPEN_RADIUS_SERVER_CONFIGPARAMS_FLAG_t	paramStatus
	)

Sets the time-out duration parameter.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	pHostAddr	Server address (ALL_RADIUS_SERVERS => global).
[in]	timeOut	TimeOut duration.
[in]	paramStatus	Parameter for a specific server is global or local.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets time-out duration parameter.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

radius_example.c.

uint32_t openapiRadiusSharedSecretMaxLengthGet

(

openapiClientHandle_t *

client_handle

)

Get the maximum size allowed for the RADIUS shared secret.

      This is used as the string length including the
      terminating NULL.

Parameters

[in]

client_handle

Client handle from registration API

Returns

size of string

OpEN API Version: 1.14