#!/usr/bin/python # Copyright 2015 Sam Yaple # # 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. # This module has been relicensed from the source below: # https://github.com/SamYaple/yaodu/blob/master/ansible/library/ceph_osd_list DOCUMENTATION = ''' --- module: find_disks short_description: Return list of devices containing a specfied name or label description: - This will return a list of all devices with either GPT partition name or filesystem label of the name specified. options: match_mode: description: - Label match mode, either strict or prefix default: 'strict' required: False choices: [ "strict", "prefix" ] type: str name: description: - Partition name or filesystem label required: True type: str aliases: [ 'partition_name' ] use_udev: description: - When True, use Linux udev to read disk info such as partition labels, uuid, etc. Some older host operating systems have issues using udev to get the info this module needs. Set to False to fall back to more low level commands such as blkid to retrieve this information. Most users should not need to change this. default: True required: False type: bool author: Sam Yaple ''' EXAMPLES = ''' - hosts: ceph-osd tasks: - name: Return all valid formated devices with the name KOLLA_CEPH_OSD find_disks: name: 'KOLLA_CEPH_OSD' register: osds - hosts: swift-object-server tasks: - name: Return all valid devices with the name KOLLA_SWIFT find_disks: name: 'KOLLA_SWIFT' register: swift_disks - hosts: swift-object-server tasks: - name: Return all valid devices with wildcard name 'swift_d*' find_disks: name: 'swift_d' match_mode: 'prefix' register: swift_disks ''' import json import pyudev import re import subprocess # nosec PREFERRED_DEVICE_LINK_ORDER = [ '/dev/disk/by-uuid', '/dev/disk/by-partuuid', '/dev/disk/by-parttypeuuid', '/dev/disk/by-label', '/dev/disk/by-partlabel' ] def get_id_part_entry_name(dev, use_udev): if use_udev: dev_name = dev.get('ID_PART_ENTRY_NAME', '') else: part = re.sub(r'.*[^\d]', '', dev.device_node) parent = dev.find_parent('block').device_node # NOTE(Mech422): Need to use -i as -p truncates the partition name out = subprocess.Popen(['/usr/sbin/sgdisk', '-i', part, # nosec parent], stdout=subprocess.PIPE).communicate() match = re.search(r'Partition name: \'(\w+)\'', out[0]) if match: dev_name = match.group(1) else: dev_name = '' return dev_name def get_id_fs_uuid(dev, use_udev): if use_udev: id_fs_uuid = dev.get('ID_FS_UUID', '') else: out = subprocess.Popen(['/usr/sbin/blkid', '-o', 'export', # nosec dev.device_node], stdout=subprocess.PIPE).communicate() match = re.search(r'\nUUID=([\w-]+)', out[0]) if match: id_fs_uuid = match.group(1) else: id_fs_uuid = '' return id_fs_uuid def is_dev_matched_by_name(dev, name, mode, use_udev): if dev.get('DEVTYPE', '') == 'partition': dev_name = get_id_part_entry_name(dev, use_udev) else: dev_name = dev.get('ID_FS_LABEL', '') if mode == 'strict': return dev_name == name elif mode == 'prefix': return dev_name.startswith(name) else: return False def find_disk(ct, name, match_mode, use_udev): for dev in ct.list_devices(subsystem='block'): if is_dev_matched_by_name(dev, name, match_mode, use_udev): yield dev def get_device_link(dev): for preferred_link in PREFERRED_DEVICE_LINK_ORDER: for link in dev.device_links: if link.startswith(preferred_link): return link return dev.device_node def extract_disk_info(ct, dev, name, use_udev): if not dev: return kwargs = dict() kwargs['fs_uuid'] = get_id_fs_uuid(dev, use_udev) kwargs['fs_label'] = dev.get('ID_FS_LABEL', '') if dev.get('DEVTYPE', '') == 'partition': kwargs['device'] = dev.find_parent('block').device_node kwargs['partition'] = dev.device_node kwargs['partition_num'] = \ re.sub(r'.*[^\d]', '', dev.device_node) if is_dev_matched_by_name(dev, name, 'strict', use_udev): kwargs['external_journal'] = False # NOTE(jeffrey4l): this is only used for bootstrap osd stage and # there is no journal partion at all. So it is OK to use # device_node directly. kwargs['journal'] = dev.device_node[:-1] + '2' kwargs['journal_device'] = kwargs['device'] kwargs['journal_num'] = 2 else: kwargs['external_journal'] = True journal_name = get_id_part_entry_name(dev, use_udev) + '_J' for journal in find_disk(ct, journal_name, 'strict', use_udev): kwargs['journal'] = get_device_link(journal) kwargs['journal_device'] = \ journal.find_parent('block').device_node kwargs['journal_num'] = \ re.sub(r'.*[^\d]', '', journal.device_node) break if 'journal' not in kwargs: # NOTE(SamYaple): Journal not found, not returning info return else: kwargs['device'] = dev.device_node yield kwargs def main(): argument_spec = dict( match_mode=dict(required=False, choices=['strict', 'prefix'], default='strict'), name=dict(aliases=['partition_name'], required=True, type='str'), use_udev=dict(required=False, default=True, type='bool') ) module = AnsibleModule(argument_spec) match_mode = module.params.get('match_mode') name = module.params.get('name') use_udev = module.params.get('use_udev') try: ret = list() ct = pyudev.Context() for dev in find_disk(ct, name, match_mode, use_udev): for info in extract_disk_info(ct, dev, name, use_udev): if info: ret.append(info) module.exit_json(disks=json.dumps(ret)) except Exception as e: module.exit_json(failed=True, msg=repr(e)) # import module snippets from ansible.module_utils.basic import * # noqa if __name__ == '__main__': main()