IBM_Storage: Added a module for managing IBM Spectrum Accelerate (#44166)

storage system pools

lib/ansible/modules/storage/ibm/ibm_sa_pool.py

@@ -0,0 +1,120 @@
+#!/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
+
+ANSIBLE_METADATA = {'status': ['preview'],
+                    'supported_by': 'community',
+                    'metadata_version': '1.1'}
+
+DOCUMENTATION = '''
+---
+module: ibm_sa_pool
+short_description: Handles pools on an IBM Spectrum Accelerate storage array.
+version_added: "2.7"
+
+description:
+    - "This module creates or deletes pools to be used on IBM Spectrum Accelerate storage systems."
+
+options:
+    pool:
+        description:
+            - Pool name.
+        required: true
+    state:
+        description:
+            - Pool state.
+        required: true
+        default: "present"
+        choices: [ "present", "absent" ]
+    size:
+        description:
+            - Pool size in GB
+        required: false
+    snapshot_size:
+        description:
+            - Pool snapshot size in GB
+        required: false
+    domain:
+        description:
+            - Adds the pool to the specified domain.
+        required: false
+    perf_class:
+        description:
+            - Assigns a perf_class to the pool.
+        required: false
+
+extends_documentation_fragment:
+    - ibm_storage
+
+author:
+    - Tzur Eliyahu (tzure@il.ibm.com)
+'''
+
+EXAMPLES = '''
+- name: Create new pool.
+  ibm_sa_pool:
+    name: pool_name
+    size: 300
+    state: present
+    username: admin
+    password: secret
+    endpoints: hostdev-system
+
+- name: Delete pool.
+  ibm_sa_pool:
+    name: pool_name
+    state: absent
+    username: admin
+    password: secret
+    endpoints: hostdev-system
+'''
+RETURN = '''
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.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']),
+            pool=dict(required=True),
+            size=dict(),
+            snapshot_size=dict(),
+            domain=dict(),
+            perf_class=dict()
+        )
+    )
+
+    module = AnsibleModule(argument_spec)
+
+    is_pyxcli_installed(module)
+
+    xcli_client = connect_ssl(module)
+    pool = xcli_client.cmd.pool_list(
+        pool=module.params['pool']).as_single_element
+    state = module.params['state']
+
+    state_changed = False
+    if state == 'present' and not pool:
+        state_changed = execute_pyxcli_command(
+            module, 'pool_create', xcli_client)
+    if state == 'absent' and pool:
+        state_changed = execute_pyxcli_command(
+            module, 'pool_delete', xcli_client)
+
+    module.exit_json(changed=state_changed)
+
+
+if __name__ == '__main__':
+    main()