File: //usr/share/doc/varnish/html/reference/varnishadm.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>varnishadm — Varnish version 6.4.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '6.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Varnish version 6.4.0 documentation" href="../index.html" />
<link rel="up" title="The Varnish Reference Manual" href="index.html" />
<link rel="next" title="varnishd" href="varnishd.html" />
<link rel="prev" title="varnish-cli" href="varnish-cli.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="varnishd.html" title="varnishd"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="varnish-cli.html" title="varnish-cli"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Varnish version 6.4.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">The Varnish Reference Manual</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="varnishadm">
<span id="varnishadm-1"></span><h1>varnishadm<a class="headerlink" href="#varnishadm" title="Permalink to this headline">¶</a></h1>
<div class="section" id="control-a-running-varnish-instance">
<h2>Control a running Varnish instance<a class="headerlink" href="#control-a-running-varnish-instance" title="Permalink to this headline">¶</a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Manual section:</th><td class="field-body">1</td>
</tr>
</tbody>
</table>
<div class="section" id="synopsis">
<h3>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h3>
<p>varnishadm [-h] [-n ident] [-t timeout] [-S secretfile] [-T [address]:port] [command [...]]</p>
</div>
<div class="section" id="description">
<h3>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h3>
<p>The <cite>varnishadm</cite> utility establishes a CLI connection to varnishd either
using -n <em>name</em> or using the -T and -S arguments. If -n <em>name</em> is
given the location of the secret file and the address:port is looked
up in shared memory. If neither is given <cite>varnishadm</cite> will look for an
instance without a given name.</p>
<p>If a command is given, the command and arguments are sent over the CLI
connection and the result returned on stdout.</p>
<p>If no command argument is given <cite>varnishadm</cite> will pass commands and
replies between the CLI socket and stdin/stdout.</p>
</div>
<div class="section" id="options">
<h3>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-h</span></kbd></td>
<td>Print program usage and exit.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-n <var>ident</var></span></kbd></td>
<td>Connect to the instance of <cite>varnishd</cite> with this name.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-S <var>secretfile</var></span></kbd></td>
<td>Specify the authentication secret file. This should be the same -S
argument as was given to <cite>varnishd</cite>. Only processes which can read
the contents of this file, will be able to authenticate the CLI connection.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-t <var>timeout</var></span></kbd></td>
<td>Wait no longer than this many seconds for an operation to finish.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-T <var><address:port></var></span></kbd></td>
</tr>
<tr><td> </td><td>Connect to the management interface at the specified address and port.</td></tr>
</tbody>
</table>
<p>The syntax and operation of the actual CLI interface is described in
the <a class="reference internal" href="varnish-cli.html#varnish-cli-7"><em>varnish-cli</em></a> manual page. Parameters are described in
<a class="reference internal" href="varnishd.html#varnishd-1"><em>varnishd</em></a> manual page.</p>
<p>Additionally, a summary of commands can be obtained by issuing the
<em>help</em> command, and a summary of parameters can be obtained by issuing
the <em>param.show</em> command.</p>
</div>
<div class="section" id="exit-status">
<h3>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h3>
<p>If a command is given, the exit status of the <cite>varnishadm</cite> utility is
zero if the command succeeded, and non-zero otherwise.</p>
</div>
<div class="section" id="examples">
<h3>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
<p>Some ways you can use varnishadm:</p>
<div class="highlight-python"><pre>varnishadm -T localhost:999 -S /var/db/secret vcl.use foo
echo vcl.use foo | varnishadm -T localhost:999 -S /var/db/secret
echo vcl.use foo | ssh vhost varnishadm -T localhost:999 -S /var/db/secret</pre>
</div>
</div>
<div class="section" id="see-also">
<h3>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference internal" href="varnishd.html#varnishd-1"><em>varnishd</em></a></li>
<li><a class="reference internal" href="varnish-cli.html#varnish-cli-7"><em>varnish-cli</em></a></li>
</ul>
</div>
<div class="section" id="authors">
<h3>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h3>
<p>The <cite>varnishadm</cite> utility and this manual page were written by Cecilie
Fritzvold. This man page has later been modified by Per Buer, Federico G.
Schwindt and Lasse Karstensen.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">varnishadm</a><ul>
<li><a class="reference internal" href="#control-a-running-varnish-instance">Control a running Varnish instance</a><ul>
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li><a class="reference internal" href="#options">OPTIONS</a></li>
<li><a class="reference internal" href="#exit-status">EXIT STATUS</a></li>
<li><a class="reference internal" href="#examples">EXAMPLES</a></li>
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
<li><a class="reference internal" href="#authors">AUTHORS</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="varnish-cli.html"
title="previous chapter">varnish-cli</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="varnishd.html"
title="next chapter">varnishd</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/varnishadm.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="varnishd.html" title="varnishd"
>next</a> |</li>
<li class="right" >
<a href="varnish-cli.html" title="varnish-cli"
>previous</a> |</li>
<li><a href="../index.html">Varnish version 6.4.0 documentation</a> »</li>
<li><a href="index.html" >The Varnish Reference Manual</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2014, Varnish Software AS.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>