NAME

webctl - Zeus Web Server control tool


SYNOPSIS

webctl [ options ]


DESCRIPTION

webctl is used to start, stop and query web sites being served by virtual server configuration. These can be on one machine, or over a cluster of many machines. webctl is the officially supported way of managing web site configurations from a scriptable interface. There are currently six machine actions webctl can perform - start, stop, restart, sync, ask and list.


OPTIONS

webctl has a number of options, listed below:

--action=start|stop|restart|sync|ask|list

This option is mandatory, and specifies the action to be performed. start, stop and restart starts, stops or restarts one or more virtual servers. They should be used in conjunction with --vs= or --allvs, to specify which virtual servers are affected. list will list the servers configured as part of a cluster. ask, when specified with --machine= will list the virtual servers running on that machine. sync, when specified with --machine= will synchronise virtual server configurations with the master configuration specified by the admin server. This can be useful to update a machine, if it was down at the time of a configuration change.

--vs=virtual server

Specifies the virtual server to be acted upon. Used in conjunction with stop, start and restart.

--dvs=dynamic virtual server

Specifies the dynamic virtual server name to be acted upon.

--allvs

Specifies all virtual servers for start and stop actions, and all running virtual servers for restart actions.

--alldvs

Specifies all dynamic virtual servers to be acted upon.

--machine=machine

Specifies the machine to be queried, when using the ask or sync actions.

--html

Specifies that output generated should be HTML formatted.

--quiet

Specified that only errors should be displayed, and successes should be silent.


EXAMPLES

   $ webctl --action=start --allvs
   VirtualServer ssltest - Success
     Successful start on backend machine localhost

This will start all virtual servers configured in the admin server's configuration directory ($ZEUSHOME/webadmin/conf/sites). webctl must run as the user-id configured to run the web server for the local machine. For remote servers, they must be configured as a cluster

   $ webctl --machine=localhost --action=ask
       support
       website
       sandbox

This will list the names of the virtual servers running on the specified machine.

   $ webctl --action=list
   Backend web servers
       akula
       chronos
       elios
       gaia
 
This lists the servers configured for this cluster.


SEE ALSO

sites(5), runningsites(5)


COPYRIGHT

Copyright (C) 2000-2001 Zeus Technology Limited. All rights reserved.