plugins/check_hpjd.c

   1 /******************************************************************************
   2 *
   3 * CHECK_HPJD.C
   4 *
   5 * Program: HP printer plugin for Nagios
   6 * License: GPL
   7 * Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)
   8 *
   9 * Last Modified: $Date$
  10 *
  11 * Command line: CHECK_HPJD <ip_address> [community]
  12 *
  13 * Description:
  14 *
  15 * This plugin will attempt to check the status of an HP printer.  The
  16 * printer must have a JetDirect card installed and TCP/IP protocol
  17 * stack enabled.  This plugin has only been tested on a few printers
  18 * and may not work well on all models of JetDirect cards.  Multiple
  19 * port JetDirect devices must have an IP address assigned to each
  20 * port in order to be monitored.
  21 *
  22 * Dependencies:
  23 *
  24 * This plugin used the 'snmpget' command included with the UCD-SNMP
  25 * package.  If you don't have the package installed you will need to
  26 * download it from http://ucd-snmp.ucdavis.edu before you can use
  27 * this plugin.
  28 *
  29 * Return Values:
  30 *
  31 * UNKNOWN       = The plugin could not read/process the output from the printer
  32 * OK            = Printer looks normal
  33 * WARNING       = Low toner, paper jam, intervention required, paper out, etc.
  34 * CRITICAL      = The printer could not be reached (it's probably turned off)
  35 *
  36 * Acknowledgements:
  37 *
  38 * The idea for the plugin (as well as some code) were taken from Jim
  39 * Trocki's pinter alert script in his "mon" utility, found at
  40 * http://www.kernel.org/software/mon
  41 *
  42 * Notes:
  43 * 'JetDirect' is copyrighted by Hewlett-Packard.
  44 *                    HP, please don't sue me... :-)
  45 *
  46 * License Information:
  47 *
  48 * This program is free software; you can redistribute it and/or modify
  49 * it under the terms of the GNU General Public License as published by
  50 * the Free Software Foundation; either version 2 of the License, or
  51 * (at your option) any later version.
  52 *
  53 * This program is distributed in the hope that it will be useful,
  54 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  55 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  56 * GNU General Public License for more details.
  57 *
  58 * You should have received a copy of the GNU General Public License
  59 * along with this program; if not, write to the Free Software
  60 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  61 *
  62 *****************************************************************************/
  63
  64 #include "common.h"
  65 #include "popen.h"
  66 #include "utils.h"
  67
  68 const char *progname = "check_hpjd";
  69 #define REVISION "$Revision$"
  70 #define COPYRIGHT "2000-2002"
  71
  72 #define HPJD_LINE_STATUS                ".1.3.6.1.4.1.11.2.3.9.1.1.2.1"
  73 #define HPJD_PAPER_STATUS               ".1.3.6.1.4.1.11.2.3.9.1.1.2.2"
  74 #define HPJD_INTERVENTION_REQUIRED      ".1.3.6.1.4.1.11.2.3.9.1.1.2.3"
  75 #define HPJD_GD_PERIPHERAL_ERROR        ".1.3.6.1.4.1.11.2.3.9.1.1.2.6"
  76 #define HPJD_GD_PAPER_JAM               ".1.3.6.1.4.1.11.2.3.9.1.1.2.8"
  77 #define HPJD_GD_PAPER_OUT               ".1.3.6.1.4.1.11.2.3.9.1.1.2.9"
  78 #define HPJD_GD_TONER_LOW               ".1.3.6.1.4.1.11.2.3.9.1.1.2.10"
  79 #define HPJD_GD_PAGE_PUNT               ".1.3.6.1.4.1.11.2.3.9.1.1.2.11"
  80 #define HPJD_GD_MEMORY_OUT              ".1.3.6.1.4.1.11.2.3.9.1.1.2.12"
  81 #define HPJD_GD_DOOR_OPEN               ".1.3.6.1.4.1.11.2.3.9.1.1.2.17"
  82 #define HPJD_GD_PAPER_OUTPUT            ".1.3.6.1.4.1.11.2.3.9.1.1.2.19"
  83 #define HPJD_GD_STATUS_DISPLAY          ".1.3.6.1.4.1.11.2.3.9.1.1.3"
  84
  85 #define ONLINE          0
  86 #define OFFLINE         1
  87
  88 #define DEFAULT_COMMUNITY "public"
  89
  90 int process_arguments (int, char **);
  91 int validate_arguments (void);
  92 void print_help (void);
  93 void print_usage (void);
  94
  95 char *community = DEFAULT_COMMUNITY;
  96 char *address = NULL;
  97
  98
  99 int
 100 main (int argc, char **argv)
 101 {
 102         char command_line[1024];
 103         int result;
 104         int line;
 105         char input_buffer[MAX_INPUT_BUFFER];
 106         char query_string[512];
 107         char error_message[MAX_INPUT_BUFFER];
 108         char *temp_buffer;
 109         int line_status = ONLINE;
 110         int paper_status = 0;
 111         int intervention_required = 0;
 112         int peripheral_error = 0;
 113         int paper_jam = 0;
 114         int paper_out = 0;
 115         int toner_low = 0;
 116         int page_punt = 0;
 117         int memory_out = 0;
 118         int door_open = 0;
 119         int paper_output = 0;
 120         char display_message[MAX_INPUT_BUFFER];
 121
 122         if (process_arguments (argc, argv) != OK)
 123                 usage ("Invalid command arguments supplied\n");
 124
 125         /* removed ' 2>1' at end of command 10/27/1999 - EG */
 126         /* create the query string */
 127         sprintf
 128                 (query_string,
 129                  "%s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0 %s.0",
 130                  HPJD_LINE_STATUS,
 131                  HPJD_PAPER_STATUS,
 132                  HPJD_INTERVENTION_REQUIRED,
 133                  HPJD_GD_PERIPHERAL_ERROR,
 134                  HPJD_GD_PAPER_JAM,
 135                  HPJD_GD_PAPER_OUT,
 136                  HPJD_GD_TONER_LOW,
 137                  HPJD_GD_PAGE_PUNT,
 138                  HPJD_GD_MEMORY_OUT,
 139                  HPJD_GD_DOOR_OPEN, HPJD_GD_PAPER_OUTPUT, HPJD_GD_STATUS_DISPLAY);
 140
 141         /* get the command to run */
 142         sprintf (command_line, "%s -m : -v 1 %s -c %s %s", PATH_TO_SNMPGET, address,
 143                                          community, query_string);
 144
 145         /* run the command */
 146         child_process = spopen (command_line);
 147         if (child_process == NULL) {
 148                 printf ("Could not open pipe: %s\n", command_line);
 149                 return STATE_UNKNOWN;
 150         }
 151
 152         child_stderr = fdopen (child_stderr_array[fileno (child_process)], "r");
 153         if (child_stderr == NULL) {
 154                 printf ("Could not open stderr for %s\n", command_line);
 155         }
 156
 157         result = STATE_OK;
 158
 159         line = 0;
 160         while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process)) {
 161
 162                 /* strip the newline character from the end of the input */
 163                 if (input_buffer[strlen (input_buffer) - 1] == '\n')
 164                         input_buffer[strlen (input_buffer) - 1] = 0;
 165
 166                 line++;
 167
 168                 temp_buffer = strtok (input_buffer, "=");
 169                 temp_buffer = strtok (NULL, "=");
 170
 171                 switch (line) {
 172
 173                 case 1:                                                                         /* 1st line should contain the line status */
 174                         if (temp_buffer != NULL)
 175                                 line_status = atoi (temp_buffer);
 176                         else {
 177                                 result = STATE_UNKNOWN;
 178                                 strcpy (error_message, input_buffer);
 179                         }
 180                         break;
 181
 182                 case 2:                                                                         /* 2nd line should contain the paper status */
 183                         if (temp_buffer != NULL)
 184                                 paper_status = atoi (temp_buffer);
 185                         else {
 186                                 result = STATE_UNKNOWN;
 187                                 strcpy (error_message, input_buffer);
 188                         }
 189                         break;
 190
 191                 case 3:                                                                         /* 3rd line should be intervention required */
 192                         if (temp_buffer != NULL)
 193                                 intervention_required = atoi (temp_buffer);
 194                         else {
 195                                 result = STATE_UNKNOWN;
 196                                 strcpy (error_message, input_buffer);
 197                         }
 198                         break;
 199
 200                 case 4:                                                                         /* 4th line should be peripheral error */
 201                         if (temp_buffer != NULL)
 202                                 peripheral_error = atoi (temp_buffer);
 203                         else {
 204                                 result = STATE_UNKNOWN;
 205                                 strcpy (error_message, input_buffer);
 206                         }
 207                         break;
 208
 209                 case 5:                                                                         /* 5th line should contain the paper jam status */
 210                         if (temp_buffer != NULL)
 211                                 paper_jam = atoi (temp_buffer);
 212                         else {
 213                                 result = STATE_UNKNOWN;
 214                                 strcpy (error_message, input_buffer);
 215                         }
 216                         break;
 217
 218                 case 6:                                                                         /* 6th line should contain the paper out status */
 219                         if (temp_buffer != NULL)
 220                                 paper_out = atoi (temp_buffer);
 221                         else {
 222                                 result = STATE_UNKNOWN;
 223                                 strcpy (error_message, input_buffer);
 224                         }
 225                         break;
 226
 227                 case 7:                                                                         /* 7th line should contain the toner low status */
 228                         if (temp_buffer != NULL)
 229                                 toner_low = atoi (temp_buffer);
 230                         else {
 231                                 result = STATE_UNKNOWN;
 232                                 strcpy (error_message, input_buffer);
 233                         }
 234                         break;
 235
 236                 case 8:                                                                         /* did data come too slow for engine */
 237                         if (temp_buffer != NULL)
 238                                 page_punt = atoi (temp_buffer);
 239                         else {
 240                                 result = STATE_UNKNOWN;
 241                                 strcpy (error_message, input_buffer);
 242                         }
 243                         break;
 244
 245                 case 9:                                                                         /* did we run out of memory */
 246                         if (temp_buffer != NULL)
 247                                 memory_out = atoi (temp_buffer);
 248                         else {
 249                                 result = STATE_UNKNOWN;
 250                                 strcpy (error_message, input_buffer);
 251                         }
 252                         break;
 253
 254                 case 10:                                                                                /* is there a door open */
 255                         if (temp_buffer != NULL)
 256                                 door_open = atoi (temp_buffer);
 257                         else {
 258                                 result = STATE_UNKNOWN;
 259                                 strcpy (error_message, input_buffer);
 260                         }
 261                         break;
 262
 263                 case 11:                                                                                /* is output tray full */
 264                         if (temp_buffer != NULL)
 265                                 paper_output = atoi (temp_buffer);
 266                         else {
 267                                 result = STATE_UNKNOWN;
 268                                 strcpy (error_message, input_buffer);
 269                         }
 270                         break;
 271
 272                 case 12:                                                                                /* display panel message */
 273                         if (temp_buffer != NULL)
 274                                 strcpy (display_message, temp_buffer + 1);
 275                         else {
 276                                 result = STATE_UNKNOWN;
 277                                 strcpy (error_message, input_buffer);
 278                         }
 279                         break;
 280
 281                 default:
 282                         break;
 283                 }
 284
 285                 /* break out of the read loop if we encounter an error */
 286                 if (result != STATE_OK)
 287                         break;
 288         }
 289
 290         /* WARNING if output found on stderr */
 291         if (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_stderr))
 292                 result = max_state (result, STATE_WARNING);
 293
 294         /* close stderr */
 295         (void) fclose (child_stderr);
 296
 297         /* close the pipe */
 298         if (spclose (child_process))
 299                 result = max_state (result, STATE_WARNING);
 300
 301         /* if there wasn't any output, display an error */
 302         if (line == 0) {
 303
 304                 /*
 305                    result=STATE_UNKNOWN;
 306                    strcpy(error_message,"Error: Could not read plugin output\n");
 307                  */
 308
 309                 /* might not be the problem, but most likely is.. */
 310                 result = STATE_UNKNOWN;
 311                 sprintf (error_message, "Timeout: No response from %s\n", address);
 312         }
 313
 314         /* if we had no read errors, check the printer status results... */
 315         if (result == STATE_OK) {
 316
 317                 if (paper_jam) {
 318                         result = STATE_WARNING;
 319                         strcpy (error_message, "Paper Jam");
 320                 }
 321                 else if (paper_out) {
 322                         result = STATE_WARNING;
 323                         strcpy (error_message, "Out of Paper");
 324                 }
 325                 else if (line_status == OFFLINE) {
 326                         if (strcmp (error_message, "POWERSAVE ON") != 0) {
 327                                 result = STATE_WARNING;
 328                                 strcpy (error_message, "Printer Offline");
 329                         }
 330                 }
 331                 else if (peripheral_error) {
 332                         result = STATE_WARNING;
 333                         strcpy (error_message, "Peripheral Error");
 334                 }
 335                 else if (intervention_required) {
 336                         result = STATE_WARNING;
 337                         strcpy (error_message, "Intervention Required");
 338                 }
 339                 else if (toner_low) {
 340                         result = STATE_WARNING;
 341                         strcpy (error_message, "Toner Low");
 342                 }
 343                 else if (memory_out) {
 344                         result = STATE_WARNING;
 345                         strcpy (error_message, "Insufficient Memory");
 346                 }
 347                 else if (door_open) {
 348                         result = STATE_WARNING;
 349                         strcpy (error_message, "A Door is Open");
 350                 }
 351                 else if (paper_output) {
 352                         result = STATE_WARNING;
 353                         strcpy (error_message, "Output Tray is Full");
 354                 }
 355                 else if (page_punt) {
 356                         result = STATE_WARNING;
 357                         strcpy (error_message, "Data too Slow for Engine");
 358                 }
 359                 else if (paper_status) {
 360                         result = STATE_WARNING;
 361                         strcpy (error_message, "Unknown Paper Error");
 362                 }
 363         }
 364
 365         if (result == STATE_OK)
 366                 printf ("Printer ok - (%s)\n", display_message);
 367
 368         else if (result == STATE_UNKNOWN) {
 369
 370                 printf ("%s\n", error_message);
 371
 372                 /* if printer could not be reached, escalate to critical */
 373                 if (strstr (error_message, "Timeout"))
 374                         result = STATE_CRITICAL;
 375         }
 376
 377         else if (result == STATE_WARNING)
 378                 printf ("%s (%s)\n", error_message, display_message);
 379
 380         return result;
 381 }
 382
 383
 384
 385
 386
 387 /* process command-line arguments */
 388 int
 389 process_arguments (int argc, char **argv)
 390 {
 391         int c;
 392
 393         int option_index = 0;
 394         static struct option long_options[] = {
 395                 {"hostname", required_argument, 0, 'H'},
 396                 {"community", required_argument, 0, 'C'},
 397 /*              {"critical",       required_argument,0,'c'}, */
 398 /*              {"warning",        required_argument,0,'w'}, */
 399 /*              {"port",           required_argument,0,'P'}, */
 400                 {"version", no_argument, 0, 'V'},
 401                 {"help", no_argument, 0, 'h'},
 402                 {0, 0, 0, 0}
 403         };
 404
 405         if (argc < 2)
 406                 return ERROR;
 407
 408
 409         while (1) {
 410                 c = getopt_long (argc, argv, "+hVH:C:", long_options, &option_index);
 411
 412                 if (c == -1 || c == EOF || c == 1)
 413                         break;
 414
 415                 switch (c) {
 416                 case 'H':                                                                       /* hostname */
 417                         if (is_host (optarg)) {
 418                                 address = strscpy(address, optarg) ;
 419                         }
 420                         else {
 421                                 usage ("Invalid host name\n");
 422                         }
 423                         break;
 424                 case 'C':                                                                       /* community */
 425                         community = strscpy (community, optarg);
 426                         break;
 427                 case 'V':                                                                       /* version */
 428                         print_revision (progname, REVISION);
 429                         exit (STATE_OK);
 430                 case 'h':                                                                       /* help */
 431                         print_help ();
 432                         exit (STATE_OK);
 433                 case '?':                                                                       /* help */
 434                         usage ("Invalid argument\n");
 435                 }
 436         }
 437
 438         c = optind;
 439         if (address == NULL) {
 440                 if (is_host (argv[c])) {
 441                         address = argv[c++];
 442                 }
 443                 else {
 444                         usage ("Invalid host name");
 445                 }
 446         }
 447
 448         if (argv[c] != NULL ) {
 449                 community = argv[c];
 450         }
 451
 452         return validate_arguments ();
 453 }
 454
 455
 456
 457
 458
 459 int
 460 validate_arguments (void)
 461 {
 462         return OK;
 463 }
 464
 465
 466
 467
 468
 469 void
 470 print_help (void)
 471 {
 472         print_revision (progname, REVISION);
 473         printf
 474                 ("Copyright (c) 2000 Ethan Galstad/Karl DeBisschop\n\n"
 475                  "This plugin tests the STATUS of an HP printer with a JetDirect card.\n"
 476                  "Net-snmp must be installed on the computer running the plugin.\n\n");
 477         print_usage ();
 478         printf
 479                 ("\nOptions:\n"
 480                  " -H, --hostname=STRING or IPADDRESS\n"
 481                  "   Check server on the indicated host\n"
 482                  " -C, --community=STRING\n"
 483                  "   The SNMP community name (default=%s)\n"
 484                  " -h, --help\n"
 485                  "   Print detailed help screen\n"
 486                  " -V, --version\n" "   Print version information\n\n",DEFAULT_COMMUNITY);
 487         support ();
 488 }
 489
 490
 491
 492
 493
 494 void
 495 print_usage (void)
 496 {
 497         printf
 498                 ("Usage: %s -H host [-C community]\n"
 499                  "       %s --help\n"
 500                  "       %s --version\n", progname, progname, progname);
 501 }
 502
 503
 504 /*
 505         if(argc<2||argc>3){
 506         printf("Incorrect number of arguments supplied\n");
 507         printf("\n");
 508         print_revision(argv[0],"$Revision$");
 509         printf("Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)\n");
 510         printf("License: GPL\n");
 511         printf("\n");
 512         printf("Usage: %s <ip_address> [community]\n",argv[0]);
 513         printf("\n");
 514         printf("Note:\n");
 515         printf(" <ip_address>     = The IP address of the JetDirect card\n");
 516         printf(" [community]      = An optional community string used for SNMP communication\n");
 517         printf("                    with the JetDirect card.  The default is 'public'.\n");
 518         printf("\n");
 519         return STATE_UNKNOWN;
 520         }
 521
 522         // get the IP address of the JetDirect device
 523         strcpy(address,argv[1]);
 524
 525         // get the community name to use for SNMP communication
 526         if(argc>=3)
 527         strcpy(community,argv[2]);
 528         else
 529         strcpy(community,"public");
 530 */