Initial commit

plugins/modules/remote_management/hpilo/hpilo_boot.py

@@ -0,0 +1,208 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright 2012 Dag Wieers <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: hpilo_boot
+author: Dag Wieers (@dagwieers)
+short_description: Boot system using specific media through HP iLO interface
+description:
+- "This module boots a system through its HP iLO interface. The boot media
+  can be one of: cdrom, floppy, hdd, network or usb."
+- This module requires the hpilo python module.
+options:
+  host:
+    description:
+    - The HP iLO hostname/address that is linked to the physical system.
+    required: true
+  login:
+    description:
+    - The login name to authenticate to the HP iLO interface.
+    default: Administrator
+  password:
+    description:
+    - The password to authenticate to the HP iLO interface.
+    default: admin
+  media:
+    description:
+    - The boot media to boot the system from
+    choices: [ "cdrom", "floppy", "hdd", "network", "normal", "usb" ]
+  image:
+    description:
+    - The URL of a cdrom, floppy or usb boot media image.
+      protocol://username:password@hostname:port/filename
+    - protocol is either 'http' or 'https'
+    - username:password is optional
+    - port is optional
+  state:
+    description:
+    - The state of the boot media.
+    - "no_boot: Do not boot from the device"
+    - "boot_once: Boot from the device once and then notthereafter"
+    - "boot_always: Boot from the device each time the server is rebooted"
+    - "connect: Connect the virtual media device and set to boot_always"
+    - "disconnect: Disconnects the virtual media device and set to no_boot"
+    - "poweroff: Power off the server"
+    default: boot_once
+    choices: [ "boot_always", "boot_once", "connect", "disconnect", "no_boot", "poweroff" ]
+  force:
+    description:
+    - Whether to force a reboot (even when the system is already booted).
+    - As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.
+    default: no
+    type: bool
+  ssl_version:
+    description:
+      - Change the ssl_version used.
+    default: TLSv1
+    choices: [ "SSLv3", "SSLv23", "TLSv1", "TLSv1_1", "TLSv1_2" ]
+requirements:
+- python-hpilo
+notes:
+- To use a USB key image you need to specify floppy as boot media.
+- This module ought to be run from a system that can access the HP iLO
+  interface directly, either by using C(local_action) or using C(delegate_to).
+'''
+
+EXAMPLES = r'''
+- name: Task to boot a system using an ISO from an HP iLO interface only if the system is an HP server
+  hpilo_boot:
+    host: YOUR_ILO_ADDRESS
+    login: YOUR_ILO_LOGIN
+    password: YOUR_ILO_PASSWORD
+    media: cdrom
+    image: http://some-web-server/iso/boot.iso
+  when: cmdb_hwmodel.startswith('HP ')
+  delegate_to: localhost
+
+- name: Power off a server
+  hpilo_boot:
+    host: YOUR_ILO_HOST
+    login: YOUR_ILO_LOGIN
+    password: YOUR_ILO_PASSWORD
+    state: poweroff
+  delegate_to: localhost
+'''
+
+RETURN = '''
+# Default return values
+'''
+
+import time
+import traceback
+import warnings
+
+HPILO_IMP_ERR = None
+try:
+    import hpilo
+    HAS_HPILO = True
+except ImportError:
+    HPILO_IMP_ERR = traceback.format_exc()
+    HAS_HPILO = False
+
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+
+
+# Suppress warnings from hpilo
+warnings.simplefilter('ignore')
+
+
+def main():
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            host=dict(type='str', required=True),
+            login=dict(type='str', default='Administrator'),
+            password=dict(type='str', default='admin', no_log=True),
+            media=dict(type='str', choices=['cdrom', 'floppy', 'rbsu', 'hdd', 'network', 'normal', 'usb']),
+            image=dict(type='str'),
+            state=dict(type='str', default='boot_once', choices=['boot_always', 'boot_once', 'connect', 'disconnect', 'no_boot', 'poweroff']),
+            force=dict(type='bool', default=False),
+            ssl_version=dict(type='str', default='TLSv1', choices=['SSLv3', 'SSLv23', 'TLSv1', 'TLSv1_1', 'TLSv1_2']),
+        )
+    )
+
+    if not HAS_HPILO:
+        module.fail_json(msg=missing_required_lib('python-hpilo'), exception=HPILO_IMP_ERR)
+
+    host = module.params['host']
+    login = module.params['login']
+    password = module.params['password']
+    media = module.params['media']
+    image = module.params['image']
+    state = module.params['state']
+    force = module.params['force']
+    ssl_version = getattr(hpilo.ssl, 'PROTOCOL_' + module.params.get('ssl_version').upper().replace('V', 'v'))
+
+    ilo = hpilo.Ilo(host, login=login, password=password, ssl_version=ssl_version)
+    changed = False
+    status = {}
+    power_status = 'UNKNOWN'
+
+    if media and state in ('boot_always', 'boot_once', 'connect', 'disconnect', 'no_boot'):
+
+        # Workaround for: Error communicating with iLO: Problem manipulating EV
+        try:
+            ilo.set_one_time_boot(media)
+        except hpilo.IloError:
+            time.sleep(60)
+            ilo.set_one_time_boot(media)
+
+        # TODO: Verify if image URL exists/works
+        if image:
+            ilo.insert_virtual_media(media, image)
+            changed = True
+
+        if media == 'cdrom':
+            ilo.set_vm_status('cdrom', state, True)
+            status = ilo.get_vm_status()
+            changed = True
+        elif media in ('floppy', 'usb'):
+            ilo.set_vf_status(state, True)
+            status = ilo.get_vf_status()
+            changed = True
+
+    # Only perform a boot when state is boot_once or boot_always, or in case we want to force a reboot
+    if state in ('boot_once', 'boot_always') or force:
+
+        power_status = ilo.get_host_power_status()
+
+        if not force and power_status == 'ON':
+            module.fail_json(msg='HP iLO (%s) reports that the server is already powered on !' % host)
+
+        if power_status == 'ON':
+            ilo.warm_boot_server()
+#            ilo.cold_boot_server()
+            changed = True
+        else:
+            ilo.press_pwr_btn()
+#            ilo.reset_server()
+#            ilo.set_host_power(host_power=True)
+            changed = True
+
+    elif state in ('poweroff'):
+
+        power_status = ilo.get_host_power_status()
+
+        if not power_status == 'OFF':
+            ilo.hold_pwr_btn()
+#            ilo.set_host_power(host_power=False)
+            changed = True
+
+    module.exit_json(changed=changed, power=power_status, **status)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/remote_management/hpilo/hpilo_facts.py

@@ -0,0 +1 @@
+hpilo_info.py

plugins/modules/remote_management/hpilo/hpilo_info.py

@@ -0,0 +1,262 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright 2012 Dag Wieers <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: hpilo_info
+author: Dag Wieers (@dagwieers)
+short_description: Gather information through an HP iLO interface
+description:
+- This module gathers information on a specific system using its HP iLO interface.
+  These information includes hardware and network related information useful
+  for provisioning (e.g. macaddress, uuid).
+- This module requires the C(hpilo) python module.
+- This module was called C(hpilo_facts) before Ansible 2.9, returning C(ansible_facts).
+  Note that the M(hpilo_info) module no longer returns C(ansible_facts)!
+options:
+  host:
+    description:
+    - The HP iLO hostname/address that is linked to the physical system.
+    required: true
+  login:
+    description:
+    - The login name to authenticate to the HP iLO interface.
+    default: Administrator
+  password:
+    description:
+    - The password to authenticate to the HP iLO interface.
+    default: admin
+  ssl_version:
+    description:
+      - Change the ssl_version used.
+    default: TLSv1
+    choices: [ "SSLv3", "SSLv23", "TLSv1", "TLSv1_1", "TLSv1_2" ]
+requirements:
+- hpilo
+notes:
+- This module ought to be run from a system that can access the HP iLO
+  interface directly, either by using C(local_action) or using C(delegate_to).
+'''
+
+EXAMPLES = r'''
+# Task to gather facts from a HP iLO interface only if the system is an HP server
+- hpilo_info:
+    host: YOUR_ILO_ADDRESS
+    login: YOUR_ILO_LOGIN
+    password: YOUR_ILO_PASSWORD
+  when: cmdb_hwmodel.startswith('HP ')
+  delegate_to: localhost
+  register: results
+
+- fail:
+    msg: 'CMDB serial ({{ cmdb_serialno }}) does not match hardware serial ({{ results.hw_system_serial }}) !'
+  when: cmdb_serialno != results.hw_system_serial
+'''
+
+RETURN = r'''
+# Typical output of HP iLO_info for a physical system
+hw_bios_date:
+    description: BIOS date
+    returned: always
+    type: str
+    sample: 05/05/2011
+
+hw_bios_version:
+    description: BIOS version
+    returned: always
+    type: str
+    sample: P68
+
+hw_ethX:
+    description: Interface information (for each interface)
+    returned: always
+    type: dict
+    sample:
+      - macaddress: 00:11:22:33:44:55
+        macaddress_dash: 00-11-22-33-44-55
+
+hw_eth_ilo:
+    description: Interface information (for the iLO network interface)
+    returned: always
+    type: dict
+    sample:
+      - macaddress: 00:11:22:33:44:BA
+      - macaddress_dash: 00-11-22-33-44-BA
+
+hw_product_name:
+    description: Product name
+    returned: always
+    type: str
+    sample: ProLiant DL360 G7
+
+hw_product_uuid:
+    description: Product UUID
+    returned: always
+    type: str
+    sample: ef50bac8-2845-40ff-81d9-675315501dac
+
+hw_system_serial:
+    description: System serial number
+    returned: always
+    type: str
+    sample: ABC12345D6
+
+hw_uuid:
+    description: Hardware UUID
+    returned: always
+    type: str
+    sample: 123456ABC78901D2
+'''
+
+import re
+import traceback
+import warnings
+
+HPILO_IMP_ERR = None
+try:
+    import hpilo
+    HAS_HPILO = True
+except ImportError:
+    HPILO_IMP_ERR = traceback.format_exc()
+    HAS_HPILO = False
+
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+from ansible.module_utils._text import to_native
+
+
+# Suppress warnings from hpilo
+warnings.simplefilter('ignore')
+
+
+def parse_flat_interface(entry, non_numeric='hw_eth_ilo'):
+    try:
+        infoname = 'hw_eth' + str(int(entry['Port']) - 1)
+    except Exception:
+        infoname = non_numeric
+
+    info = {
+        'macaddress': entry['MAC'].replace('-', ':'),
+        'macaddress_dash': entry['MAC']
+    }
+    return (infoname, info)
+
+
+def main():
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            host=dict(type='str', required=True),
+            login=dict(type='str', default='Administrator'),
+            password=dict(type='str', default='admin', no_log=True),
+            ssl_version=dict(type='str', default='TLSv1', choices=['SSLv3', 'SSLv23', 'TLSv1', 'TLSv1_1', 'TLSv1_2']),
+        ),
+        supports_check_mode=True,
+    )
+    is_old_facts = module._name == 'hpilo_facts'
+    if is_old_facts:
+        module.deprecate("The 'hpilo_facts' module has been renamed to 'hpilo_info', "
+                         "and the renamed one no longer returns ansible_facts", version='2.13')
+
+    if not HAS_HPILO:
+        module.fail_json(msg=missing_required_lib('python-hpilo'), exception=HPILO_IMP_ERR)
+
+    host = module.params['host']
+    login = module.params['login']
+    password = module.params['password']
+    ssl_version = getattr(hpilo.ssl, 'PROTOCOL_' + module.params.get('ssl_version').upper().replace('V', 'v'))
+
+    ilo = hpilo.Ilo(host, login=login, password=password, ssl_version=ssl_version)
+
+    info = {
+        'module_hw': True,
+    }
+
+    # TODO: Count number of CPUs, DIMMs and total memory
+    try:
+        data = ilo.get_host_data()
+    except hpilo.IloCommunicationError as e:
+        module.fail_json(msg=to_native(e))
+
+    for entry in data:
+        if 'type' not in entry:
+            continue
+        elif entry['type'] == 0:  # BIOS Information
+            info['hw_bios_version'] = entry['Family']
+            info['hw_bios_date'] = entry['Date']
+        elif entry['type'] == 1:  # System Information
+            info['hw_uuid'] = entry['UUID']
+            info['hw_system_serial'] = entry['Serial Number'].rstrip()
+            info['hw_product_name'] = entry['Product Name']
+            info['hw_product_uuid'] = entry['cUUID']
+        elif entry['type'] == 209:  # Embedded NIC MAC Assignment
+            if 'fields' in entry:
+                for (name, value) in [(e['name'], e['value']) for e in entry['fields']]:
+                    if name.startswith('Port'):
+                        try:
+                            infoname = 'hw_eth' + str(int(value) - 1)
+                        except Exception:
+                            infoname = 'hw_eth_ilo'
+                    elif name.startswith('MAC'):
+                        info[infoname] = {
+                            'macaddress': value.replace('-', ':'),
+                            'macaddress_dash': value
+                        }
+            else:
+                (infoname, entry_info) = parse_flat_interface(entry, 'hw_eth_ilo')
+                info[infoname] = entry_info
+        elif entry['type'] == 209:  # HPQ NIC iSCSI MAC Info
+            for (name, value) in [(e['name'], e['value']) for e in entry['fields']]:
+                if name.startswith('Port'):
+                    try:
+                        infoname = 'hw_iscsi' + str(int(value) - 1)
+                    except Exception:
+                        infoname = 'hw_iscsi_ilo'
+                elif name.startswith('MAC'):
+                    info[infoname] = {
+                        'macaddress': value.replace('-', ':'),
+                        'macaddress_dash': value
+                    }
+        elif entry['type'] == 233:  # Embedded NIC MAC Assignment (Alternate data format)
+            (infoname, entry_info) = parse_flat_interface(entry, 'hw_eth_ilo')
+            info[infoname] = entry_info
+
+    # Collect health (RAM/CPU data)
+    health = ilo.get_embedded_health()
+    info['hw_health'] = health
+
+    memory_details_summary = health.get('memory', {}).get('memory_details_summary')
+    # RAM as reported by iLO 2.10 on ProLiant BL460c Gen8
+    if memory_details_summary:
+        info['hw_memory_details_summary'] = memory_details_summary
+        info['hw_memory_total'] = 0
+        for cpu, details in memory_details_summary.items():
+            cpu_total_memory_size = details.get('total_memory_size')
+            if cpu_total_memory_size:
+                ram = re.search(r'(\d+)\s+(\w+)', cpu_total_memory_size)
+                if ram:
+                    if ram.group(2) == 'GB':
+                        info['hw_memory_total'] = info['hw_memory_total'] + int(ram.group(1))
+
+        # reformat into a text friendly format
+        info['hw_memory_total'] = "{0} GB".format(info['hw_memory_total'])
+
+    if is_old_facts:
+        module.exit_json(ansible_facts=info)
+    else:
+        module.exit_json(**info)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/remote_management/hpilo/hponcfg.py

@@ -0,0 +1,116 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2012, Dag Wieers <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = r'''
+---
+module: hponcfg
+author: Dag Wieers (@dagwieers)
+short_description: Configure HP iLO interface using hponcfg
+description:
+- This modules configures the HP iLO interface using hponcfg.
+options:
+  path:
+    description:
+    - The XML file as accepted by hponcfg.
+    required: true
+    aliases: ['src']
+  minfw:
+    description:
+    - The minimum firmware level needed.
+    required: false
+  executable:
+    description:
+    - Path to the hponcfg executable (`hponcfg` which uses $PATH).
+    default: hponcfg
+  verbose:
+    description:
+    - Run hponcfg in verbose mode (-v).
+    default: no
+    type: bool
+requirements:
+- hponcfg tool
+notes:
+- You need a working hponcfg on the target system.
+'''
+
+EXAMPLES = r'''
+- name: Example hponcfg configuration XML
+  copy:
+    content: |
+      <ribcl VERSION="2.0">
+        <login USER_LOGIN="user" PASSWORD="password">
+          <rib_info MODE="WRITE">
+            <mod_global_settings>
+              <session_timeout value="0"/>
+              <ssh_status value="Y"/>
+              <ssh_port value="22"/>
+              <serial_cli_status value="3"/>
+              <serial_cli_speed value="5"/>
+            </mod_global_settings>
+          </rib_info>
+        </login>
+      </ribcl>
+    dest: /tmp/enable-ssh.xml
+
+- name: Configure HP iLO using enable-ssh.xml
+  hponcfg:
+    src: /tmp/enable-ssh.xml
+
+- name: Configure HP iLO on VMware ESXi hypervisor
+  hponcfg:
+    src: /tmp/enable-ssh.xml
+    executable: /opt/hp/tools/hponcfg
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+def main():
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            src=dict(type='path', required=True, aliases=['path']),
+            minfw=dict(type='str'),
+            executable=dict(default='hponcfg', type='str'),
+            verbose=dict(default=False, type='bool'),
+        )
+    )
+
+    # Consider every action a change (not idempotent yet!)
+    changed = True
+
+    src = module.params['src']
+    minfw = module.params['minfw']
+    executable = module.params['executable']
+    verbose = module.params['verbose']
+
+    options = ' -f %s' % src
+
+    if verbose:
+        options += ' -v'
+
+    if minfw:
+        options += ' -m %s' % minfw
+
+    rc, stdout, stderr = module.run_command('%s %s' % (executable, options))
+
+    if rc != 0:
+        module.fail_json(rc=rc, msg="Failed to run hponcfg", stdout=stdout, stderr=stderr)
+
+    module.exit_json(changed=changed, stdout=stdout, stderr=stderr)
+
+
+if __name__ == '__main__':
+    main()