power_ipmi.pm 4.84 KB
Newer Older
1 2 3 4
#!/usr/bin/perl -w

#
# Copyright (c) 2000-2003, 2006-2007 University of Utah and the Flux Group.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file 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 Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
#

#
# module for controlling SuperMicro IPMI cards
# needs a working "/usr/local/bin/ipmitool" binary installed
# (try pkg_add -r ipmitool)
#
# supports new(ip), power(on|off|cyc[le]), status
#

package power_ipmi;

$| = 1; # Turn off line buffering on output

use strict;
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin'; # Required when using system() or backticks `` in combination with the perl -T taint checks

sub new($$;$) {

    # The next two lines are some voodoo taken from perltoot(1)
    my $proto = shift;
    my $class = ref($proto) || $proto;

    my $devicename = shift;
    my $debug = shift;

    if (!defined($debug)) {
        $debug = 0;
    }

    if ($debug) {
        print "power_ipmi module initializing... debug level $debug\n";
    }

    my $self = {};

    $self->{DEBUG} = $debug;

    $self->{DEVICENAME} = $devicename;
    $self->{un} = "ADMIN";              # default username
    $self->{pw} = "ADMIN";              # default password

    # Do a quick query, to see if it works
    system("ipmitool -H $self->{DEVICENAME} -U $self->{un} -P $self->{pw} power status >/dev/null 2>\&1");
    if ( $? != 0 ) {                    # system() sets $? to a non-zero value in case of failure
        warn "ERROR: Unable to connect to $devicename via IPMI\n";
        return undef;
    }
    else {
        bless($self,$class);
        return $self;
    }
}

sub power {
    my $self = shift;
    my $op = shift;
    my @ports = @_;   # Doesn't really matter, an IPMI card only has a single "outlet", which is for the node the card is installed in

    my $errors = 0;
    my ($retval, $output);

    if    ($op eq "on")  { $op = "power on";    }
    elsif ($op eq "off") { $op = "power off";   }
    elsif ($op =~ /cyc/) { $op = "power reset"; }

    ($retval,$output) = $self->_execipmicmd($op);
    if ( $retval != 0 ) {        # increment $errors if return value was not 0
        $errors++;
        print STDERR $self->{DEVICENAME}, ": could not control power status of device\n";
    }

    return $errors;
}

sub status {
    my $self = shift;
    my $statusp = shift; # pointer to an associative (hashed) array (i.o.w. passed by reference)
    my %status;          # local associative array which we'll pass back through $statusp

    my $errors = 0;
    my ($retval, $output);


    # Get power status (i.e. whether system is on/off)
    ($retval,$output) = $self->_execipmicmd("power status");
    if ( $retval != 0 ) {
        $errors++;
        print STDERR $self->{DEVICENAME}, ": could not get power status from device\n";
    }
    else { $status{'outlet1'} = $output; print("Power status is: $output\n") if $self->{DEBUG}; } # there's only 1 "outlet" on an IPMI card


    # Get Sensor Data Repository (sdr) entries and readings
    ($retval,$output) = $self->_execipmicmd("sdr");
    if ( $retval != 0 ) {
        $errors++;
        print STDERR $self->{DEVICENAME}, ": could not get sensor data from device\n";
    }
    else { $status{'sdr'} = $output; print("SDR data is:\n$output\n") if $self->{DEBUG}; }


    if ($statusp) { %$statusp = %status; } # update passed-by-reference array
    return $errors;
}

sub _execipmicmd {                         # _ indicates that this is a private method (Perl convention)
    my ($self,$op) = @_;
    my $ipmicmd = "ipmitool -H $self->{DEVICENAME} -U $self->{un} -P $self->{pw} "; # ipmitool command syntax, to be completed
                                                                                    # with an operation to perform
    my $cmd = $ipmicmd . $op;
    my $output;

    if ( $self->{DEBUG} > 1 ) {
        print STDERR "**** Executing $cmd\n";
        $output = `$cmd`;                  # get output of the $cmd, e.g. many lines of sensor readings or "Chassis power is on"
        chomp ( $output );                 # remove the \n at the end, if any
    }
    else { $output = `$cmd 2>/dev/null`; } # if there's any stderr output, silence it
                                           # (system() and backticks `` execute the command using the /bin/sh shell)

    return ($?, $output);
}

# End with true
1;