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: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSERVICE" "8" "10/18/2010" "Amanda 3\&.2\&.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 \fIhostname\fR \fIauth\fR \fIservice\fR [\-f\ \fIinput_file\fR] [\fB\-o\fR\ \fIconfigoption\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\-o \fR\fB\fIconfigoption\fR\fR
  57 .RS 4
  58 See the "CONFIGURATION OVERRIDE" section in
  59 \fBamanda\fR(8)\&.
  60 .RE
  61 .SH "EXAMPLE"
  62 .PP
  63 The noop service is easy to execute because it does not require a REQ packet:
  64 .nf
  65 amservice hostname bsdtcp noop < /dev/null.fi
  66 .PP
  67 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\&.
  68 .PP
  69 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\&.
  70 .SH "EXIT CODE"
  71
  72 The exit code of \fBamservice\fR is one of:
  73 .nf
  74  0  = success
  75  1  = error executing amandad on the client\&.
  76 .fi
  77 .PP
  78 As
  79 \fBamservice\fR
  80 doesn\'t parse the REP packet, it can only detect failures in executing amandad on the client\&.
  81 \fBamservice\fR
  82 can exit with value 0 even if the user is not authorized to execute the service\&. An error message will be printed\&.
  83 .SH "SEE ALSO"
  84 .PP
  85 \fBamanda\fR(8),
  86 \fBamanda\fR(8),
  87 \fBamcheck\fR(8),
  88 \fBamdump\fR(8),
  89 \fBamadmin\fR(8)
  90 .PP
  91 The Amanda Wiki:
  92 : http://wiki.zmanda.com/
  93 .SH "AUTHOR"
  94 .PP
  95 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  96 .RS 4
  97 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  98 .RE