custom fields in query_params

[fabricat]

I have a custom field named uid to keep the UUIDs assigned to VMs across several virtualization platforms.

Now, I'd prefer to rely on that field, rather than the VM name (that could change over time).
Unfortunately, when if I try to run the following task...

- name: "update VM on Netbox"
  netbox.netbox.netbox_virtual_machine:
    netbox_url: "{{ NETBOX_URL }}"
    netbox_token: "{{ NETBOX_TOKEN }}"
    state: present
    query_params:
      - cf_uid
      - cluster
    data:
      name:    "{{ vm_name }}"
      cluster: "{{ vm_cluster }}"
      custom_fields:
        uid: "{{ vm_id }}"

... I get this error

More than one result returned for {my-vm-name}

I see the following request on the server:

GET /api/virtualization/virtual-machines/?cluster_id=11&limit=0

It seems that the cf_uid param is stripped by Ansible or Python module.
How can I get my "unique ID" custom field to act as a real unique ID?

[fabricat]

Wait: is there a way to change the name of a virtual machine in Netbox using Ansible? 🤔

[rodvand]

Interesting question. I believe the difference in name of the query parameter and how they're defined in the module makes it hard to achieve just this.

If you remove the cluster from your query_params you get an error about it being an invalid kwarg. This is due to these lines matching the provided args with the "allowed" args from the spec:

ansible_modules/plugins/module_utils/netbox_utils.py

Lines 845 to 848 in a2cf3f4

	if child:
	matches = query_params.intersection(set(child.keys()))
	else:
	matches = query_params.intersection(set(module_data.keys()))

To get this working one would have to have some sort of translation from the custom_fields.uid to cf_uid. Doesn't sound impossible, but that's just after having a very brief look at it...

[rodvand]

And yes, I believe you should be able to change the name of a virtual machine if you use a combination of query_params that ensures you receive a unique VM back. I did this the other day with VLAN groups, using the name instead of the slug (which is default) as the query parameter.

[telecomschik]

Hello
Did find any solutions to get object by uid?