Code

Added multiline output capability to check_by_ssh. Thanks to Matthias Flacke (#1769653)
[nagiosplug.git] / plugins / check_by_ssh.c
index b777b072f65d9d325b8ef873bb93f0a4d55c22fc..7306e743da5cb162a9179713b6f6c6eff64eafc5 100644 (file)
@@ -1,26 +1,39 @@
 /******************************************************************************
-
- The Nagios Plugins are free software; you can redistribute them
- and/or modify them under the terms of the GNU General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
- $Id$
- *****************************************************************************/
+*
+* Nagios check_by_ssh plugin
+*
+* License: GPL
+* Copyright (c) 1999-2006 nagios-plugins team
+*
+* Last Modified: $Date$
+*
+* Description:
+*
+* This file contains the check_by_ssh plugin
+*
+* License Information:
+*
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 2 of the License, or
+* (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*
+* $Id$
+* 
+******************************************************************************/
  
 const char *progname = "check_by_ssh";
 const char *revision = "$Revision$";
-const char *copyright = "2000-2004";
+const char *copyright = "2000-2006";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
@@ -33,9 +46,10 @@ int validate_arguments (void);
 void print_help (void);
 void print_usage (void);
 
-int commands = 0;
-int services = 0;
-int skip = 0;
+unsigned int commands = 0;
+unsigned int services = 0;
+int skip_stdout = 0;
+int skip_stderr = 0;
 char *remotecmd = NULL;
 char *comm = NULL;
 char *hostname = NULL;
@@ -79,17 +93,28 @@ main (int argc, char **argv)
                printf ("%s\n", comm);
 
        result = np_runcmd(comm, &chld_out, &chld_err, 0);
-       /* UNKNOWN if output found on stderr */
-       if(chld_err.buflen) {
-               printf(_("Remote command execution failed: %s\n"),
-                          chld_err.buflen ? chld_err.buf : _("Unknown error"));
+
+       if (skip_stdout == -1) /* --skip-stdout specified without argument */
+               skip_stdout = chld_out.lines;
+       if (skip_stderr == -1) /* --skip-stderr specified without argument */
+               skip_stderr = chld_err.lines;
+
+       /* UNKNOWN if (non-skipped) output found on stderr */
+       if(chld_err.lines > skip_stderr) {
+               printf (_("Remote command execution failed: %s\n"),
+                       chld_err.line[skip_stderr]);
                return STATE_UNKNOWN;
        }
 
        /* this is simple if we're not supposed to be passive.
         * Wrap up quickly and keep the tricks below */
        if(!passive) {
-               printf ("%s\n", skip < chld_out.lines ? chld_out.line[skip] : chld_out.buf);
+               if (chld_out.lines > skip_stdout)
+                       for (i = skip_stdout; i < chld_out.lines; i++)
+                               puts (chld_out.line[i]);
+               else
+                       printf (_("%s - check_by_ssh: Remote command '%s' returned status %d\n"),
+                               state_text(result), remotecmd, result);
                return result;  /* return error status from remote command */
        }
 
@@ -106,7 +131,7 @@ main (int argc, char **argv)
 
        local_time = time (NULL);
        commands = 0;
-       for(i = skip; chld_out.line[i]; i++) {
+       for(i = skip_stdout; i < chld_out.lines; i++) {
                status_text = strstr (chld_out.line[i], "STATUS CODE: ");
                if (status_text == NULL) {
                        printf ("%s", chld_out.line[i]);
@@ -148,11 +173,15 @@ process_arguments (int argc, char **argv)
                {"user", required_argument, 0, 'u'},
                {"logname", required_argument, 0, 'l'},
                {"command", required_argument, 0, 'C'},
-               {"skip", required_argument, 0, 'S'},
+               {"skip", optional_argument, 0, 'S'}, /* backwards compatibility */
+               {"skip-stdout", optional_argument, 0, 'S'},
+               {"skip-stderr", optional_argument, 0, 'E'},
                {"proto1", no_argument, 0, '1'},
                {"proto2", no_argument, 0, '2'},
                {"use-ipv4", no_argument, 0, '4'},
                {"use-ipv6", no_argument, 0, '6'},
+               {"ssh-option", required_argument, 0, 'o'},
+               {"quiet", no_argument, 0, 'q'},
                {0, 0, 0, 0}
        };
 
@@ -164,7 +193,7 @@ process_arguments (int argc, char **argv)
                        strcpy (argv[c], "-t");
 
        while (1) {
-               c = getopt_long (argc, argv, "Vvh1246ft:H:O:p:i:u:l:C:S:n:s:", longopts,
+               c = getopt_long (argc, argv, "Vvh1246fqt:H:O:p:i:u:l:C:S::E::n:s:o:", longopts,
                                 &option);
 
                if (c == -1 || c == EOF)
@@ -234,14 +263,30 @@ process_arguments (int argc, char **argv)
                                asprintf (&remotecmd, "%s;echo STATUS CODE: $?;", remotecmd);
                        asprintf (&remotecmd, "%s%s", remotecmd, optarg);
                        break;
-               case 'S':                                                                       /* Skip n lines in the output to ignore system banner */
-                       if (!is_integer (optarg))
-                               usage_va(_("skip lines must be an integer"));
+               case 'S':                                                                       /* skip n (or all) lines on stdout */
+                       if (optarg == NULL)
+                               skip_stdout = -1; /* skip all output on stdout */
+                       else if (!is_integer (optarg))
+                               usage_va(_("skip-stdout argument must be an integer"));
                        else
-                               skip = atoi (optarg);
+                               skip_stdout = atoi (optarg);
+                       break;
+               case 'E':                                                                       /* skip n (or all) lines on stderr */
+                       if (optarg == NULL)
+                               skip_stderr = -1; /* skip all output on stderr */
+                       else if (!is_integer (optarg))
+                               usage_va(_("skip-stderr argument must be an integer"));
+                       else
+                               skip_stderr = atoi (optarg);
+                       break;
+               case 'o':                                                                       /* Extra options for the ssh command */
+                       asprintf (&comm, "%s -%c '%s'", comm, c, optarg);
+                       break;
+               case 'q':                                                                       /* Tell the ssh command to be quiet */
+                       asprintf (&comm, "%s -%c", comm, c);
                        break;
                default:                                                                        /* help */
-                       usage_va(_("Unknown argument - %s"), optarg);
+                       usage5();
                }
        }
 
@@ -299,8 +344,10 @@ print_help (void)
        printf ("Copyright (c) 1999 Karl DeBisschop <kdebisschop@users.sourceforge.net>\n");
        printf (COPYRIGHT, copyright, email);
 
-       printf (_("This plugin uses SSH to execute commands on a remote host\n\n"));
+       printf (_("This plugin uses SSH to execute commands on a remote host"));
 
+  printf ("\n\n");
+  
        print_usage ();
 
        printf (_(UT_HELP_VRSN));
@@ -309,56 +356,51 @@ print_help (void)
 
        printf (_(UT_IPv46));
 
-       printf (_("\
- -1, --proto1\n\
-    tell ssh to use Protocol 1\n\
- -2, --proto2\n\
-    tell ssh to use Protocol 2\n\
- -S, --skiplines=n\n\
-    Ignore first n lines on STDERR (to suppress a logon banner)\n\
- -f\n\
-    tells ssh to fork rather than create a tty\n"));
-
-       printf (_("\
- -C, --command='COMMAND STRING'\n\
-    command to execute on the remote machine\n\
- -l, --logname=USERNAME\n\
-    SSH user name on remote host [optional]\n\
- -i, --identity=KEYFILE\n\
-    identity of an authorized key [optional]\n\
- -O, --output=FILE\n\
-    external command file for nagios [optional]\n\
- -s, --services=LIST\n\
-    list of nagios service names, separated by ':' [optional]\n\
- -n, --name=NAME\n\
-    short name of host in nagios configuration [optional]\n"));
-
+  printf (" %s\n", "-1, --proto1");
+  printf ("    %s\n", _("tell ssh to use Protocol 1 [optional]"));
+  printf (" %s\n", "-2, --proto2");
+  printf ("    %s\n", _("tell ssh to use Protocol 2 [optional]"));
+  printf (" %s\n", "-S, --skip-stdout[=n]");
+  printf ("    %s\n", _("Ignore all or (if specified) first n lines on STDOUT [optional]"));
+  printf (" %s\n", "-E, --skip-stderr[=n]");
+  printf ("    %s\n", _("Ignore all or (if specified) first n lines on STDERR [optional]"));
+  printf (" %s\n", "-f");
+  printf ("    %s\n", _("tells ssh to fork rather than create a tty [optional]"));
+  printf (" %s\n","-C, --command='COMMAND STRING'");
+  printf ("    %s\n", _("command to execute on the remote machine"));
+  printf (" %s\n","-l, --logname=USERNAME");
+  printf ("    %s\n", _("SSH user name on remote host [optional]"));
+  printf (" %s\n","-i, --identity=KEYFILE");
+  printf ("    %s\n", _("identity of an authorized key [optional]"));
+  printf (" %s\n","-O, --output=FILE");
+  printf ("    %s\n", _("external command file for nagios [optional]"));
+  printf (" %s\n","-s, --services=LIST");
+  printf ("    %s\n", _("list of nagios service names, separated by ':' [optional]"));
+  printf (" %s\n","-n, --name=NAME");
+  printf ("    %s\n", _("short name of host in nagios configuration [optional]"));
+  printf (" %s\n","-o, --ssh-option=OPTION");
+  printf ("    %s\n", _("Call ssh with '-o OPTION' (may be used multiple times) [optional]"));
+  printf (" %s\n","-q, --quiet");
+  printf ("    %s\n", _("Tell ssh to suppress warning and diagnostic messages [optional]"));
        printf (_(UT_WARN_CRIT));
-
        printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
-
-       printf (_("\n\
-The most common mode of use is to refer to a local identity file with\n\
-the '-i' option. In this mode, the identity pair should have a null\n\
-passphrase and the public key should be listed in the authorized_keys\n\
-file of the remote host. Usually the key will be restricted to running\n\
-only one command on the remote server. If the remote SSH server tracks\n\
-invocation agruments, the one remote program may be an agent that can\n\
-execute additional commands as proxy\n"));
-
-       printf (_("\n\
-To use passive mode, provide multiple '-C' options, and provide\n\
-all of -O, -s, and -n options (servicelist order must match '-C'\n\
-options)\n"));
-
-       printf ("\n\
-$ check_by_ssh -H localhost -n lh -s c1:c2:c3 \\\n\
-    -C uptime -C uptime -C uptime -O /tmp/foo\n\
-$ cat /tmp/foo\n\
-[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c1;0; up 2 days...\n\
-[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c2;0; up 2 days...\n\
-[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c3;0; up 2 days...\n");
-
+  printf (" %s\n", _("The most common mode of use is to refer to a local identity file with"));
+  printf (" %s\n", _("the '-i' option. In this mode, the identity pair should have a null"));
+  printf (" %s\n", _("passphrase and the public key should be listed in the authorized_keys"));
+  printf (" %s\n", _("file of the remote host. Usually the key will be restricted to running"));
+  printf (" %s\n", _("only one command on the remote server. If the remote SSH server tracks"));
+  printf (" %s\n", _("invocation arguments, the one remote program may be an agent that can"));
+  printf (" %s\n", _("execute additional commands as proxy"));
+  printf (" %s\n", _("To use passive mode, provide multiple '-C' options, and provide"));
+  printf (" %s\n", _("all of -O, -s, and -n options (servicelist order must match '-C'options)"));
+  printf ("\n");
+  printf ("%s\n", _("Examples:"));
+  printf (" %s\n", "$ check_by_ssh -H localhost -n lh -s c1:c2:c3 -C uptime -C uptime -C uptime -O /tmp/foo");
+  printf (" %s\n", "$ cat /tmp/foo");
+  printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c1;0; up 2 days");
+  printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c2;0; up 2 days");
+  printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c3;0; up 2 days");
+       printf (_(UT_VERBOSE));
        printf (_(UT_SUPPORT));
 }
 
@@ -367,7 +409,10 @@ $ cat /tmp/foo\n\
 void
 print_usage (void)
 {
-       printf ("\n\
-Usage: %s [-f46] [-t timeout] [-i identity] [-l user] -H <host> -C <command>\n\
-                  [-n name] [-s servicelist] [-O outputfile] [-p port]\n", progname);
+       printf (_("Usage:"));
+       printf (" %s -H <host> -C <command> [-fqv] [-1|-2] [-4|-6]\n"
+               "       [-S [lines]] [-E [lines]] [-t timeout] [-i identity]\n"
+               "       [-l user] [-n name] [-s servicelist] [-O outputfile]\n"
+               "       [-p port] [-o ssh-option]\n",
+               progname);
 }