Initial commit

[ta/infra-ansible.git] / roles / baremetal_provision / library / os_node_power_check.py

diff --git a/roles/baremetal_provision/library/os_node_power_check.py b/roles/baremetal_provision/library/os_node_power_check.py
new file mode 100644 (file)
index 0000000..2950248
--- /dev/null
+++ b/roles/baremetal_provision/library/os_node_power_check.py
@@ -0,0 +1,114 @@
+#!/usr/bin/python
+
+# Copyright 2019 Nokia
+
+# 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.
+
+import fnmatch
+
+try:
+    import shade
+    from shade import meta
+    HAS_SHADE = True
+except ImportError:
+    HAS_SHADE = False
+
+DOCUMENTATION = '''
+---
+module: os_node_power_check
+short_description: Retrieve facts about ironic nodes list provided,
+                   Returns a list of nodes which are not in specified power state
+version_added: "2.0"
+description:
+    - Retrieve facts about ironic nodes list provided,
+      Returns a list of nodes which are not in specified power state
+requirements:
+    - "python >= 2.6"
+    - "shade"
+options:
+   nodes_details:
+     description:
+       - List of dicts [{uuid: <ironic_node_id>, name: <ironic_node_name>},....], containing ironic node ids and names.
+     required: True
+     default: None
+   ironic_url:
+     description:
+       - The ironic URL to connect to
+     required: True
+     default: None
+   power_state:
+     description:
+       - The specified power state in which nodes are expected to be
+     required: True
+     default: None
+returns:
+     power_pending_list
+extends_documentation_fragment: openstack
+'''
+
+EXAMPLES = '''
+- os_node_power_check:
+    nodes_details:
+      - uuid: <id-1>
+        name: <name-1>
+      - uuid: <id-2>
+        name: <name-2>
+    power_state: 'power on'
+'''
+
+def main():
+    argument_spec = openstack_full_argument_spec(
+        nodes_details=dict(type='list', required=True), 
+        ironic_url=dict(required=False),
+        power_state=dict(required=True),
+    )
+    module_kwargs = openstack_module_kwargs()
+    module = AnsibleModule(argument_spec, **module_kwargs)
+
+    if not HAS_SHADE:
+        module.fail_json(msg='shade is required for this module')
+    if (module.params['auth_type'] in [None, 'None'] and
+            module.params['ironic_url'] is None):
+        module.fail_json(msg="Authentication appears to be disabled, "
+                             "Please define an ironic_url parameter")
+
+    if (module.params['ironic_url'] and
+            module.params['auth_type'] in [None, 'None']):
+        module.params['auth'] = dict(
+            endpoint=module.params['ironic_url']
+        )
+
+    try:
+        cloud = shade.operator_cloud(**module.params)
+
+        nodes_details = module.params['nodes_details']
+        power_state = module.params['power_state']
+        power_pending_list = []
+
+        for node in nodes_details:
+            node_name = node['uuid']
+            node_details = cloud.get_machine(node_name)
+
+            if not node_details['power_state'] == power_state:
+                power_pending_list.append(node_name)
+
+        module.exit_json(changed=False, ansible_facts=dict(power_pending_list=power_pending_list))
+
+    except shade.OpenStackCloudException as e:
+        module.fail_json(msg=str(e))
+
+# this is magic, see lib/ansible/module_common.py
+from ansible.module_utils.basic import *
+from ansible.module_utils.openstack import *
+if __name__ == '__main__':
+    main()