netbox_device_interface fails on a second run to form_factor

[lassizci]

ISSUE TYPE

• Bug Report

SOFTWARE VERSIONS

Ansible:

2.9.7

Netbox:

v2.7.11

Collection:

0.2.0

SUMMARY

netbox_device_interface seems to fail every time after the initial interface creation due to form_factor missing in the existing data. I can't find such field from Netbox API. netbox_interface on the other hand specifies type instead of form_factor. Is this on purpose? I'm not sure I understood the difference, but tried this one instead, as I had other issue with netbox_interface.

STEPS TO REPRODUCE

Run this task twice in a row

- hosts: localhost
  connection: local
  become: no
  gather_facts: no
  collections:
    - netbox.netbox
  vars_files:
    - vars/netbox/secrets.yml
  vars:
    netbox_url: https://netbox.mydomain
   
  tasks:
    - name: add interface to device
      netbox.netbox.netbox_device_interface:
         netbox_url: "{{ netbox_url }}" 
         netbox_token: "{{ netbox_token }}" 
         data:
           name: public
           device:  test1 
           form_factor: "1000base-t"

EXPECTED RESULTS

Should succeed on both runs

ACTUAL RESULTS

The full traceback is:
  File "/tmp/ansible_netbox.netbox.netbox_device_interface_payload_3tfvr86m/ansible_netbox.netbox.netbox_device_interface_payload.zip/ansible_collections/netbox/netbox/plugins/module_utils/netbox_utils.py", line 675, in _update_netbox_object
    if serialized_nb_obj[key] != updated_obj[key]:
fatal: [localhost]: FAILED! => changed=false 
  invocation:
    module_args:
      data:
        description: null
        device: test1
        enabled: null
        form_factor: 1000base-t
        lag: null
        mac_address: null
        mgmt_only: null
        mode: null
        mtu: null
        name: public
        tagged_vlans: null
        tags: null
        untagged_vlan: null
      netbox_token: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
      netbox_url: https://netbox
      state: present
      update_vc_child: false
      validate_certs: true
  msg: form_factor does not exist on existing object. Check to make sure valid field.

[FragmentedPacket]

@lassizci Can you try the PR I have open for this?

[ThomasADavis]

It's using slugs as the type, instead of the full description..

ie, '10gbase-t' not '10GBASE-T (10GE)'

[lassizci]

@FragmentedPacket thanks! Yes, it seems to work. As mentioned, the type indeed has to be a slug, not the full description.

[mrlesmithjr]

Just wanted to add that I have too just ran into this bug using netbox_device_interface on the second round.

failed: [localhost] (item={'data': {'description': '', 'device': 'ATL-OOB-3750A', 'enabled': True, 'form_factor': '1000BASE-T (1GE)', 'lag': None, 'mac_address': None, 'mgmt_only': False, 'mode': None, 'mtu': 1500, 'name': 'g0/0/1', 'tagged_vlans': [], 'tags': [], 'untagged_vlan': None}, 'state': 'present'}) => {"ansible_loop_var": "item", "changed": false, "item": {"data": {"description": "", "device": "ATL-OOB-3750A", "enabled": true, "form_factor": "1000BASE-T (1GE)", "lag": null, "mac_address": null, "mgmt_only": false, "mode": null, "mtu": 1500, "name": "g0/0/1", "tagged_vlans": [], "tags": [], "untagged_vlan": null}, "state": "present"}, "msg": "form_factor does not exist on existing object. Check to make sure valid field."}

[FragmentedPacket]

@lassizci and @mrlesmithjr I just merged the fix for this and suggest changing form_factor to type going forward.

I will try and get a release out within the next day or two bearing time.