Blob Blame History Raw
'\" t
.\"     Title: amservice
.\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 12/01/2017
.\"    Manual: System Administration Commands
.\"    Source: Amanda 3.5.1
.\"  Language: English
.\"
.TH "AMSERVICE" "8" "12/01/2017" "Amanda 3\&.5\&.1" "System Administration Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
amservice \- run an amanda service on a client
.SH "SYNOPSIS"
.HP \w'\fBamservice\fR\ 'u
\fBamservice\fR [\-f\ \fIinput_file\fR\ [\-s]] [\-\-config\ \fICONFIG\fR] [\-\-features\ \fIFEATURES\-STRING\fR] [\-\-stream\ \fINAME,IN,OUT\fR]*
     [\fB\-o\fR\ \fIconfigoption\fR...] \fIhostname\fR \fIauth\fR \fIservice\fR
.SH "DESCRIPTION"
.PP
\fBAmservice\fR
execute an Amanda service on a client\&. It can be used without amanda server configuration (amanda\&.conf and disklist)\&. It can be used to check communication between a server and a client\&. Amservice reads stdin to capture the REQ packet to send to the client\&.
.PP
See the
\fBamanda\fR(8)
man page for more details about Amanda\&.
.SH "OPTIONS"
.PP
\fBhostname\fR
.RS 4
The hostname of the client\&.
.RE
.PP
\fBauth\fR
.RS 4
The auth to use, one of: bsd, bsdudp, bsdtcp, ssh, rsh or krb5\&. The client must be configured with this auth\&.
.RE
.PP
\fBservice\fR
.RS 4
The amanda service to execute on the client\&. One of noop, selfcheck or sendsize\&.
.RE
.PP
\fB\-f input_file\fR
.RS 4
Use the file input_file instead of stdin to read the REQ packet from\&.
.RE
.PP
\fB\-s\fR
.RS 4
Redirect the first connected stream to stdin/stdout\&. The \-f argument is required for the REQ packet, the REP packet is not printed on stdout\&.
.RE
.PP
\fB\-\-config\fR
.RS 4
The amanda configuration\&.
.RE
.PP
\fB\-\-features\fR \fIFEATURES\-STRING\fR
.RS 4
The features of the remote client\&.
.RE
.PP
\fB\-\-stream\fR \fINAME,IN,OUT\fR
.RS 4
The vstream to open, their name and the two file descriptors\&.
.RE
.PP
\fB\-o \fR\fB\fIconfigoption\fR\fR
.RS 4
See the "CONFIGURATION OVERRIDE" section in
\fBamanda\fR(8)\&.
.RE
.SH "EXAMPLE"
.PP
The noop service is easy to execute because it does not require a REQ packet:
.nf
amservice hostname bsdtcp noop < /dev/null
.fi
.PP
The example executes the noop service on the client using bsdtcp auth\&. This is useful for debugging connection problems\&. It print an OPTIONS line upon success\&.
.PP
It is more difficult to execute the selfcheck or sendsize service, as these require a valid REQ packet\&. If you have already uccessfully run amanda, you can find valid REQ packets in the amandad\&.*\&.debug files\&.
.SH "EXIT CODE"

The exit code of \fBamservice\fR is one of:
.nf
 0  = success
 1  = error executing amandad on the client\&.
.fi
.PP
As
\fBamservice\fR
doesn\*(Aqt parse the REP packet, it can only detect failures in executing amandad on the client\&.
\fBamservice\fR
can exit with value 0 even if the user is not authorized to execute the service\&. An error message will be printed\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
\fBamanda\fR(8),
\fBamcheck\fR(8),
\fBamdump\fR(8),
\fBamadmin\fR(8)
.PP
The Amanda Wiki:
: http://wiki.zmanda.com/
.SH "AUTHOR"
.PP
\fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
.RS 4
Zmanda, Inc\&. (http://www\&.zmanda\&.com)
.RE