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