man/man8/vmpsd.8

   1 .TH VMPSD 8 "23 June 2004" "" "FreeRADIUS VMPS Daemon"
   2 .SH NAME
   3 vmpsd - VLAN Membership Policy Server for Cisco Switches
   4 .SH SYNOPSIS
   5 .B radiusd
   6 .RB [ \-d
   7 .IR config_directory ]
   8 .RB [ \-f ]
   9 .RB [ \-i
  10 .IR ip-address ]
  11 .RB [ \-l
  12 .IR log_directory ]
  13 .RB [ \-g
  14 .IR facility ]
  15 .RB [ \-p
  16 .IR port ]
  17 .RB [ \-s ]
  18 .RB [ \-v ]
  19 .RB [ \-x ]
  20 .RB [ \-X ]
  21 .SH DESCRIPTION
  22 VMPSd is a high-performance and highly configurable VMPS server based
  23 on the existing FreeRADIUS framework.
  24
  25 .SH BACKGROUND
  26 \fVMPS\fP is used to dynamically update the configuration of ports on
  27 a switch.  When a new device connects to a port, the switch sends a
  28 VMPS query to the server, informing the server of the new devices MAC
  29 address.  The server then responds with the VLAN to which the device
  30 should be assigned.
  31
  32 .SH OPTIONS
  33
  34 .IP "\-l \fIlogging directory\fP"
  35 This defaults to \fI/var/log\fP. \fBvmpsd\fP writes a logfile here
  36 called \fIvmpsd.log\fP. It contains informational and error messages,
  37 and optionally a record of every login attempt (for aiding an ISP's
  38 helpdesk). The special arguments \fIstdout\fP and \fIstderr\fP cause
  39 the information to get written to the standard output, or standard
  40 error instead. The special argument \fIsyslog\fP sends the information
  41 with \fBsyslog\fP(3).
  42
  43 This command line option is deprecated.  See the \fIlog_dir\fP
  44 configuration item in the \fIvmpsd.conf\fP file.
  45
  46 .IP "\-g \fIfacility\fP"
  47 Specifies the syslog facility to be used with \fB-l syslog\fP. Default is
  48 \fIdaemon\fP. Another reasonable choice would be \fIauthpriv\fP.
  49
  50 .IP "\-d \fIconfig directory\fP"
  51 Defaults to \fI/etc/raddb\fP. \fBvmpsd\fP looks here for its configuration
  52 files such as the \fIdictionary\fP and the \fIvmpsd.conf\fP files.
  53
  54 .IP "\-i \fIip-address\fP"
  55 Defines which IP address that the server uses for sending and
  56 receiving packets.
  57
  58 If this command-line option is given, then the "bind_address" and all
  59 "listen{}" entries in \fIvmpsd.conf\fP are ignored.
  60
  61 .IP \-f
  62 Do not fork, stay running as a foreground process.
  63
  64 .IP "\-p \fIport\fP"
  65 Normally vmpsd listens on the ports specified in the configuration
  66 file. When this option is given, it listens on the specified port
  67 for vmps requests.
  68
  69 If this command-line option is given, then the "port" directive in
  70 \fIvmpsd.conf\fP is ignored.
  71
  72 .IP \-s
  73 Run in "single server" mode.  The server normally runs with multiple
  74 threads and/or processes, which can lower its response time to
  75 requests.  Some systems have issues with threading, however, so
  76 running in "single server" mode may help to address those issues.  In
  77 single server mode, the server will also not "daemonize"
  78 (auto-background) itself.
  79
  80 .IP \-v
  81 Print server version information and exit.
  82
  83 .IP \-X
  84 Debugging mode.  Equivalent to -sfxx.
  85
  86 .IP \-x
  87 Finer-grained debug mode. In this mode the server will print details
  88 of every request on it's \fBstdout\fP output. You can specify this
  89 option multiple times (-x -x or -xx) to get more detailed output.
  90
  91 .SH CONFIGURATION
  92 \fBvmpsd\fP uses a number of configuration files. Each file has it's
  93 own manpage describing the format of the file. These files are:
  94 .IP vmpsd.conf
  95 The main configuration file, which sets the administrator-controlled
  96 items.
  97 .SH SEE ALSO
  98 vmpsd.conf(5)
  99 .SH AUTHOR
 100 The FreeRADIUS Server Project (http://www.freeradius.org)