~ubuntu-branches/ubuntu/natty/freeradius/natty-updates

« back to all changes in this revision

Viewing changes to man/man1/radclient.1

  • Committer: Bazaar Package Importer
  • Author(s): Paul Hampson
  • Date: 2006-01-15 13:34:13 UTC
  • mto: (3.1.3 dapper) (4.1.3 sid) (1.1.14 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20060115133413-zo1dslttvdoalqym
Tags: upstream-1.1.0
ImportĀ upstreamĀ versionĀ 1.1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH RADCLIENT 1 "22 June 2004" "" "FreeRADIUS Daemon"
 
1
.TH RADCLIENT 1 "7 April 2005" "" "FreeRADIUS Daemon"
2
2
.SH NAME
3
3
radclient - send packets to a RADIUS server, show reply
4
4
.SH SYNOPSIS
11
11
.IR file ]
12
12
.RB [ \-i
13
13
.IR id ]
 
14
.RB [ \-n
 
15
.IR num_requests_per_second ]
 
16
.RB [ \-p
 
17
.IR num_requests_in_parallel ]
14
18
.RB [ \-r
15
19
.IR num_retries ]
16
20
.RB [ \-s ]
31
35
these attribute/value pairs using the dictionary, and sends them
32
36
to the remote server.
33
37
.PP
34
 
The \fIUser-Password\fP attribute is automatically encrypted by \fIradclient\fP.
 
38
The \fIUser-Password\fP and \fICHAP-Password\fP attributes are
 
39
automatically encrypted before the packet is sent to the server.
35
40
 
36
41
.SH OPTIONS
37
42
 
38
43
.IP \-c\ \fIcount\fP
39
44
Send each packet \fIcount\fP times.
40
 
\fI/etc/raddb\fP.
41
 
 
42
45
.IP \-d\ \fIraddb_directory\fP
43
46
The directory that contains the RADIUS dictionary files. Defaults to
44
47
\fI/etc/raddb\fP.
45
 
 
46
48
.IP \-f\ \fIfile\fP
47
49
File to read the attribute/value pairs from. If this is not specified,
48
 
they are read from stdin.
49
 
 
 
50
they are read from stdin.  This option can be specified multiple
 
51
times, in which case packets are sent in order by file, and within
 
52
each file, by first packet to last packet.  A blank line separates
 
53
logical packets within a file.
50
54
.IP \-i\ \fIid\fP
51
55
Use \fIid\fP as the RADIUS request Id.
52
 
 
 
56
.IP \-n\ \fInum_requests_per_second\fP
 
57
Send \fInum_requests_per_second\fP, evenly spaced over time.  By
 
58
default, the requests are sent as fast as possible.  This option
 
59
allows you to slow down the rate at which radclient sends requests.
 
60
.IP \-p\ \fInum_requests_in_parallel\fP
 
61
Send \fInum_requests_in_parallel\fP, without waiting for a response
 
62
for each one.  By default, radclient sends the first request it has
 
63
read, waits for the response, and once the response is received, sends
 
64
the second request in its list.  This option allows you to send many
 
65
requests at simultaneously.  Once \fInum_requests_in_parallel\fP are
 
66
sent, radclient waits for all of the responses to arrive (or for the
 
67
requests to time out), before sending any more packets.
53
68
.IP \-q
54
69
Go to quiet mode, and do not print out anything.
55
 
 
56
70
.IP \-r\ \fInum_retries\fP
57
71
Try to send each packet \fInum_retries\fP times, before giving up on
58
72
it.  The default is 10.
59
 
 
60
 
.IP \-s\
 
73
.IP \-s
61
74
Print out some summaries of packets sent and received.
62
 
 
63
75
.IP \-S\ \fIshared_secret_file\fP
64
76
Rather than reading the shared secret from the command-line (where it
65
77
can be seen by others on the local system), read it instead from
66
78
\fIshared_secret_file\fP.
67
 
 
68
79
.IP \-t\ \fItimeout\fP
69
80
Wait \fItimeout\fP seconds before deciding that the NAS has not
70
81
responded to a request, and re-sending the packet.  The default
71
82
timeout is 3.
72
 
 
73
83
.IP \-v
74
84
Print out version information.
75
 
 
76
85
.IP \-x
77
 
Print out extra debugging information.
78
 
 
 
86
Print out debugging information.
79
87
.IP server[:port]
80
88
The hostname or IP address of the remote server. Optionally a UDP port
81
89
can be specified. If no UDP port is specified, it is looked up in
84
92
service is not found in \fI/etc/services\fP, 1813 and 1812 are used
85
93
respectively.
86
94
 
87
 
.IP acct\ |\ auth |\ status |\ disconnect
 
95
.IP acct\ |\ auth\ |\ status\ |\ disconnect
88
96
Use \fBauth\fP to send an authentication packet (Access-Request),
89
97
\fBacct\fP to send an accounting packet (Accounting-Request),
90
98
\fBstatus\fP to send an status packet (Status-Server), or
99
107
 
100
108
.SH EXAMPLE
101
109
 
102
 
A sample session that queries the remote server for \fIStatus-Server\fP
103
 
(not all servers support this.  Cistron-radiusd does since version
104
 
1.6.5):
 
110
A sample session that queries the remote server for
 
111
\fIStatus-Server\fP (not all servers support this, but FreeRADIUS has
 
112
configurable support for it).
105
113
.RS
106
114
.sp
107
115
.nf
108
116
.ne 3
109
 
 
110
117
$ echo "User-Name = fnord" | radclient 192.168.1.42 12 s3cr3t
111
118
Sending request to server 192.168.1.42, port 1812.
112
119
radrecv: Packet from host 192.168.1.42 code=2, id=140, length=54
113
120
    Reply-Message = "FreeRADIUS up 21 days, 02:05"
114
 
 
115
121
.fi
116
122
.sp
117
123
.RE
118
124
 
119
125
.SH SEE ALSO
120
126
radiusd(8),
121
 
radtest(1).
122
127
.SH AUTHORS
123
128
Miquel van Smoorenburg, miquels@cistron.nl.
124
129
Alan DeKok <aland@freeradius.org>