#!/usr/bin/python # -*- coding: utf-8 -*- # # Copyright (c) 2017 Red Hat, Inc. # 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: ovirt_host_storage_facts short_description: Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage) author: "Daniel Erez (@derez)" deprecated: removed_in: 3.0.0 # was Ansible 2.13 why: When migrating to collection we decided to use only _info modules. alternative: Use M(ovirt.ovirt.ovirt_host_storage_info) instead. description: - "Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)." options: host: description: - "Host to get device list from." required: true iscsi: description: - "Dictionary with values for iSCSI storage type:" suboptions: address: description: - "Address of the iSCSI storage server." target: description: - "The target IQN for the storage device." username: description: - "A CHAP user name for logging into a target." password: description: - "A CHAP password for logging into a target." portal: description: - "The portal being used to connect with iscsi." fcp: description: - "Dictionary with values for fibre channel storage type:" suboptions: address: description: - "Address of the fibre channel storage server." port: description: - "Port of the fibre channel storage server." lun_id: description: - "LUN id." extends_documentation_fragment: - community.general.ovirt_facts ''' EXAMPLES = ''' # Examples don't contain auth parameter for simplicity, # look at ovirt_auth module to see how to reuse authentication: - name: Gather information about HostStorages with specified target and address ovirt_host_storage_info: host: myhost iscsi: target: iqn.2016-08-09.domain-01:nickname address: 10.34.63.204 register: result - name: Print gathered information ansible.builtin.debug: msg: "{{ result.ovirt_host_storages }}" ''' RETURN = ''' ovirt_host_storages: description: "List of dictionaries describing the HostStorage. HostStorage attributes are mapped to dictionary keys, all HostStorage attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host_storage." returned: On success. type: list ''' import traceback try: import ovirtsdk4.types as otypes except ImportError: pass from ansible.module_utils.common.removed import removed_module from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils._ovirt import ( check_sdk, create_connection, get_dict_of_struct, ovirt_info_full_argument_spec, get_id_by_name, ) def _login(host_service, iscsi): host_service.iscsi_login( iscsi=otypes.IscsiDetails( username=iscsi.get('username'), password=iscsi.get('password'), address=iscsi.get('address'), target=iscsi.get('target'), portal=iscsi.get('portal') ), ) def _get_storage_type(params): for sd_type in ['iscsi', 'fcp']: if params.get(sd_type) is not None: return sd_type def main(): argument_spec = ovirt_info_full_argument_spec( host=dict(required=True), iscsi=dict(default=None, type='dict'), fcp=dict(default=None, type='dict'), ) module = AnsibleModule(argument_spec) is_old_facts = module._name in ('ovirt_host_storage_facts', 'community.general.ovirt_host_storage_facts') if is_old_facts: module.deprecate("The 'ovirt_host_storage_facts' module has been renamed to 'ovirt_host_storage_info', " "and the renamed one no longer returns ansible_facts", version='3.0.0', collection_name='community.general') # was Ansible 2.13 check_sdk(module) try: auth = module.params.pop('auth') connection = create_connection(auth) # Get Host hosts_service = connection.system_service().hosts_service() host_id = get_id_by_name(hosts_service, module.params['host']) storage_type = _get_storage_type(module.params) host_service = hosts_service.host_service(host_id) if storage_type == 'iscsi': # Login iscsi = module.params.get('iscsi') _login(host_service, iscsi) # Get LUNs exposed from the specified target host_storages = host_service.storage_service().list() if storage_type == 'iscsi': filterred_host_storages = [host_storage for host_storage in host_storages if host_storage.type == otypes.StorageType.ISCSI] if 'target' in iscsi: filterred_host_storages = [host_storage for host_storage in filterred_host_storages if iscsi.get('target') == host_storage.logical_units[0].target] elif storage_type == 'fcp': filterred_host_storages = [host_storage for host_storage in host_storages if host_storage.type == otypes.StorageType.FCP] result = dict( ovirt_host_storages=[ get_dict_of_struct( struct=c, connection=connection, fetch_nested=module.params.get('fetch_nested'), attributes=module.params.get('nested_attributes'), ) for c in filterred_host_storages ], ) if is_old_facts: module.exit_json(changed=False, ansible_facts=result) else: module.exit_json(changed=False, **result) except Exception as e: module.fail_json(msg=str(e), exception=traceback.format_exc()) finally: connection.close(logout=auth.get('token') is None) if __name__ == '__main__': main()