Baptiste Jonglez 7 years ago
parent
commit
10c86d6b16
1 changed files with 6 additions and 3 deletions
  1. 6 3
      src/lib/dhcpsrv/radius_host_data_source.h

+ 6 - 3
src/lib/dhcpsrv/radius_host_data_source.h

@@ -16,7 +16,7 @@
 namespace isc {
 namespace dhcp {
 
-/// @brief MySQL Host Data Source
+/// @brief Radius Host Data Source
 ///
 /// This class implements the @ref isc::dhcp::BaseHostDataSource interface to
 /// a radius protocol.
@@ -27,14 +27,17 @@ public:
     ///
     /// Uses the following keywords in the parameters passed to it to
     /// connect to the database:
-    /// - password - Password for radius
+    /// - password - Password (secret) to connect to radius server (mandatory)
+    /// - name - Realm to append to usernames, for instance "kea.isc.org" to
+    ///          send "<mac>@kea.isc.org" as username to the Radius server (mandatory)
     /// - host - Host to which to connect (optional, defaults to "localhost")
-    /// - port - Port to witch to connect (optional, defaults to 1812)
+    /// - port - Port to which to connect (optional, defaults to 1812)
     ///
     /// @param parameters A data structure relating keywords and values
     ///        concerned with the database.
     ///
     /// @throw isc::dhcp::NoPassword Mandatory password not given
+    /// @throw isc::dhcp::NoDatabaseName Mandatory realm was not given
     /// @throw isc::dhcp::DbOpenError Error opening the database
     /// @throw isc::dhcp::DbOperationError An operation on the open database has
     ///        failed.