1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/storage/ibm/ibm_sa_vol_map.py
Alexei Znamensky 3778eac1ba
Tidy up validations + bug fixes + deprecations (#1830)
* fixed validation-modules for plugins/modules/database/misc/elasticsearch_plugin.py

* fixed validation-modules for plugins/modules/database/misc/kibana_plugin.py

* fixed validation-modules for plugins/modules/database/misc/riak.py

* fixed validation-modules for plugins/modules/database/vertica/vertica_info.py

* fixed validation-modules for plugins/modules/database/vertica/vertica_role.py

* fixed validation-modules for plugins/modules/database/vertica/vertica_schema.py

* fixed validation-modules for plugins/modules/database/vertica/vertica_user.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_domain.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_host_ports.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_host.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_pool.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_vol.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_vol_map.py

* fixed validation-modules for plugins/modules/storage/ibm/ibm_sa_host_ports.py

* fixed validation-modules for plugins/modules/system/runit.py

* fixed validation-modules for plugins/modules/source_control/bzr.py

* fixed validation-modules for plugins/modules/source_control/hg.py

* fixed validation-modules for plugins/modules/storage/emc/emc_vnx_sg_member.py

* fixed validation-modules for plugins/modules/identity/opendj/opendj_backendprop.py

* fixed validation-modules for plugins/modules/files/iso_extract.py

* fixed validation-modules for plugins/modules/monitoring/logstash_plugin.py

* fixed validation-modules for plugins/modules/database/aerospike/aerospike_migrations.py

* Tidy up a number of sanity checks for some modules

* added changelog fragment

* Some parameters in vertica_* had their aliases documented as the name, and sometimes vice-versa as well

* Adjustments per PR

* Rolled back sanity ignores for runit

* Update changelogs/fragments/1830-valmod_docmissingtype_batch1.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
2021-02-16 09:27:24 +01:00

142 lines
3.5 KiB
Python

#!/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()