.\" Man page generated from reStructuredText. . .TH VARNISH-CLI 7 "" "" "" .SH NAME varnish-cli \- Varnish Command Line Interface . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH DESCRIPTION .sp Varnish has a command line interface (CLI) which can control and change most of the operational parameters and the configuration of Varnish, without interrupting the running service. .sp The CLI can be used for the following tasks: .INDENT 0.0 .TP .B configuration You can upload, change and delete VCL files from the CLI. .TP .B parameters You can inspect and change the various parameters Varnish has available through the CLI. The individual parameters are documented in the varnishd(1) man page. .TP .B bans Bans are filters that are applied to keep Varnish from serving stale content. When you issue a ban Varnish will not serve any \fIbanned\fP object from cache, but rather re\-fetch it from its backend servers. .TP .B process management You can stop and start the cache (child) process though the CLI. You can also retrieve the latest stack trace if the child process has crashed. .UNINDENT .sp If you invoke varnishd(1) with \-T, \-M or \-d the CLI will be available. In debug mode (\-d) the CLI will be in the foreground, with \-T you can connect to it with varnishadm or telnet and with \-M varnishd will connect back to a listening service \fIpushing\fP the CLI to that service. Please see \fIvarnishd(1)\fP for details. .SS Syntax .sp The Varnish CLI is similar to another command line interface, the Bourne Shell. Commands are usually terminated with a newline, and they may take arguments. The command and its arguments are \fItokenized\fP before parsing, and as such arguments containing spaces must be enclosed in double quotes. .sp It means that command parsing of .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C help banner .ft P .fi .UNINDENT .UNINDENT .sp is equivalent to .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C "help" banner .ft P .fi .UNINDENT .UNINDENT .sp because the double quotes only indicate the boundaries of the \fBhelp\fP token. .sp Within double quotes you can escape characters with \e (backslash). The \en, \er, and \et get translated to newlines, carriage returns, an tabs. Double quotes and backslashes themselves can be escaped with \e" and \e\e respectively. .sp To enter characters in octals use the \ennn syntax. Hexadecimals can be entered with the \exnn syntax. .sp Commands may not end with a newline when a shell\-style \fIhere document\fP (here\-document or heredoc) is used. The format of a here document is: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C << word here document word .ft P .fi .UNINDENT .UNINDENT .sp \fIword\fP can be any continuous string chosen to make sure it doesn\(aqt appear naturally in the following \fIhere document\fP\&. Traditionally EOF or END is used. .SS Quoting pitfalls .sp Integrating with the Varnish CLI can be sometimes surprising when quoting is involved. For instance in Bourne Shell the delimiter used with here documents may or may not be separated by spaces from the \fB<<\fP token: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C cat <\(aq Line 1 Pos 1) < .INDENT 0.0 .INDENT 3.5 Authenticate. .UNINDENT .UNINDENT .SS backend.list [\-p] [] .INDENT 0.0 .INDENT 3.5 List backends. \-p also shows probe status. .UNINDENT .UNINDENT .SS backend.set_health [auto|healthy|sick] .INDENT 0.0 .INDENT 3.5 Set health status on the backends. .UNINDENT .UNINDENT .SS ban [&& ...] .INDENT 0.0 .INDENT 3.5 Mark obsolete all objects where all the conditions match. .UNINDENT .UNINDENT .sp See \fIvcl(7)_ban\fP for details .SS ban.list .INDENT 0.0 .INDENT 3.5 List the active bans. .sp The output format is: .INDENT 0.0 .IP \(bu 2 Time the ban was issued. .IP \(bu 2 Objects referencing this ban. .IP \(bu 2 \fBC\fP if ban is completed = no further testing against it. .IP \(bu 2 if \fBlurker\fP debugging is enabled: .INDENT 2.0 .IP \(bu 2 \fBR\fP for req.* tests .IP \(bu 2 \fBO\fP for obj.* tests .IP \(bu 2 Pointer to ban object .UNINDENT .IP \(bu 2 Ban specification .UNINDENT .UNINDENT .UNINDENT .SS banner .INDENT 0.0 .INDENT 3.5 Print welcome banner. .UNINDENT .UNINDENT .SS help [] .INDENT 0.0 .INDENT 3.5 Show command/protocol help. .UNINDENT .UNINDENT .SS panic.clear [\-z] .INDENT 0.0 .INDENT 3.5 Clear the last panic, if any, \-z will clear related varnishstat counter(s) .UNINDENT .UNINDENT .SS panic.show .INDENT 0.0 .INDENT 3.5 Return the last panic, if any. .UNINDENT .UNINDENT .SS param.set .INDENT 0.0 .INDENT 3.5 Set parameter value. .UNINDENT .UNINDENT .SS param.show [\-l] [|changed] .INDENT 0.0 .INDENT 3.5 Show parameters and their values. .UNINDENT .UNINDENT .sp The long form with \fB\-l\fP shows additional information, including documentation and minimum, maximum and default values, if defined for the parameter. If a parameter is specified with \fB\fP, show only that parameter. If \fBchanged\fP is specified, show only those parameters whose values differ from their defaults. .SS ping [] .INDENT 0.0 .INDENT 3.5 Keep connection alive. .UNINDENT .UNINDENT .SS quit .INDENT 0.0 .INDENT 3.5 Close connection. .UNINDENT .UNINDENT .SS start .INDENT 0.0 .INDENT 3.5 Start the Varnish cache process. .UNINDENT .UNINDENT .SS status .INDENT 0.0 .INDENT 3.5 Check status of Varnish cache process. .UNINDENT .UNINDENT .SS stop .INDENT 0.0 .INDENT 3.5 Stop the Varnish cache process. .UNINDENT .UNINDENT .SS storage.list .INDENT 0.0 .INDENT 3.5 List storage devices. .UNINDENT .UNINDENT .SS vcl.discard .INDENT 0.0 .INDENT 3.5 Unload the named configuration (when possible). .UNINDENT .UNINDENT .SS vcl.inline [auto|cold|warm] .INDENT 0.0 .INDENT 3.5 Compile and load the VCL data under the name provided. .sp Multi\-line VCL can be input using the here document \fIref_syntax\fP\&. .UNINDENT .UNINDENT .SS vcl.label .INDENT 0.0 .INDENT 3.5 Apply label to configuration. .UNINDENT .UNINDENT .SS vcl.list .INDENT 0.0 .INDENT 3.5 List all loaded configuration. .UNINDENT .UNINDENT .SS vcl.load [auto|cold|warm] .INDENT 0.0 .INDENT 3.5 Compile and load the VCL file under the name provided. .UNINDENT .UNINDENT .SS vcl.show [\-v] .INDENT 0.0 .INDENT 3.5 Display the source code for the specified configuration. .UNINDENT .UNINDENT .SS vcl.state [auto|cold|warm] .INDENT 0.0 .INDENT 3.5 Force the state of the named configuration. .UNINDENT .UNINDENT .SS vcl.use .INDENT 0.0 .INDENT 3.5 Switch to the named configuration immediately. .UNINDENT .UNINDENT .SS Backend Pattern .sp A backend pattern can be a backend name or a combination of a VCL name and backend name in "VCL.backend" format. If the VCL name is omitted, the active VCL is assumed. Partial matching on the backend and VCL names is supported using shell\-style wilcards, e.g. asterisk (*). .sp Examples: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C backend.list def* backend.list b*.def* backend.set_health default sick backend.set_health def* healthy backend.set_health * auto .ft P .fi .UNINDENT .UNINDENT .SS Ban Expressions .sp A ban expression consists of one or more conditions. A condition consists of a field, an operator, and an argument. Conditions can be ANDed together with "&&". .sp A field can be any of the variables from VCL, for instance req.url, req.http.host or obj.http.set\-cookie. .sp Operators are "==" for direct comparison, "~" for a regular expression match, and ">" or "<" for size comparisons. Prepending an operator with "!" negates the expression. .sp The argument could be a quoted string, a regexp, or an integer. Integers can have "KB", "MB", "GB" or "TB" appended for size related fields. .SS VCL Temperature .sp A VCL program goes through several states related to the different commands: it can be loaded, used, and later discarded. You can load several VCL programs and switch at any time from one to another. There is only one active VCL, but the previous active VCL will be maintained active until all its transactions are over. .sp Over time, if you often refresh your VCL and keep the previous versions around, resource consumption will increase, you can\(aqt escape that. However, most of the time you want only one to pay the price only for the active VCL and keep older VCLs in case you\(aqd need to rollback to a previous version. .sp The VCL temperature allows you to minimize the footprint of inactive VCLs. Once a VCL becomes cold, Varnish will release all the resources that can be be later reacquired. You can manually set the temperature of a VCL or let varnish automatically handle it. .SS Scripting .sp If you are going to write a script that talks CLI to varnishd, the include/cli.h contains the relevant magic numbers. .sp One particular magic number to know, is that the line with the status code and length field always is exactly 13 characters long, including the NL character. .sp The varnishapi library contains functions to implement the basics of the CLI protocol, see the \fIvcli.h\fP include file. .SS Authentication with \-S .sp If the \-S secret\-file is given as argument to varnishd, all network CLI connections must authenticate, by proving they know the contents of that file. .sp The file is read at the time the auth command is issued and the contents is not cached in varnishd, so it is possible to update the file on the fly. .sp Use the unix file permissions to control access to the file. .sp An authenticated session looks like this: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C critter phk> telnet localhost 1234 Trying ::1... Trying 127.0.0.1... Connected to localhost. Escape character is \(aq^]\(aq. 107 59 ixslvvxrgkjptxmcgnnsdxsvdmvfympg Authentication required. auth 455ce847f0073c7ab3b1465f74507b75d3dc064c1e7de3b71e00de9092fdc89a 200 279 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Varnish Cache CLI 1.0 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Linux,4.4.0\-1\-amd64,x86_64,\-jnone,\-smalloc,\-smalloc,\-hcritbit varnish\-trunk revision dc360a4 Type \(aqhelp\(aq for command list. Type \(aqquit\(aq to close CLI session. Type \(aqstart\(aq to launch worker process. .ft P .fi .UNINDENT .UNINDENT .sp The CLI status of 107 indicates that authentication is necessary. The first 32 characters of the response text is the challenge "ixsl...mpg". The challenge is randomly generated for each CLI connection, and changes each time a 107 is emitted. .sp The most recently emitted challenge must be used for calculating the authenticator "455c...c89a". .sp The authenticator is calculated by applying the SHA256 function to the following byte sequence: .INDENT 0.0 .IP \(bu 2 Challenge string .IP \(bu 2 Newline (0x0a) character. .IP \(bu 2 Contents of the secret file .IP \(bu 2 Challenge string .IP \(bu 2 Newline (0x0a) character. .UNINDENT .sp and dumping the resulting digest in lower\-case hex. .sp In the above example, the secret file contained foon and thus: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C critter phk> cat > _ ixslvvxrgkjptxmcgnnsdxsvdmvfympg foo ixslvvxrgkjptxmcgnnsdxsvdmvfympg ^D critter phk> hexdump \-C _ 00000000 69 78 73 6c 76 76 78 72 67 6b 6a 70 74 78 6d 63 |ixslvvxrgkjptxmc| 00000010 67 6e 6e 73 64 78 73 76 64 6d 76 66 79 6d 70 67 |gnnsdxsvdmvfympg| 00000020 0a 66 6f 6f 0a 69 78 73 6c 76 76 78 72 67 6b 6a |.foo.ixslvvxrgkj| 00000030 70 74 78 6d 63 67 6e 6e 73 64 78 73 76 64 6d 76 |ptxmcgnnsdxsvdmv| 00000040 66 79 6d 70 67 0a |fympg.| 00000046 critter phk> sha256 _ SHA256 (_) = 455ce847f0073c7ab3b1465f74507b75d3dc064c1e7de3b71e00de9092fdc89a critter phk> openssl dgst \-sha256 < _ 455ce847f0073c7ab3b1465f74507b75d3dc064c1e7de3b71e00de9092fdc89a .ft P .fi .UNINDENT .UNINDENT .sp The sourcefile lib/libvarnish/cli_auth.c contains a useful function which calculates the response, given an open filedescriptor to the secret file, and the challenge string. .SH EXAMPLES .sp Load a multi\-line VCL using shell\-style \fIhere document\fP: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C vcl.inline example << EOF vcl 4.0; backend www { .host = "127.0.0.1"; .port = "8080"; } EOF .ft P .fi .UNINDENT .UNINDENT .sp Ban all requests where req.url exactly matches the string /news: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C ban req.url == "/news" .ft P .fi .UNINDENT .UNINDENT .sp Ban all documents where the serving host is "example.com" or "www.example.com", and where the Set\-Cookie header received from the backend contains "USERID=1663": .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C ban req.http.host ~ "^(?i)(www\e\e.)?example\e\e.com$" && obj.http.set\-cookie ~ "USERID=1663" .ft P .fi .UNINDENT .UNINDENT .SH AUTHORS .sp This manual page was originally written by Per Buer and later modified by Federico G. Schwindt, Dridi Boukelmoune, Lasse Karstensen and Poul\-Henning Kamp. .SH SEE ALSO .INDENT 0.0 .IP \(bu 2 \fIvarnishadm(1)\fP .IP \(bu 2 \fIvarnishd(1)\fP .IP \(bu 2 \fIvcl(7)\fP .UNINDENT .\" Generated by docutils manpage writer. .