Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

Excerpt

The Radius Server resource contains settings for the radius servers used by the Radius Configuration.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionYesNostringnone64 - Max LengthSpecifies the RADIUS server description for easy referent in the general configuration section.
RadiusServerYesYesstringnone256 - Max LengthSpecifies the RADIUS server IP address or Fully Qualified Domain Name (FQDN) for connecting with this server.
PortYesYesint1812Specifies the communications port to use for connecting to the RADIUS server.
EncryptedSharedSecretYesYesstringnone256 - Max LengthSpecifies the shared secret to use (as specified in the RADIUS client configuration) to communicate with the RADIUS server.
SendConnectivityPacketYesYesEnum0Possible values:
  • 0 - eStatusServer
  • 1 - eRequest
Controls which RADIUS packet type to send to the server on verifying the network connectivity. The server connectivity status is declared to be up on successful reception of a response. Likewise, the server connectivity status is declared to be down on event there is no response from the server. Status-Server (RFC 5997)*
- Periodically sends Status-Server packet every minute as "keep-alive" ping to verify and declare the server connectivity status. Request*
- Sends an Access-Request or Accounting-Request packet to verify and declare the authentication or accounting server connectivity status respectively on-demand.

Runtime

Parameter Name Description Data Type Possible Values
rt_RADStatusEnumPossible values:
  • 0 - eRADUp
  • 1 - eRADDown

Statistics

Parameter Name Description Data Type Possible Values
rt_RoundTripTimeIndicates the average time it takes for RADIUS pings to reach the server and for the

...

SBC

...

to get a response.string
rt_SuccessfulPingsIndicates the number of successful RADIUS pings made since last reset.int
rt_FailedPingsIndicates the number of failed RADIUS pings made since last reset.int
rt_TotalPingsIndicates the total number of RADIUS pings made since last reset.long
rt_LastResetTimeIndicates the date and time when the statistics were last reset.long
rt_NumberOfCDRAttemptedIndicate the number of successful logging of CDRs this server.int
rt_NumberOfCDRFailedIndicate the number of failed logging of CDRs this server.int