zorpctl(8) [debian man page]
ZORPCTL(8) [FIXME: manual] ZORPCTL(8) NAME
zorpctl_ - Start and stop zorp instances. SYNOPSIS
zorpctl command [options [instances/@instance-list-file]] DESCRIPTION
zorpctl starts and stops zorp(8) instances based on the contents of the instances.conf(5) file. Multiple instance names can be specified in the command-line or in a file to start or stop several instances. If an error occurs while stopping or starting an instance, an exclamation mark is appended to the instance name as zorpctl processes the request, and a summary is printed when the program exits. If no instance is specified, the command is executed on all instances. The instances to be controlled can be specified in a file instead of listing them in the command line, e.g.: zorpctl command options instances.txt. The instances.txt should contain every instance name in a new line. COMMANDS
start Starts the specified Zorp instance(s). force-start Starts the specified Zorp instance(s) even if they are disabled. stop Stops the specified Zorp instance(s). force-stop Forces the specified Zorp instance(s) to stop using the KILL signal. restart Restart the specified Zorp instance(s). force-restart Forces the specified Zorp instance(s) to restart by stopping them using the KILL signal. reload Reload the specified Zorp instance(s). status Display the status of the specified Zorp instance(s). --verbose or -v Display detailed status information. gui-status Display the status of the specified Zorp instance(s) in an internal format easily parsable by ZMC. NOTE: This command is mainly used internally within Zorp, and the structure of its output may change. version Display version information on Zorp. inclog Raise the verbosity (log) level of the specified Zorp instance(s) by one. declog Decrease the verbosity (log) level of the specified Zorp instance(s) by one. log Change various log related settings in the specified Zorp instance(s) using the following options: --vinc or -i Increase verbosity level by one. --vdec or -d Decrease verbosity level by one. --vset <verbosity> or -s <verbosity> Set verbosity level to <verbosity>. --log-spec <spec> or -S <spec> Set verbosity mask on a per category basis. The format of this value is described in zorp(8). --help or -h Display this help screen on the options of the log command. szig Display internal information from the specified Zorp instance(s). The information to be disblayed can be specified with the following options: --walk or -w Walk the specified tree. --root [node] or -r [node] Set the root node of the walk operation to [node]. --help or -h Display a brief help on the options of the szig command. help Display a brief help message. EXAMPLES
zorpctl start zorp_ftp The command above starts the zorp instance named zorp-ftp with parameters described in the instances.conf file. FILES
The default location for instances.conf is /etc/zorp/instances.conf. AUTHOR
This manual page was written by the BalaBit Documentation Team <documentation@balabit.com>. COPYRIGHT
Copyright (C) 2006 BalaBit IT Security Ltd. All rights reserved. For more information about the legal status of this document please read: http://www.balabit.com/products/zorp/docs/legal_notice.bbq [FIXME: source] 03/06/2012 ZORPCTL(8)
Check Out this Related Man Page
ZORP(8) [FIXME: manual] ZORP(8) NAME
zorp_ - Zorp Firewall Suite SYNOPSIS
zorp [options] DESCRIPTION
The zorp command is the main entry point for a Zorp instance, and as such it is generally called by zorpctl(8) with command line parameters specified in instances.conf(5). OPTIONS
--version or -V Display version number and compilation information. --as <name> or -a <name> Set instance name to <name>. Instance names may consist of the characters [a-zA-Z0-9_] and must begin with a letter. Log messages of this instance are prefixed with this name. --also-as <name> or -A <name> Add a secondary instance named <name>. Secondary instances share the same Zorp process but they have a separate section in the configuration file. --policy <name> or -p <name> Use the file called <name> as policy. This file must be a valid policy file. --verbose <verbosity> or -v <verbosity> Set verbosity level to <verbosity>, or if <verbosity> is omitted increment it by one. Default the verbosity level is 3; possible values are 0-10. --pidfile <pidfile> or -P <pidfile> Set path to the PID file where the pid of the main process is stored. --foreground or -F Do not daemonize, run in the foreground. --process-mode <mode> Set processing mode to one of background, safe-background or foreground. --no-syslog or -l Send log messages to the standard output instead of syslog. --log-tags or -T Prepend log category and log level to each message. --log-escape Escape non-printable characters to avoid binary log files. Each character less than 0x20 and greater than 0x7F are escaped in the form <XX>. --log-spec <spec> or -s <spec> Set verbosity mask on a per category basis. Each log message has an assigned multi-level category, where levels are separated by a dot. For example, HTTP requests are logged under http.request. <spec> is a comma separated list of log specifications. A single log specification consists of a wildcard matching log category, a colon, and a number specifying the verbosity level of that given category. Categories match from left to right. E.g.: --logspec 'http.*:5,core:3'. The last matching entry will be used as the verbosity of the given category. If no match is found the default verbosity specified with --verbose is used. --threads <num> or -t <num> Set the maximum number of threads that can be used in parallel by this Zorp instance. --idle-threads <num> or -I Set the maximum number of idle threads; this option has effect only if threadpools are enabled (see the option --threadpools). --threadpools or -O Enable the use of threadpools, which means that threads associated with sessions are not automatically freed, only if the maximum number of idle threads is exceeded. --user <user> or -u <user> Switch to the supplied user after starting up. --group <group> or -g <group> Switch to the supplied group after starting up. --chroot <dir> or -R <dir> Change root to the specified directory before reading the configuration file. The directory must be set up accordingly. --caps <caps> or -C <caps> Switch to the supplied set of capabilities after starting up. This should contain the required capabilities in the permitted set. For the syntax of capability description see the man page cap_from_text(3). --no-caps or -N Do not change capabilities at all. --crypto-engine <engine> or -E <engine> Set the OpenSSL crypto engine to be used for hardware accelerated crypto support. --stack-size <size> or -S <size> Set the maximum stack size used by threads. Note that the maximum number of parallel threads is influenced by the size specified here. The default stack size is 512 KB, the maximum you can set is 8192 KB. FILES
/etc/zorp/ /etc/zorp/policy.py /etc/zorp/instances.conf AUTHOR
This manual page was written by the BalaBit Documentation Team <documentation@balabit.com>. COPYRIGHT
Copyright (C) 2006 BalaBit IT Security Ltd. All rights reserved. For more information about the legal status of this document please read: http://www.balabit.com/products/zorp/docs/legal_notice.bbq [FIXME: source] 03/06/2012 ZORP(8)