diff options
Diffstat (limited to 'rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html')
| -rw-r--r-- | rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html | 547 |
1 files changed, 0 insertions, 547 deletions
diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html b/rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html deleted file mode 100644 index 6754bc2a..00000000 --- a/rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html +++ /dev/null @@ -1,547 +0,0 @@ -<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>The Apache Tomcat Connector - Reference Guide - Status Worker Reference</title><meta name="author" value="Rainer Jung"><meta name="email" value="rjung@apache.org"><link href="../style.css" type="text/css" rel="stylesheet"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="4"><!--PAGE HEADER--><tr><td colspan="2"><!--TOMCAT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="left" alt="Apache Tomcat" border="0"></a><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="http://www.apache.org/images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="true"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li></ul><p><strong>Reference Guide</strong></p><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a href="../reference/apache.html">Apache HTTP Server</a></li><li><a href="../reference/iis.html">IIS</a></li></ul><p><strong>Generic HowTo</strong></p><ul><li><a href="../generic_howto/quick.html">For the impatient</a></li><li><a href="../generic_howto/workers.html">All about workers</a></li><li><a href="../generic_howto/timeouts.html">Timeouts</a></li><li><a href="../generic_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../generic_howto/proxy.html">Reverse Proxy</a></li></ul><p><strong>Webserver HowTo</strong></p><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server</a></li><li><a href="../webserver_howto/iis.html">IIS</a></li><li><a href="../webserver_howto/nes.html">Netscape/SunOne/Sun</a></li></ul><p><strong>AJP Protocol Reference</strong></p><ul><li><a href="../ajp/ajpv13a.html">AJPv13</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul><p><strong>Miscellaneous Documentation</strong></p><ul><li><a href="../miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></li><li><a href="http://issues.apache.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=Tomcat+Connectors&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html">Old JK/JK2 documentation</a></li></ul><p><strong>News</strong></p><ul><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/20100101.html">2010</a></li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>The Apache Tomcat Connector - Reference Guide</h1><h2>Status Worker Reference</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/status.html"><img src="../images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version - </a></small></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -Tomcat Connectors has a special type of worker, the so-called status worker. -The status worker does not forward requests to Tomcat instances. Instead it allows -to retrieve status and configuration information at runtime, -and furthermore to change many configuration items dynamically. This can be done -via a simple embedded web interface. -</p> -<p> -The status worker is especially powerful, when used together with load balancing workers. -</p> -<p> -This document does not explain the HTML user interface of the status worker. -Until now it is very simple, so just go ahead and use it. This doc instead -tries to explain the less obvious features of the status worker. We also will give a -complete coverage of the various request parameters and their meaning, so that you can -include the status worker in your automation scripts. -</p> -<p> -The documentation of the status worker starts with <b>jk 1.2.20</b> -</p> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Usage Patterns"><strong>Usage Patterns</strong></a></font></td></tr><tr><td><blockquote> -<br> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Actions"><strong>Actions</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The status worker knows about six actions. -<ul> -<li> -<b>list</b>: lists the configurations and runtime information of all configured workers. -The output will be grouped by global information first (version data), then load balancer -information, after that AJP worker information and finally the legend. For load balancers, -there will be a summary part, and after that details for each member worker. For all workers, -we also include the URL mappings (forward definitions). -</li> -<li> -<b>show</b>: the same as list, but only shows data for one chosen worker -</li> -<li> -<b>edit</b>: produces a form to edit configuration data for a chosen worker. There is a -special subtype of "edit", that makes it easy to change one attribute for all members of -a load balancer, e.g. their activation state. -</li> -<li> -<b>update</b>: commit changes made in an edit form. <b>Caution</b>: the changes will not be -persisted to the configuration files. As soon as your restart your web server, all changes -made through the status worker will be lost! On the other hand, the changes done by the status -worker will be applied during runtime without a restart of the web server. -</li> -<li> -<b>reset</b>: reset all runtime statistics for a worker. -</li> -<li> -<b>recover</b>: Mark a member of a load balancer, that is in error state, for immediate recovery. -</li> -<li> -<b>version</b>: only show version information of the web server and the JK software -</li> -<li> -<b>dump</b>: list the original workers configuration. <b>Caution</b>: the dump will only contain -the configuration that was used during startup. Any changes applied later by the dynamic management -interface of the status worker itself will not be contained in this dump. -The dump action has been added in version 1.2.27. -</li> -</ul> -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Format"><strong>Output Format</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -For most actions you can choose between 4 output formats. -<ul> -<li> -<b>HTML</b>: Used interactively with a browser -</li> -<li> -<b>XML</b>: Mostly useful for automation, when your scripting environment is XML friendly. -This format has rich structure information, but does not work line based, so you would really -like to use it together with XML tools. -</li> -<li> -<b>Properties</b>: This format is a line based format, that conforms to the rules of Java -property files. Most structure information is contained in the hierarchical key. For information, -that is of configuration nature, the format should produce lines very similar to the ones you can -use in workers.properties. It will not produce a complete configuration file! -</li> -<li> -<b>Text</b>: A simple textual output format. -</li> -</ul> -The "edit" action does only make sense for the HTML output type. -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="User Interface Features"><strong>User Interface Features</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -In the HTML view, there is an <b>automatic refresh</b> feature, implemented via the meta refresh -option of HTML. Once you start the automatic refresh, the UI will will respect it for all actions -except edit, update and maintain. Even if you navigate through one of those, the automatic refresh -will start again as soon as you come back to one of the other actions. -</p> -<p> -Many parts of the HTML page can be minimised, if they are not interesting for you. There are a couple -of "Hide" links, which will collapse parts of the information. The feature exists for the following -blocks of information: -<ul> -<li> -<b>Legend</b>: Do not show the legend for the information presented in "list" and "show" actions -</li> -<li> -<b>URI mappings</b>: Do not show the URI mapping for the workers -</li> -<li> -<b>Load Balancing Workers</b>: Do not show workers of type "lb" -</li> -<li> -<b>AJP Workers</b>: Do not show workers of type ajp -</li> -<li> -<b>Balancer Members</b>: Do not show detailed information concerning each member of load balancers -</li> -<li> -<b>Load Balancer Configuration</b>: Do not show configuration data for load balancers -</li> -<li> -<b>Load Balancer Summary</b>: Do not show status summary for load balancers -</li> -<li> -<b>AJP Configuration</b>: Do not show configuration data for ajp workers load balancer members -</li> -</ul> -The last three minimisation features have been added in version 1.2.27. -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Special Considerations concerning URL Maps and Virtual Hosts"><strong>Special Considerations concerning URL Maps and Virtual Hosts</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -<b>Note: </b>The following restriction has been removed starting with version 1.2.26. -</p> -<p> -The Apache module mod_jk makes use of the internal Apache httpd infrastructure concerning -virtual hosts. The downside of this is, that the status worker can only show URL maps, for -the virtual host it is defined in. It is not able to reach the configuration objects -for other virtual hosts. Of course you can define a status worker in any virtual host you -are using. All information presented apart from the URL maps will be the same, independent -of the virtual host the status worker has been called in. -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Logging"><strong>Logging</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The status worker will log changes made to the configuration with log level "info" to the usual -JK log file. Invalid requests will be logged with log level "warn". If you want to report some -broken behaviour, log file content of level "debug" or even "trace" will be useful. -</p> -</blockquote></td></tr></table> - -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuration"><strong>Configuration</strong></a></font></td></tr><tr><td><blockquote> -<br> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Basic Configuration"><strong>Basic Configuration</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The basic configuration of a status worker is very similar to that of a usual ajp worker. -You need to specify a name for the worker, and the URLs you want to map to it. The first -part of the configuration happens in the workers.properties file. We define a worker named -mystatus of type status: -<div class="example"><pre> -worker.list=mystatus -worker.mystatus.type=status -</pre></div> -Then we define a URL, which should be mapped to this worker, i.e. the URL we use -to reach the functionality of the status worker. You can use any method mod_jk supports -for the web server of your choice. Possibilities are maps inside uriworkermap.properties, -an additional mount attribute in workers.properties, or in Apache JkMount. Here's an -example for a uriworkermap.properties line: -<div class="example"><pre> -/private/admin/mystatus=mystatus -</pre></div> -The URI pattern is case sensitive. -</p> -<p> -As you will learn in the following sections, the status worker is very powerful. You should -use the usual authentication and authorisation methods of your web server to secure this URL. -</p> -<p> -You can also define multiple instances of the status worker, by using different names and URL mappings. -For instance you might want to configure them individually -and then allow special groups of people to use them -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Customisation"><strong>Output Customisation</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -There are a couple of attributes for the workers.properties entries, which allow to customise -various aspects of the output of the status worker. -</p> -<p> -The attribute <b>css</b> can be set to the URL of a stylesheet: -<div class="example"><pre> -worker.mystatus.css=/private/admin/static/mystatus.css -</pre></div> -When writing HTML output, the status worker then includes the line -<div class="example"><pre> -<link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> -</pre></div> -There is no sample stylesheet included with the mod_jk release, and by default the attribute css -is empty, so no stylesheet reference will be included in the pages. The HTML code -of the status worker output pages does not include any class attributes. If you like to contribute a -stylesheet or improvements to the HTML layout, please contact us on the tomcat developers list. -</p> -<p> -The properties output format can be customised via the attribute <b>prefix</b>. The names of all -properties the status worker does output, will begin with this prefix. The default is "worker". -</p> -<p> -Several attributes influence the format when writing XML output. -The attribute <b>ns</b> allows to set a namespace prefix, that will be used for every status worker+element. -The default is "jk:". Setting it to "-" disables the namespace prefix. -</p> -<p> -With the attribute xmlns you can map the prefix to a namespace URL. The default value -is xmlns:jk="http://tomcat.apache.org". Setting it to "-" disables the output of the URL. -</p> -<p> -Finally you can specify an XML document type via the attribute doctype. The specified string will -be inserted at the beginning of the document, directly after the xml header. The default is empty. -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Securing Access"><strong>Securing Access</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -We urge you to use the builtin access control features of your web server to control -access to the status worker URLs you have chosen. Nevertheless two configuration -attributes of status workers are helpful. The attribute "read_only" disables all features of -the status worker, that can be used to change configurations or runtime status of the other workers. -A read_only status worker will not allow access to the edit, update, reset or recover actions. -The default value is "False", ie. read/write. To enable read_only you need to set it to "True". -</p> -<p> -You could configure two status workers, one has read_only and will be made available to a larger -admin group, the other one will be used fully featured, but only by fewer people: -<div class="example"><pre> -worker.list=jk-watch -worker.jk-watch.type=status -worker.jk-watch.read_only=True -worker.jk-watch.mount=/user/status/jk -worker.list=jk-manage -worker.jk-manage.type=status -worker.jk-manage.mount=/admin/status/jk -</pre></div> -Starting with version 1.2.21, a read/write status worker can also be switched temporarily -into read-only mode by the user via a link in the HTML GUI. The user can always switch it -back to read/write. Only a status worker configured as read-only via the "read_only" attribute -is completely safe from applying any changes. -</p> -<p> -The other attribute you can use is <b>user</b>. By default this list is empty, which means -no limit on the users. You can set "user" to a comma separated list of user names. If your -web server is configured such that it sends the user names with the request, the status worker -will check, if the name attached with the request is contained in it's "user" list. -</p> -<p> -The user list can be split over multiple occurrences of the "user" attribute. -</p> -<p> -By default, the user names are matched case sensitively. Starting with version 1.2.21 you can set -the attribute <b>user_case_insensitive</b> to "True". Then the comparison will be made case insensitive. -</p> -</blockquote></td></tr></table> - -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Service Availability Rating"><strong>Service Availability Rating</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -For load balancing workers the status worker shows some interesting overview information. -It categorises the members of the load balancer into the classes "good", "bad" and degraded". -This feature can be combined with external escalation procedures. Depending on your global -system design and your operating practises your preferred categorisation might vary. -</p> -<p> -The categorisation is based on the activation state of the workers (active, disabled or stopped), -which is a pure configuration state, and the runtime state -(OK or ERR with possible substates idle, busy, recovering, probing, and forced recovery) -which only depends on the runtime situation. -</p> -<p> -The runtime substates have the following meaning: -<ul> -<li> -<b>OK (idle)</b>: This worker didn't receive any request since the last balancer -maintenance. By default balancer maintenance runs every 60 seconds. The -worker should be OK, but since we didn't have to use it for some time, we -can't be sure. This state has been called N/A before version 1.2.24. -</li> -<li> -<b>OK (busy)</b>: All connections for this worker are in use for requests. -</li> -<li> -<b>ERROR (recovering)</b>: The worker was in error state for some time and is now -marked for recovery. The next request suitable for this worker will use it. -</li> -<li> -<b>ERROR (probing)</b>: After setting the worker to recovering, we received a request -suitable for this worker. This request is now using the worker. -</li> -<li> -<b>ERROR (forced recovery)</b>: The worker is in error, but we don't have an alternative -worker, so we keep using it. -</li> -</ul> -</p> -<p> -By default the status worker groups into "good" all members, that have activation "active" and -runtime state not equal to "error" with empty substate. -The "bad" group consists of the members, that have either activation -"stopped", or are in runtime state "error" with empty substate. -</p> -<p> -Workers that fit neither of the two groups, are considered to be "degraded". -</p> -<p> -You can define other rules for the grouping into good, bad and degraded. -The two attributes "good" and "bad" can be populated by a comma-separated list ob single characters or -dot-separated pairs. Each character stands for the first character of one of the possible states "active", -"disabled", "stopped", "ok", "idle", "busy", "recovering" and "error". The additional states "probing" -and "forced recovery" are always rated equivalent to "recovering". -Comma-separated entries will be combined -with logical "or", if you combine a configuration and a runtime state with a dot. the are combined with logical -"and". So the default value for "good" is "a.o,a.i,a.b,a.r", for "bad" it is "e,s". -</p> -<p> -The status worker first tries to match against the "bad" definitions, if this doesn't succeed -it tries to match against "good", and finally it chooses "degraded", if no "bad" or "good" match -can be found. -</p> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Request Parameters"><strong>Request Parameters</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -This section should help you building automation scripts based on the jk status -management interface. This interface is stable in the sense, that we only expect -to add further parameters in the future. Existing parameters from previous versions -will keep their original semantics. We also expect the output formats XML, Properties -and Text to be kept stable. So please use those, if you want to parse status worker -output in your automation scripts. -</p> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Actions"><strong>Actions</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The action is determined by the parameter <b>cmd</b>. It can have the values "list", "show", -"edit", "update", "reset", "recover", "version" and "dump". If you omit the <b>cmd</b> parameter, -the default "list" will be used. -All actions except for "list", "refresh", "version" and "dump" need additional parameters. -</p> -<p> -The action "dump" has been added in version 1.2.27. -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Format"><strong>Output Format</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The format is determined by the parameter <b>mime</b>. It can have the values "html", "xml", -"txt" and "prop". If you omit the <b>mime</b> parameter, the default "html" -will be used. The action "edit" (the edit form) does only make sense for "mime=html". -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Worker Selection"><strong>Worker Selection</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -Actions that operate on a single worker need one or two additional parameters to select -this worker. The parameter <b>w</b> contains the name of the worker from the worker list. -If an action operates on a member (sub worker) of a load balancer, the parameter <b>w</b> -contains the name of the load balancer worker, and the additional parameter <b>sw</b> contains the -name of the sub worker. -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Automatic Refresh"><strong>Automatic Refresh</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -During automatic refresh, the parameter <b>re</b> contain the refresh interval in seconds. -If you omit this parameter, automatic refresh will be off. -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Hide Options"><strong>Hide Options</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -The parameter <b>opt</b> contains a bit mask of activated options. The default is 0, so -by default no options are activated. The following options exist: -<ul> -<li> -<b>0x0001</b>: hide members of lb workers -</li> -<li> -<b>0x0002</b>: hide URL maps -</li> -<li> -<b>0x0004</b>: hide the legend -</li> -<li> -<b>0x0008</b>: hide load balancer workers -</li> -<li> -<b>0x0010</b>: hide ajp workers -</li> -<li> -<b>0x0020</b>: only allow read_only actions for a read/write status worker. -</li> -<li> -<b>0x0040</b>: hide load balancer configuration -</li> -<li> -<b>0x0080</b>: hide load balancer status summary -</li> -<li> -<b>0x0100</b>: hide configuration for ajp and load balancer member workers -</li> -</ul> -Values 0x0040-0x0100 have been added in version 1.2.27. -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Data Parameters for the standard Update Action"><strong>Data Parameters for the standard Update Action</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -You can use the edit action with a final click to the update button, to change settings of workers. -But you can also make direct calls to the update action. The following request parameters -contain the configuration information, you want to change. First the list for load balancer workers: -<ul> -<li> -<b>vlr</b>: retries (number) -</li> -<li> -<b>vlt</b>: recover_time (seconds) -</li> -<li> -<b>vlee</b>: error_escalation_time (seconds) -</li> -<li> -<b>vlx</b>: max_reply_timeouts (number) -</li> -<li> -<b>vls</b>: sticky_session (0/f/n/off=off, 1/t/y/on=on; case insensitive) -</li> -<li> -<b>vlf</b>: sticky_session_force (0/f/n/off=off, 1/t/y/on=on; case insensitive) -</li> -<li> -<b>vlm</b>: method (0/r="Requests", 1/t="Traffic", 2/b="Busyness", 3/s="Sessions"; case insensitive, only first character is used) -</li> -<li> -<b>vll</b>: lock (0/o="Optimistic", 1/p="Pessimistic"; case insensitive, only first character is used) -</li> -</ul> -And now the list of parameters you can use to change settings for load balancer members: -<ul> -<li> -<b>vwa</b>: activation flag (0/a="active", 1/d="disabled", 2/s="stopped"; case insensitive, only first character is used) -</li> -<li> -<b>vwf</b>: load balancing factor (integer weight) -</li> -<li> -<b>vwn</b>: route for use with sticky sessions (string) -</li> -<li> -<b>vwr</b>: redirect to define simple failover rules (string) -</li> -<li> -<b>vwc</b>: domain to tell JK about your replication design (string) -</li> -<li> -<b>vwd</b>: distance to express preferences (integer) -</li> -</ul> -Finally the list of parameters you can use to change settings for ajp workers and ajp load balancer members: -<ul> -<li> -<b>vahst</b>: host (string) -</li> -<li> -<b>vaprt</b>: port (number) -</li> -<li> -<b>vacpt</b>: connection_pool_timeout (number) -</li> -<li> -<b>vact</b>: connect_timeout (number) -</li> -<li> -<b>vapt</b>: prepost_timeout (number) -</li> -<li> -<b>vart</b>: reply_timeout (number) -</li> -<li> -<b>var</b>: retries (number) -</li> -<li> -<b>varo</b>: recovery_options (number) -</li> -<li> -<b>vamps</b>: max_packet_size (number) -</li> -</ul> -Note that changing the host name or port will only take effect for new connections. -Already established connections to the old address will still be used. -Nevertheless this feature is interesting, because you can provision load balancer -members with port "0", which will automatically be stopped during startup. Later -when you know the final names and ports, you can set them and they will be -automatically activated. -</p> -<p> -The leading character "v" has been added to the parameters in version 1.2.27. -Changing settings for ajp workers has also been introduced in version 1.2.27. -</p> -<p> -For the details of all parameters, we refer to the <a href="workers.html">workers.properties Reference</a>. -</p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Aspect Editing for Load Balancer Members"><strong>Aspect Editing for Load Balancer Members</strong></a></font></td></tr><tr><td><blockquote> -<br> -<p> -You can use the edit action to edit all settings for a load balancer or for a -member of a load balancer respectively on one page. If you want to edit one -configuration aspect for all members of a load balancer simultaneously, this -will be triggered by the parameter <b>att</b>. The value of the parameter indicates, -which aspect you want to edit. The list is the same as in the previous section, -except for "vahst" and "vaprt": -"vwa", "vwf", "vwn", "vwr", "vwc", "vwd", "vacpt", "vact", "vapt", "vart", "var", -"varo" and "vamps". But here you -need to put the name into the parameter <b>att</b>, instead of using it as a request -parameter name. -</p> -<p> -The values of the common aspect for all the load balancer members will be given -in parameters named "val0", "val1", .... -</p> -</blockquote></td></tr></table> -</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> - Copyright © 1999-2011, Apache Software Foundation - </em></font></div></td></tr></table></body></html>
\ No newline at end of file |