Blob Blame History Raw
diff -uNr a/configure.ac b/configure.ac
--- a/configure.ac	2017-10-05 14:14:39.688675727 +0200
+++ b/configure.ac	2017-10-05 14:15:17.964291884 +0200
@@ -265,7 +265,8 @@
 		 fence/agents/alom/Makefile
 		 fence/agents/apc/Makefile
 		 fence/agents/apc_snmp/Makefile
-		 fence/agents/amt/Makefile 
+		 fence/agents/amt/Makefile
+		 fence/agents/amt_ws/Makefile
 		 fence/agents/bladecenter/Makefile
 		 fence/agents/brocade/Makefile
 		 fence/agents/cisco_mds/Makefile
diff -uNr a/fence/agents/amt_ws/fence_amt_ws.py b/fence/agents/amt_ws/fence_amt_ws.py
--- a/fence/agents/amt_ws/fence_amt_ws.py	1970-01-01 01:00:00.000000000 +0100
+++ b/fence/agents/amt_ws/fence_amt_ws.py	2017-10-05 14:15:17.965291874 +0200
@@ -0,0 +1,243 @@
+#!/usr/bin/python -tt
+
+#
+# Fence agent for Intel AMT (WS) based on code from the openstack/ironic project:
+# https://github.com/openstack/ironic/blob/master/ironic/drivers/modules/amt/power.py
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+import sys
+import atexit
+import logging
+sys.path.append("@FENCEAGENTSLIBDIR@")
+from fencing import *
+from fencing import run_delay, fail_usage, fail, EC_STATUS
+
+import pywsman
+from xml.etree import ElementTree
+
+
+#BEGIN_VERSION_GENERATION
+RELEASE_VERSION="Fence agent for Intel AMT (WS)"
+REDHAT_COPYRIGHT=""
+BUILD_DATE=""
+#END_VERSION_GENERATION
+
+POWER_ON='2'
+POWER_OFF='8'
+POWER_CYCLE='10'
+
+RET_SUCCESS = '0'
+
+CIM_PowerManagementService           = ('http://schemas.dmtf.org/wbem/wscim/1/'
+                                        'cim-schema/2/CIM_PowerManagementService')
+CIM_ComputerSystem                   = ('http://schemas.dmtf.org/wbem/wscim/'
+                                        '1/cim-schema/2/CIM_ComputerSystem')
+CIM_AssociatedPowerManagementService = ('http://schemas.dmtf.org/wbem/wscim/'
+                                        '1/cim-schema/2/'
+                                        'CIM_AssociatedPowerManagementService')
+
+CIM_BootConfigSetting                = ('http://schemas.dmtf.org/wbem/wscim/'
+                                        '1/cim-schema/2/CIM_BootConfigSetting')
+CIM_BootSourceSetting                = ('http://schemas.dmtf.org/wbem/wscim/'
+                                        '1/cim-schema/2/CIM_BootSourceSetting')
+
+
+def xml_find(doc, namespace, item):
+    if doc is None:
+        return
+    tree = ElementTree.fromstring(doc.root().string())
+    query = ('.//{%(namespace)s}%(item)s' % {'namespace': namespace,
+                                             'item': item})
+    return tree.find(query)
+
+def _generate_power_action_input(action):
+    method_input = "RequestPowerStateChange_INPUT"
+    address = 'http://schemas.xmlsoap.org/ws/2004/08/addressing'
+    anonymous = ('http://schemas.xmlsoap.org/ws/2004/08/addressing/'
+                 'role/anonymous')
+    wsman = 'http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd'
+    namespace = CIM_PowerManagementService
+
+    doc = pywsman.XmlDoc(method_input)
+    root = doc.root()
+    root.set_ns(namespace)
+    root.add(namespace, 'PowerState', action)
+
+    child = root.add(namespace, 'ManagedElement', None)
+    child.add(address, 'Address', anonymous)
+
+    grand_child = child.add(address, 'ReferenceParameters', None)
+    grand_child.add(wsman, 'ResourceURI', CIM_ComputerSystem)
+
+    g_grand_child = grand_child.add(wsman, 'SelectorSet', None)
+    g_g_grand_child = g_grand_child.add(wsman, 'Selector', 'ManagedSystem')
+    g_g_grand_child.attr_add(wsman, 'Name', 'Name')
+    return doc
+
+def get_power_status(_, options):
+    client = pywsman.Client(options["--ip"], int(options["--ipport"]), \
+                            '/wsman', 'http', 'admin', options["--password"])
+    namespace = CIM_AssociatedPowerManagementService
+    client_options = pywsman.ClientOptions()
+    doc = client.get(client_options, namespace)
+    _SOAP_ENVELOPE = 'http://www.w3.org/2003/05/soap-envelope'
+    item = 'Fault'
+    fault = xml_find(doc, _SOAP_ENVELOPE, item)
+    if fault is not None:
+        logging.error("Failed to get power state for: %s port:%s", \
+                      options["--ip"], options["--ipport"])
+        fail(EC_STATUS)
+
+    item = "PowerState"
+    try: power_state = xml_find(doc, namespace, item).text
+    except AttributeError:
+        logging.error("Failed to get power state for: %s port:%s", \
+                      options["--ip"], options["--ipport"])
+        fail(EC_STATUS)
+    if power_state == POWER_ON:
+        return "on"
+    elif power_state == POWER_OFF:
+        return "off"
+    else:
+        fail(EC_STATUS)
+
+def set_power_status(_, options):
+    client = pywsman.Client(options["--ip"], int(options["--ipport"]), \
+                            '/wsman', 'http', 'admin', options["--password"])
+
+    method = 'RequestPowerStateChange'
+    client_options = pywsman.ClientOptions()
+    client_options.add_selector('Name', 'Intel(r) AMT Power Management Service')
+
+    if options["--action"] == "on":
+        target_state = POWER_ON
+    elif options["--action"] == "off":
+        target_state = POWER_OFF
+    elif options["--action"] == "reboot":
+        target_state = POWER_CYCLE
+    if options["--action"] in ["on", "off", "reboot"] \
+       and options.has_key("--boot-option"):
+        set_boot_order(_, client, options)
+
+    doc = _generate_power_action_input(target_state)
+    client_doc = client.invoke(client_options, CIM_PowerManagementService, \
+                               method, doc)
+    item = "ReturnValue"
+    return_value = xml_find(client_doc, CIM_PowerManagementService, item).text
+    if return_value != RET_SUCCESS:
+        logging.error("Failed to set power state: %s for: %s", \
+                      options["--action"], options["--ip"])
+        fail(EC_STATUS)
+
+def set_boot_order(_, client, options):
+    method_input = "ChangeBootOrder_INPUT"
+    address = 'http://schemas.xmlsoap.org/ws/2004/08/addressing'
+    anonymous = ('http://schemas.xmlsoap.org/ws/2004/08/addressing/'
+                 'role/anonymous')
+    wsman = 'http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd'
+    namespace = CIM_BootConfigSetting
+
+    if options["--boot-option"] == "pxe":
+        device = "Intel(r) AMT: Force PXE Boot"
+    elif options["--boot-option"] in ["hd", "hdsafe"]:
+        device = "Intel(r) AMT: Force Hard-drive Boot"
+    elif options["--boot-option"] == "cd":
+        device = "Intel(r) AMT: Force CD/DVD Boot"
+    elif options["--boot-option"] == "diag":
+        device = "Intel(r) AMT: Force Diagnostic Boot"
+    else:
+        logging.error('Boot device: %s not supported.', \
+                      options["--boot-option"])
+        return
+
+    method = 'ChangeBootOrder'
+    client_options = pywsman.ClientOptions()
+    client_options.add_selector('InstanceID', \
+                                'Intel(r) AMT: Boot Configuration 0')
+
+    doc = pywsman.XmlDoc(method_input)
+    root = doc.root()
+    root.set_ns(namespace)
+
+    child = root.add(namespace, 'Source', None)
+    child.add(address, 'Address', anonymous)
+
+    grand_child = child.add(address, 'ReferenceParameters', None)
+    grand_child.add(wsman, 'ResourceURI', CIM_BootSourceSetting)
+
+    g_grand_child = grand_child.add(wsman, 'SelectorSet', None)
+    g_g_grand_child = g_grand_child.add(wsman, 'Selector', device)
+    g_g_grand_child.attr_add(wsman, 'Name', 'InstanceID')
+    if options["--boot-option"] == "hdsafe":
+        g_g_grand_child = g_grand_child.add(wsman, 'Selector', 'True')
+        g_g_grand_child.attr_add(wsman, 'Name', 'UseSafeMode')
+
+    client_doc = client.invoke(client_options, CIM_BootConfigSetting, \
+                               method, doc)
+    item = "ReturnValue"
+    return_value = xml_find(client_doc, CIM_BootConfigSetting, item).text
+    if return_value != RET_SUCCESS:
+        logging.error("Failed to set boot device to: %s for: %s", \
+                      options["--boot-option"], options["--ip"])
+        fail(EC_STATUS)
+
+def reboot_cycle(_, options):
+    status = set_power_status(_, options)
+    return not bool(status)
+
+def define_new_opts():
+    all_opt["boot_option"] = {
+        "getopt" : "b:",
+        "longopt" : "boot-option",
+        "help" : "-b, --boot-option=[option]     "
+                "Change the default boot behavior of the\n"
+                "                                  machine."
+                " (pxe|hd|hdsafe|cd|diag)",
+        "required" : "0",
+        "shortdesc" : "Change the default boot behavior of the machine.",
+        "choices" : ["pxe", "hd", "hdsafe", "cd", "diag"],
+        "order" : 1
+    }
+
+def main():
+    atexit.register(atexit_handler)
+
+    device_opt = ["ipaddr", "no_login", "passwd", "boot_option", "no_port",
+                  "method"]
+
+    define_new_opts()
+
+    all_opt["ipport"]["default"] = "16992"
+
+    options = check_input(device_opt, process_input(device_opt))
+
+    docs = {}
+    docs["shortdesc"] = "Fence agent for AMT (WS)"
+    docs["longdesc"] = "fence_amt_ws is an I/O Fencing agent \
+which can be used with Intel AMT (WS). This agent requires \
+the pywsman Python library which is included in OpenWSMAN. \
+(http://openwsman.github.io/)."
+    docs["vendorurl"] = "http://www.intel.com/"
+    show_docs(options, docs)
+
+    run_delay(options)
+
+    result = fence_action(None, options, set_power_status, get_power_status, \
+                          None, reboot_cycle)
+
+    sys.exit(result)
+
+if __name__ == "__main__":
+    main()
diff -uNr a/fence/agents/amt_ws/Makefile.am b/fence/agents/amt_ws/Makefile.am
--- a/fence/agents/amt_ws/Makefile.am	1970-01-01 01:00:00.000000000 +0100
+++ b/fence/agents/amt_ws/Makefile.am	2017-10-05 14:15:17.965291874 +0200
@@ -0,0 +1,17 @@
+MAINTAINERCLEANFILES	= Makefile.in
+
+TARGET			= fence_amt_ws
+
+SRC			= $(TARGET).py
+
+EXTRA_DIST		= $(SRC)
+
+sbin_SCRIPTS		= $(TARGET)
+
+man_MANS		= $(TARGET).8
+
+FENCE_TEST_ARGS         = -p test -a test
+
+include $(top_srcdir)/make/fencebuild.mk
+include $(top_srcdir)/make/fenceman.mk
+include $(top_srcdir)/make/agentpycheck.mk
diff -uNr a/tests/data/metadata/fence_amt_ws.xml b/tests/data/metadata/fence_amt_ws.xml
--- a/tests/data/metadata/fence_amt_ws.xml	1970-01-01 01:00:00.000000000 +0100
+++ b/tests/data/metadata/fence_amt_ws.xml	2017-10-05 14:10:49.145987710 +0200
@@ -0,0 +1,155 @@
+<?xml version="1.0" ?>
+<resource-agent name="fence_amt_ws" shortdesc="Fence agent for AMT (WS)" >
+<longdesc>fence_amt_ws is an I/O Fencing agent which can be used with Intel AMT (WS). This agent requires the pywsman Python library which is included in OpenWSMAN. (http://openwsman.github.io/).</longdesc>
+<vendor-url>http://www.intel.com/</vendor-url>
+<parameters>
+	<parameter name="ipport" unique="0" required="0">
+		<getopt mixed="-u, --ipport=[port]" />
+		<content type="integer" default="16992"  />
+		<shortdesc lang="en">TCP/UDP port to use for connection with device</shortdesc>
+	</parameter>
+	<parameter name="port" unique="0" required="0" deprecated="1">
+		<getopt mixed="-n, --plug=[ip]" />
+		<content type="string"  />
+		<shortdesc lang="en">IP address or hostname of fencing device (together with --port-as-ip)</shortdesc>
+	</parameter>
+	<parameter name="inet6_only" unique="0" required="0">
+		<getopt mixed="-6, --inet6-only" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Forces agent to use IPv6 addresses only</shortdesc>
+	</parameter>
+	<parameter name="ipaddr" unique="0" required="0" deprecated="1">
+		<getopt mixed="-a, --ip=[ip]" />
+		<content type="string"  />
+		<shortdesc lang="en">IP Address or Hostname</shortdesc>
+	</parameter>
+	<parameter name="inet4_only" unique="0" required="0">
+		<getopt mixed="-4, --inet4-only" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Forces agent to use IPv4 addresses only</shortdesc>
+	</parameter>
+	<parameter name="method" unique="0" required="0">
+		<getopt mixed="-m, --method=[method]" />
+		<content type="select" default="onoff"  >
+			<option value="onoff" />
+			<option value="cycle" />
+		</content>
+		<shortdesc lang="en">Method to fence (onoff|cycle)</shortdesc>
+	</parameter>
+	<parameter name="passwd_script" unique="0" required="0" deprecated="1">
+		<getopt mixed="-S, --password-script=[script]" />
+		<content type="string"  />
+		<shortdesc lang="en">Script to retrieve password</shortdesc>
+	</parameter>
+	<parameter name="passwd" unique="0" required="0" deprecated="1">
+		<getopt mixed="-p, --password=[password]" />
+		<content type="string"  />
+		<shortdesc lang="en">Login password or passphrase</shortdesc>
+	</parameter>
+	<parameter name="boot_option" unique="0" required="0">
+		<getopt mixed="-b, --boot-option=[option]" />
+		<content type="select"  >
+			<option value="pxe" />
+			<option value="hd" />
+			<option value="hdsafe" />
+			<option value="cd" />
+			<option value="diag" />
+		</content>
+		<shortdesc lang="en">Change the default boot behavior of the machine.</shortdesc>
+	</parameter>
+	<parameter name="action" unique="0" required="1">
+		<getopt mixed="-o, --action=[action]" />
+		<content type="string" default="reboot"  />
+		<shortdesc lang="en">Fencing Action</shortdesc>
+	</parameter>
+	<parameter name="plug" unique="0" required="0" obsoletes="port">
+		<getopt mixed="-n, --plug=[ip]" />
+		<content type="string"  />
+		<shortdesc lang="en">IP address or hostname of fencing device (together with --port-as-ip)</shortdesc>
+	</parameter>
+	<parameter name="ip" unique="0" required="0" obsoletes="ipaddr">
+		<getopt mixed="-a, --ip=[ip]" />
+		<content type="string"  />
+		<shortdesc lang="en">IP Address or Hostname</shortdesc>
+	</parameter>
+	<parameter name="password" unique="0" required="0" obsoletes="passwd">
+		<getopt mixed="-p, --password=[password]" />
+		<content type="string"  />
+		<shortdesc lang="en">Login password or passphrase</shortdesc>
+	</parameter>
+	<parameter name="password_script" unique="0" required="0" obsoletes="passwd_script">
+		<getopt mixed="-S, --password-script=[script]" />
+		<content type="string"  />
+		<shortdesc lang="en">Script to retrieve password</shortdesc>
+	</parameter>
+	<parameter name="verbose" unique="0" required="0">
+		<getopt mixed="-v, --verbose" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Verbose mode</shortdesc>
+	</parameter>
+	<parameter name="debug" unique="0" required="0" deprecated="1">
+		<getopt mixed="-D, --debug-file=[debugfile]" />
+		<content type="string"  />
+		<shortdesc lang="en">Write debug information to given file</shortdesc>
+	</parameter>
+	<parameter name="debug_file" unique="0" required="0" obsoletes="debug">
+		<getopt mixed="-D, --debug-file=[debugfile]" />
+		<content type="string"  />
+		<shortdesc lang="en">Write debug information to given file</shortdesc>
+	</parameter>
+	<parameter name="version" unique="0" required="0">
+		<getopt mixed="-V, --version" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Display version information and exit</shortdesc>
+	</parameter>
+	<parameter name="help" unique="0" required="0">
+		<getopt mixed="-h, --help" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Display help and exit</shortdesc>
+	</parameter>
+	<parameter name="power_wait" unique="0" required="0">
+		<getopt mixed="--power-wait=[seconds]" />
+		<content type="second" default="0"  />
+		<shortdesc lang="en">Wait X seconds after issuing ON/OFF</shortdesc>
+	</parameter>
+	<parameter name="login_timeout" unique="0" required="0">
+		<getopt mixed="--login-timeout=[seconds]" />
+		<content type="second" default="5"  />
+		<shortdesc lang="en">Wait X seconds for cmd prompt after login</shortdesc>
+	</parameter>
+	<parameter name="power_timeout" unique="0" required="0">
+		<getopt mixed="--power-timeout=[seconds]" />
+		<content type="second" default="20"  />
+		<shortdesc lang="en">Test X seconds for status change after ON/OFF</shortdesc>
+	</parameter>
+	<parameter name="delay" unique="0" required="0">
+		<getopt mixed="--delay=[seconds]" />
+		<content type="second" default="0"  />
+		<shortdesc lang="en">Wait X seconds before fencing is started</shortdesc>
+	</parameter>
+	<parameter name="shell_timeout" unique="0" required="0">
+		<getopt mixed="--shell-timeout=[seconds]" />
+		<content type="second" default="3"  />
+		<shortdesc lang="en">Wait X seconds for cmd prompt after issuing command</shortdesc>
+	</parameter>
+	<parameter name="port_as_ip" unique="0" required="0">
+		<getopt mixed="--port-as-ip" />
+		<content type="boolean"  />
+		<shortdesc lang="en">Make "port/plug" to be an alias to IP address</shortdesc>
+	</parameter>
+	<parameter name="retry_on" unique="0" required="0">
+		<getopt mixed="--retry-on=[attempts]" />
+		<content type="integer" default="1"  />
+		<shortdesc lang="en">Count of attempts to retry power on</shortdesc>
+	</parameter>
+</parameters>
+<actions>
+	<action name="on" automatic="0"/>
+	<action name="off" />
+	<action name="reboot" />
+	<action name="status" />
+	<action name="monitor" />
+	<action name="metadata" />
+	<action name="validate-all" />
+</actions>
+</resource-agent>