[Bug]: Breaking changes in 3.6.0, device_role -> role

[shaul75]

PR: #1062

Ansible NetBox Collection version

v3.14.0

Ansible version

https://github.com/netbox-community/netbox/releases/tag/v3.6.0

The device_role field on the Device model has been renamed to role. The device_role field has been temporarily retained on the REST API serializer for devices for backward compatibility, but is read-only.

NetBox version

v3.6.0

Python version

3.10

Steps to Reproduce

      netbox.netbox.netbox_device:
        data:
          name: "{{ ansible_facts['product_name'] }}"
          device_type: "{{ ansible_facts['product_name'] }}"
          device_role: 1
          site: 1
        state: present

Expected Behavior

Device is created/updated

Observed Behavior

{"role":["This field is required."]}
fatal: [10.0.20.10 -> localhost]: FAILED! => {
    "changed": false
}

[sthierolf]

Can confirm this bug in latest NetBox version 3.6.1 too.

Workaround:
By manually adding the device first (this means: device exists) and then running Ansible role against that device (to have other data done automatically) the error is not thrown.
Eventually this workaround helps for 1-5 devices, but it is no fun for 100s of devices.

[gtherond]

I do confirm, the issue comes from the following upstream API breaking change: netbox-community/netbox#6391

They did put device_role field as a RO one while the RW field is now named role.
A simple quick and dirty fix would be to change the device_role mapping to role instead of device_role api field.
in here:

ansible_modules/plugins/module_utils/netbox_utils.py

Line 321 in 4211b71

"device_roles": "device_role",

[BackblazeJeremy]

For those like me that need this fix ahead of a release, you can do so by installing the collection by hash with ansible-galaxy. You can do so by creating this requirements.yml file:

roles: []
collections:
  - name: https://github.com/netbox-community/ansible_modules.git
    type: git
    version: 5f497b5d0e5524529636eea68466bfbec203dd4b

Then apply it with ansible-galaxy install -r requirements.yml. This worked for me.