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: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSERVICE" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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] [\-o\ \fIconfigoption\fR]...
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBAmservice\fR
  29 execute an
  30 \fIAmanda\fR
  31 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\&.
  32 .PP
  33 See the
  34 \fBamanda\fR(8)
  35 man page for more details about
  36 \fIAmanda\fR\&.
  37 .SH "OPTIONS"
  38 .PP
  39 \fBhostname\fR
  40 .RS 4
  41 The hostname of the client\&.
  42 .RE
  43 .PP
  44 \fBauth\fR
  45 .RS 4
  46 The auth to use, one of: bsd, bsdudp, bsdtcp, ssh, rsh or krb5\&. The client must be configured with this auth\&.
  47 .RE
  48 .PP
  49 \fBservice\fR
  50 .RS 4
  51 The amanda service to execute on the client\&. One of noop, selfcheck or sendsize\&.
  52 .RE
  53 .PP
  54 \fB\-f input_file\fR
  55 .RS 4
  56 Use the file input_file instead of stdin to read the REQ packet from\&.
  57 .RE
  58 .PP
  59 \fB\-o\fR \fIconfigoption\fR
  60 .RS 4
  61 See the "\fBCONFIGURATION OVERRIDE\fR" section in
  62 \fBamanda\fR(8)\&.
  63 .RE
  64 .SH "EXAMPLE"
  65 .PP
  66 The noop service is easy to execute because it does not require a REQ packet:
  67 .nf
  68 amservice hostname bsdtcp noop < /dev/null.fi
  69 .PP
  70 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\&.
  71 .PP
  72 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\&.
  73 .SH "EXIT CODE"
  74
  75 The exit code of \fBamservice\fR is one of:
  76 .nf
  77  0  = success
  78  1  = error executing amandad on the client\&.
  79 .fi
  80 .PP
  81 As
  82 \fBamservice\fR
  83 doesn\'t parse the REP packet, it can only detect failures in executing amandad on the client\&.
  84 \fBamservice\fR
  85 can exit with value 0 even if the user is not authorized to execute the service\&. An error message will be printed\&.
  86 .SH "SEE ALSO"
  87 .PP
  88 \fBamanda\fR(8),
  89 \fBamcheck\fR(8),
  90 \fBamdump\fR(8),
  91 \fBamadmin\fR(8)
  92 .SH "AUTHOR"
  93 .PP
  94 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  95 .RS 4
  96 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  97 .RE