1VARNISHADM(1)                                                    VARNISHADM(1)
2
3
4

NAME

6       varnishadm - Control a running Varnish instance
7

SYNOPSIS

9       varnishadm  [-h]  [-n  ident]  [-t  timeout]  [-S  secretfile] [-T [ad‐
10       dress]:port] [command [...]]
11

DESCRIPTION

13       The varnishadm utility establishes a CLI connection to varnishd  either
14       using -n name or using the -T and -S arguments. If -n name is given the
15       location of the secret file and the address:port is looked up in shared
16       memory.  If neither is given varnishadm will look for an instance with‐
17       out a given name.
18
19       If a command is given, the command and arguments are sent over the  CLI
20       connection and the result returned on stdout.
21
22       If  no  command  argument  is  given  varnishadm will pass commands and
23       replies between the CLI socket and stdin/stdout.
24

OPTIONS

26       -h     Print program usage and exit.
27
28       -p     Force pass mode and make the output follow  the  VCLI  protocol.
29              This  disables  command-history/command-completion  and makes it
30              easier for programs to parse the response(s).
31
32       -n ident
33              Connect to the instance of varnishd with this name.
34
35       -S secretfile
36              Specify the authentication secret file. This should be the  same
37              -S  argument  as was given to varnishd. Only processes which can
38              read the contents of this file, will be able to authenticate the
39              CLI connection.
40
41       -t timeout
42              Wait  no  longer than this many seconds for an operation to fin‐
43              ish.
44
45       -T <address:port>
46              Connect to the management interface at the specified address and
47              port.
48
49       The  syntax  and  operation of the actual CLI interface is described in
50       the varnish-cli(7) manual page. Parameters are described in varnishd(1)
51       manual page.
52
53       Additionally, a summary of commands can be obtained by issuing the help
54       command, and a summary of parameters can be  obtained  by  issuing  the
55       param.show command.
56

EXIT STATUS

58       If  a  command  is  given, the exit status of the varnishadm utility is
59       zero if the command succeeded, and non-zero otherwise.
60

EXAMPLES

62       Some ways you can use varnishadm:
63
64          varnishadm -T localhost:999 -S /var/db/secret vcl.use foo
65          echo vcl.use foo | varnishadm -T localhost:999 -S /var/db/secret
66          echo vcl.use foo | ssh vhost varnishadm -T localhost:999 -S /var/db/secret
67

SEE ALSO

69       • varnishd(1)
70
71       • varnish-cli(7)
72

AUTHORS

74       The varnishadm utility and this manual page  were  written  by  Cecilie
75       Fritzvold.  This man page has later been modified by Per Buer, Federico
76       G.  Schwindt and Lasse Karstensen.
77
78
79
80
81                                                                 VARNISHADM(1)
Impressum