[Docs]: Problem with the netbox.netbox.netbox_device_type module

[ghost]

Change Type

Correction

Area

Functionality/features

Proposed Changes

First of all I apologize if my English is not completely understandable.

Hi, I'm trying to populate all my company network in Netbox using Ansible.
At this point, I'm stuck in the netbox.netbox.netbox_device_type module. When I try to put a device type from the https://github.com/netbox-community/devicetype-library I get errors in the parameters.

I read https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_device_type_module.html#ansible-collections-netbox-netbox-netbox-device-type-module, it seems to not support the parameters: console-ports, power-ports and interfaces

Is my fault that I'm not using the module correctly?

THE FILES

├── create_device_types
      ├── tasks
      │   └── main.yml
      └── vars
            └── main.yml

create_device_types/tasks/main.yml

---
- name: Create locations
  netbox.netbox.netbox_device_type:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ device_type }}"
    state: present
  loop: "{{ device_type }}"
  loop_control: 
    loop_var: device_type
    label: "{{ device_type['model']}}"

create_device_types/vars/main.yml

device_type:
  - model: PowerEdge R550
    manufacturer: Dell
    slug: dell-poweredge-r550
    u_height: 2
    is_full_depth: true
    subdevice_role: parent
    console-ports:
      - name: Serial
        type: de-9
      - name: Rear VGA
        type: other
      - name: Front VGA
        type: other
    power-ports:
      - name: Power 1
        type: iec-60320-c14
      - name: Power 2
        type: iec-60320-c14
    interfaces:
      - name: Gig-E 1
        type: 1000base-t
      - name: Gig-E 2
        type: 1000base-t
      - name: iDRAC
        type: 1000base-t
        mgmt_only: true

Result executing ansible

$ ansible-playbook populate_devices.yml 
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not
match 'all'

PLAY [PLAY 1 - Create Tenants groups] *****************************************************************************

TASK [create_device_types : Create locations] *********************************************************************
[WARNING]: TASK: create_device_types : Create locations: The loop variable 'device_type' is already in use. You
should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
failed: [localhost] (item=PowerEdge R550) => {"ansible_loop_var": "device_type", "changed": false, "device_type": {"console-ports": [{"name": "Serial", "type": "de-9"}, {"name": "Rear VGA", "type": "other"}, {"name": "Front VGA", "type": "other"}], "interfaces": [{"name": "Gig-E 1", "type": "1000base-t"}, {"name": "Gig-E 2", "type": "1000base-t"}, {"mgmt_only": true, "name": "iDRAC", "type": "1000base-t"}], "is_full_depth": true, "manufacturer": "Dell", "model": "PowerEdge R550", "power-ports": [{"name": "Power 1", "type": "iec-60320-c14"}, {"name": "Power 2", "type": "iec-60320-c14"}], "slug": "dell-poweredge-r550", "subdevice_role": "parent", "u_height": 2}, "msg": "Unsupported parameters for (netbox.netbox.netbox_device_type) module: data.console-ports, data.interfaces, data.power-ports. Supported parameters include: airflow, comments, custom_fields, description, is_full_depth, manufacturer, model, part_number, slug, subdevice_role, tags, u_height, weight, weight_unit."}

PLAY RECAP ********************************************************************************************************
localhost                  : ok=0    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

[ghost]

I saw in the Netbox REST API Swagger documentation that in POST /api/dcim/device-types/, looking at the json format and changing it to yaml:

i tried:

device_type:
  - model: PowerEdge R550
    manufacturer: Dell
    slug: dell-poweredge-r550
    u_height: 2
    is_full_depth: true
    subdevice_role: parent
    custom_fields:
      console-ports:
        - name: Serial
          type: de-9
        - name: Rear VGA
          type: other
        - name: Front VGA
          type: other
      power-ports:
        - name: Power 1
          type: iec-60320-c14
        - name: Power 2
          type: iec-60320-c14
      interfaces:
        - name: Gig-E 1
          type: 1000base-t
        - name: Gig-E 2
          type: 1000base-t
        - name: iDRAC
          type: 1000base-t
          mgmt_only: true

but I get an error:

$ ansible-playbook populate_devices.yml
 
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not
match 'all'

PLAY [PLAY 1 - POPULATING DEVICES] *****************************************************************************

TASK [create_device_types : Create locations] ******************************************************************
[WARNING]: TASK: create_device_types : Create locations: The loop variable 'device_type' is already in use. You
should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
failed: [localhost] (item=PowerEdge R550) => {"ansible_loop_var": "device_type", "changed": false, "device_type": {"custom_fields": 
{"console-ports": [{"name": "Serial", "type": "de-9"}, {"name": "Rear VGA", "type": "other"}, {"name": "Front VGA", "type": "other"}], "interfaces": [{"name": "Gig-E 1", "type": "1000base-t"}, {"name": "Gig-E 2", "type": "1000base-t"}, {"mgmt_only": true, "name": "iDRAC", "type": "1000base-t"}], "power-ports": [{"name": "Power 1", "type": "iec-60320-c14"}, {"name": "Power 2", "type": "iec-60320-c14"}]}, "is_full_depth": true, "manufacturer": "Dell", "model": "PowerEdge R550", "slug": "dell-poweredge-r550", "subdevice_role": "parent", "u_height": 2}, "msg": "{\"__all__\":[\"Unknown field name 'console-ports' in custom field data.\"]}"}

PLAY RECAP *****************************************************************************************************
localhost                  : ok=0    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0 

[ghost]

I finally get a solution using python3 i will share my code with you all:
List of fodlers and files:

.
└── roles
    └── create_device_types
           └── files
           │   └── payon3.py
           ├── tasks
           │   └── main.yml
           └── vars
                 └── main.yml

roles/create_device_types/files/payon3.py

import yaml
# Carga el YAML original
# [put more devices from https://github.com/netbox-community/devicetype-library/]
original_yaml = """
device_type:
  - model: C9200L-48P-4G
    manufacturer: Cisco
    part_number: C9200L-48P-4G
    slug: cisco-c9200l-48p-4g
    u_height: 1
    is_full_depth: false
    comments: '[Cisco Catalyst 9200 Series Switches Data Sheet](https://www.cisco.com/c/en/us/products/collateral/switches/catalyst-9200-series-switches/nb-06-cat9200-ser-data-sheet-cte-en.html)'
    console-ports:
      - name: Console
        type: rj-45
      - name: usb
        type: usb-mini-b
    power-ports:
      - name: PS-1
        type: iec-60320-c14
        maximum_draw: 740
      - name: PS-2
        type: iec-60320-c14
        maximum_draw: 740
    interfaces:
      - name: GigabitEthernet1/0/1
        type: 1000base-t
      - name: GigabitEthernet0
        type: 1000base-t
        mgmt_only: true

  - model: PowerEdge R550
    manufacturer: Dell
    slug: dell-poweredge-r550
    u_height: 2
    is_full_depth: true
    subdevice_role: parent
    console-ports:
    - name: Serial
      type: de-9
    - name: Rear VGA
      type: other
    - name: Front VGA
      type: other
    power-ports:
    - name: Power 1
      type: iec-60320-c14
    - name: Power 2
      type: iec-60320-c14
    interfaces:
    - name: Gig-E 1
      type: 1000base-t
    - name: Gig-E 2
      type: 1000base-t
    - name: iDRAC
      type: 1000base-t
      mgmt_only: true

"""

data = yaml.safe_load(original_yaml)

# Crear una lista de device_type con las claves que se quieren mantener
device_type_list = []
for device in data['device_type']:
    device_type_data = {
			key: value for key, value in device.items() if key not in ['console-ports', 'interfaces', 'rear-ports', 'front-ports', 'power-ports']
    }
    device_type_list.append(device_type_data)

# Crear listas separadas para cada tipo de puerto
console_ports_list = []
interfaces_list = []
rear_ports_list = []
front_ports_list = []
power_ports_list = []

for device in data['device_type']:
	for port in device.get('console-ports', []):
		console_ports_list.append({'device_type': device['slug'], **port})

	for port in device.get('interfaces', []):
		interfaces_list.append({'device_type': device['slug'], **port})

	for port in device.get('rear-ports', []):
		rear_ports_list.append({'device_type': device['slug'], **port})

	for port in device.get('front-ports', []):
		front_ports_list.append({'device_type': device['slug'], **port})

	for port in device.get('power-ports', []):
		power_ports_list.append({'device_type': device['slug'], **port})

# Crear un diccionario final con todas las listas
final_data = {
	'device_type': device_type_list,
	'console_ports': console_ports_list,
	'interfaces': interfaces_list,
	'rear_ports': rear_ports_list,
	'front_ports': front_ports_list,
	'power_ports': power_ports_list
}


# Convertir el diccionario final a YAML
yaml_object = yaml.dump(final_data, indent=2, sort_keys=False,allow_unicode=True)
with open("roles/create_device_types/vars/main.yml", 'w', encoding='utf-8') as archivo:
	archivo.write(yaml_object)

roles/create_device_types/tasks/main.yml

- name: creating main.yml for device_types
  ansible.builtin.script:
    executable: python3
    cmd: payon3.py

- name: Correcion para main.yml
  ansible.builtin.shell: |
    sed -i 's/  rear_port:/  rear_port_template:/g' roles/create_device_types/vars/main.yml

- name: Create device type
  netbox.netbox.netbox_device_type:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ device_type }}"
    state: present
  loop: "{{ device_type }}"
  loop_control: 
    loop_var: device_type
    label: "{{ device_type['model']}}"

- name: Create console ports
  netbox.netbox.netbox_console_port_template:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ console_ports }}"
    state: present
  loop: "{{ console_ports }}"
  loop_control: 
    loop_var: console_ports
    label: "{{ console_ports['device_type']}}"

- name: Create interfaces
  netbox.netbox.netbox_device_interface_template:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ interfaces }}"
    state: present
  loop: "{{ interfaces }}"
  loop_control: 
    loop_var: interfaces
    label: "{{ interfaces['device_type']}}"

- name: Create rear ports
  netbox.netbox.netbox_rear_port_template:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ rear_ports }}"
    state: present
  loop: "{{ rear_ports }}"
  loop_control: 
    loop_var: rear_ports
    label: "{{ rear_ports['device_type']}}"

- name: Create front ports
  netbox.netbox.netbox_front_port_template:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ front_ports }}"
    state: present
  loop: "{{ front_ports }}"
  loop_control: 
    loop_var: front_ports
    label: "{{ front_ports['device_type']}}"

- name: Create power ports
  netbox.netbox.netbox_power_port_template:
    netbox_url: "{{ lookup('ansible.builtin.env', 'NETBOX_API') }}"
    netbox_token: "{{ lookup('ansible.builtin.env', 'NETBOX_TOKEN') }}"
    data: "{{ power_ports }}"
    state: present
  loop: "{{ power_ports }}"
  loop_control: 
    loop_var: power_ports
    label: "{{ power_ports['device_type']}}"

roles/create_device_types/tasks/main.yml

# [created from roles/create_device_types/files/payon3.py]

device_type:
- model: C9200L-48P-4G
  manufacturer: Cisco
  part_number: C9200L-48P-4G
  slug: cisco-c9200l-48p-4g
  u_height: 1
  is_full_depth: false
  comments: '[Cisco Catalyst 9200 Series Switches Data Sheet](https://www.cisco.com/c/en/us/products/collateral/switches/catalyst-9200-series-switches/nb-06-cat9200-ser-data-sheet-cte-en.html)'
- model: PowerEdge R550
  manufacturer: Dell
  slug: dell-poweredge-r550
  u_height: 2
  is_full_depth: true
  subdevice_role: parent
console_ports:
- device_type: cisco-c9200l-48p-4g
  name: Console
  type: rj-45
- device_type: cisco-c9200l-48p-4g
  name: usb
  type: usb-mini-b
- device_type: dell-poweredge-r550
  name: Serial
  type: de-9
- device_type: dell-poweredge-r550
  name: Rear VGA
  type: other
- device_type: dell-poweredge-r550
  name: Front VGA
  type: other
interfaces:
- device_type: cisco-c9200l-48p-4g
  name: GigabitEthernet1/0/1
  type: 1000base-t
- device_type: cisco-c9200l-48p-4g
  name: GigabitEthernet0
  type: 1000base-t
  mgmt_only: true
- device_type: dell-poweredge-r550
  name: Gig-E 1
  type: 1000base-t
- device_type: dell-poweredge-r550
  name: Gig-E 2
  type: 1000base-t
- device_type: dell-poweredge-r550
  name: iDRAC
  type: 1000base-t
  mgmt_only: true
rear_ports: []
front_ports: []
power_ports:
- device_type: cisco-c9200l-48p-4g
  name: PS-1
  type: iec-60320-c14
  maximum_draw: 740
- device_type: cisco-c9200l-48p-4g
  name: PS-2
  type: iec-60320-c14
  maximum_draw: 740
- device_type: dell-poweredge-r550
  name: Power 1
  type: iec-60320-c14
- device_type: dell-poweredge-r550
  name: Power 2
  type: iec-60320-c14

AND IT WORKS! but i need to run it two times

$ ansible-playbook populate_devices.yml -f 20
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not
match 'all'

PLAY [PLAY 1 - POPULATING DEVICES] ********************************************************************************

TASK [create_device_types : creating main.yml for device_types] ***************************************************
changed: [localhost]

TASK [create_device_types : Correcion para main.yml] **************************************************************
changed: [localhost]

TASK [create_device_types : Create device type] *******************************************************************
fatal: [localhost]: FAILED! => {"msg": "'device_type' is undefined. 'device_type' is undefined"}

PLAY RECAP ********************************************************************************************************
localhost                  : ok=2    changed=2    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

$ ansible-playbook populate_devices.yml -f 20
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not
match 'all'

PLAY [PLAY 1 - POPULATING DEVICES] ********************************************************************************

TASK [create_device_types : creating main.yml for device_types] ***************************************************
changed: [localhost]

TASK [create_device_types : Correcion para main.yml] **************************************************************
changed: [localhost]

TASK [create_device_types : Create device type] *******************************************************************
[WARNING]: TASK: create_device_types : Create device type: The loop variable 'device_type' is already in use. You
should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
changed: [localhost] => (item=C9200L-48P-4G)
changed: [localhost] => (item=PowerEdge R550)

TASK [create_device_types : Create console ports] *****************************************************************
[WARNING]: TASK: create_device_types : Create console ports: The loop variable 'console_ports' is already in use.
You should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=dell-poweredge-r550)
changed: [localhost] => (item=dell-poweredge-r550)
changed: [localhost] => (item=dell-poweredge-r550)

TASK [create_device_types : Create interfaces] ********************************************************************
[WARNING]: TASK: create_device_types : Create interfaces: The loop variable 'interfaces' is already in use. You
should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=dell-poweredge-r550)
changed: [localhost] => (item=dell-poweredge-r550)
changed: [localhost] => (item=dell-poweredge-r550)

TASK [create_device_types : Create rear ports] ********************************************************************
skipping: [localhost]

TASK [create_device_types : Create front ports] *******************************************************************
skipping: [localhost]

TASK [create_device_types : Create power ports] *******************************************************************
[WARNING]: TASK: create_device_types : Create power ports: The loop variable 'power_ports' is already in use. You
should set the `loop_var` value in the `loop_control` option for the task to something else to avoid variable
collisions and unexpected behavior.
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=cisco-c9200l-48p-4g)
changed: [localhost] => (item=dell-poweredge-r550)
changed: [localhost] => (item=dell-poweredge-r550)

PLAY RECAP ********************************************************************************************************
localhost                  : ok=6    changed=6    unreachable=0    failed=0    skipped=2    rescued=0    ignored=0