Made it 2.0.0, and removed the changes that are in 1.1.x, as
[freeradius.git] / man / man5 / clients.conf.5
1 .TH clients.conf 5 "13 June 2005" "" "FreeRADIUS client configuration"
2 .SH NAME
3 clients.conf \- FreeRADIUS client configuration
4 .SH DESCRIPTION
5 The 
6 .I clients.conf
7 file contains definitions of RADIUS clients.
8 .PP
9 The information in this file overrides any information provided in
10 the deprecated 
11 .BR clients (5)
12 and 
13 .BR naslist (5)
14 files.
15 .PP
16 The file format is the same as that used for
17 .I radiusd.conf.
18 See 
19 .BR radiusd.conf (5)
20 for more details.
21 .PP
22 Each RADIUS client entry has the following basic form:
23 .IP
24 .nf
25 client <hostname|ip-address|ip-network> {
26        <attribute> = <value>
27  }
28 .fi
29 .LP
30 ip-network is used to specify a network of clients. Networks are
31 specified in CIDR notation. If multiple overlapping networks are
32 defined, the best match (smallest possible network) will be chosen for
33 a packet.
34 .SH ATTRIBUTES
35 The attributes that can appear in a 
36 .B client
37 section are listed below. Required attributes are labelled as
38 such. All other attributes are optional.
39 .PP
40 .TP 0.5i
41 .B secret [Required]
42 The RADIUS shared secret used for communication between the client/NAS
43 and the RADIUS server.
44 .TP 0.5i
45 .B shortname [Required]
46 A short alias that can be used in place of the IP address or fully
47 qualified hostname provided in the first line of the section.
48 .TP 0.5i
49 .B nastype
50 The nastype attribute is used to tell the 
51 .BR checkrad.pl
52 script which NAS-specific method it should use when checking
53 simultaneous use.
54
55 The following values are currently recognized:
56 .nf
57 cisco
58 computone
59 livingston
60 max40xx
61 multitech
62 netserver
63 pathras
64 patton
65 portslave
66 tc
67 usrhiper
68 other
69 .fi
70 .TP 0.5i
71 .B login
72 Reserved for future use.
73 .TP 0.5i
74 .B password
75 Reserved for future use.
76 .SH EXAMPLES
77 .IP
78 .nf
79 client 127.0.0.1 {
80         secret          = testing123
81         shortname       = localhost
82         nastype         = other     
83 }
84 .fi
85 .LP
86 This adds a client for the loopback address. This is useful in testing
87 the 
88 server locally, for example with 
89 .BR radclient (1).
90 .IP
91 .nf
92 client 192.168.0.0/24 {
93        secret          = testing123-1
94        shortname       = private-network-1
95 }
96 .fi
97 .LP
98 This entry represents any client from the 192.168.0.0/24 network. 
99 .SH FILES
100 .I /etc/raddb/clients.conf
101
102 .I /etc/raddb/radiusd.conf
103 .SH "SEE ALSO"
104 .BR radiusd (8),
105 .BR radiusd.conf (5),
106 .BR clients (5),
107 .BR naslist (5)
108
109 .SH AUTHOR
110 This manual page was authored by Shawn K. O'Shea <shawn@eth0.net>.
111
112 FreeRADIUS is authored by the FreeRADIUS team. 
113 http://freeradius.org/