Prev: Next: , Up: Top[Contents][Index]


10 poundctl

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. For this to work, pound configuration file must contain a Control statement (see Control statement). When started, poundctl opens the default pound.cfg file, looks up for this statement and then uses the pathname defined in it as the control socket file.

This behavior can be altered in two ways. First, if the configuration file is in a non-standard location, the pathname of this file can be given to the program using the -f command line option. Secondly, the socket name can be supplied in the command line explicitly, using the -s option.

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:

listener

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.

service

Symbolic name or ordinal number of the service located in that listener.

backend

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

Prev: Next: , Up: Top[Contents][Index]