diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 06:50:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 06:50:17 +0000 |
commit | 86ed03f8adee56c050c73018537371c230a664a6 (patch) | |
tree | eae3d04cdf1c49848e5a671327ab38297f4acb0d /agents/ifmib | |
parent | Initial commit. (diff) | |
download | fence-agents-86ed03f8adee56c050c73018537371c230a664a6.tar.xz fence-agents-86ed03f8adee56c050c73018537371c230a664a6.zip |
Adding upstream version 4.12.1.upstream/4.12.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'agents/ifmib')
-rw-r--r-- | agents/ifmib/README | 45 | ||||
-rw-r--r-- | agents/ifmib/fence_ifmib.py | 116 |
2 files changed, 161 insertions, 0 deletions
diff --git a/agents/ifmib/README b/agents/ifmib/README new file mode 100644 index 0000000..6fe8a2b --- /dev/null +++ b/agents/ifmib/README @@ -0,0 +1,45 @@ +Intro: +------ +This is an SNMP-based fencing agent for RHCS. It was designed with the use-case +of disabling ethernet ports on an iSCSI SAN, but could be used to disable any +port on any SNMP v1/2c/3 device that implementes the IF-MIB. + +The script requires NetSNMP to be installed and working on all nodes +in the cluster. There are no requirements for any MIBs to be setup --- all of +the required OIDs are hard-coded into the script. Since the IF-MIB is an IETF +standard, these identifiers are very widely supported and will not change. + + +Typical usage: +-------------- +To use this agent with the switch used on the iSCSI network, you'll need: + 1) A managed switch running SNMP. + 2) An SNMP community with write privileges. + 3) Permission to send SNMP through any ACLs or firewalls from the nodes. + 4) The ifIndex or ifPort associated with the ports being used by the cluster nodes. + +Consider a three-node cluster composed of A, B, and C. Each node has two +network interfaces - one used for network and cluster communication, the second +used for iSCSI traffic. If A needs to be fenced, B and C will run this script +to administratively disable the switchport for A's connection to the iSCSI +storage. + +If you are using a single interface for cluster and iSCSI traffic, this will +still work, but you will lose network connectivity to the fenced host. + + +cluster.conf: +------------- +There is no GUI support for this fence agent at this time. To use it, you will +need something like this cluster.conf + +<fencedevice agent="fence_ifmib" name="myswitch" comm="fencing" ipaddr="sw1"/> + +In a node's fencing methods, you'll include a line like this: + +<device name="myswitch" port="43" option="off"/> + +This node will be fenced by disabling the port with ifIndex 43 on the host sw1. +In SNMP speak, we set IF-MIB::ifAdminStatus.43 = down(2). + +If you will use port name (like fc1/1), script will try to find ifIndex. diff --git a/agents/ifmib/fence_ifmib.py b/agents/ifmib/fence_ifmib.py new file mode 100644 index 0000000..d119134 --- /dev/null +++ b/agents/ifmib/fence_ifmib.py @@ -0,0 +1,116 @@ +#!@PYTHON@ -tt + +# The Following agent has been tested on: +# - Cisco MDS UROS 9134 FC (1 Slot) Chassis ("1/2/4 10 Gbps FC/Supervisor-2") Motorola, e500v2 +# with BIOS 1.0.16, kickstart 4.1(1c), system 4.1(1c) +# - Cisco MDS 9124 (1 Slot) Chassis ("1/2/4 Gbps FC/Supervisor-2") Motorola, e500 +# with BIOS 1.0.16, kickstart 4.1(1c), system 4.1(1c) +# - Partially with APC PDU (Network Management Card AOS v2.7.0, Rack PDU APP v2.7.3) +# Only lance if is visible + +import sys +import atexit +sys.path.append("@FENCEAGENTSLIBDIR@") +from fencing import * +from fencing import fail_usage, array_to_dict +from fencing_snmp import FencingSnmp + +### CONSTANTS ### +# IF-MIB trees for alias, status and port +ALIASES_OID = ".1.3.6.1.2.1.31.1.1.1.18" +PORTS_OID = ".1.3.6.1.2.1.2.2.1.2" +STATUSES_OID = ".1.3.6.1.2.1.2.2.1.7" + +# Status constants returned as value from SNMP +STATUS_UP = 1 +STATUS_DOWN = 2 +STATUS_TESTING = 3 + +### GLOBAL VARIABLES ### +# Port number converted from port name or index +port_num = None + +### FUNCTIONS ### + +# Convert port index or name to port index +def port2index(conn, port): + res = None + + if port.isdigit(): + res = int(port) + else: + ports = conn.walk(PORTS_OID, 30) + + for x in ports: + if x[1].strip('"') == port: + res = int(x[0].split('.')[-1]) + break + + if res == None: + fail_usage("Can't find port with name %s!"%(port)) + + return res + +def get_power_status(conn, options): + global port_num + + if port_num == None: + port_num = port2index(conn, options["--plug"]) + + (_, status) = conn.get("%s.%d"%(STATUSES_OID, port_num)) + return status == str(STATUS_UP) and "on" or "off" + +def set_power_status(conn, options): + global port_num + + if port_num == None: + port_num = port2index(conn, options["--plug"]) + + conn.set("%s.%d" % (STATUSES_OID, port_num), (options["--action"] == "on" and STATUS_UP or STATUS_DOWN)) + +def get_outlets_status(conn, options): + result = {} + + res_fc = conn.walk(PORTS_OID, 30) + res_aliases = array_to_dict(conn.walk(ALIASES_OID, 30)) + + for x in res_fc: + port_number = x[0].split('.')[-1] + + port_name = x[1].strip('"') + port_alias = (port_number in res_aliases and res_aliases[port_number].strip('"') or "") + port_status = "" + result[port_name] = (port_alias, port_status) + + return result + +# Main agent method +def main(): + device_opt = ["fabric_fencing", "ipaddr", "login", "passwd", "no_login", "no_password", \ + "port", "snmp_version", "snmp"] + + atexit.register(atexit_handler) + + all_opt["snmp_version"]["default"] = "2c" + + options = check_input(device_opt, process_input(device_opt)) + + docs = {} + docs["shortdesc"] = "Fence agent for IF MIB" + docs["longdesc"] = "fence_ifmib is an I/O Fencing agent \ +which can be used with any SNMP IF-MIB capable device. \ +\n.P\n\ +It was written with managed ethernet switches in mind, in order to \ +fence iSCSI SAN connections. However, there are many devices that \ +support the IF-MIB interface. The agent uses IF-MIB::ifAdminStatus \ +to control the state of an interface." + docs["vendorurl"] = "http://www.ietf.org/wg/concluded/ifmib.html" + show_docs(options, docs) + + # Operate the fencing device + result = fence_action(FencingSnmp(options), options, set_power_status, get_power_status, get_outlets_status) + + sys.exit(result) + +if __name__ == "__main__": + main() |