Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
RADIUS Configuration And Status [OPENAPI_RADIUS]

Enumerations

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

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. 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...
 
uint32_t openapiRadiusEncryptedSharedSecretSizeGet (openapiClientHandle_t *client_handle)
 Get the size for an encrypted RADIUS shared secret. More...
 
uint32_t openapiRadiusServerAddressMaxLengthGet (openapiClientHandle_t *client_handle)
 Get the maximum size allowed for the RADIUS servers address parameter. More...
 
uint32_t openapiRadiusServerNameMaxLengthGet (openapiClientHandle_t *client_handle)
 Get the maximum size allowed for the RADIUS servers name 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

Designates a server as primary or secondary.

Definition at line 44 of file openapi_radius.h.

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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
[in]serverNamename identifying the server in the configuration
Return values
OPEN_E_NONEserver added
OPEN_E_FAILadding server failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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

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_handleClient handle from registration API
[out]modeOPEN_FALSE indicates attribute 4 not configured, OPEN_TRUE indicates attribute 4 configured
[out]ipAddrthe IP address to send, only IPv4 addresses supported
Return values
OPEN_E_NONEget succeeded
OPEN_E_FAILget failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]modeset to OPEN_FALSE to unconfigure attribute 4, set to OPEN_TRUE to set attribute 4
[in]ipAddrthe IP address to send, only IPv4 addresses supported
Return values
OPEN_E_NONEset succeeded
OPEN_E_FAILset failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
[out]portNumberserver's port number
Return values
OPEN_E_NONEget succeeded
OPEN_E_FAILget failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
[in]portNumberserver's port number
Return values
OPEN_E_NONEset succeeded
OPEN_E_FAILset failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
Return values
OPEN_E_NONEserver removed
OPEN_E_FAILremoving server failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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

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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]encryptedSecretencrypted secret
Return values
OPEN_E_NONEset succeeded
OPEN_E_FAILset failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
[out]serverTypeserver's type
Return values
OPEN_E_NONEget succeeded
OPEN_E_FAILget failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient handle from registration API
[in]serverAddressDNS name/IP address of the server
[in]addressTypeindicates whether serverAddress contains a DNS name or a IP address
[in]serverTypeserver's type
Return values
OPEN_E_NONEset succeeded
OPEN_E_FAILset failed
OPEN_E_PARAMinvalid parameter passed
OPEN_E_INTERNALinternal 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_handleClient 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_handleClient 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_handleClient 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_handleClient handle from registration API
Returns
size of string

OpEN API Version: 1.14