Gecko [ www.thearyasamaj.org ]

Name	Size	Permission
ftpasswd.html	14.61 KB	-rw-r--r--
ftpmail.html	8 KB	-rw-r--r--
ftpquota.html	10.9 KB	-rw-r--r--
index.html	9.04 KB	-rw-r--r--
mod_auth_otp.html	16.5 KB	-rw-r--r--
mod_ban.html	22.53 KB	-rw-r--r--
mod_copy.html	4.85 KB	-rw-r--r--
mod_ctrls_admin.html	15.05 KB	-rw-r--r--
mod_deflate.html	6.89 KB	-rw-r--r--
mod_digest.html	12.92 KB	-rw-r--r--
mod_dnsbl.html	6.1 KB	-rw-r--r--
mod_dynmasq.html	3.26 KB	-rw-r--r--
mod_exec.html	23.89 KB	-rw-r--r--
mod_geoip.html	17.06 KB	-rw-r--r--
mod_ifsession.html	11.02 KB	-rw-r--r--
mod_ifversion.html	4.96 KB	-rw-r--r--
mod_ldap.html	32.32 KB	-rw-r--r--
mod_load.html	2.97 KB	-rw-r--r--
mod_log_forensic.html	9.78 KB	-rw-r--r--
mod_qos.html	2.62 KB	-rw-r--r--
mod_quotatab.html	25.02 KB	-rw-r--r--
mod_quotatab_file.html	2.23 KB	-rw-r--r--
mod_quotatab_ldap.html	2.63 KB	-rw-r--r--
mod_quotatab_radius.html	2.08 KB	-rw-r--r--
mod_quotatab_sql.html	10.93 KB	-rw-r--r--
mod_radius.html	22.11 KB	-rw-r--r--
mod_ratio.html	6.99 KB	-rw-r--r--
mod_readme.html	2.69 KB	-rw-r--r--
mod_rewrite.html	30.06 KB	-rw-r--r--
mod_sftp.html	93.71 KB	-rw-r--r--
mod_sftp_pam.html	5.47 KB	-rw-r--r--
mod_sftp_sql.html	5.63 KB	-rw-r--r--
mod_shaper.html	23.28 KB	-rw-r--r--
mod_site_misc.html	5.81 KB	-rw-r--r--
mod_snmp.html	42.38 KB	-rw-r--r--
mod_sql.html	62.81 KB	-rw-r--r--
mod_sql_odbc.html	10.2 KB	-rw-r--r--
mod_sql_passwd.html	24.44 KB	-rw-r--r--
mod_sql_sqlite.html	2.95 KB	-rw-r--r--
mod_statcache.html	8.29 KB	-rw-r--r--
mod_tls.html	85.34 KB	-rw-r--r--
mod_tls_fscache.html	2.73 KB	-rw-r--r--
mod_tls_memcache.html	3.91 KB	-rw-r--r--
mod_tls_redis.html	3.6 KB	-rw-r--r--
mod_tls_shmcache.html	6.78 KB	-rw-r--r--
mod_unique_id.html	3.54 KB	-rw-r--r--
mod_wrap.html	12.38 KB	-rw-r--r--
mod_wrap2.html	24.83 KB	-rw-r--r--
mod_wrap2_file.html	4.69 KB	-rw-r--r--
mod_wrap2_redis.html	5.33 KB	-rw-r--r--
mod_wrap2_sql.html	8.33 KB	-rw-r--r--

Code Editor : mod_ctrls_admin.html

<!DOCTYPE html>
<html>
<head>
<title>ProFTPD module mod_ctrls_admin</title>
</head>

<hr>
<center>
<h2>ProFTPD module <code>mod_ctrls_admin</code></h2>
</center>
<hr>

This module is contained in the <code>mod_ctrls_admin.c</code> file for
ProFTPD /1.3.x, and is not compiled by default. Installation
instructions are discussed <a href="#Installation">here</a>.

This module implements administrative control actions for the
<code>ftpdctl</code> program.

The most current version of <code>mod_ctrls_admin</code> is distributed with
the ProFTPD source.

<h2>Author</h2>

Please contact TJ Saunders &lt;tj at castaglia.org&gt; with any
questions, concerns, or suggestions regarding this module.

<h2>Directives</h2>
<ul>
 <li><a href="#AdminControlsACLs">AdminControlsACLs</a>
 <li><a href="#AdminControlsEngine">AdminControlsEngine</a>
</ul>

<h2>Control Actions</h2>
<ul>
 <li><a href="#config"><code>config</code></a>
 <li><a href="#debug"><code>debug</code></a>
 <li><a href="#dns"><code>dns</code></a>
 <li><a href="#down"><code>down</code></a>
 <li><a href="#get"><code>get</code></a>
 <li><a href="#kick"><code>kick</code></a>
 <li><a href="#restart"><code>restart</code></a>
 <li><a href="#scoreboard"><code>scoreboard</code></a>
 <li><a href="#shutdown"><code>shutdown</code></a>
 <li><a href="#status"><code>status</code></a>
 <li><a href="#trace"><code>trace</code></a>
 <li><a href="#up"><code>up</code></a>
</ul>

<hr>
<h1>Directives</h1>

<hr>
<h3><a name="AdminControlsACLs">AdminControlsACLs</a></h3>
Syntax: AdminControlsACLs actions|all allow|deny user|group list 
Default: None 
Context: server config 
Module: mod_ctrls_admin 
Compatibility: 1.2.10rc1 and later

The <code>AdminControlsACLs</code> directive configures access lists of
users or groups who are allowed (or denied) the ability to
use the actions implemented by <code>mod_ctrls_admin</code>. The
default behavior is to deny everyone unless an ACL allowing access has been
explicitly configured.

If &quot;allow&quot; is used, then list, a comma-delimited list
of users or groups, can use the given actions; all
others are denied. If &quot;deny&quot; is used, then the list of
users or groups cannot use actions all others are
allowed. Multiple <code>AdminControlsACLs</code> directives may be used to
configure ACLs for different control actions, and for both users and groups.

<hr>
<h3><a name="AdminControlsEngine">AdminControlsEngine</a></h3>
Syntax: AdminControlsEngine on|off|actions 
Default: None 
Context: server config 
Module: mod_ctrls_admin 
Compatibility: 1.2.10rc1 and later

The <code>AdminControlsEngine</code>directive enables or disables the
<code>mod_ctrls_admin</code> module, and thus the handling of its
implemented control actions.

If only certain of the module's control actions are wanted, provide a list
of those actions, rather than the normal &quot;on&quot; or
&quot;off&quot;. Any of <code>mod_ctrls_admin</code>'s control actions that
do not appear in actions will be unregistered; by default, all of
the module's control actions are registered.

<hr>
<h1>Control Actions</h1>

<hr>
<h3><a name="config"><code>config</code></a></h3>
Syntax: ftpdctl config set|remove ip-address|dns-name[:port] directive ... 
Purpose: Update configuration of a virtual server

The <code>config</code> control action can be used to update the configuration
of an individual virtual server, without requiring a <code>SIGHUP</code>
to restart the daemin and reparse the configuration. The <code>config</code>
action supports two subcommands: "set" and "remove".

Both <code>config</code> subcommands take the address of the virtual server
whose configuration is to be changed. This can be specified as a DNS name
or an IP address, and optionally the port number. If no port number is
explicitly provided, a default of port 21 is assumed. IPv6 addresses are
supported. Examples:
<pre>
 $ ftpdctl config set 10.1.2.3 ...
 $ ftpdctl config set ftp.example.com:2121 ...
 $ ftpdctl config set '[::1]:4242' ...
</pre>
Note that using the IPv6 syntax may require that you enclose the
address in single quotes, to prevent the shell from parsing those characters.

When setting a configuration directive, all of the parameters of that
configuration directive are required, just as if you were typing that
configuration directive in the config file:
<pre>
 $ ftpdctl config set 192.168.0.101:2121 TLSRequired off
 ftpdctl: config set: TLSRequired configured
</pre>

When removing a configuration directive, only the configuration directive
name is needed:
<pre>
 $ ftpdctl config remove 192.168.0.101 TLSRequired
 ftpdctl: config remove: TLSRequired removed
</pre>

<hr>
<h3><a name="debug"><code>debug</code></a></h3>
Syntax: ftpdctl debug [level [number]]|memory|config 
Purpose: Obtain debug information from the running daemon

Obtaining debug output from the server greatly helps in diagnosing problems.
The trick is in getting this debug output from the server. The
<code>debug</code> control action can be used to gather such information.

First, this control action can increase or query the debug logging verbosity
of the daemon on-the-fly, to obtain the needed output, and then to return the
daemon to a more silent state of logging.

Example:
<pre>
 $ ftpdctl debug level 9
</pre>
raises the verbosity of the daemon to its maximum level. Once enough output
has been collected, use:
<pre>
 $ ftpdctl debug level 0
</pre>
to return the daemon to its default debug output level.

Instead, to simply check the current debug logging verbosity, use:
<pre>
 $ ftpdctl debug level
</pre>

Alternatively, for developers (i.e. if <code>proftpd</code> was
compiled with the <code>--enable-devel</code> configure option), this control
action can be used to display the current memory allocation of the daemon:
<pre>
 $ ftpdctl debug memory
</pre>
Memory allocations for session processes are currently not available via
this control action.

<hr>
<h3><a name="dns"><code>dns</code></a></h3>
Syntax: ftpdctl dns on|off 
Purpose: DNS configuration

The <code>dns</code> control action can be used to enable or disable
the <code>UseReverseDNS</code> configuration at run time:
<pre>
 # Enable resolution of IP addresses to DNS names
 $ ftpdctl dns on

# Disable resolution of IP addresses to DNS names
 $ ftpdctl dns off
</pre>

Note that the <code>dns</code> control action also supports a command for
clearing any cached DNS lookup information:
<pre>
 $ ftpdctl dns clear cache
</pre>

<hr>
<h3><a name="down"><code>down</code></a></h3>
Syntax: ftpdctl down ip-address|dns-name[#port]|&quot;all&quot; 
Purpose: Turn down a virtual server

The <code>down</code> control action can be used to &quot;turn down&quot;
an individual virtual server, so that clients cannot connect to it. Once
a virtual server has been &quot;downed&quot;, the
&quot;<a href="#up">up</a>&quot; control action can be used to bring
that virtual server back up.

If a port number is not specified, it defaults to 21.

Note that using &quot;down all&quot; effectively puts the daemon in an
&quot;administrative&quot; shutdown state, where the daemon is still running
but no servers are available for servicing incoming connection requests.
Current sessions are not affected.

<hr>
<h3><a name="get"><code>get</code></a></h3>
Syntax: ftpdctl get &quot;config&quot;|&quot;directives&quot; 
Purpose: Obtain configuration information

The <code>get</code> control action can be used obtain various sorts of
configuration information from the daemon. At present, this control action
only supports the &quot;config&quot; and &quot;directives&quot; parameters.

The &quot;config&quot; parameter causes <code>ftpdctl</code> to display
a configuration dump, similar to what is displayed by a syntax check
(i.e. using the <code>-t</code> proftpd command-line option).

The &quot;directives&quot; parameter causes <code>ftpdctl</code> to display a
sorted list of all supported configuration directives, as well as the module
which handles the corresponding directive.

<hr>
<h3><a name="kick"><code>kick</code></a></h3>
Syntax: ftpdctl kick [class name]|[host dns-name|ip-address][user name] 
Purpose: Kick a currently connected class, host or user from the daemon

The <code>kick</code> control action can be used to disconnect a currently
connected class, host or user from the daemon.

Examples:
<pre>
 $ ftpdctl kick user bob dave 
</pre>
will kick all sessions that have logged in as user &quot;bob&quot; or user &quot;dave&quot;.
<pre>
 $ ftpdctl kick host luser.host.net
</pre>
will kick all sessions that have connected from host &quot;luser.host.net&quot;.
<pre>
 $ ftpdctl kick class eval intranet
</pre>
will kick all sessions that belong to classes &quot;eval&quot; and &quot;intranet&quot;.

You can also use the <code>-n &lt;count&gt;</code> command-line option to
specify the maximum number of clients to be kicked. For example, perhaps
you only want to kick off 10 clients from host &quot;luser.host.net&quot;
rather than kicking all of them off. To do this, use:
<pre>
 $ ftpdctl kick host -n 10 luser.host.net
</pre>

<hr>
<h3><a name="restart"><code>restart</code></a></h3>
Syntax: ftpdctl restart 
Purpose: Restart the daemon

The <code>restart</code> control action causes the daemon to re-read its
configuration file, just as if a <code>SIGHUP</code> had been used. This is
convenient for administrators, as it does not (necessarily) require root
privileges, nor knowledge of the daemon's PID, to restart the daemon.

Example:
<pre>
 $ ftpdctl restart
</pre>
In addition, you can use the <code>restart</code> control to ask the daemon
how many times it has been restarted:
<pre>
 $ ftpdctl restart count
 ftpdctl: restarted 4 times since 2010-01-06 23:20:09 GMT
</pre>

<hr>
<h3><a name="scoreboard"><code>scoreboard</code></a></h3>
Syntax: ftpdctl scoreboard scrub 
Purpose: Scrubs the ScoreboardFile for dead processes

The <code>scoreboard</code> control action can be used to force the
<code>ScoreboardFile</code> to be &quot;scrubbed&quot; for dead session
processes which may not have exited cleanly.
<pre>
 $ ftpdctl scoreboard scrub

# The verb "clean" is synonymous with "scrub"
 $ ftpdctl scoreboard clean
</pre>

<hr>
<h3><a name="shutdown"><code>shutdown</code></a></h3>
Syntax: ftpdctl shutdown [&quot;graceful&quot; seconds] 
Purpose: Stop the daemon

The <code>shutdown</code> control action shuts the daemon down. This is
convenient for administrators, as it does not (necessarily) require root
privileges, nor knowledge of the daemon's PID, to stop the daemon.

The optional &quot;graceful&quot; parameter allows for a graceful shutdown,
in which <code>proftpd</code> will wait for the given number of seconds
for all current sessions to end, before shutting down.

Example:
<pre>
 $ ftpdctl shutdown graceful 30
</pre>
will cause <code>proftpd</code> to wait for 30 seconds for all current
sessions to end before shutting down completely.

<hr>
<h3><a name="status"><code>status</code></a></h3>
Syntax: ftpdctl status ip-address|dns-name[#port]|&quot;all&quot; 
Purpose: Display the status of virtual servers

The <code>status</code> control action can be used to show the status of
a particular virtual server, whether it is up or down.

If a port number is not specified, it defaults to 21.

If &quot;status all&quot; is used, the status of all virtual servers will be
displayed.

<hr>
<h3><a name="trace"><code>trace</code></a></h3>
Syntax: ftpdctl trace channel:level|&quot;info&quot; 
Purpose: Configure trace channel log levels

The <code>trace</code> control action can be used to dynamically change
the log levels of trace log levels.

Example:
<pre>
 $ ftpdctl trace delay:10
</pre>
will set the log verbosity level of the delay trace log channel to 10.

Additionally, the <code>trace</code> control action can be used to display
the list of current trace channels and their log levels, e.g.:
<pre>
 $ ftpdctl trace info
 ftpdctl: Channel Level 
 ftpdctl: ---------- ------
 ftpdctl: pam 10 
 ftpdctl: netacl 10 
 ftpdctl: response 10 
 ftpdctl: auth 10 
 ftpdctl: utf8 10 
 ftpdctl: inet 10 
 ftpdctl: binding 10 
 ftpdctl: dns 10 
 ftpdctl: dso 10 
 ftpdctl: parser 10 
 ftpdctl: pool 10 
 ftpdctl: ctrls 10 
 ftpdctl: data 10 
 ftpdctl: netio 10 
 ftpdctl: config 10 
 ftpdctl: ident 10 
 ftpdctl: command 10 
 ftpdctl: delay 10 
 ftpdctl: timer 10 
 ftpdctl: var 10 
 ftpdctl: event 10 
 ftpdctl: fsio 10 
 ftpdctl: site 10 
</pre>

<hr>
<h3><a name="up"><code>up</code></a></h3>
Syntax: ftpdctl up ip-address|dns-name[#port] 
Purpose: Turn up a &quot;downed&quot; virtual server

The <code>up</code> control action can be used to &quot;turn up&quot;
any virtual server that has been &quot;downed&quot; by the
&quot;<a href="#down">down</a>&quot; control action. Note that using the
&quot;<a href="#restart">restart</a>&quot; control action is sufficient to
enable, with one command, all virtual servers that have been downed.

If a port number is not specified, it defaults to 21.

<hr>
<h2><a name="Installation">Installation</a></h2>
This module requires that controls support be enabled in <code>proftpd</code>
via the <code>--enable-ctrls</code> configure option. Follow the normal
steps for using third-party modules in ProFTPD:
<pre>
 $ ./configure --enable-ctrls --with-modules=mod_ctrls_admin
</pre>
To build <code>mod_ctrls_admin</code> as a DSO module:
<pre>
 $ ./configure --enable-ctrls --enable-dso --with-shared=mod_ctrls_admin
</pre>
Then follow the usual steps:
<pre>
 $ make
 $ make install
</pre>

For those with an existing ProFTPD installation, you can use the
<code>prxs</code> tool to add <code>mod_ctrls_admin</code>, as a DSO module, to
your existing server:
<pre>
 $ prxs -c -i -d mod_ctrls_admin.c
</pre>

</body>
</html>

${this.title}

Code Editor : mod_ctrls_admin.html