Do not deprecate vm_nic records return value

The module does work with list of NICs (the items input parameter).
It is natural to also return a list of NICs.

Reverts db9dff7

Signed-off-by: Justin Cinkelj <justin.cinkelj@xlab.si>

Author: justinc1

changelogs/fragments/return_documentation_update_vm_nic.yml

@@ -25,13 +25,8 @@ return value ``results`` is deprecated.
 A new return value ``record`` is added as replacement.
 The old ``results`` return value will remain available until release 3.0.0.
 
-Module `scale_computing.hypercore.vm_nic <../collections/scale_computing/hypercore/vm_nic_module.html>`_
-return value ``records`` is deprecated.
-A new return value ``record`` is added as replacement.
-The old ``records`` return value will remain available until release 3.0.0.
-
 Only playbooks that store output from ``scale_computing.hypercore.iso``
-(or ``scale_computing.hypercore.vm_nic``) module using ``register:`` keyword are affected.
+module using ``register:`` keyword are affected.
 
 Added deprecation note for modules
 `scale_computing.hypercore.vm <../collections/scale_computing/hypercore/vm_module.html>`_ and
@@ -62,31 +57,6 @@ For ``scale_computing.hypercore.iso`` module:
       ansible.builtin.debug:
         msg: The uploaded_iso size={{ uploaded_iso.record.size }}
 
-
-For ``scale_computing.hypercore.vm_nic`` module:
-
-.. code-block:: yaml
-
-    # Store vm_nic module output
-    - name: Set VLAN for VM {{ vm_name }} 1st NIC
-      scale_computing.hypercore.vm_nic:
-        vm_name: "{{ vm_name }}"
-        items:
-          - vlan: "{{ vlan }}"
-        state: present
-      register: vm_nic_result
-
-    # Use vm_nic module output, old syntax, valid until release < 3.0.0
-    - name: Show VM {{ vm_name }} 1st NIC VLAN - deprecated syntax
-      ansible.builtin.debug:
-        msg: The configured VLAN is {{ vm_nic_result.records.vlan }} - deprecated syntax
-
-    # Use vm_nic module output, new syntax, valid after release >= 1.2.0
-    - name: Show VM {{ vm_name }} 1st NIC VLAN
-      ansible.builtin.debug:
-        msg: The configured VLAN is {{ vm_nic_result.record.vlan }}
-
-
 Release 3.0.0 (not yet released)
 ================================
 

docs/rst/extra/deprecation.rst

@@ -1,31 +1,27 @@
 ---
-- name: Change VLAN for 1st NIC of a specific VM
+- name: Configure VM with a two NICs with specific VLANs
   hosts: localhost
   connection: local
   gather_facts: false
   vars:
     vm_name: demo-vm
-    vlan: 10
+    vlan_a: 10
+    vlan_b: 11
 
   tasks:
-    - name: Set VLAN for VM {{ vm_name }} 1st NIC
+    - name: Configure VM {{ vm_name }} with 2 NICs, VLANs {{ vlan_a }} and {{ vlan_b }}
       scale_computing.hypercore.vm_nic:
         vm_name: "{{ vm_name }}"
         items:
-          - vlan: "{{ vlan }}"
-        state: present
+          - vlan: "{{ vlan_a }}"
+          - vlan: "{{ vlan_b }}"
+        state: set
       register: vm_nic_result
 
     - name: Show the VM {{ vm_name }} new NIC state
       ansible.builtin.debug:
-        var: vm_nic_result.record
+        var: vm_nic_result
 
-    # Use vm_nic module output, old syntax, valid until release < 3.0.0
-    - name: Show VM {{ vm_name }} 1st NIC VLAN - deprecated syntax
+    - name: Show VM {{ vm_name }} new NIC VLANs
       ansible.builtin.debug:
-        msg: The configured VLAN is {{ vm_nic_result.records.vlan }} - deprecated syntax
-
-    # Use vm_nic module output, new syntax, valid after release >= 1.2.0
-    - name: Show VM {{ vm_name }} 1st NIC VLAN
-      ansible.builtin.debug:
-        msg: The configured VLAN is {{ vm_nic_result.record.vlan }}
+        msg: The configured VLANs are {{ vm_nic_result.records | map(attribute="vlan") }}

examples/vm_nic.yml

@@ -69,10 +69,6 @@
           - Is network interface connected or not.
 notes:
   - C(check_mode) is not supported.
-  - Return value C(record) is added in version 1.2.0, and deprecates return value C(records).
-    Return value C(records) will be removed in future release.
-    R(List of deprecation changes, scale_computing.hypercore.deprecation)
-    includes examples to help with transition.
 """
 
 EXAMPLES = r"""
@@ -140,41 +136,9 @@
 """
 
 RETURN = r"""
-record:
-  description:
-    - The created or changed record for nic on a specified virtual machine.
-  returned: success
-  type: dict
-  contains:
-    uuid:
-      description: Unique identifier
-      type: str
-      sample: 07a2a68a-0afa-4718-9c6f-00a39d08b67e
-    vlan:
-      description: VLAN tag of the interface
-      type: int
-      sample: 15
-    type:
-      description: Virtualized network device types
-      type: str
-      sample: virtio
-    mac:
-      description: MAC address of the virtual network device
-      type: str
-      sample: 12-34-56-78-AB
-    connected:
-      description: Enabled and can make connections
-      type: bool
-      sample: true
-    ipv4_addresses:
-      description: IPv4 addresses registered with this device
-      type: list
-      elements: str
-      sample: 192.0.2.1
 records:
   description:
     - The created or changed record for nic on a specified virtual machine.
-    - This value is deprecated and will be removed in a future release. Please use record instead.
   returned: success
   type: dict
   contains:
@@ -339,22 +303,13 @@ def main():
         ),
     )
 
-    module.deprecate(
-        "The 'records' return value is being renamed to 'record'. "
-        "Please use 'record' since 'records' will be removed in future release. "
-        "But for now both values are being returned to allow users to migrate their automation.",
-        version="3.0.0",
-        collection_name="scale_computing.hypercore",
-    )
-
     try:
         client = Client.get_client(module.params["cluster_instance"])
         rest_client = RestClient(client=client)
-        changed, record, diff, reboot = run(module, rest_client)
+        changed, records, diff, reboot = run(module, rest_client)
         module.exit_json(
             changed=changed,
-            records=record,
-            record=record,
+            records=records,
             diff=diff,
             vm_rebooted=reboot,
         )

plugins/modules/vm_nic.py

@@ -200,7 +200,6 @@ def test_minimal_set_of_params(self, run_main_with_reboot, mocker):
         assert results == {
             "changed": False,
             "records": {},
-            "record": {},
             "diff": {"before": {}, "after": {}},
             "vm_rebooted": False,
         }