Create of VLAN using the API and /available-vlans/ fails when role or tenant is present #8454

New Issue

adam · 2025-12-29T20:36:56+01:00

adam commented

2025-12-29 20:36:56 +01:00

Originally created by @einaram on GitHub (Aug 10, 2023).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.6-beta1

Python version

3.10

Steps to Reproduce

Create a tenant and note the ID
Create a VLAN group and note the ID
Run a POST to `api/ipam/vlan-groups//available-vlans/ like:


curl -X 'POST' \
  'https://demo.netbox.dev/api/ipam/vlan-groups/2/available-vlans/' \
  -d '{
  "name": "a_VLAN_name",
  "tenant": 2
}'

Expected Behavior

A new VLAN should be created

Observed Behavior

Bad request is returned with an error message that indicates that the deserialization used the tenant object instead of the ID:

  "tenant": [
    "Related objects must be referenced by numeric ID or by dictionary of attributes. Received an unrecognized value: Strickland Propane"
  ]
}

Originally created by @einaram on GitHub (Aug 10, 2023). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.6-beta1 ### Python version 3.10 ### Steps to Reproduce 1. Create a tenant and note the ID 2. Create a VLAN group and note the ID 3. Run a POST to `api/ipam/vlan-groups/<VLAN-group-id>/available-vlans/ like: ``` curl -X 'POST' \ 'https://demo.netbox.dev/api/ipam/vlan-groups/2/available-vlans/' \ -d '{ "name": "a_VLAN_name", "tenant": 2 }' ``` ### Expected Behavior A new VLAN should be created ### Observed Behavior Bad request is returned with an error message that indicates that the deserialization used the tenant object instead of the ID: ```{ "tenant": [ "Related objects must be referenced by numeric ID or by dictionary of attributes. Received an unrecognized value: Strickland Propane" ] } ```

adam added the type: bug status: under review severity: medium labels 2025-12-29 20:36:56 +01:00

adam closed this issue

2025-12-29 20:36:56 +01:00

adam commented

2025-12-29 20:36:57 +01:00

@einaram commented on GitHub (Aug 10, 2023):

I have tested possible solution by not deserializing requested_vlans and instead adding vid to the raw data. This, and tests modified to test this behavoir is available here:
https://github.com/netbox-community/netbox/compare/develop...einaram:netbox:13440-fix-available-vlan-post

@einaram commented on GitHub (Aug 10, 2023): I have tested possible solution by not deserializing `requested_vlans` and instead adding `vid` to the raw data. This, and tests modified to test this behavoir is available here: https://github.com/netbox-community/netbox/compare/develop...einaram:netbox:13440-fix-available-vlan-post

adam commented

2025-12-29 20:36:57 +01:00

@jeremystretch commented on GitHub (Aug 23, 2023):

This and similar API endpoints were refactored recently in feature to use the new common AvailableObjectsView (see #12180), however the bug does still exist. Testing shows that tenant assignment works as expected when provisioning available IPs, but not for available VLANs. This is due to a difference between the serializers: CreateAvailableVLANSerializer defines a tenant field whereas AvailableIPSerializer does not.

Further investigation is needed to determine the appropriate fix. We need to ensure that all serializers that enable the automatic creation of "available" objects operate in a consistent manner.

@jeremystretch commented on GitHub (Aug 23, 2023): This and similar API endpoints were refactored recently in `feature` to use the new common AvailableObjectsView (see #12180), however the bug does still exist. Testing shows that tenant assignment works as expected when provisioning available IPs, but not for available VLANs. This is due to a difference between the serializers: CreateAvailableVLANSerializer defines a `tenant` field whereas AvailableIPSerializer does not. Further investigation is needed to determine the appropriate fix. We need to ensure that _all_ serializers that enable the automatic creation of "available" objects operate in a consistent manner.

adam commented

2025-12-29 20:36:58 +01:00

@jeremystretch commented on GitHub (Sep 25, 2023):

@arthanson this may be related to #13746

@jeremystretch commented on GitHub (Sep 25, 2023): @arthanson this may be related to #13746

adam commented

2025-12-29 20:36:58 +01:00

@arthanson commented on GitHub (Sep 25, 2023):

This is fixed by #13746

@arthanson commented on GitHub (Sep 25, 2023): This is fixed by #13746

adam commented

2025-12-29 20:36:58 +01:00

@jeremystretch commented on GitHub (Oct 5, 2023):

Confirmed that this has been resolved by PR #13889. Thanks @arthanson!

@jeremystretch commented on GitHub (Oct 5, 2023): Confirmed that this has been resolved by PR #13889. Thanks @arthanson!

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#8454