From: Alan T. DeKok Date: Fri, 25 Dec 2020 15:12:28 +0000 (-0500) Subject: update to be correct X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c90f3334ed7fe9759a0a495492952ee7eb6ed076;p=thirdparty%2Ffreeradius-server.git update to be correct --- diff --git a/doc/antora/modules/reference/pages/man/radmin.adoc b/doc/antora/modules/reference/pages/man/radmin.adoc index 14fb20c34e1..b196bf52006 100644 --- a/doc/antora/modules/reference/pages/man/radmin.adoc +++ b/doc/antora/modules/reference/pages/man/radmin.adoc @@ -22,10 +22,13 @@ _name_] [*-q*] FreeRADIUS Server administration tool that connects to the control socket of a running server, and gives a command-line interface to it. -At this time, only a few commands are supported. Please type "help" at +At this time, only a few commands are supported. Please type `help` at the command prompt for detailed information about the supported commands. +The `radmin` command supports full tab completion, inline help via `?` +and `help`, and command history. + == WARNING The security protections offered by this command are limited to the @@ -37,20 +40,37 @@ amount of control over the server. The following command-line options are accepted by the program. -* Defaults to _/etc/raddb_. *radmin* looks here for the server -configuration files to find the "listen" section that defines the -control socket filename. -* Run _command_ and exit. -* Echo commands as they are being executed. -* Specify the socket filename directly. The radiusd.conf file is not -read. -* Print usage help information. -* Reads input from the specified file. If not specified, stdin is used. -This also sets "-q". -* Writes the commands which are executed to this log file. This -functionality is off by default. -* Read _raddb/name.conf_ instead of _raddb/radiusd.conf_. -* Quiet mode. +*-d config_directory*:: + Defaults to _/etc/raddb_. *radmin* looks here for the server + configuration files to find the "listen" section that defines the + control socket filename. + +*-e command*:: + Run _command_ and exit. + +*-E*:: + Echo commands as they are being executed. + +*-f socket_file*:: + Specify the socket filename directly. The radiusd.conf file is not + read. + +*-h*:: + Print usage help information. + +*-i input_file*:: + Reads input from the specified file. If this option is not + specified, `stdin` is used. This also sets `-q`. + +*-l log_file*:: + Writes the commands which are executed to this log file. This + functionality is off by default. + +*-n name*:: + Read `raddb/name.conf` instead of `raddb/radiusd.conf`. + +*-q*:: + Quiet mode. == COMMANDS @@ -58,83 +78,49 @@ The commands implemented by the command-line interface are almost completely controlled by the server. There are a few commands interpreted locally by radmin: -* Reconnect to the server. -* Exit from radmin. -* Exit from radmin. +*exit*:: + Exit from radmin. + +*quit*:: + Exit from radmin. + +*reconnect*:: + Reconnect to the server. -The other commands are implemented by the server. Type "help" at the + +The other commands are implemented by the server. Type `help` at the prompt for more information. == EXAMPLES -* Set debug logs to /var/log/radius/bob.log. There is very little -checking of this filename. Rogue administrators may be able use this -command to over-write almost any file on the system. If those -administrators have write access to "radius.conf", they can do the same -thing without radmin, too. -* Enable debugging output for all requests that match the condition. Any -"unlang" condition is valid here. The condition is parsed as a string, -so it must be enclosed in single or double quotes. Strings enclosed in -double-quotes must have back-slashes and the quotation marks escaped -inside of the string. - +*debug file /var/log/radius/bob.log*:: + + Set debug logs to `/var/log/radius/bob.log`. There is very little + checking of this filename. Rogue administrators may be able use this + command to over-write almost any file on the system. However, if + the rogue administrators have write access to the main `radius.conf` + file, then they can do the same thing without `radmin`, too. + +*debug condition '(User-Name == "bob")'*:: + Enable debugging output for all requests that match the condition. Any + `unlang` condition is valid here. The condition is parsed as a string, + so it must be enclosed in single or double quotes. Strings enclosed in + double-quotes must have back-slashes and the quotation marks escaped + inside of the string. ++ Only one debug condition can be active at a time. -* A more complex condition that enables debugging output for requests -containing User-Name "bob", or requests that originate from source IP -address 192.0.2.22. +*debug condition '((User-Name == ""bob"") || (Packet-Src-IP-Address == 192.0.2.22))'*:: + A more complex condition that enables debugging output for requests + containing User-Name "bob", or requests that originate from source IP + address 192.0.2.22. + +*debug condition*:: * Disable debug conditionals. == FULL LIST OF COMMANDS -* do sub-command of add -* Add client configuration commands -* Add new client definition from -* debugging commands -* Enable debugging for requests matching [condition] -* Set debug level to . Higher is more debugging. -* Send all debugging output to [filename] -* do sub-command of del -* Delete client configuration commands -* Delete a dynamically created client -* sends a HUP signal to the server, or optionally to one module -* commands to inject packets into a running server -* Inject packets to the destination IP and port. -* Inject packets as if they came from -* Inject packet from input-file>, with results sent to -* reconnect to a running server -* terminates the server, and cause it to exit -* do sub-command of set -* set module commands -* set configuration for -* set the module to be alive or dead (always return "fail") -* set home server commands -* set state for given home server -* do sub-command of show -* do sub-command of client -* show configuration for given client -* shows list of global clients -* show debug properties -* Shows current debugging condition. -* Shows current debugging level. -* Shows current debugging file. -* do sub-command of home_server -* show configuration for given home server -* shows list of home servers -* shows state of given home server -* do sub-command of module -* show configuration for given module -* show other module properties -* shows list of loaded modules -* show sections where may be used -* shows time at which server started -* Prints version of the running server -* Prints out configuration as XML -* do sub-command of stats -* show statistics for given client, or for all clients (auth or acct) -* show statistics for given home server (ipaddr and port), or for all -home servers (auth or acct) -* show statistics for the given detail file +Connect to the server and type `help` for a full list of commands. == SEE ALSO