Enumerations
enum	OPEN_RADIUS_SERVER_ENTRY_TYPE_t { OPEN_RADIUS_SERVER_ENTRY_TYPE_PRIMARY = 1, OPEN_RADIUS_SERVER_ENTRY_TYPE_SECONDARY }

Functions
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.

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.

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.

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.

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.

open_error_t	openapiRadiusAuthServerRemove (openapiClientHandle_t client_handle, open_buffdesc serverAddress, OPEN_IP_ADDRESS_TYPE_t addressType)
	Remove a RADIUS authentication server.

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.

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.

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.

uint32_t	openapiRadiusEncryptedSharedSecretSizeGet (openapiClientHandle_t *client_handle)
	Get the size for an encrypted RADIUS shared secret.

uint32_t	openapiRadiusServerAddressMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS servers address parameter.

uint32_t	openapiRadiusServerNameMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS servers name parameter.

uint32_t	openapiRadiusSharedSecretMaxLengthGet (openapiClientHandle_t *client_handle)
	Get the maximum size allowed for the RADIUS shared secret.

Detailed Description

Function Documentation

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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 serverAddr is determined by calling openapiRadiusServerAddressMaxLengthGet().; Maximum size for serverName is determined by calling openapiRadiusServerNameMaxLengthGet().

OpEN API Version: 1.14

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

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

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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 serverAddr is determined by calling openapiRadiusServerAddressMaxLengthGet().

OpEN API Version: 1.14

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]	serverAddr	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

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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

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]	serverAddr	DNS name/IP address of the server
[in]	addressType	indicates whether serverAddr 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

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

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

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

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

Enumerations

Functions

Detailed Description

Function Documentation