Difference between revisions of "Fence na.lib"

From AN!Wiki
Jump to: navigation, search
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 
{{na_header}}
 
{{na_header}}
  
This is the fence agent's function library that exists in <span class="code">/etc/na/</span>.
+
This is the fence agent's function library that exists in <span class="code">/etc/fence_na/</span>.
  
 +
* Download the [http://nodeassassin.org/files/fence_na/fence_na.lib source code].
 
<source lang="perl">
 
<source lang="perl">
 
#!/usr/bin/perl
 
#!/usr/bin/perl
Line 10: Line 11:
 
# Node Assassin - Fence Agent
 
# Node Assassin - Fence Agent
 
# Digimer; digimer@alteeve.com
 
# Digimer; digimer@alteeve.com
# Mar. 07, 2010.
+
# Jun. 27, 2010.
# Version: 0.1.004
+
# Version: 1.1.5
 
#
 
#
 +
# This software is released under the GPL v2. See the LICENSE file for a copy
 +
# of the GPL v2.
  
 +
 +
# This connects to a Node Assassin and puts the handle in
 +
# $conf->{'system'}{handle}.
 +
sub connect_to_na
 +
{
 +
my ($conf, $log)=@_;
 +
$conf->{na}{handle}=new Net::Telnet(
 +
Timeout => 10,
 +
Errmode => 'die',
 +
Port => $conf->{na}{tcp_port},
 +
Prompt => '/EOM$/',
 +
Errmode => 'return'
 +
) or do_exit($conf, $log, 1);
 +
$conf->{na}{handle}->open($conf->{na}{ipaddr});
 +
if ($conf->{na}{handle}->errmsg)
 +
{
 +
record($conf, $log, "Connection to Node Assassin: [$conf->{na}{ipaddr}] failed.\nError was: [".$conf->{na}{handle}->errmsg."]\n", 1);
 +
$conf->{na}{handle}="";
 +
};
 +
record($conf, $log, "na::handle: [$conf->{na}{handle}]\n") if $conf->{'system'}{debug};
 +
 +
return ($conf->{na}{handle});
 +
}
 +
 +
# This handles the actual execution of an action plan.
 +
sub do_actions
 +
{
 +
my ($conf, $log)=@_;
 +
 +
# In the next step, when a 'check' is seen, the node's power feed is
 +
# checked and an exit status is stored here. Exits 0, 1 and 2 have
 +
# special meaning, so I default to 9 as it has no meaning to the
 +
# FenceAgentAPI.
 +
my $exit_code=9;
 +
 +
# Process the orders.
 +
print "Processing: [$conf->{'system'}{call_order}]\n";
 +
foreach my $order (split/,/, $conf->{'system'}{call_order})
 +
{
 +
record($conf, $log, "Calling: [$order]\n") if $conf->{'system'}{debug};
 +
 +
# Handle a 'release_all' call.
 +
if ($order eq "release_all")
 +
{
 +
set_all_state($conf, $log, 0);
 +
next;
 +
}
 +
 +
# Handle a 'fence_all' call.
 +
if ($order eq "fence_all")
 +
{
 +
set_all_state($conf, $log, 1);
 +
next;
 +
}
 +
 +
# handle a sleep request. This defaults to one second when no
 +
# integer was included.
 +
if ($order=~/^sleep/)
 +
{
 +
my $time=$order=~/sleep (\d+)/ ? $1 : 1;
 +
record ($conf, $log, "Sleeping: $time, ");
 +
if ($time == 1)
 +
{
 +
sleep 1;
 +
record ($conf, $log, "Done.\n");
 +
}
 +
else
 +
{
 +
while ($time)
 +
{
 +
$time--;
 +
sleep 1;
 +
record ($conf, $log, "$time, ") if $time > 1;
 +
record ($conf, $log, "$time. Done.\n") if $time == 1;
 +
}
 +
}
 +
next;
 +
}
 +
 +
# Handle a status check via Node Assassin.
 +
record($conf, $log, "order: [$order]\n") if $conf->{'system'}{debug};
 +
if ($order=~/(\d\d):(\D+)/)
 +
{
 +
my $node=$1;
 +
my $check=$2;
 +
 +
# Verify the state of the port.
 +
record($conf, $log, "Status check on node: [$node] -> [$check]\n") if $conf->{'system'}{debug};
 +
 +
# Get the state.
 +
my $states=get_states($conf, $log);
 +
if ($states == 1)
 +
{
 +
# I had a connection problem. Exit with error
 +
# code '1' as per:
 +
# http://sources.redhat.com/cluster/wiki/FenceAgentAPI
 +
do_exit($conf, $log, 1);
 +
}
 +
 +
# Make the states a bit easier to type.
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
 +
# Return the status of the requested node.
 +
record($conf, $log, "Node Assassin: [#$conf->{'system'}{na_id}/$conf->{na}{na_name}], Node: [$node] Power/Reset/Feed states: [$power_state/$reset_state/$feed_state]\n") if $conf->{'system'}{debug};
 +
if ($check eq "check")
 +
{
 +
# Return '2' if the node is off and '0' if it
 +
# is on.
 +
$exit_code=$feed_state ? 0 : 2;
 +
}
 +
elsif ($check eq "off")
 +
{
 +
# 'off' was called, make sure the node is now
 +
# off. This may be called by 'reboot' in which
 +
# case 'exit_code' will simply be over-written
 +
# when the final 'reboot' state check is called.
 +
$exit_code=$feed_state ? 1 : 0;
 +
}
 +
elsif ($check eq "on")
 +
{
 +
# 'on' was called, make sure the node is now
 +
# off.
 +
$exit_code=$feed_state ? 0 : 1;
 +
}
 +
elsif ($check eq "reboot")
 +
{
 +
# Make sure that 'exit_code' was set to '0' by
 +
# the earlier call. We checked again to make
 +
# sure the node came back up, and will log an
 +
# error if it didn't, but we return '0' just
 +
# the same, as per the API.
 +
if (not $exit_code)
 +
{
 +
# The power off portion worked. Check if the
 +
# node booted properly and record an error if
 +
# not.
 +
if (not $feed_state)
 +
{
 +
record($conf, $log, "\nWARNING: Node: [$node] failed to boot after a successful power off during a\n", 1);
 +
record($conf, $log, "WARNING: reboot action. This is a non-critical error as the node was fenced\n", 1);
 +
record($conf, $log, "WARNING: successfully but may indicate a hardware failure with the node or\n", 1);
 +
record($conf, $log, "WARNING: with Node Assassin itself.\n\n", 1);
 +
}
 +
}
 +
else
 +
{
 +
# The power off portion failed, exit with '1'.
 +
$exit_code=1;
 +
}
 +
$exit_code=$feed_state ? 0 : 1;
 +
}
 +
next;
 +
}
 +
 +
# Handle a fence call.
 +
my @set_state=$conf->{na}{handle}->cmd("$order");
 +
foreach my $line (@set_state)
 +
{
 +
chomp $line;
 +
next if not $line;
 +
record($conf, $log, "$line\n");
 +
}
 +
record($conf, $log, "Call complete.\n") if $conf->{'system'}{debug};
 +
}
 +
 +
return ($exit_code);
 +
}
  
 
# This cleanly exits the agent.
 
# This cleanly exits the agent.
Line 21: Line 193:
 
$exit_status=9 if not defined $exit_status;
 
$exit_status=9 if not defined $exit_status;
 
 
$conf->{node}{handle}->close;
+
# Close the Node Assassin and log file handle, if they exist.
$log->close();
+
$conf->{na}{handle}->close() if $conf->{na}{handle};
 +
$log->close() if $log;
 +
 
exit ($exit_status);
 
exit ($exit_status);
 
}
 
}
Line 33: Line 207:
 
 
 
# Create the hash reference to store the states in.
 
# Create the hash reference to store the states in.
my $state={};
+
my $states={};
 
 
 
# Call '00:0' to get the states. If it fails, return 1 as per
 
# Call '00:0' to get the states. If it fails, return 1 as per
 
# FenceAgentAPI requirements.
 
# FenceAgentAPI requirements.
my @check_state=$conf->{node}{handle}->cmd("00:0") or return(1);
+
my @check_state=$conf->{na}{handle}->cmd("00:0") or return(1);
 
 
 
# Loop through the output.
 
# Loop through the output.
Line 44: Line 218:
 
# Chomp the newline off and then pull the port and state out.
 
# Chomp the newline off and then pull the port and state out.
 
chomp $line;
 
chomp $line;
my ($this_node, $this_state)=($line=~/(\d+): (.*)$/);
+
my ($this_node, $power_state, $reset_state, $feed_state)=($line=~/^- Node (\d+): P(\d+), R(\d+), F(\d+)$/);
 
# Skip if this isn't a status line.
 
# Skip if this isn't a status line.
next if ((not $this_node) || (not $this_state));
+
next if not $this_node;
 
# Convert the state to a simple on/off.
 
# Convert the state to a simple on/off.
$this_state=$this_state =~ /fenced/i ? "off" : "on";
 
 
# Store the state.
 
# Store the state.
$state->{$this_node}=$this_state;
+
$states->{$this_node}{power_state}=$power_state;
record($conf, $log, "state->{$this_node}: [$state->{$this_node}]\n");
+
$states->{$this_node}{reset_state}=$reset_state;
 +
$states->{$this_node}{feed_state}=$feed_state;
 +
record($conf, $log, "Node: [$this_node], Power State: [$states->{$this_node}{power_state}], Reset State: [$states->{$this_node}{reset_state}], Feed State: [$states->{$this_node}{feed_state}].\n") if $conf->{'system'}{debug};
 
}
 
}
 
 
 
# Return the hash reference.
 
# Return the hash reference.
return ($state);
+
return ($states);
 
}
 
}
  
Line 62: Line 237:
 
{
 
{
 
my ($conf, $log)=@_;
 
my ($conf, $log)=@_;
my $msg=q`
 
Node Assassin Fencing Agent
 
 
This program interfaces with one or more Node Assassin fence devices to
 
set one or more nodes to one or more states.
 
 
Usage:
 
 
Arguments are read from STDIN as 'variable=value' pairs, one pair per
 
new line. This is the method used by 'fenced'.
 
 
For testing, arguments may be passed as command line arguments.
 
./fence_na <options>
 
 
Overview:
 
 
This takes arguments that defined which Node Assassin to call, what
 
node to work on and what action should be taken. These arguments are
 
defined by the FenceAgentAPI. These actions are then translated into
 
a set of Node Assassin states which then get passed to the device.
 
 
Node Assassin Ports:
 
 
The 'fenced' daemon programmatically refers to a given node as a
 
"Port". This conflicts with the Node Assassin internal definition of a
 
port. Please do not confuse the two!
 
 
 
When the 'fenced' daemon sets the 'port' value, this is understood to
+
# Point the user at the man page.
be the Node ID to be acted on. Internally then, the Node ID is
+
print "See 'man fence_na' for instructions on using the Node Assassin Fence Agent.\n";
converted to two Node Assassin ports; One for "power" and one for
+
"reset". The conversion is done this way:
+
+
((fenced port * 2) - 1) = Power Port
+
(fenced port * 2)      = Reset Port
+
+
For example, when fenced sets 'port=4', it is converted to:
+
Power Port = ((4*2)-1) = 7
+
Reset Port = (4*2)    = 8
+
+
With this conversion complete, this fence agent knows what calls to
+
make to accomplish the task set in the 'action' argument.
+
 
+
Node Assassin States:
+
 
+
Each Node Assassin port can be set to one of four states. They are:
+
 
+
0
+
This state will fence the nodes specified by the list. The
+
fence will remain active until released.
+
+
1
+
This will release the fence on the specified NA port.
+
+
2
+
This will fence the node(s) for one second. This is meant to be
+
used on ports connected to a node's power button. If the node
+
is alive and supports ACPI, this should start a graceful power
+
down of the node. Conversly, if the node was off, this will
+
boot the node. When connected to a node's reset switch, this
+
will cause a quick reboot without a graceful power off.
+
+
3
+
This state will fence the node(s) for five seconds. This is
+
specifically designed for ports connected to a node's power
+
button. It will allow a frozen node to be forced off by holding
+
the power button closed long enough to force a power off. This
+
state serves no real difference over state 2 when connected to
+
a reset switch.
+
 
+
Options:
+
 
+
Which options are valid depends on how the arguments are passed in. The
+
"main" method of passing arguments is via STDIN as a series of
+
'varible=value' pairs, one per line. All arguments accepted this way
+
have command-line arguments passed in via single-dashes switches. Each
+
option below shows either calling method's arguments, where available.
+
+
-h
+
+
Prints this help message.
+
+
-v, -V
+
+
Prints the version of this fence agent and then the version of
+
any configured, reachable Node Assassins.
+
+
-q
+
+
Tells this fence agent to only print critical messages.
+
+
-a <val>, ipaddr=<val>
+
+
Tells the fence agent which Node Assassin to use.
+
+
NOTE! The name or IP addresses *MUST* match a name or IP
+
      address defined in '/etc/na/fence_na.conf'! Specifically,
+
      it must match one of the 'node::X::ipaddr' entries where
+
      'X' is the ID of the Node Assassin.
+
+
-l <val>, login=<val>
+
+
This is the login name used to connect to this fence agent. It
+
must match the value 'system::username' in
+
'/etc/na/fence_na.conf'.
+
+
-p <val>, passwd=<val>
+
+
This is the login password used to connect to this fence agent.
+
It must match the value 'system::password' in
+
'/etc/na/fence_na.conf'.
+
+
-n <val>, port=<val>
+
+
This tells the fence agent which node to act on.
+
+
NOTE! Please do not confuse this with the Node Assassin's
+
      internal concept of a port.
+
+
-o <val>, action=<val>
+
+
This is the action (formerly 'option') to perform on the
+
selected node. Valid actions and how Node Assassin implements
+
them are:
+
+
on
+
+
1. Reset pin is opened (fence released)
+
2. Power pin is opened
+
3. Wait one second
+
4. Power pin is closed for one second
+
5. Wait one second
+
6. Power feed is checked for 'on' state
+
+
off
+
+
1. Reset pin is closed (fenced), disabling the node
+
  immediately.
+
2. Wait one second.
+
3. Reset pin is opened (fence released). Some machines
+
  will not power off is it's reset pin is held closed.
+
4. Wait one second.
+
5. Power pin is closed
+
6. Wait for five seconds to ensure PSU is shut down.
+
7. Reset pin is closed
+
  Note: With both the power and reset help closed, the
+
      node will not boot even when it's front panel
+
      power button is pressed.
+
8. Power feed is checked for 'off' state
+
+
reboot
+
+
Note: This will do a hard reboot! Do not use when a
+
      normal restart would suffice.
+
1.  Reset pin is closed (fenced) to ensure immediate
+
    disabling of the node.
+
2.  Wait one second.
+
3.  Reset pin is opened (fence released)
+
4.  Wait one second.
+
5.  Power pin is closed (fenced) for five seconds
+
6.  Wait five seconds to ensure power down.
+
7.  Power feed is checked for 'off' state
+
8.  Power pin is closed (fenced) for one second to
+
    begin booting the node.
+
9.  Wait one second.
+
10. Power feed is checked for 'on' state
+
+
status
+
+
The associated node's power feed is checked and it's
+
status is returned.
+
+
monitor, list
+
+
Unknown what is to be done under these actions.
+
+
###############################################################
+
NOTE: The following states are supported by Node Assassin only.
+
      These states are not used by the 'fenced' daemon and are
+
      provided here as a convenience for the user.
+
###############################################################
+
     
+
soft_reboot (not yet implemented, requires NA v1.1.4 or better)
+
+
1. Power pin is closed for one second. Nodes who
+
  support ACPI should initiate shutdown at the OS
+
  level.
+
2. A loop starts checking the power feed line. The
+
  status is checked once a second until the power feed
+
  returns 'off'.
+
3. Wait one second
+
4. Power pin is closed for one second.
+
5. Wait one second.
+
6. Power feed is checked for 'on' state.
+
+
soft_off (not yet implemented, requires NA v1.1.4 or better)
+
+
1. Power pin is closed for one second. Nodes who
+
  support ACPI should initiate shutdown at the OS
+
  level.
+
2. A loop starts checking the power feed line. The
+
  status is checked once a second until the power feed
+
  returns 'off'.
+
+
release
+
+
1. Power pin is opened (fence released)
+
2. Reset pin is opened (fence released)
+
+
all_stop (not yet implemented, requires NA v1.1.4 or better)
+
+
1. The '-n/port' and '-a/ipaddr' arguments are ignored.
+
2. A loop starts for all Node Assassins configured.
+
3. For each NA, a loop is started to step through all
+
  supported nodes.
+
4. For each node on each Node Assassin:
+
4.1. Power feed is checked for 'on' status. If on;
+
4.2. Power pin is closed (fenced) for one second,
+
    initiating an ACPI induced shut down.
+
+
all_start (not yet implemented, requires NA v1.1.4 or better)
+
+
1. The '-n/port' and '-a/ipaddr' arguments are ignored.
+
2. A loop starts for all Node Assassins configured.
+
3. For each NA, a loop is started to step through all
+
  supported nodes.
+
4. For each node on each Node Assassin:
+
4.1. Power feed is checked for 'off' status. If off;
+
4.2. Power pin is closed (fenced) for one second,
+
    initiating a boot of the node, if there is a node
+
    connected.
+
+
-S <path>, passwd_script=<path> (Not Implemented)
+
+
This is the path to a script that returns the password to use
+
when running this fence agent.
+
+
 
+
Examples:
+
 
+
To simulate how 'fenced' calls the script, create a text file called
+
'args.txt' containing:
+
+
-----------------------------------------------------------------------
+
# Test file used as input for the NA fence agent.
+
ipaddr=ariel.alteeve.com
+
port=02
+
login=ariel
+
passwd=gr0tt0
+
action=off
+
-----------------------------------------------------------------------
+
+
Now use 'cat' the pipe the contents into the fence agent:
+
+
cat args.txt | ./fence_na
+
+
This will call the 'off' function against node #02 connected to the
+
Node Assassin at 'ariel.alteeve.com', fencing it. Change the action
+
line to 'action=on' and re-run the script again to release the fence
+
and boot the node.
+
+
To duplicate the same call using command line arguments:
+
+
./fence_na -a ariel.alteeve.com -n 2 -l ariel -p gr0tt0 -o off
+
+
Note:
+
 
+
An internal pager is not implemented. You may wish to run this via
+
'less':
+
+
./fence_na | less
+
 
+
Updated:
+
 
+
Mar. 7, 2010 Digimer
+
`;
+
print $msg;
+
 
 
 
do_exit($conf, $log, 0);
 
do_exit($conf, $log, 0);
 +
}
 +
 +
# This error message is printed when there was a connection problem with a
 +
# given Node Assassin.
 +
sub no_connection_error
 +
{
 +
my ($conf, $log, $na_id)=@_;
 +
record ($conf, $log, "\nERROR: Unable to query Node Assassin: [$conf->{na}{$na_id}{na_name}]!\n", 1);
 +
record ($conf, $log, "ERROR: Please check that it is connected, that the information in\n", 1);
 +
record ($conf, $log, "ERROR: '/etc/na/fence_na.conf' is accurate and that the proper configuration\n", 1);
 +
record ($conf, $log, "ERROR: has be uploaded to the device.\n\n", 1);
 +
return (0);
 
}
 
}
  
Line 346: Line 260:
 
{
 
{
 
my ($conf, $log)=@_;
 
my ($conf, $log)=@_;
 +
record($conf, $log, "In the 'process_action' function.\n") if $conf->{'system'}{debug};
 
 
 
# Make this more readable.
 
# Make this more readable.
my $na_id=$conf->{'system'}{node_assassin_id};
+
my $na_id=$conf->{'system'}{na_id};
my $action=$conf->{node}{action};
+
my $action=$conf->{na}{action};
my $port=$conf->{node}{port};
+
my $node=$conf->{na}{port};
 +
record($conf, $log, "na_id: [$na_id], action: [$action], port: [$node]\n") if $conf->{'system'}{debug};
 
 
# Translate the port passed in by the fence agent into the actual ports
+
# The following actions require a port. Error if I don't have one.
# in the Node Assassin. Mapping is:
+
if ($node eq "00")
# Node 01 -> Power = Port 01
+
{
# Node 01 -> Reset = Port 02
+
# These are the incompatible calls.
# Node 02 -> Power = Port 03
+
if (($action eq "on") || ($action eq "off") || ($action eq "reboot") || ($action eq "status"))
# Node 02 -> Reset = Port 04
+
{
# Node 03 -> Power = Port 05
+
record($conf, $log, "\nERROR! Action request: [$action] requires a port number!\n", 1) if $conf->{'system'}{debug};
# Node 03 -> Reset = Port 06
+
record($conf, $log, "ERROR: I got: [$node] which does not seem to be valid.\n\n", 1);
# Node 04 -> Power = Port 07
+
do_exit($conf, $log, 9);
# Node 04 -> Reset = Port 08
+
}
# ...
+
}
my $power_port=sprintf("%02d", (($port*2)-1));
+
my $reset_port=sprintf("%02d", ($port*2));
+
record($conf, $log, "Translated node port: [$port] to power port: [$power_port] and reset port: [$reset_port]\n");
+
 
 
 +
# Make sure my call order is clear.
 +
$conf->{'system'}{call_order}="";
 
if ($action eq "on")
 
if ($action eq "on")
 
{
 
{
# Release the fence and boot the node.
+
# Release the fence, if fenced, and boot the node.
$conf->{'system'}{call_order}="$reset_port:1,$power_port:1,sleep,$power_port:2,sleep,$power_port:on";
+
$states=get_states($conf, $log);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
if ($feed_state)
 +
{
 +
# Node is already running.
 +
record($conf, $log, "Asked to turn on node: [$node], but it's already running.\n");
 +
do_exit($conf, $log, 0);
 +
}
 +
elsif (($power_state) || ($reset_state))
 +
{
 +
# Node was fenced, release it first.
 +
$conf->{'system'}{call_order}="$node:0,sleep,";
 +
}
 +
$conf->{'system'}{call_order}.="$node:2,sleep,$node:on";
 
}
 
}
 
elsif ($action eq "off")
 
elsif ($action eq "off")
 
{
 
{
# Fence the node by pressing and holding the reset to make sure
+
# Fence the node.
# the node immediately dies. Then I release the fence long
+
$conf->{'system'}{call_order}="$node:1,sleep,$node:off";
# enough to force a power off, then I re-apply then fence to
+
# make sure the node doesn't come back up. This is needed
+
# because some machines won't power off if the reset is held
+
# high when the power is pressed, even for > 4 seconds.
+
$conf->{'system'}{call_order}="$reset_port:0,sleep,$reset_port:1,sleep,$power_port:0,sleep 5,$reset_port:0,$power_port:off";
+
 
}
 
}
 
elsif ($action eq "reboot")
 
elsif ($action eq "reboot")
 
{
 
{
# Currently, I don't do this gracefully because, well, if it's
+
# I don't do this gracefully because the API says this should
# being fenced, it's not meant to be graceful.
+
# be an 'off' -> 'on' process, and 'off' is fence...
# This is a combination of the 'off' -> 'on' actions.
+
$conf->{'system'}{call_order}="$node:1,sleep,$node:0,sleep,$node:off,$node:2,sleep,$node:on";
$conf->{'system'}{call_order}="$reset_port:0,sleep,$reset_port:1,sleep,$power_port:3,sleep 6,$power_port:off,$power_port:2,sleep,$power_port:reboot";
+
 
}
 
}
 
elsif ($action eq "status")
 
elsif ($action eq "status")
 
{
 
{
# This should check the probe, but for now, it checks the
+
# This checks the node's power feed.
# port's state.
+
$conf->{'system'}{call_order}="$node:check";
$conf->{'system'}{call_order}="$power_port:check";
+
 
}
 
}
elsif (($action eq "monitor") or ($action eq "list"))
+
### ALL ACTIONS BELOW HERE ARE OUTSIDE OF THE FenceAgentAPI!
 +
elsif ($action eq "release")
 
{
 
{
# Not sure what to do here.
+
# Release the given node without booting it.
 +
$conf->{'system'}{call_order}="$node:0";
 +
}
 +
elsif ($action eq "release_all")
 +
{
 +
# Release all ports.
 +
$conf->{'system'}{call_order}="release_all";
 +
}
 +
elsif ($action eq "fence_all")
 +
{
 +
# Fence all ports.
 +
$conf->{'system'}{call_order}="fence_all";
 +
}
 +
elsif ($action eq "boot")
 +
{
 +
# Boot the specific node if it is off.
 +
$states=get_states($conf, $log);
 +
 +
# Decide how, or if, to proceed based on the current state of
 +
# each node.
 +
$node=sprintf("%02d", $node);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
if (($power_state) || ($reset_state))
 +
{
 +
# Node was fenced, release first.
 +
$conf->{'system'}{call_order}.="$node:0,sleep,";
 +
}
 +
if (not $feed_state)
 +
{
 +
# Boot the node.
 +
$conf->{'system'}{call_order}.="$node:2,sleep,";
 +
}
 +
else
 +
{
 +
record($conf, $log, "WARNING: Node: [$node] seems to be already on, taking no action.\n", 1);
 +
}
 +
$conf->{'system'}{call_order}=~s/,$//;
 +
}
 +
elsif ($action eq "boot_all")
 +
{
 +
# Boot all nodes that are off.
 +
$states=get_states($conf, $log);
 +
 +
# Decide how, or if, to proceed based on the current state of
 +
# each node.
 +
foreach my $node (1..$conf->{na}{max_nodes})
 +
{
 +
$node=sprintf("%02d", $node);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
if (($power_state) || ($reset_state))
 +
{
 +
# Node was fenced, release first.
 +
$conf->{'system'}{call_order}.="$node:0,sleep,";
 +
}
 +
if (not $feed_state)
 +
{
 +
# Boot the node.
 +
$conf->{'system'}{call_order}.="$node:2,sleep,";
 +
}
 +
}
 +
$conf->{'system'}{call_order}=~s/,$//;
 +
}
 +
elsif ($action eq "shutdown")
 +
{
 +
# Shutdown a specific node that is on cleanly via ACPI.
 +
$states=get_states($conf, $log);
 +
$node=sprintf("%02d", $node);
 +
my $feed_state=$states->{$node}{feed_state};
 +
if ($feed_state)
 +
{
 +
# shutdown the node.
 +
$conf->{'system'}{call_order}.="$node:2";
 +
}
 +
else
 +
{
 +
record($conf, $log, "WARNING: Node: [$node] seems to be already off, taking no action. Is the cable connected?\n", 1);
 +
}
 +
$conf->{'system'}{call_order}=~s/,$//;
 +
}
 +
elsif ($action eq "shutdown_all")
 +
{
 +
# Shutdown all nodes that are on cleanly via ACPI.
 +
$states=get_states($conf, $log);
 +
 +
# Decide how, or if, to proceed based on the current state of
 +
# each node.
 +
foreach my $node (1..$conf->{na}{max_nodes})
 +
{
 +
$node=sprintf("%02d", $node);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
if ($feed_state)
 +
{
 +
# Shutdown the node.
 +
$conf->{'system'}{call_order}.="$node:2,sleep,";
 +
}
 +
}
 +
$conf->{'system'}{call_order}=~s/,$//;
 +
}
 +
elsif ($action eq "forcedown_all")
 +
{
 +
# Shutdown all nodes that are on by holding the power button
 +
# until they go down.
 +
$states=get_states($conf, $log);
 +
 +
# Decide how, or if, to proceed based on the current state of
 +
# each node.
 +
foreach my $node (1..$conf->{na}{max_nodes})
 +
{
 +
$node=sprintf("%02d", $node);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
if ($feed_state)
 +
{
 +
# Boot the node.
 +
$conf->{'system'}{call_order}.="$node:3,sleep,";
 +
}
 +
}
 +
$conf->{'system'}{call_order}=~s/,$//;
 
}
 
}
 
else
 
else
 
{
 
{
record($conf, $log, "Unknown action request: [$action]!\n");
+
record($conf, $log, "\nERROR: Unknown action request: [$action]!\n\n", 1);
 
do_exit($conf, $log, 9);
 
do_exit($conf, $log, 9);
 
}
 
}
Line 417: Line 465:
 
my $read=IO::Handle->new();
 
my $read=IO::Handle->new();
 
my $shell_call="$conf->{'system'}{conf_file}";
 
my $shell_call="$conf->{'system'}{conf_file}";
# print "Shell call: [$shell_call]\n";
+
record($conf, $log, "Shell call: [$shell_call]\n") if $conf->{'system'}{debug};
 
open ($read, "<$shell_call") or die "Failed to read: [$shell_call], error was: $!\n";
 
open ($read, "<$shell_call") or die "Failed to read: [$shell_call], error was: $!\n";
 
while (<$read>)
 
while (<$read>)
Line 435: Line 483:
 
$val=~s/\s+$//;
 
$val=~s/\s+$//;
 
next if (not $var);
 
next if (not $var);
# print "Storing: [$var] = [$val]\n";
+
record($conf, $log, "Storing: [$var] = [$val]\n") if $conf->{'system'}{debug};
 
_make_hash_reference($conf, $var, $val);
 
_make_hash_reference($conf, $var, $val);
 
}
 
}
Line 447: Line 495:
 
{
 
{
 
my ($conf, $log, $bad)=@_;
 
my ($conf, $log, $bad)=@_;
 
# MADI: Remove this before release.
 
record($conf, $log, "Got args:\n");
 
 
 
 
# Loop through the passed arguments, if any.
 
# Loop through the passed arguments, if any.
 +
record($conf, $log, "Got args:\n") if $conf->{'system'}{debug};
 
my $set_next="";
 
my $set_next="";
 
foreach my $arg (@ARGV)
 
foreach my $arg (@ARGV)
 
{
 
{
# MADI: Remove this before release.
+
record($conf, $log, "[$arg]\n") if $conf->{'system'}{debug};
# record($conf, $log, "[$arg]\n");
+
 
$conf->{'system'}{got_cla}=1;
 
$conf->{'system'}{got_cla}=1;
 
 
Line 464: Line 509:
 
{
 
{
 
# It's set, use it's contents as the hash key.
 
# It's set, use it's contents as the hash key.
$conf->{node}{$set_next}=$arg;
+
$conf->{na}{$set_next}=$arg;
+
record($conf, $log, "Setting: 'na::$set_next': [$conf->{na}{$set_next}]\n") if $conf->{'system'}{debug};
# MADI: Remove this before release.
+
record($conf, $log, "Setting: 'node::$set_next': [$conf->{node}{$set_next}]\n");
+
 
 
 
# Clear it now for the next go-round.
 
# Clear it now for the next go-round.
Line 478: Line 521:
 
help($conf, $log);
 
help($conf, $log);
 
}
 
}
elsif ($arg=~/-[vV]/)
+
elsif ($arg=~/-v/)
 
{
 
{
 
# Print the version information and then exit.
 
# Print the version information and then exit.
 
$conf->{'system'}{version}=1;
 
$conf->{'system'}{version}=1;
 +
record($conf,$log,"Setting version\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg=~/-q/)
 
elsif ($arg=~/-q/)
Line 487: Line 531:
 
# Suppress all non-critical messages from STDOUT.
 
# Suppress all non-critical messages from STDOUT.
 
$conf->{'system'}{quiet}=1;
 
$conf->{'system'}{quiet}=1;
 +
}
 +
elsif ($arg=~/-d/)
 +
{
 +
# Enable debug mode.
 +
$conf->{'system'}{debug}=1;
 
}
 
}
 
elsif ($arg=~/^-/)
 
elsif ($arg=~/^-/)
Line 498: Line 547:
 
# Node Assassin to call.
 
# Node Assassin to call.
 
$set_next="ipaddr";
 
$set_next="ipaddr";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg eq "l")
 
elsif ($arg eq "l")
Line 504: Line 553:
 
# This is the login name.
 
# This is the login name.
 
$set_next="login";
 
$set_next="login";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg eq "p")
 
elsif ($arg eq "p")
Line 513: Line 562:
 
# contents will replace# this value.
 
# contents will replace# this value.
 
$set_next="passwd";
 
$set_next="passwd";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg eq "n")
 
elsif ($arg eq "n")
Line 519: Line 568:
 
# This is the node to work on.
 
# This is the node to work on.
 
$set_next="port";
 
$set_next="port";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg eq "o")
 
elsif ($arg eq "o")
Line 525: Line 574:
 
# This is the action to take.
 
# This is the action to take.
 
$set_next="action";
 
$set_next="action";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
elsif ($arg eq "S")
 
elsif ($arg eq "S")
Line 534: Line 583:
 
# the password to STDOUT.
 
# the password to STDOUT.
 
$set_next="passwd_script";
 
$set_next="passwd_script";
# record ($conf, $log, "Next argument will be stored in: [$set_next]\n");
+
record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
 
}
 
}
 
}
 
}
Line 541: Line 590:
 
### MADI: I might want to pick up arguments via multiple lines.
 
### MADI: I might want to pick up arguments via multiple lines.
 
# Bad argument.
 
# Bad argument.
record($conf, $log, "Argument: [$arg] is not valid!\n");
+
record($conf, $log, "\nERROR: Argument: [$arg] is not valid!\n");
record($conf, $log, "Please run './fence_na --help' to see a list of valid arguments.\n");
+
record($conf, $log, "ERROR: Please run: [man fence_na] to see a list of valid arguments.\n\n");
 
$bad=1;
 
$bad=1;
 
}
 
}
Line 563: Line 612:
 
 
 
# Record the line for now, but comment this out before release.
 
# Record the line for now, but comment this out before release.
record ($conf, $log, "Processing option line: [$option]\n");
+
record ($conf, $log, "Processing option line: [$option]\n") if $conf->{'system'}{debug};
 
 
 
# strip leading and trailing whitespace
 
# strip leading and trailing whitespace
Line 582: Line 631:
 
 
 
# Record the line for now, but comment this out before release.
 
# Record the line for now, but comment this out before release.
record ($conf, $log, "Name: [$name], value: [$value].\n");
+
record ($conf, $log, "Name: [$name], value: [$value].\n") if $conf->{'system'}{debug};
 
 
 
# Set my variables depending on the veriable name.
 
# Set my variables depending on the veriable name.
Line 589: Line 638:
 
# This is only used by 'fenced', but I record it for
 
# This is only used by 'fenced', but I record it for
 
# potential debugging.
 
# potential debugging.
$conf->{node}{agent}=$value;
+
$conf->{na}{agent}=$value;
 
}
 
}
 
elsif ($name eq "fm")
 
elsif ($name eq "fm")
Line 595: Line 644:
 
# This is a deprecated argument that should no longer
 
# This is a deprecated argument that should no longer
 
# be used. Now 'port' should be used.
 
# be used. Now 'port' should be used.
if (not $conf->{node}{port})
+
if (not $conf->{na}{port})
 
{
 
{
 
# Port isn't set yet, use this value which may
 
# Port isn't set yet, use this value which may
 
# be replaced if 'port' is set later.
 
# be replaced if 'port' is set later.
 
(undef, $value) = split /\s+/,$value;
 
(undef, $value) = split /\s+/,$value;
$conf->{node}{port}=$value;
+
$conf->{na}{port}=$value;
warn "Warning! The argument 'fm' is deprecated, use 'port' instead. Value: [$value] set for 'port'\n";
+
record($conf, $log, "Warning! The argument 'fm' is deprecated, use 'port' instead.\n", 1);
 +
record($conf, $log, "Warning! Value: [$value] set for 'port'\n", 1);
 
}
 
}
 
else
 
else
 
{
 
{
 
# Port was already set, so simply ignore this.
 
# Port was already set, so simply ignore this.
warn "Warning! The argument 'fm' is deprecated, use 'port' instead. Value: [$value] ignored.\n";
+
record($conf, $log, "Warning! The argument 'fm' is deprecated, use 'port' instead.\n", 1);
 +
record($conf, $log, "Warning! Value: [$value] ignored.\n", 1);
 
}
 
}
 
}
 
}
Line 613: Line 664:
 
# Record the IP Address or name of the Node Assassin to
 
# Record the IP Address or name of the Node Assassin to
 
# use.
 
# use.
$conf->{node}{ipaddr}=$value;
+
$conf->{na}{ipaddr}=$value;
 
}  
 
}  
 
elsif ($name eq "login")
 
elsif ($name eq "login")
 
{
 
{
 
# Record the login name that was passed.
 
# Record the login name that was passed.
$conf->{node}{login}=$value;
+
$conf->{na}{login}=$value;
 
}  
 
}  
 
elsif ($name eq "name")
 
elsif ($name eq "name")
 
{
 
{
 
# Depricated argument used formerly for login name.
 
# Depricated argument used formerly for login name.
if (not $conf->{node}{login})
+
if (not $conf->{na}{login})
 
{
 
{
 
# Login isn't set yet, use this value which may
 
# Login isn't set yet, use this value which may
 
# be replaced if 'login' is seen later.
 
# be replaced if 'login' is seen later.
$conf->{node}{login}=$value;
+
$conf->{na}{login}=$value;
warn "Warning! The argument 'name' is deprecated, use 'login' instead. Value: [$value] set for 'login'.\n";
+
record($conf, $log, "Warning! The argument 'name' is deprecated, use 'login' instead.\n", 1);
 +
record($conf, $log, "Warning! Value: [$value] set for 'login'.\n", 1);
 
}
 
}
 
else
 
else
Line 634: Line 686:
 
# I've already seen the 'login' value so I will
 
# I've already seen the 'login' value so I will
 
# ignore this value.
 
# ignore this value.
warn "Warning! The argument 'name' is deprecated, use 'login' instead. Value: [$value] ignored.\n";
+
record($conf, $log, "Warning! The argument 'name' is deprecated, use 'login' instead.\n", 1);
 +
record($conf, $log, "Warning! Value: [$value] ignored.\n", 1);
 
}
 
}
 
}
 
}
 
elsif (($name eq "action") or ($name eq "option"))
 
elsif (($name eq "action") or ($name eq "option"))
 
{
 
{
# It looks like 'option' is going to be deprecated in
+
# 'option' is deprecated.
# favour of 'action'. If/when that happens, add a warn.
+
record($conf, $log, "Please use 'action', not 'option', as the later is deprecated.\n", 1) if $name eq "option";
$conf->{node}{action}=$value;
+
$conf->{na}{action}=$value;
 
}
 
}
 
elsif ($name eq "passwd")
 
elsif ($name eq "passwd")
 
{
 
{
 
# This is the login password.
 
# This is the login password.
$conf->{node}{passwd}=$value;
+
$conf->{na}{passwd}=$value;
 
}  
 
}  
 
elsif ($name eq "passwd_script")
 
elsif ($name eq "passwd_script")
Line 653: Line 706:
 
# password to the agent. At this time, this is not
 
# password to the agent. At this time, this is not
 
# implemented.
 
# implemented.
$conf->{node}{passwd_script}=$value;
+
$conf->{na}{passwd_script}=$value;
 
}
 
}
 
elsif ($name eq "port")
 
elsif ($name eq "port")
 
{
 
{
 
# This sets the port number to act on.
 
# This sets the port number to act on.
$conf->{node}{port}=$value;
+
$conf->{na}{port}=$value;
}  
+
}
 +
elsif ($name eq "nodename")
 +
{
 +
# This is passed by 'fenced' via 'cluster.conf' as of
 +
# cluster version 3, but it's not yet documented.
 +
$conf->{'system'}{nodename}=$value;
 +
}
 +
elsif ($name eq "quiet")
 +
{
 +
# This is passed by 'fenced' via 'cluster.conf' as a
 +
# custom argument to supress output to STDOUT.
 +
$conf->{'system'}{quiet}=1;
 +
}
 
else
 
else
 
{
 
{
warn "Illegal name in option: [$option] at line: [$line_count]\n";
+
record($conf, $log, "\nERROR: Illegal name in option: [$option] at line: [$line_count]\n\n", 1);
$bad=1;
+
# 'rohara' from #linux-cluster suggested it's better to
 +
# simply ignore unknown input, as that is the behaviour
 +
# the fenced authors expect.
 +
#$bad=1;
 
}
 
}
 
}
 
}
Line 672: Line 740:
 
sub record
 
sub record
 
{
 
{
my ($conf, $log, $msg)=@_;
+
my ($conf, $log, $msg, $critical)=@_;
 +
$critical=0 if not $critical;
 
 
 +
# The log file gets everything.
 
print $log $msg;
 
print $log $msg;
# print $msg if not $conf->{'system'}{quiet};
+
print $msg if not $conf->{'system'}{quiet};
 +
 +
# Critical messages have to print, so this ensure that it gets out
 +
# when 'quiet' is in use.
 +
print $msg if (($critical) && ($conf->{'system'}{quiet}));
 
 
 
return(0);
 
return(0);
 
}
 
}
  
# When asked to 'monitor' or 'list', do this... whatever 'this' is. All I know
+
# This sets all ports of a given Node Assassin to the requested state.
# is that it should not generate output.
+
sub set_all_state
sub show_list
+
 
{
 
{
my ($conf, $log)=@_;
+
my ($conf, $log, $state)=@_;
+
$state=0 if not defined $state;
### MADI: No idea what will be needed here, so here are both queries.
+
###      Make them available elsewhere if not used here.
+
record($conf, $log, "Checking states:\n");
+
my @state_out=$conf->{node}{handle}->cmd("00:0");
+
foreach my $line (@state_out)
+
{
+
# record($conf, $log, $line);
+
}
+
record($conf, $log, "Done.\n");
+
  
# Query states and Node Assassin info.
+
my $max_port=$conf->{na}{max_nodes};
record($conf, $log, "Checking Node Assassin info:\n");
+
foreach my $node (1..$max_port)
my @info_out=$conf->{node}{handle}->cmd("00:1");
+
my $node_name="";
+
foreach my $line (@info_out)
+
 
{
 
{
record($conf, $log, $line);
+
$node=sprintf("%02d", $node).":$state";
$node_name=$1 if $line=~/- Node Name: ..... (.*)/;
+
record ($conf, $log, "Calling: [$node]\n") if $conf->{'system'}{debug};
 +
my @set_state=$conf->{na}{handle}->cmd("$node");
 +
foreach my $line (@set_state)
 +
{
 +
chomp $line;
 +
next if not $line;
 +
record($conf, $log, "$line\n");
 +
}
 
}
 
}
record($conf, $log, "Node name: [$node_name]\n");
 
record($conf, $log, "Done.\n");
 
 
 
do_exit($conf, $log, 0);
+
return (9);
 
}
 
}
  
# This queries the Node Assassin and returns the state of the requested node.
+
# When asked to 'monitor' or 'list', show a CSV of all nodes and their aliases,
sub show_state
+
# when found in the config file.
 +
sub show_list
 
{
 
{
 
my ($conf, $log)=@_;
 
my ($conf, $log)=@_;
 +
record($conf, $log, "In 'show_list' function.\n") if $conf->{'system'}{debug};
 
 
my @state_out=$conf->{node}{handle}->cmd("00:0");
+
# Get an up to date list of the ports.
my $state="";
+
my $na_id=$conf->{'system'}{na_id};
my $node=$conf->{node}{port};
+
record($conf, $log, "na_id: [$na_id], max_node: [$conf->{na}{max_nodes}]\n") if $conf->{'system'}{debug};
foreach my $line (@state_out)
+
 +
for (1..$conf->{na}{max_nodes})
 
{
 
{
chomp;
+
my $node=$_;
my $line=$_;
+
my $alias=$conf->{na}{$na_id}{alias}{$node} ? $conf->{na}{$na_id}{alias}{$node} : "--";
my ($state)=($line=~/- Node $node: (.*?)/);
+
record ($conf, $log, "$node,$alias\n", 1);
if ($state)
+
{
+
$state=lc($state)=~/fenced/ ? 2 : 0;
+
last;
+
}
+
 
}
 
}
# No state means something went wrong while talking to the Node
 
# Assassin.
 
$state=1 if (($state != 0) && ($state != 2));
 
 
 
# As per: http://sources.redhat.com/cluster/wiki/FenceAgentAPI
+
do_exit($conf, $log, 0);
# The exit state must be:
+
# 0 = Node is running
+
# 1 = Failed to contact fence, unknown state.
+
# 2 = Node is fenced.
+
do_exit($conf, $log, $state);
+
 
}
 
}
  
Line 749: Line 805:
 
 
 
# Print the Fence Agent version first.
 
# Print the Fence Agent version first.
print "Fence Agent: ......... Node Assassin ver. $conf->{'system'}{agent_version}\n";
+
record ($conf, $log, "Fence Agent: ..... Node Assassin ver. $conf->{'system'}{agent_version}\n", 1);
print "Configured Nodes: .... $conf->{'system'}{nodes}\n";
+
record ($conf, $log, "Node Assassins: .. $conf->{'system'}{na_num}\n", 1);
for my $node (1..$conf->{'system'}{nodes})
+
for my $na_id (1..$conf->{'system'}{na_num})
 
{
 
{
print " - Node $node Name: .. $conf->{node}{$node}{name}\n";
+
$conf->{'system'}{na_id}=$na_id;
print " - Node $node IP: .... $conf->{node}{$node}{ip}\n";
+
$conf->{na}{ipaddr}=    $conf->{na}{$na_id}{ipaddr};
print " - Node $node Port: .. $conf->{node}{$node}{port}\n";
+
$conf->{na}{tcp_port}=  $conf->{na}{$na_id}{tcp_port};
print " - Node $node MAC: ... $conf->{node}{$node}{mac}\n";
+
$conf->{na}{na_name}=    $conf->{na}{$na_id}{na_name};
print " - Node $node Netmask: $conf->{node}{$node}{ip}\n";
+
my $build_date="";
print " - Node $node Gateway: $conf->{node}{$node}{ip}\n";
+
my $serial_number="";
 +
my $firmware_ver="";
 +
connect_to_na($conf, $log);
 +
if ($conf->{na}{handle})
 +
{
 +
# Get the NAOS version and serial numbers.
 +
my @details=$conf->{na}{handle}->cmd("00:1");
 +
foreach my $line (sort {$a cmp $b} @details)
 +
{
 +
chomp $line;
 +
($build_date)=($line=~/\s(\S+)$/) if ($line =~ /Build Date/i );
 +
($serial_number)=($line=~/\s(\S+)$/) if ($line =~ /Serial Number/i );
 +
($firmware_ver)=($line=~/\s(\S+)$/) if ($line =~ /NAOS Version/i );
 +
record($conf, $log, "line: [$line]\n") if $conf->{'system'}{debug};
 +
}
 +
}
 +
else
 +
{
 +
$build_date="??";
 +
$serial_number="??";
 +
$firmware_ver="??";
 +
}
 +
record ($conf, $log, " - Node Assassin:  #$na_id\n", 1);
 +
record ($conf, $log, "  - Name: ....... $conf->{na}{$na_id}{na_name}\n", 1);
 +
record ($conf, $log, "   - IP Address: . $conf->{na}{$na_id}{ipaddr}\n", 1);
 +
record ($conf, $log, "  - TCP Port: ... $conf->{na}{$na_id}{tcp_port}\n", 1);
 +
record ($conf, $log, "   - MAC Address:  $conf->{na}{$na_id}{mac}\n", 1);
 +
record ($conf, $log, "  - Netmask: .... $conf->{na}{$na_id}{netmask}\n", 1);
 +
record ($conf, $log, "   - Gateway: .... $conf->{na}{$na_id}{gateway}\n", 1);
 +
record ($conf, $log, "   - Serial #: ... $serial_number\n", 1);
 +
record ($conf, $log, "  - Firmware: ... $firmware_ver\n", 1);
 +
record ($conf, $log, "  - Build Date: . $build_date (yyyy-mm-dd)\n", 1);
 +
record ($conf, $log, "  - Max Nodes: .. $conf->{na}{$na_id}{max_nodes}\n", 1);
 +
 +
# Get the node states.
 +
$states=get_states($conf, $log);
 +
for (1..$conf->{na}{$na_id}{max_nodes})
 +
{
 +
my $node=sprintf("%02d", $_);
 +
my $power_state=$states->{$node}{power_state};
 +
my $reset_state=$states->{$node}{reset_state};
 +
my $feed_state=$states->{$node}{feed_state};
 +
record ($conf, $log, "    - Node $node: .. p[$power_state], r[$reset_state], f[$feed_state]\n", 1);
 +
}
 +
 +
# Close the handle for the next loop.
 +
if ($conf->{na}{handle})
 +
{
 +
show_list($conf, $log, "version", 1);
 +
$conf->{na}{tcp_port}->close();
 +
}
 +
else
 +
{
 +
no_connection_error($conf, $log, $na_id);
 +
}
 
}
 
}
 
do_exit($conf, $log, 0);
 
do_exit($conf, $log, 0);

Latest revision as of 17:02, 25 August 2010

 Node Assassin :: Fence na.lib

This is the fence agent's function library that exists in /etc/fence_na/.

#!/usr/bin/perl
#
# This is the function library for the Node Assassin fence agent.
# 
# Node Assassin - Fence Agent
# Digimer; digimer@alteeve.com
# Jun. 27, 2010.
# Version: 1.1.5
#
# This software is released under the GPL v2. See the LICENSE file for a copy
# of the GPL v2.
 
 
# This connects to a Node Assassin and puts the handle in
# $conf->{'system'}{handle}.
sub connect_to_na
{
	my ($conf, $log)=@_;
	$conf->{na}{handle}=new Net::Telnet(
		Timeout	=>	10,
		Errmode	=>	'die',
		Port	=>	$conf->{na}{tcp_port},
		Prompt	=>	'/EOM$/',
		Errmode	=>	'return'
	) or do_exit($conf, $log, 1);
	$conf->{na}{handle}->open($conf->{na}{ipaddr});
	if ($conf->{na}{handle}->errmsg)
	{
		record($conf, $log, "Connection to Node Assassin: [$conf->{na}{ipaddr}] failed.\nError was: [".$conf->{na}{handle}->errmsg."]\n", 1);
		$conf->{na}{handle}="";
	};
	record($conf, $log, "na::handle: [$conf->{na}{handle}]\n") if $conf->{'system'}{debug};
 
	return ($conf->{na}{handle});
}
 
# This handles the actual execution of an action plan.
sub do_actions
{
	my ($conf, $log)=@_;
 
	# In the next step, when a 'check' is seen, the node's power feed is
	# checked and an exit status is stored here. Exits 0, 1 and 2 have
	# special meaning, so I default to 9 as it has no meaning to the
	# FenceAgentAPI.
	my $exit_code=9;
 
	# Process the orders.
	print "Processing: [$conf->{'system'}{call_order}]\n";
	foreach my $order (split/,/, $conf->{'system'}{call_order})
	{
		record($conf, $log, "Calling: [$order]\n") if $conf->{'system'}{debug};
 
		# Handle a 'release_all' call.
		if ($order eq "release_all")
		{
			set_all_state($conf, $log, 0);
			next;
		}
 
		# Handle a 'fence_all' call.
		if ($order eq "fence_all")
		{
			set_all_state($conf, $log, 1);
			next;
		}
 
		# handle a sleep request. This defaults to one second when no
		# integer was included.
		if ($order=~/^sleep/)
		{
			my $time=$order=~/sleep (\d+)/ ? $1 : 1;
			record ($conf, $log, "Sleeping: $time, ");
			if ($time == 1)
			{
				sleep 1;
				record ($conf, $log, "Done.\n");
			}
			else
			{
				while ($time)
				{
					$time--;
					sleep 1;
					record ($conf, $log, "$time, ") if $time > 1;
					record ($conf, $log, "$time. Done.\n") if $time == 1;
				}
			}
			next;
		}
 
		# Handle a status check via Node Assassin.
		record($conf, $log, "order: [$order]\n") if $conf->{'system'}{debug};
		if ($order=~/(\d\d):(\D+)/)
		{
			my $node=$1;
			my $check=$2;
 
			# Verify the state of the port.
			record($conf, $log, "Status check on node: [$node] -> [$check]\n") if $conf->{'system'}{debug};
 
			# Get the state.
			my $states=get_states($conf, $log);
			if ($states == 1)
			{
				# I had a connection problem. Exit with error
				# code '1' as per:
				# http://sources.redhat.com/cluster/wiki/FenceAgentAPI
				do_exit($conf, $log, 1);
			}
 
			# Make the states a bit easier to type.
			my $power_state=$states->{$node}{power_state};
			my $reset_state=$states->{$node}{reset_state};
			my $feed_state=$states->{$node}{feed_state};
 
			# Return the status of the requested node.
			record($conf, $log, "Node Assassin: [#$conf->{'system'}{na_id}/$conf->{na}{na_name}], Node: [$node] Power/Reset/Feed states: [$power_state/$reset_state/$feed_state]\n") if $conf->{'system'}{debug};
			if ($check eq "check")
			{
				# Return '2' if the node is off and '0' if it
				# is on.
				$exit_code=$feed_state ? 0 : 2;
			}
			elsif ($check eq "off")
			{
				# 'off' was called, make sure the node is now
				# off. This may be called by 'reboot' in which
				# case 'exit_code' will simply be over-written
				# when the final 'reboot' state check is called.
				$exit_code=$feed_state ? 1 : 0;
			}
			elsif ($check eq "on")
			{
				# 'on' was called, make sure the node is now
				# off.
				$exit_code=$feed_state ? 0 : 1;
			}
			elsif ($check eq "reboot")
			{
				# Make sure that 'exit_code' was set to '0' by
				# the earlier call. We checked again to make
				# sure the node came back up, and will log an
				# error if it didn't, but we return '0' just
				# the same, as per the API.
				if (not $exit_code)
				{
					# The power off portion worked. Check if the
					# node booted properly and record an error if
					# not.
					if (not $feed_state)
					{
						record($conf, $log, "\nWARNING: Node: [$node] failed to boot after a successful power off during a\n", 1);
						record($conf, $log, "WARNING: reboot action. This is a non-critical error as the node was fenced\n", 1);
						record($conf, $log, "WARNING: successfully but may indicate a hardware failure with the node or\n", 1);
						record($conf, $log, "WARNING: with Node Assassin itself.\n\n", 1);
					}
				}
				else
				{
					# The power off portion failed, exit with '1'.
					$exit_code=1;
				}
				$exit_code=$feed_state ? 0 : 1;
			}
			next;
		}
 
		# Handle a fence call.
		my @set_state=$conf->{na}{handle}->cmd("$order");
		foreach my $line (@set_state)
		{
			chomp $line;
			next if not $line;
			record($conf, $log, "$line\n");
		}
		record($conf, $log, "Call complete.\n") if $conf->{'system'}{debug};
	}
 
	return ($exit_code);
}
 
# This cleanly exits the agent.
sub do_exit
{
	($conf, $log, $exit_status)=@_;
	$exit_status=9 if not defined $exit_status;
 
	# Close the Node Assassin and log file handle, if they exist.
	$conf->{na}{handle}->close() if $conf->{na}{handle};
	$log->close() if $log;
 
	exit ($exit_status);
}
 
# This gets the states for the active node and returns the states in a hash
# reference.
sub get_states
{
	my ($conf, $log)=@_;
 
	# Create the hash reference to store the states in.
	my $states={};
 
	# Call '00:0' to get the states. If it fails, return 1 as per
	# FenceAgentAPI requirements.
	my @check_state=$conf->{na}{handle}->cmd("00:0") or return(1);
 
	# Loop through the output.
	foreach my $line (@check_state)
	{
		# Chomp the newline off and then pull the port and state out.
		chomp $line;
		my ($this_node, $power_state, $reset_state, $feed_state)=($line=~/^- Node (\d+): P(\d+), R(\d+), F(\d+)$/);
		# Skip if this isn't a status line.
		next if not $this_node;
		# Convert the state to a simple on/off.
		# Store the state.
		$states->{$this_node}{power_state}=$power_state;
		$states->{$this_node}{reset_state}=$reset_state;
		$states->{$this_node}{feed_state}=$feed_state;
		record($conf, $log, "Node: [$this_node], Power State: [$states->{$this_node}{power_state}], Reset State: [$states->{$this_node}{reset_state}], Feed State: [$states->{$this_node}{feed_state}].\n") if $conf->{'system'}{debug};
	}
 
	# Return the hash reference.
	return ($states);
}
 
# This returns the 'help' message.
sub help
{
	my ($conf, $log)=@_;
 
	# Point the user at the man page.
	print "See 'man fence_na' for instructions on using the Node Assassin Fence Agent.\n";
 
	do_exit($conf, $log, 0);
}
 
# This error message is printed when there was a connection problem with a
# given Node Assassin.
sub no_connection_error
{
	my ($conf, $log, $na_id)=@_;
	record ($conf, $log, "\nERROR: Unable to query Node Assassin: [$conf->{na}{$na_id}{na_name}]!\n", 1);
	record ($conf, $log, "ERROR: Please check that it is connected, that the information in\n", 1);
	record ($conf, $log, "ERROR: '/etc/na/fence_na.conf' is accurate and that the proper configuration\n", 1);
	record ($conf, $log, "ERROR: has be uploaded to the device.\n\n", 1);
	return (0);
}
 
# This handles the actual actions.
sub process_action
{
	my ($conf, $log)=@_;
	record($conf, $log, "In the 'process_action' function.\n") if $conf->{'system'}{debug};
 
	# Make this more readable.
	my $na_id=$conf->{'system'}{na_id};
	my $action=$conf->{na}{action};
	my $node=$conf->{na}{port};
	record($conf, $log, "na_id: [$na_id], action: [$action], port: [$node]\n") if $conf->{'system'}{debug};
 
	# The following actions require a port. Error if I don't have one.
	if ($node eq "00")
	{
		# These are the incompatible calls.
		if (($action eq "on") || ($action eq "off") || ($action eq "reboot") || ($action eq "status"))
		{
			record($conf, $log, "\nERROR! Action request: [$action] requires a port number!\n", 1) if $conf->{'system'}{debug};
			record($conf, $log, "ERROR: I got: [$node] which does not seem to be valid.\n\n", 1);
			do_exit($conf, $log, 9);
		}
	}
 
	# Make sure my call order is clear.
	$conf->{'system'}{call_order}="";
	if ($action eq "on")
	{
		# Release the fence, if fenced, and boot the node.
		$states=get_states($conf, $log);
		my $power_state=$states->{$node}{power_state};
		my $reset_state=$states->{$node}{reset_state};
		my $feed_state=$states->{$node}{feed_state};
		if ($feed_state)
		{
			# Node is already running.
			record($conf, $log, "Asked to turn on node: [$node], but it's already running.\n");
			do_exit($conf, $log, 0);
		}
		elsif (($power_state) || ($reset_state))
		{
			# Node was fenced, release it first.
			$conf->{'system'}{call_order}="$node:0,sleep,";
		}
		$conf->{'system'}{call_order}.="$node:2,sleep,$node:on";
	}
	elsif ($action eq "off")
	{
		# Fence the node.
		$conf->{'system'}{call_order}="$node:1,sleep,$node:off";
	}
	elsif ($action eq "reboot")
	{
		# I don't do this gracefully because the API says this should
		# be an 'off' -> 'on' process, and 'off' is fence...
		$conf->{'system'}{call_order}="$node:1,sleep,$node:0,sleep,$node:off,$node:2,sleep,$node:on";
	}
	elsif ($action eq "status")
	{
		# This checks the node's power feed.
		$conf->{'system'}{call_order}="$node:check";
	}
	### ALL ACTIONS BELOW HERE ARE OUTSIDE OF THE FenceAgentAPI!
	elsif ($action eq "release")
	{
		# Release the given node without booting it.
		$conf->{'system'}{call_order}="$node:0";
	}
	elsif ($action eq "release_all")
	{
		# Release all ports.
		$conf->{'system'}{call_order}="release_all";
	}
	elsif ($action eq "fence_all")
	{
		# Fence all ports.
		$conf->{'system'}{call_order}="fence_all";
	}
	elsif ($action eq "boot")
	{
		# Boot the specific node if it is off.
		$states=get_states($conf, $log);
 
		# Decide how, or if, to proceed based on the current state of
		# each node.
		$node=sprintf("%02d", $node);
		my $power_state=$states->{$node}{power_state};
		my $reset_state=$states->{$node}{reset_state};
		my $feed_state=$states->{$node}{feed_state};
		if (($power_state) || ($reset_state))
		{
			# Node was fenced, release first.
			$conf->{'system'}{call_order}.="$node:0,sleep,";
		}
		if (not $feed_state)
		{
			# Boot the node.
			$conf->{'system'}{call_order}.="$node:2,sleep,";
		}
		else
		{
			record($conf, $log, "WARNING: Node: [$node] seems to be already on, taking no action.\n", 1);
		}
		$conf->{'system'}{call_order}=~s/,$//;
	}
	elsif ($action eq "boot_all")
	{
		# Boot all nodes that are off.
		$states=get_states($conf, $log);
 
		# Decide how, or if, to proceed based on the current state of
		# each node.
		foreach my $node (1..$conf->{na}{max_nodes})
		{
			$node=sprintf("%02d", $node);
			my $power_state=$states->{$node}{power_state};
			my $reset_state=$states->{$node}{reset_state};
			my $feed_state=$states->{$node}{feed_state};
			if (($power_state) || ($reset_state))
			{
				# Node was fenced, release first.
				$conf->{'system'}{call_order}.="$node:0,sleep,";
			}
			if (not $feed_state)
			{
				# Boot the node.
				$conf->{'system'}{call_order}.="$node:2,sleep,";
			}
		}
		$conf->{'system'}{call_order}=~s/,$//;
	}
	elsif ($action eq "shutdown")
	{
		# Shutdown a specific node that is on cleanly via ACPI.
		$states=get_states($conf, $log);
		$node=sprintf("%02d", $node);
		my $feed_state=$states->{$node}{feed_state};
		if ($feed_state)
		{
			# shutdown the node.
			$conf->{'system'}{call_order}.="$node:2";
		}
		else
		{
			record($conf, $log, "WARNING: Node: [$node] seems to be already off, taking no action. Is the cable connected?\n", 1);
		}
		$conf->{'system'}{call_order}=~s/,$//;
	}
	elsif ($action eq "shutdown_all")
	{
		# Shutdown all nodes that are on cleanly via ACPI.
		$states=get_states($conf, $log);
 
		# Decide how, or if, to proceed based on the current state of
		# each node.
		foreach my $node (1..$conf->{na}{max_nodes})
		{
			$node=sprintf("%02d", $node);
			my $power_state=$states->{$node}{power_state};
			my $reset_state=$states->{$node}{reset_state};
			my $feed_state=$states->{$node}{feed_state};
			if ($feed_state)
			{
				# Shutdown the node.
				$conf->{'system'}{call_order}.="$node:2,sleep,";
			}
		}
		$conf->{'system'}{call_order}=~s/,$//;
	}
	elsif ($action eq "forcedown_all")
	{
		# Shutdown all nodes that are on by holding the power button
		# until they go down.
		$states=get_states($conf, $log);
 
		# Decide how, or if, to proceed based on the current state of
		# each node.
		foreach my $node (1..$conf->{na}{max_nodes})
		{
			$node=sprintf("%02d", $node);
			my $power_state=$states->{$node}{power_state};
			my $reset_state=$states->{$node}{reset_state};
			my $feed_state=$states->{$node}{feed_state};
			if ($feed_state)
			{
				# Boot the node.
				$conf->{'system'}{call_order}.="$node:3,sleep,";
			}
		}
		$conf->{'system'}{call_order}=~s/,$//;
	}
	else
	{
		record($conf, $log, "\nERROR: Unknown action request: [$action]!\n\n", 1);
		do_exit($conf, $log, 9);
	}
}
 
# Read in the config file.
sub read_conf
{
	my ($conf)=@_;
	$conf={} if not $conf;
 
	# I can't call the 'record' method here because I've not read in the
	# log file and thus don't know where to write the log to yet. Comment
	# out or delete 'print' statements before release.
	my $read=IO::Handle->new();
	my $shell_call="$conf->{'system'}{conf_file}";
	record($conf, $log, "Shell call: [$shell_call]\n") if $conf->{'system'}{debug};
	open ($read, "<$shell_call") or die "Failed to read: [$shell_call], error was: $!\n";
	while (<$read>)
	{
		chomp;
		my $line=$_;
		next if not $line;
		next if $line !~ /=/;
		$line=~s/^\s+//;
		$line=~s/\s+$//;
		next if $line =~ /^#/;
		next if not $line;
		my ($var, $val)=(split/=/, $line, 2);
		$var=~s/^\s+//;
		$var=~s/\s+$//;
		$val=~s/^\s+//;
		$val=~s/\s+$//;
		next if (not $var);
		record($conf, $log, "Storing: [$var] = [$val]\n") if $conf->{'system'}{debug};
		_make_hash_reference($conf, $var, $val);
	}
	$read->close();
 
	return (0);
}
 
# Read in command line arguments
sub read_cla
{
	my ($conf, $log, $bad)=@_;
 
	# Loop through the passed arguments, if any.
	record($conf, $log, "Got args:\n") if $conf->{'system'}{debug};
	my $set_next="";
	foreach my $arg (@ARGV)
	{
		record($conf, $log, "[$arg]\n") if $conf->{'system'}{debug};
		$conf->{'system'}{got_cla}=1;
 
		# If 'set_next' has a value, push this argument into the 'conf'
		# hash.
		if ($set_next)
		{
			# It's set, use it's contents as the hash key.
			$conf->{na}{$set_next}=$arg;
			record($conf, $log, "Setting: 'na::$set_next': [$conf->{na}{$set_next}]\n") if $conf->{'system'}{debug};
 
			# Clear it now for the next go-round.
			$set_next="";
			next;
		}
		if ($arg=~/-h/)
		{
			# Print the help message and then exit.
			help($conf, $log);
		}
		elsif ($arg=~/-v/)
		{
			# Print the version information and then exit.
			$conf->{'system'}{version}=1;
			record($conf,$log,"Setting version\n") if $conf->{'system'}{debug};
		}
		elsif ($arg=~/-q/)
		{
			# Suppress all non-critical messages from STDOUT.
			$conf->{'system'}{quiet}=1;
		}
		elsif ($arg=~/-d/)
		{
			# Enable debug mode.
			$conf->{'system'}{debug}=1;
		}
		elsif ($arg=~/^-/)
		{
			$arg=~s/^-//;
 
			### These are the switches set by Red Hat.
			if ($arg eq "a")
			{
				# This is the IP address or hostname of the
				# Node Assassin to call.
				$set_next="ipaddr";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
			elsif ($arg eq "l")
			{
				# This is the login name.
				$set_next="login";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
			elsif ($arg eq "p")
			{
				# This is the password. If it starts with '/'
				# it is interpreted to be a file containing the
				# password which will be read in and it's
				# contents will replace# this value.
				$set_next="passwd";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
			elsif ($arg eq "n")
			{
				# This is the node to work on.
				$set_next="port";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
			elsif ($arg eq "o")
			{
				# This is the action to take.
				$set_next="action";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
			elsif ($arg eq "S")
			{
				# This is the script to run to retrieve the
				# password when it is not stored in
				# 'cluster.conf'. This script should echo/print
				# the password to STDOUT.
				$set_next="passwd_script";
				record ($conf, $log, "Next argument will be stored in: [$set_next]\n") if $conf->{'system'}{debug};
			}
		}
		else
		{
			### MADI: I might want to pick up arguments via multiple lines.
			# Bad argument.
			record($conf, $log, "\nERROR: Argument: [$arg] is not valid!\n");
			record($conf, $log, "ERROR: Please run: [man fence_na] to see a list of valid arguments.\n\n");
			$bad=1;
		}
	}
}
 
# Read arguments from STDIN. This is adapted from the 'fence_brocade' agent.
sub read_stdin
{
	my ($conf, $log, $bad)=@_;
 
	return (0) if $conf->{'system'}{got_cla};
 
	my $option;
	my $line_count=0;
	while(defined (my $option=<>))
	{
		# Get rid of newlines.
		chomp $option;
 
		# Record the line for now, but comment this out before release.
		record ($conf, $log, "Processing option line: [$option]\n") if $conf->{'system'}{debug};
 
		# strip leading and trailing whitespace
		$option=~s/^\s*//;
		$option=~s/\s*$//;
 
		# skip comments
		next if ($option=~ /^#/);
 
		# Increment my option line count.
		$line_count++;
 
		# Go to the next line if the option line is empty.
		next if not $option;
 
		# Split the option up into the name and the value.
		($name,$value)=split /\s*=\s*/, $option;
 
		# Record the line for now, but comment this out before release.
		record ($conf, $log, "Name: [$name], value: [$value].\n") if $conf->{'system'}{debug};
 
		# Set my variables depending on the veriable name.
		if ($name eq "agent")
		{
			# This is only used by 'fenced', but I record it for
			# potential debugging.
			$conf->{na}{agent}=$value;
		}
		elsif ($name eq "fm")
		{
			# This is a deprecated argument that should no longer
			# be used. Now 'port' should be used.
			if (not $conf->{na}{port})
			{
				# Port isn't set yet, use this value which may
				# be replaced if 'port' is set later.
				(undef, $value) = split /\s+/,$value;
				$conf->{na}{port}=$value;
				record($conf, $log, "Warning! The argument 'fm' is deprecated, use 'port' instead.\n", 1);
				record($conf, $log, "Warning! Value: [$value] set for 'port'\n", 1);
			}
			else
			{
				# Port was already set, so simply ignore this.
				record($conf, $log, "Warning! The argument 'fm' is deprecated, use 'port' instead.\n", 1);
				record($conf, $log, "Warning! Value: [$value] ignored.\n", 1);
			}
		}
		elsif ($name eq "ipaddr") 
		{
			# Record the IP Address or name of the Node Assassin to
			# use.
			$conf->{na}{ipaddr}=$value;
		} 
		elsif ($name eq "login")
		{
			# Record the login name that was passed.
			$conf->{na}{login}=$value;
		} 
		elsif ($name eq "name")
		{
			# Depricated argument used formerly for login name.
			if (not $conf->{na}{login})
			{
				# Login isn't set yet, use this value which may
				# be replaced if 'login' is seen later.
				$conf->{na}{login}=$value;
				record($conf, $log, "Warning! The argument 'name' is deprecated, use 'login' instead.\n", 1);
				record($conf, $log, "Warning! Value: [$value] set for 'login'.\n", 1);
			}
			else
			{
				# I've already seen the 'login' value so I will
				# ignore this value.
				record($conf, $log, "Warning! The argument 'name' is deprecated, use 'login' instead.\n", 1);
				record($conf, $log, "Warning! Value: [$value] ignored.\n", 1);
			}
		}
		elsif (($name eq "action") or ($name eq "option"))
		{
			# 'option' is deprecated.
			record($conf, $log, "Please use 'action', not 'option', as the later is deprecated.\n", 1) if $name eq "option";
			$conf->{na}{action}=$value;
		}
		elsif ($name eq "passwd")
		{
			# This is the login password.
			$conf->{na}{passwd}=$value;
		} 
		elsif ($name eq "passwd_script")
		{
			# This is the path to the script that will return the
			# password to the agent. At this time, this is not
			# implemented.
			$conf->{na}{passwd_script}=$value;
		}
		elsif ($name eq "port")
		{
			# This sets the port number to act on.
			$conf->{na}{port}=$value;
		}
		elsif ($name eq "nodename")
		{
			# This is passed by 'fenced' via 'cluster.conf' as of
			# cluster version 3, but it's not yet documented.
			$conf->{'system'}{nodename}=$value;
		}
		elsif ($name eq "quiet")
		{
			# This is passed by 'fenced' via 'cluster.conf' as a
			# custom argument to supress output to STDOUT.
			$conf->{'system'}{quiet}=1;
		}
		else
		{
			record($conf, $log, "\nERROR: Illegal name in option: [$option] at line: [$line_count]\n\n", 1);
			# 'rohara' from #linux-cluster suggested it's better to
			# simply ignore unknown input, as that is the behaviour
			# the fenced authors expect.
			#$bad=1;
		}
	}
	return ($bad);
}
 
# This function simply prints messages to both the log and to stdout.
sub record
{
	my ($conf, $log, $msg, $critical)=@_;
	$critical=0 if not $critical;
 
	# The log file gets everything.
	print $log $msg;
	print $msg if not $conf->{'system'}{quiet};
 
	# Critical messages have to print, so this ensure that it gets out
	# when 'quiet' is in use.
	print $msg if (($critical) && ($conf->{'system'}{quiet}));
 
	return(0);
}
 
# This sets all ports of a given Node Assassin to the requested state.
sub set_all_state
{
	my ($conf, $log, $state)=@_;
	$state=0 if not defined $state;
 
	my $max_port=$conf->{na}{max_nodes};
	foreach my $node (1..$max_port)
	{
		$node=sprintf("%02d", $node).":$state";
		record ($conf, $log, "Calling: [$node]\n") if $conf->{'system'}{debug};
		my @set_state=$conf->{na}{handle}->cmd("$node");
		foreach my $line (@set_state)
		{
			chomp $line;
			next if not $line;
			record($conf, $log, "$line\n");
		}
	}
 
	return (9);
}
 
# When asked to 'monitor' or 'list', show a CSV of all nodes and their aliases,
# when found in the config file.
sub show_list
{
	my ($conf, $log)=@_;
	record($conf, $log, "In 'show_list' function.\n") if $conf->{'system'}{debug};
 
	# Get an up to date list of the ports.
	my $na_id=$conf->{'system'}{na_id};
	record($conf, $log, "na_id: [$na_id], max_node: [$conf->{na}{max_nodes}]\n") if $conf->{'system'}{debug};
 
	for (1..$conf->{na}{max_nodes})
	{
		my $node=$_;
		my $alias=$conf->{na}{$na_id}{alias}{$node} ? $conf->{na}{$na_id}{alias}{$node} : "--";
		record ($conf, $log, "$node,$alias\n", 1);
	}
 
	do_exit($conf, $log, 0);
}
 
# This prints the version information of this fence agent and of any configured
# fence devices.
sub version
{
	my ($conf, $log)=@_;
 
	# Print the Fence Agent version first.
	record ($conf, $log, "Fence Agent: ..... Node Assassin ver. $conf->{'system'}{agent_version}\n", 1);
	record ($conf, $log, "Node Assassins: .. $conf->{'system'}{na_num}\n", 1);
	for my $na_id (1..$conf->{'system'}{na_num})
	{
		$conf->{'system'}{na_id}=$na_id;
		$conf->{na}{ipaddr}=     $conf->{na}{$na_id}{ipaddr};
		$conf->{na}{tcp_port}=   $conf->{na}{$na_id}{tcp_port};
		$conf->{na}{na_name}=    $conf->{na}{$na_id}{na_name};
		my $build_date="";
		my $serial_number="";
		my $firmware_ver="";
		connect_to_na($conf, $log);
		if ($conf->{na}{handle})
		{
			# Get the NAOS version and serial numbers.
			my @details=$conf->{na}{handle}->cmd("00:1");
			foreach my $line (sort {$a cmp $b} @details)
			{
				chomp $line;
				($build_date)=($line=~/\s(\S+)$/) if ($line =~ /Build Date/i );
				($serial_number)=($line=~/\s(\S+)$/) if ($line =~ /Serial Number/i );
				($firmware_ver)=($line=~/\s(\S+)$/) if ($line =~ /NAOS Version/i );
				record($conf, $log, "line: [$line]\n") if $conf->{'system'}{debug};
			}
		}
		else
		{
			$build_date="??";
			$serial_number="??";
			$firmware_ver="??";
		}
		record ($conf, $log, " - Node Assassin:  #$na_id\n", 1);
		record ($conf, $log, "   - Name: ....... $conf->{na}{$na_id}{na_name}\n", 1);
		record ($conf, $log, "   - IP Address: . $conf->{na}{$na_id}{ipaddr}\n", 1);
		record ($conf, $log, "   - TCP Port: ... $conf->{na}{$na_id}{tcp_port}\n", 1);
		record ($conf, $log, "   - MAC Address:  $conf->{na}{$na_id}{mac}\n", 1);
		record ($conf, $log, "   - Netmask: .... $conf->{na}{$na_id}{netmask}\n", 1);
		record ($conf, $log, "   - Gateway: .... $conf->{na}{$na_id}{gateway}\n", 1);
		record ($conf, $log, "   - Serial #: ... $serial_number\n", 1);
		record ($conf, $log, "   - Firmware: ... $firmware_ver\n", 1);
		record ($conf, $log, "   - Build Date: . $build_date (yyyy-mm-dd)\n", 1);
		record ($conf, $log, "   - Max Nodes: .. $conf->{na}{$na_id}{max_nodes}\n", 1);
 
		# Get the node states.
		$states=get_states($conf, $log);
		for (1..$conf->{na}{$na_id}{max_nodes})
		{
			my $node=sprintf("%02d", $_);
			my $power_state=$states->{$node}{power_state};
			my $reset_state=$states->{$node}{reset_state};
			my $feed_state=$states->{$node}{feed_state};
			record ($conf, $log, "     - Node $node: .. p[$power_state], r[$reset_state], f[$feed_state]\n", 1);
		}
 
		# Close the handle for the next loop.
		if ($conf->{na}{handle})
		{
			show_list($conf, $log, "version", 1);
			$conf->{na}{tcp_port}->close();
		}
		else
		{
			no_connection_error($conf, $log, $na_id);
		}
	}
	do_exit($conf, $log, 0);
}
 
 
###############################################################################
# Private functions below here.                                               #
###############################################################################
 
### Contributed by Shaun Fryer and Viktor Pavlenko by way of TPM.
# This is a helper to the above '_add_href' method. It is called each time a
# new string is to be created as a new hash key in the passed hash reference.
sub _add_hash_reference
{
	my $href1=shift;
	my $href2=shift;
 
	for my $key (keys %$href2)
	{
		if (ref $href1->{$key} eq 'HASH')
		{
			_add_hash_reference($href1->{$key}, $href2->{$key});
		}
		else
		{
			$href1->{$key}=$href2->{$key};
		}
	}
}
 
### Contributed by Shaun Fryer and Viktor Pavlenko by way of TPM.
# This takes a string with double-colon seperators and divides on those
# double-colons to create a hash reference where each element is a hash key.
sub _make_hash_reference
{
	my $href=shift;
	my $key_string=shift;
	my $value=shift;
# 	print "variable: [$key_string], value: [$value]\n";
 
	my $chomp_root=0;
	if ($chomp_root) { $key_string=~s/\w+:://; }
 
	my @keys = split /::/, $key_string;
	my $last_key = pop @keys;
	my $_href = {};
	$_href->{$last_key}=$value;
	while (my $key = pop @keys)
	{
		my $elem = {};
		$elem->{$key} = $_href;
		$_href = $elem;
	}
	_add_hash_reference($href, $_href);
}
 
1;

 

Input, advice, complaints and meanderings all welcome!
Digimer digimer@alteeve.ca https://alteeve.ca/w legal stuff:  
All info is provided "As-Is". Do not use anything here unless you are willing and able to take resposibility for your own actions. © 1997-2013
Naming credits go to Christopher Olah!
In memory of Kettle, Tonia, Josh, Leah and Harvey. In special memory of Hannah, Jack and Riley.
Personal tools
Namespaces

Variants
Actions
Navigation
projects
Toolbox