#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (C) 2018 IBM CORPORATION # Author(s): Tzur Eliyahu <tzure@il.ibm.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 DOCUMENTATION = ''' --- module: ibm_sa_vol_map short_description: Handles volume mapping on IBM Spectrum Accelerate Family storage systems. description: - "This module maps volumes to or unmaps them from the hosts on IBM Spectrum Accelerate Family storage systems." options: vol: description: - Volume name. required: true type: str state: default: "present" choices: [ "present", "absent" ] description: - When the state is present the volume is mapped. When the state is absent, the volume is meant to be unmapped. type: str cluster: description: - Maps the volume to a cluster. required: false type: str host: description: - Maps the volume to a host. required: false type: str lun: description: - The LUN identifier. required: false type: str override: description: - Overrides the existing volume mapping. required: false type: str extends_documentation_fragment: - community.general.ibm_storage author: - Tzur Eliyahu (@tzure) ''' EXAMPLES = ''' - name: Map volume to host. community.general.ibm_sa_vol_map: vol: volume_name lun: 1 host: host_name username: admin password: secret endpoints: hostdev-system state: present - name: Map volume to cluster. community.general.ibm_sa_vol_map: vol: volume_name lun: 1 cluster: cluster_name username: admin password: secret endpoints: hostdev-system state: present - name: Unmap volume. community.general.ibm_sa_vol_map: host: host_name username: admin password: secret endpoints: hostdev-system state: absent ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ibm_sa_utils import (execute_pyxcli_command, connect_ssl, spectrum_accelerate_spec, is_pyxcli_installed) def main(): argument_spec = spectrum_accelerate_spec() argument_spec.update( dict( state=dict(default='present', choices=['present', 'absent']), vol=dict(required=True), lun=dict(), cluster=dict(), host=dict(), override=dict() ) ) module = AnsibleModule(argument_spec) is_pyxcli_installed(module) xcli_client = connect_ssl(module) # required args mapping = False try: mapped_hosts = xcli_client.cmd.vol_mapping_list( vol=module.params.get('vol')).as_list for host in mapped_hosts: if host['host'] == module.params.get("host", ""): mapping = True except Exception: pass state = module.params['state'] state_changed = False if state == 'present' and not mapping: state_changed = execute_pyxcli_command(module, 'map_vol', xcli_client) if state == 'absent' and mapping: state_changed = execute_pyxcli_command( module, 'unmap_vol', xcli_client) module.exit_json(changed=state_changed) if __name__ == '__main__': main()