cs_instance_info: add host filter (#83)

Author: resmo

changelogs/fragments/83-cs_instance_info_host_filter.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - cs_instance_info - implemented support for ``host`` filter (https://github.com/ngine-io/ansible-collection-cloudstack/pull/83).

plugins/modules/cs_instance_info.py

@@ -35,6 +35,11 @@
     description:
       - Project the instance is related to.
     type: str
+  host:
+    description:
+      - Filter by host name.
+    type: str
+    version_added: 2.2.0
 extends_documentation_fragment:
 - ngine_io.cloudstack.cloudstack
 '''
@@ -56,6 +61,11 @@
 - name: Show information on all instances
   debug:
     msg: "{{ vms }}"
+
+- name: Gather information from all instances on a host
+  ngine_io.cloudstack.cs_instance_info:
+    host: host01.example.com
+  register: vms
 '''
 
 RETURN = '''
@@ -279,13 +289,29 @@ def __init__(self, module):
             'hostname': 'host',
         }
 
+    def get_host(self, key=None):
+        host = self.module.params.get('host')
+        if not host:
+            return
+
+        args = {
+            'fetch_list': True,
+        }
+        res = self.query_api('listHosts', **args)
+        if res:
+            for h in res:
+                if host.lower() in [h['id'], h['ipaddress'], h['name'].lower()]:
+                    return self._get_by_key(key, h)
+        self.fail_json(msg="Host not found: %s" % host)
+
     def get_instances(self):
         instance_name = self.module.params.get('name')
 
         args = {
             'account': self.get_account(key='name'),
             'domainid': self.get_domain(key='id'),
             'projectid': self.get_project(key='id'),
+            'hostid': self.get_host(key='id'),
             'fetch_list': True,
         }
         # Do not pass zoneid, as the instance name must be unique across zones.
@@ -354,6 +380,7 @@ def main():
         domain=dict(),
         account=dict(),
         project=dict(),
+        host=dict(),
     ))
 
     module = AnsibleModule(

tests/integration/targets/cs_instance_info/tasks/main.yml

@@ -78,3 +78,16 @@
     - '"name" in instance_info.instances[0]'
     - '"service_offering" in instance_info.instances[0]'
     - '"host" in instance_info.instances[0]'
+
+- name: remember host
+  set_fact:
+    host: "{{ instance_info.instances[0]['host']}}"
+
+- name: test instance info for all instances of a host
+  cs_instance_info:
+    host: "{{ host }}"
+  register: instance_info
+- name: verify test instance info
+  assert:
+    that:
+    - instance_info.instances[0]['host'] == host