git.gag.com Git - debian/amanda/blob - man/amservice.8

   1 '\" t
   2 .\"     Title: amservice
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/21/2012
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.3.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSERVICE" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amservice \- run an amanda service on a client
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBamservice\fR\ 'u
  34 \fBamservice\fR [\-f\ \fIinput_file\fR\ [\-s]] [\fB\-o\fR\ \fIconfigoption\fR...] \fIhostname\fR \fIauth\fR \fIservice\fR
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBAmservice\fR
  38 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\&.
  39 .PP
  40 See the
  41 \fBamanda\fR(8)
  42 man page for more details about Amanda\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \fBhostname\fR
  46 .RS 4
  47 The hostname of the client\&.
  48 .RE
  49 .PP
  50 \fBauth\fR
  51 .RS 4
  52 The auth to use, one of: bsd, bsdudp, bsdtcp, ssh, rsh or krb5\&. The client must be configured with this auth\&.
  53 .RE
  54 .PP
  55 \fBservice\fR
  56 .RS 4
  57 The amanda service to execute on the client\&. One of noop, selfcheck or sendsize\&.
  58 .RE
  59 .PP
  60 \fB\-f input_file\fR
  61 .RS 4
  62 Use the file input_file instead of stdin to read the REQ packet from\&.
  63 .RE
  64 .PP
  65 \fB\-s\fR
  66 .RS 4
  67 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\&.
  68 .RE
  69 .PP
  70 \fB\-o \fR\fB\fIconfigoption\fR\fR
  71 .RS 4
  72 See the "CONFIGURATION OVERRIDE" section in
  73 \fBamanda\fR(8)\&.
  74 .RE
  75 .SH "EXAMPLE"
  76 .PP
  77 The noop service is easy to execute because it does not require a REQ packet:
  78 .nf
  79 amservice hostname bsdtcp noop < /dev/null
  80 .fi
  81 .PP
  82 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\&.
  83 .PP
  84 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\&.
  85 .SH "EXIT CODE"
  86
  87 The exit code of \fBamservice\fR is one of:
  88 .nf
  89  0  = success
  90  1  = error executing amandad on the client\&.
  91 .fi
  92 .PP
  93 As
  94 \fBamservice\fR
  95 doesn\*(Aqt parse the REP packet, it can only detect failures in executing amandad on the client\&.
  96 \fBamservice\fR
  97 can exit with value 0 even if the user is not authorized to execute the service\&. An error message will be printed\&.
  98 .SH "SEE ALSO"
  99 .PP
 100 \fBamanda\fR(8),
 101 \fBamanda\fR(8),
 102 \fBamcheck\fR(8),
 103 \fBamdump\fR(8),
 104 \fBamadmin\fR(8)
 105 .PP
 106 The Amanda Wiki:
 107 : http://wiki.zmanda.com/
 108 .SH "AUTHOR"
 109 .PP
 110 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 111 .RS 4
 112 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 113 .RE