Prefix module doesn't discern between identically named vlans from different vlan groups and/or sites

[artiomello]

Ansible NetBox Collection version

v3.9.0

Ansible version

Running in AWX. Version is irrelevant to the case.

NetBox version

v3.3.7

Python version

3.8

Steps to Reproduce

netbox.netbox.netbox_prefix module doesn't have a way to specify vlans from specific vlan groups and/or sites, which in turn means that when you have identical vlan names in different vlan groups and/or sitesthe module will give the following error:
"msg": "More than one result returned for vlan"

1. Create two different VLAN Groups or Sites
2. Create an identically named VLAN in each group/site
3. Run the module with the vlan name defined
4. Make a sad face

Expected Behavior

There should be a way to specify exact the vlan from a specific vlan groups and/or sites.
If Netbox functionality and logic, allows this, the module should reflect it.

Observed Behavior

Got a "failed" status with the following message:

"msg": "More than one result returned for vlan"

[sc68cal]

Can you share the relevant sections of your playbook and traceback? I have multiple sites at work with vlan and vlan groups, and multiple prefixes, and have not encountered this error, however our playbooks may differ in how we reference things.

[artiomello]

I create them using a loop like so:

And the prefix definition is:

Don't mind the vlan being commented. As you can see, both the site and vlan is defined, but when I run it I get this:

And I have this vlan name defined in two different vlan groups within the same site.

[sc68cal]

Looking at my playbooks, I was setting the following for a prefix:

    - name: Create netbox prefixes for each CCP function
      netbox_prefix:
        netbox_url: "{{ netbox_url }}"
        netbox_token: "{{ netbox_token }}"
        data:
          site: "{{ netbox_site_slug }}"
          prefix: "{{ item.prefix }}"
          description: "{{ item.description }}"
          vlan:
            name: "{{ item.vlan_name | default(omit) }}"
            vlan_group: "{{ item.vlan_group | default(omit) }}"
          tags:
            - "{{ az_tag }}"
          prefix_role: "{{ item.role }}"
        state: present
      loop: "{{ ccp_vlans_subnets }}"
      # some vlans don't have prefixes, so only create a prefix
      # if one is defined
      when: "'prefix' in item"

I believe you need to set the vlan key to have both the vlan_group and name attribute so that you select the correct VLAN.

[artiomello]

And how does one know that the vlan key in fact has two additional subkeys, if you don't mind my asking?

https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_prefix_module.html#ansible-collections-netbox-netbox-netbox-prefix-module

[sc68cal]

See the example named name: Create prefix with several specified options

[artiomello]

What I'm trying to say is shouldn't someone update the actual key description of the module so that it's clear as day what options are available for use? That's why descriptions are there in the first place and that's also why I had this problem - because it's not mentioned in the description.

The fact that there's an example with additional options seem to mean a great deal less, considering that there are some modules that have examples with key options that are explicitly deprecated in the module's description.

[rodvand]

https://netbox-ansible-collection.readthedocs.io/en/latest/getting_started/how-to-use/advanced.html#passing-in-dictionaries

It would be unmanageable to keep every description up to date with the various options you can pass.