The poundctl command displays status of various objects of
the running instance and allows you to change some of them.
The program communicates with the running pound daemon via
a UNIX socket or remotely, via HTTP or HTTPS. The URL of the
communication socket can be given explicitly by the -s
command line option, or obtained from poundctl or
pound configuration files.
If the .poundctl exists in the home directory, the
configuration will be obtained from it. Otherwise, if
poundctl runs on the same machine as the pound
daemon and communicates with it via the UNIX socket, the program will
scan the pound.cfg file for the Control statement
(see Control statement) and read the socket file name from it.
These ways of configuring poundctl are discussed below,
in Configuring poundctl. In examples below, it is assumed that the
socket URL is obtained from one of configuration files.
The program invocation syntax is:
poundctl [options] command object [arg]
Here, options are command line options, command is a
command verb that instructs poundctl what to do,
object identifies the pound object to operate upon
(see objects), and optional arg supplies argument to the
command verb.
Pound objects identifiers are formed in a path-like fashion:
/listener/service/backend
where:
Symbolic name of the listener or its ordinal number in the configuration. If referring to a globally-defined service, or to a backend in such a service, a dash is used.
Symbolic name or ordinal number of the service located in that listener.
Ordinal number of backend in the service.
Depending on the command, either ‘/backend’ or both ‘/service/backend’ may be omitted.
For example, the following command will disable backend 2 in service 1 of listener 0:
poundctl disable /0/1/2
Assuming listener 0 is named ‘web’, this example can also be written as:
poundctl disable /web/1/2
The following command disables the listener 0 itself:
poundctl disable /0
A dash in place of listener refers to the global scope. Thus, the following disables service 1 defined in the global scope of pound.cfg:
poundctl disable /-/1