.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "VINYLADM" "1" "" ""
.SH NAME
vinyladm \- Control a running Vinyl Cache instance
.\" Copyright (c) 2010-2021 Varnish Software AS
.\" SPDX-License-Identifier: BSD-2-Clause
.\" See LICENSE file for full text of license
.
.SH SYNOPSIS
.sp
vinyladm [\-h] [\-n workdir] [\-p] [\-S secretfile] [\-T [address]:port] [\-t timeout] [command [...]]
.SH DESCRIPTION
.sp
The \fIvinyladm\fP utility establishes a CLI connection to \fBvinyld\fP either
using \-n \fIworkdir\fP or using the \-T and \-S arguments. If \-n \fIworkdir\fP is
given, the location of the secret file and the address:port are looked
up in shared memory. If neither is given, \fIvinyladm\fP uses the \-n
defaults documented for \fIvinyld(1)\fP\&.
.sp
If a command is given, the command and arguments are sent over the CLI
connection and the result returned on stdout.
.sp
If no command argument is given \fIvinyladm\fP will pass commands and
replies between the CLI socket and stdin/stdout.
.SH OPTIONS
.INDENT 0.0
.TP
.B  \-h
Print program usage and exit.
.TP
.BI \-n \ workdir
Specify the Vinyl Cache working directory of the instance to attach
to. See \fIvinyld(1)\fP \fB\-n\fP option documentation for
additional information and defaults.
.TP
.B  \-p
Force \fIpass\fP mode and make the output follow the VCLI protocol.
This disables command\-history/command\-completion and makes it
easier for programs to parse the response(s).
.TP
.BI \-S \ secretfile
Specify the authentication secret file. This should be the same \-S
argument as was given to \fBvinyld\fP\&. Only processes which can read
the contents of this file, will be able to authenticate the CLI connection.
.TP
.BI \-T \ <address:port>
Connect to the management interface at the specified address and port.
.TP
.BI \-t \ timeout
Wait no longer than this many seconds for an operation to finish.
.UNINDENT
.sp
The syntax and operation of the actual CLI interface is described in
the \fIvinyl\-cli(7)\fP manual page. Parameters are described in
\fIvinyld(1)\fP manual page.
.sp
Additionally, a summary of commands can be obtained by issuing the
\fIhelp\fP command, and a summary of parameters can be obtained by issuing
the \fIparam.show\fP command.
.SH EXIT STATUS
.sp
If a command is given, the exit status of the \fIvinyladm\fP utility is
zero if the command succeeded, and non\-zero otherwise.
.SH EXAMPLES
.sp
Some ways you can use vinyladm:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
vinyladm \-T localhost:999 \-S /var/db/secret vcl.use foo
echo vcl.use foo | vinyladm \-T localhost:999 \-S /var/db/secret
echo vcl.use foo | ssh vhost vinyladm \-T localhost:999 \-S /var/db/secret
.EE
.UNINDENT
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fIvinyld(1)\fP
.IP \(bu 2
\fIvinyl\-cli(7)\fP
.UNINDENT
.SH AUTHORS
.sp
The \fIvinyladm\fP 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.
.\" Generated by docutils manpage writer.
.