[4.0] 223351d Doc applies to both backend.list and backend.set_health
Lasse Karstensen
lkarsten at varnish-software.com
Thu Jan 15 16:35:41 CET 2015
commit 223351da4045a283aafec1664a5c43bce5b10f9f
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date: Tue Nov 11 23:10:35 2014 +0000
Doc applies to both backend.list and backend.set_health
Move explanation to its own section. Also mention the state options.
diff --git a/doc/sphinx/reference/varnish-cli.rst b/doc/sphinx/reference/varnish-cli.rst
index ca2fc8c..7f419ff 100644
--- a/doc/sphinx/reference/varnish-cli.rst
+++ b/doc/sphinx/reference/varnish-cli.rst
@@ -128,15 +128,12 @@ panic.clear
storage.list
List storage devices
-backend.list
- List all backends
+backend.list [<backend_expression>]
+ List backends.
-backend.set_health matcher state
- Set health status on a backend. The matcher expression can be a
- backend name or a parenthesized "(IP:port)" expression, or both. All
- fields are optional. If no exact matching backend is found, partial
- matching will be attempted based on the provided name, IP and port
- fields.
+backend.set_health <backend_expression> <state>
+ Set health status on the backends.
+ State is any of auto, healthy or sick values.
ban <field> <operator> <arg> [&& <field> <oper> <arg>]...
All objects where the all the conditions match will be marked obsolete.
@@ -144,6 +141,13 @@ ban <field> <operator> <arg> [&& <field> <oper> <arg>]...
ban.list
List the active bans.
+Backend Expression
+------------------
+
+A backend expression can be a backend name or a combination of backend
+name, IP address and port in "name(IP address:port)" format. All fields
+are optional. If no exact matching backend is found, partial matching
+will be attempted based on the provided name, IP address and port fields.
Ban Expressions
---------------
More information about the varnish-commit
mailing list