4.[Limitations - OS compatibility, etc.](#limitations)
5.[Development - Guide for contributing to the module](#development)
6.[Release Notes](#release-notes)
...
...
@@ -42,15 +54,32 @@ The `freeradius` class installs the base server. In the early releases, this cla
have many parameters as most values are hard-coded. I am working on parameterising more
of the global settings to increase flexibility. Patches are welcome.
*`control_socket` Enable the control-socket virtual server. See also the "radmin" program. Default: `false`
*`max_requests` The maximum number of requests which the server keeps track of. This should be 256 multiplied by the number of clients. Default: `4096`
*`max_servers` Limit on the total number of servers running. Default: `4096`
*`mysql_support` Install support for MySQL. Default: `false`
*`perl_support` Install support for Perl. Default: `false`
*`ip` Default: `undef`. The IP address of the client. For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied.
*`ip6` Default: `undef`. The IPv6 address of the client. `ip` and `ip6` are mutually exclusive but one must be supplied.
*`net` Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
*`shortname` required. A short alias that is used in place of the IP address or fully qualified hostname provided in the first line of the section.
*`secret` required. The RADIUS shared secret used for communication between the client/NAS and the RADIUS server.
*`server` Default: `undef`
*`virtual_server` Default: `undef`. The virtual server that traffic from this client should be sent to.
*`nastype` Default: `undef`. The nastype attribute is used to tell the checkrad.pl script which NAS-specific method it should use when checking simultaneous use.
*`netmask` Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
*`redirect` Default: `undef`
*`port` Default: `undef`. The UDP port that this virtual server should listen on. Leave blank if this client is not tied to a virtual server.
*`srcip` Default: `undef`
##### `ip`
Default: `undef`. The IP address of the client. For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied.
##### `ip6`
Default: `undef`. The IPv6 address of the client. `ip` and `ip6` are mutually exclusive but one must be supplied.
##### `net`
Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
##### `shortname`
required. A short alias that is used in place of the IP address or fully qualified hostname provided in the first line of the section.
##### `secret`
required. The RADIUS shared secret used for communication between the client/NAS and the RADIUS server.
##### `server`
Default: `undef`
##### `virtual_server`
Default: `undef`. The virtual server that traffic from this client should be sent to.
##### `nastype`
Default: `undef`. The nastype attribute is used to tell the checkrad.pl script which NAS-specific method it should use when checking simultaneous use.
##### `netmask`
Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
##### `redirect`
Default: `undef`
##### `port`
Default: `undef`. The UDP port that this virtual server should listen on. Leave blank if this client is not tied to a virtual server.