Amservice: Difference between revisions

From wiki.zmanda.com
Jump to navigation Jump to search
(new manpage)
 
mNo edit summary
Line 10: Line 10:
==DESCRIPTION==
==DESCRIPTION==


Amservice executes an amanda service on a client. It can be used without an 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.
Amservice executes an amanda service on a client. It can be used without an amanda server configuration ([[amanda.conf]] and [[amanda#DISKLIST_FILE|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.


See the [[amanda]](8) man page for more details about Amanda.
See the [[amanda]](8) man page for more details about Amanda.
Line 26: Line 26:
; -f ''input_file'' : Use the file input_file instead of stdin to read the REQ packet from.
; -f ''input_file'' : Use the file input_file instead of stdin to read the REQ packet from.


; -o ''config_option'': See the "CONFIGURATION OVERRIDE" section in [[amanda]](8).
; -o ''config_option'': See the "[[Amanda#CONFIGURATION_OVERRIDE|CONFIGURATION OVERRIDE]]" section in [[amanda]](8).


==EXAMPLE==
==EXAMPLE==
Line 34: Line 34:
   amservice hostname bsdtcp noop < /dev/null
   amservice hostname bsdtcp noop < /dev/null
    
    
The exmple executes the noop service on the client using bsdtcp auth. This is useful for debugging connection problems. It prints an OPTIONS line upon success.
The example executes the noop service on the client using bsdtcp auth. This is useful for debugging connection problems. It prints an OPTIONS line upon success.


It is more difficult to execute the selfcheck or sendsize service, as these require a valid REQ packet. If you have already successfully run amanda, you can find valid REQ packets in the amandad.*.debug file.
It is more difficult to execute the selfcheck or sendsize service, as these require a valid REQ packet. If you have already successfully run amanda, you can find valid REQ packets in the amandad.*.debug file.

Revision as of 20:21, 7 June 2008

NOTE: amservice will be available in Amanda-2.6.1.

NAME

amservice — run an amanda service on a client

SYNOPSIS

amservice hostname auth service [-f input_file] [-o config_option]...

DESCRIPTION

Amservice executes an amanda service on a client. It can be used without an 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.

See the amanda(8) man page for more details about Amanda.

OPTIONS

All options may be abbreviated to the shortest non-ambiguous sub-string. If no options are given, everything is displayed.

hostname
The hostname of the client.
auth
The auth to use, one of: bsd, bsdudp, bsdtcp, ssh, rsh or krb5. The client must be configured with this auth.
service
The amanda service to execute on the client. One of noop, selfcheck or sendsize.
-f input_file
Use the file input_file instead of stdin to read the REQ packet from.
-o config_option
See the "CONFIGURATION OVERRIDE" section in amanda(8).

EXAMPLE

The noop service is easy to execute because it does not require a REQ packet:

  amservice hostname bsdtcp noop < /dev/null
  

The example executes the noop service on the client using bsdtcp auth. This is useful for debugging connection problems. It prints an OPTIONS line upon success.

It is more difficult to execute the selfcheck or sendsize service, as these require a valid REQ packet. If you have already successfully run amanda, you can find valid REQ packets in the amandad.*.debug file.

EXIT CODES

The exit code of amservice is one of:

  • 0 = success
  • 1 = error executing amandad on the client

As amservice doesn´t parse the REP packet, it can only detect failure in executing amandad on the client. Amservice can exit with value 0 even if the user is not authorized to execute the service.

SEE ALSO

amanda(8), amcheck(8), amdump(8), amadmin(8)