Release/1.9.1

examples/clusters_info.yml

@@ -28,3 +28,11 @@
       sort_order: "ASCENDING"
       sort_attribute: "name"
     register: result
+
+  - name: List clusters using filter and custom_filter
+    ntnx_clusters_info:
+      filter:
+        name: <name>
+      custom_filter:
+        external_ip: <external_ip>
+    register: result

examples/fip_info.yml

@@ -29,3 +29,12 @@
         offset: 0
       register: result
       ignore_errors: True
+
+
+    - name: List floating_ips using filter and custom_filter
+      ntnx_floating_ips_info:
+        filter:
+          name: <name>
+        custom_filter:
+          private_ip: <private_ip>
+      register: result

examples/hosts_info.yml

@@ -29,3 +29,11 @@
       sort_attribute: "name"
     register: result
     ignore_errors: True
+
+  - name: List hosts using filter and custom_filter
+    ntnx_hosts_info:
+      filter:
+        name: <name>
+      custom_filter:
+        serial_number: <serial_number>
+    register: result

examples/inventory/ansible.cfg

@@ -0,0 +1,7 @@
+[defaults]
+inventory = nutanix.yaml
+
+[inventory]
+enable_plugins = nutanix.ncp.ntnx_prism_vm_inventory
+
+

examples/inventory/nutanix.yaml

@@ -0,0 +1,13 @@
+plugin: nutanix.ncp.ntnx_prism_vm_inventory
+nutanix_hostname: <pc_ip>
+nutanix_username: <username>
+nutanix_password: <password>
+validate_certs: false
+data: {"offset": 0, "length": 1000}
+groups:
+  group_1: "'<name_prefix>' in name"
+  group_2: "'<vm_name>'==name"
+keyed_groups:
+  - prefix: "host"
+    separator: ':'
+    key: "ansible_host"

examples/inventory/nutanix.yml

@@ -0,0 +1,13 @@
+plugin: nutanix.ncp.ntnx_prism_vm_inventory
+nutanix_host: <pc_ip>
+nutanix_username: <user>
+nutanix_password: <pass>
+validate_certs: false
+data: {"offset": 0, "length": 1000}
+groups:
+  group_1: "'<name_prefix>' in name"
+  group_2: "'<vm_name>'==name"
+keyed_groups:
+  - prefix: "host"
+    separator: ':'
+    key: "ansible_host"

examples/ndb/create_clone.yml

@@ -0,0 +1,121 @@
+---
+- name: Create clone
+  hosts: localhost
+  gather_facts: false
+  collections:
+    - nutanix.ncp
+  module_defaults:
+    group/nutanix.ncp.ntnx:
+      nutanix_host: <ndb-era-ip>
+      nutanix_username: <username>
+      nutanix_password: <password>
+      validate_certs: false
+
+  tasks:
+    - set_fact:
+        clone_db:
+          name: <Clone Db Name>
+        db_params_profile:
+          name: <Db Profile Name>
+        vm:
+          name: <Vm Name>
+          password: <Vm password>
+        cluster:
+          name: <Cluster Name>
+        network_profile:
+          name: <Network Profile Name>
+        compute_profile:
+          name: <Compute Profile Name>
+        public_ssh_key: <Public SSH Key>
+        time_machine:
+          name: <Time Machine Name>
+        snapshot:
+          uuid: <Snapshot UUID>
+
+    - name: create clone using snapshot
+      ntnx_ndb_database_clones:
+        name: "{{clone_db.name}}"
+        desc: "ansible-created-clone"
+
+        db_params_profile:
+          name: "{{db_params_profile.name}}"
+
+        db_vm:
+          create_new_server:
+            name: "{{ vm.name }}"
+            desc: "vm for db server"
+            password: "{{ vm.password }}"
+            cluster:
+              name: "{{cluster.name}}"
+            network_profile:
+              name: "{{ network_profile.name }}"
+            compute_profile:
+              name: "{{ compute_profile.name }}"
+            pub_ssh_key: "{{ public_ssh_key }}"
+
+        postgres:
+          db_password: "{{vm.password}}"
+
+        time_machine:
+          name: "{{time_machine.name}}"
+          snapshot_uuid: "{{snapshot.uuid}}"
+
+        removal_schedule:
+          days: 2
+          timezone: "Asia/Calcutta"
+          remind_before_in_days: 1
+          delete_database: True
+
+        refresh_schedule:
+          days: 2
+          time: "12:00:00"
+          timezone: "Asia/Calcutta"
+
+      register: output
+
+    - debug:
+        msg: "{{output}}"
+
+    - name: create clone using point in time
+      ntnx_ndb_database_clones:
+        name: "{{clone_db.name}}"
+        desc: "ansible-created-clone"
+
+        db_params_profile:
+          name: "{{db_params_profile.name}}"
+
+        db_vm:
+          create_new_server:
+            name: "{{ vm.name }}"
+            desc: "vm for db server"
+            password: "{{ vm.password }}"
+            cluster:
+              name: "{{cluster.name}}"
+            network_profile:
+              name: "{{ network_profile.name }}"
+            compute_profile:
+              name: "{{ compute_profile.name }}"
+            pub_ssh_key: "{{ public_ssh_key }}"
+
+        postgres:
+          db_password: "{{vm.password}}"
+
+        time_machine:
+          name: "{{time_machine.name}}"
+          pitr_timestamp: "2023-02-28 12:00:00"
+          timestamp: "Asia/Calcutta"
+
+        removal_schedule:
+          days: 2
+          timezone: "Asia/Calcutta"
+          remind_before_in_days: 1
+          delete_database: True
+
+        refresh_schedule:
+          days: 2
+          time: "12:00:00"
+          timezone: "Asia/Calcutta"
+      register: output
+
+    - debug:
+        msg: "{{output}}"

examples/ndb/refresh_clone.yml

@@ -0,0 +1,40 @@
+---
+- name: Create Refresh clone
+  hosts: localhost
+  gather_facts: false
+  collections:
+    - nutanix.ncp
+  module_defaults:
+    group/nutanix.ncp.ntnx:
+      nutanix_host: <ndb-era-ip>
+      nutanix_username: <username>
+      nutanix_password: <password>
+      validate_certs: false
+
+  tasks:
+    - set_fact:
+        clone_db:
+          uuid: <Clone Db UUID>
+        snapshot:
+          uuid: <Snapshot UUID>
+
+    - name: create spec for refresh clone to a pitr timestamp
+      check_mode: yes
+      ntnx_ndb_database_clone_refresh:
+        uuid: "{{clone_db.uuid}}"
+        pitr_timestamp: "2023-02-04 07:29:36"
+        timezone: "UTC"
+      register: output
+
+
+    - debug:
+        msg: "{{output}}"
+
+    - name: refresh db clone
+      ntnx_ndb_database_clone_refresh:
+        uuid: "{{clone_db.uuid}}"
+        snapshot_uuid: "{{snapshot.uuid}}"
+      register: output
+
+    - debug:
+        msg: "{{output}}"

examples/subnet_info.yml

@@ -29,3 +29,12 @@
       check_mode: true
       register: result
       ignore_errors: True
+
+    - name: List subnets filter and custom_filter
+      ntnx_subnets_info:
+        filter:
+          name: <name>
+        custom_filter:
+          adapter_type: <adapter_type>
+          vswitch_name: <vswitch_name>
+      register: result

examples/vm.yml

@@ -17,6 +17,19 @@
         script_path: ""
         subnet_name: ""
         image_name: ""
+        password: ""
+        fqdn: ""
+
+  - name: Create Cloud-init Script file
+    copy:
+      dest: "cloud_init.yml"
+      content: |
+         #cloud-config
+         chpasswd:
+           list: |
+             root: "{{ password }}"
+             expire: False
+         fqdn: "{{ fqdn }}"
 
   - name: create Vm
     ntnx_vms:
@@ -47,7 +60,7 @@
       memory_gb: 1
       guest_customization:
         type: "cloud_init"
-        script_path: "{{ script_path }}"
+        script_path: "./cloud_init.yml"
         is_overridable: True
     register: output
 

examples/vm_info.yml

@@ -22,7 +22,13 @@
         kind: vm
       register: result
       ignore_errors: True
-
+
+    - name: List vms using FIQL filter string
+      ntnx_vms_info:
+        filter_string: "vm_name=={{vm.name}};power_state==off"
+      register: result
+      ignore_errors: True
+
     - name: List vms using length, offset and ascending vm_name sorting 
       ntnx_vms_info:
         length: 10
@@ -31,3 +37,12 @@
         sort_attribute: "vm_name"
       register: result
       ignore_errors: True
+
+    - name: List vms using filter and custom_filter
+      ntnx_vms_info:
+        filter:
+          vm_name: <name>
+        custom_filter:
+          num_sockets: <num_sockets>
+
+      register: result

examples/vm_operations.yml

@@ -20,9 +20,8 @@
 
   - name: hard power off the vm
     ntnx_vms:
-        state: present
+        state: hard_poweroff
         vm_uuid: "{{ vm_uuid }}"
-        operation: hard_poweroff
     register: result
     ignore_errors: true
 

galaxy.yml

@@ -1,6 +1,6 @@
 namespace: "nutanix"
 name: "ncp"
-version: "1.9.0"
+version: "1.9.1"
 readme: "README.md"
 authors:
   - "Abhishek Chaudhary (@abhimutant)"

plugins/doc_fragments/ntnx_info.py

@@ -31,10 +31,14 @@ class ModuleDocFragment(object):
     type: int
   filter:
     description:
-      - The filter in FIQL syntax used for the results
+      - The filter in key-value syntax used for the results
     type: dict
   custom_filter:
     description:
-      - The filter in FIQL syntax used for the results
+      - The filter in key-value syntax used for the results
     type: dict
+  filter_string:
+    description:
+      - The filter in FIQL syntax used for the results
+    type: str
 """

plugins/doc_fragments/ntnx_vms_base.py

@@ -194,4 +194,19 @@ class ModuleDocFragment(object):
           - CDROM
           - DISK
           - NETWORK
+  owner:
+    description: Name or UUID of the owner
+    required: false
+    type: dict
+    suboptions:
+      name:
+        description:
+          - Owner Name
+          - Mutually exclusive with C(uuid)
+        type: str
+      uuid:
+        description:
+          - Owner UUID
+          - Mutually exclusive with C(name)
+        type: str
 """

plugins/inventory/ntnx_prism_vm_inventory.py

@@ -179,6 +179,11 @@ def parse(self, inventory, loader, path, cache=True):
             for key, value in entity["status"]["resources"].items():
                 self.inventory.set_variable(vm_name, key, value)
 
+            if "metadata" in entity and "categories" in entity["metadata"]:
+                self.inventory.set_variable(
+                    vm_name, "ntnx_categories", entity["metadata"]["categories"]
+                )
+
             # Add variables created by the user's Jinja2 expressions to the host
             self._set_composite_vars(
                 self.get_option("compose"),

plugins/module_utils/base_info_module.py

@@ -15,12 +15,21 @@ class BaseInfoModule(BaseModule):
         length=dict(type="int"),
         filter=dict(type="dict"),
         custom_filter=dict(type="dict"),
+        filter_string=dict(type="str"),
     )
 
+    info_args_mutually_exclusive = [
+        ("filter", "filter_string"),
+    ]
+
     def __init__(self, skip_info_args=False, **kwargs):
         self.argument_spec = deepcopy(BaseModule.argument_spec)
         self.argument_spec.pop("state")
         self.argument_spec.pop("wait")
         if not skip_info_args:
             self.argument_spec.update(self.info_argument_spec)
+            info_args_mutually_exclusive = deepcopy(self.info_args_mutually_exclusive)
+            if kwargs.get("mutually_exclusive"):
+                info_args_mutually_exclusive.extend(kwargs["mutually_exclusive"])
+            kwargs["mutually_exclusive"] = info_args_mutually_exclusive
         super(BaseInfoModule, self).__init__(**kwargs)