netdump-server

NETDUMP-SERVER(8)               System Programs              NETDUMP-SERVER(8)



NAME
       netdump-server - handle crash dumps over the network

SYNOPSIS
       netdump-server [--port portnumber]
                [--addr address]
                [--concurrent number]
                [--pidfile path]
                [--dumpdir path]
                [--daemon]
                [--secure <0|1>]
                [--help] [--usage]

DESCRIPTION
       Listens to the network for clients that crash and uses the netdump
       protocol to recieve a memory dump and a stack trace. The memory dump
       and oops message are stored in a timestamped directory in /var/crash.
       The server can also run scripts when some events happen.

OPTIONS
       --port portnumber
              Specifies the IP port number for the netdump server to listen
              to.  The default is 6666.

       --addr address
              Specifies the IP address for the netdump server to listen to.
              The default is any.

       --concurrent number
              You can limit the amount of concurrent dumps being done at any
              one time. If more clients than the specified maximum connects at
              one time the last ones will just be logged and then rebooted.

       --dumpdir path
              Specify the location where received vmcore files are saved.
              Defaults to /var/crash

       --pidfile path
              Store a pidfile.  The default service uses /var/run/netdump-
              server.pid.  The default is not to write a pidfile.

       --daemon
              netdump-server should background itself and run as a daemon.

       --secure
              Specify a 0 here to disable the client authentication bits.
              This will enable any client to dump core to this server without
              any credentials.  If using this option, you may specify the
              NETDUMPKEYEXCHANGE=none option in /etc/sysconfig/netdump on the
              client systems.

EXAMPLES
       netdump-server --daemon
       This launches the netdump-server and puts it in the background,
       listening for crashed clients.


EXIT STATUS
       Exit status is 0 for a clean exit and non-0 for a non-clean exit.

FILES
       /etc/netdump.conf
              A configuration file read by netdump-server on startup. It is a
              "key=value" style file. Currently it supports the options: port,
              max_concurrent_dumps, daemon, pidfile and secure.

       /etc/init.d/netdump-server
              An init script to start a default system installation of
              netdump-server.  This is normally turned off by default; use the
              command
              /sbin/chkconfig netdump-server on
              to enable the netdump-server service.

       /var/crash
              The main directory where the crash dump files are stored. Each
              dump is put in a subdirectory named with the ip of the crashed
              machine and the date and time of the crash.

       /var/crash/scripts
              This directory can contain scripts that are run at various
              times.  The script files should be executable and owned by the
              netdump user.  They all get passed the ip of the crashing
              machine as the first argument, and each one except netdump-start
              gets the directory that the dump is written into as the second
              argument.

              netdump-start - This is called when a client connects to the
              server to tell it that it has just started the netdump client.
              This normally means that the machine just booted up.

              netdump-crash - This is run when a client reports that it has
              crashed.  If it returns a non-zero value the dump request will
              be ignored and the client will be told to reboot immediately

              netdump-nospace - This is run when there is not enough diskspace
              for the dump of the crashed machine. If this script exits with a
              non-zero return value netdump-server will try once again (but
              only once) before giving up the dump. If this script exits with
              a zero return value, netdump-server will reboot the client
              without performing a dump.

              netdump-reboot - This is run when netdump-server is finished
              with a client and is about to tell the client to reboot itself.

              The four executable scripts are run in the foreground by the
              netdump-server, so any time-consuming task done by the scripts
              will block the netdump-server from servicing any crash or log
              requests from any other source.  Therefore it may be advisable
              to run any time-consuming tasks in the background, allowing the
              script to return back to the netdump-server.


SEE ALSO
       netdump(8)


BUGS
       Report any bugs you find to http://bugzilla.redhat.com/bugzilla


AUTHOR
       Alexander Larsson <alexl@redhat.com>



Linux                             14 Feb 2002                NETDUMP-SERVER(8)