Filter VRF on GraphQL ip_address does not filter #9853

New Issue

adam · 2025-12-29T21:23:34+01:00

adam commented

2025-12-29 21:23:34 +01:00

Originally created by @antoinekh on GitHub (Jun 17, 2024).

Deployment Type

Self-hosted

NetBox Version

4.0.5

Python Version

3.10

Steps to Reproduce

Create IP addresses on multiple VRF
Make a graphQL request to get IP addresse on a dedicated VRF

Easy to test https://demo.netbox.dev/graphql/ as there is already IP not on dedicated VRF.

Expected Behavior

Filter the request with the VRF name and only display

Observed Behavior

GraphQL request

query GetIP {
  ip_address_list (filters: {vrf : "ABC"}){
    id
    display
    vrf {
      id
      name
    }
  }
}

I also tried with

query GetIP {
  ip_address_list (filters: {vrf :{name:{contains: "ABC"}}}){
    id
    display
    vrf {
      id
      name
    }
  }
}

But this seems not supported:

{
  "data": null,
  "errors": [
    {
      "message": "String cannot represent a non string value: {name: {contains: \"ABC\"}}",
      "locations": [
        {
          "line": 2,
          "column": 35
        }
      ]
    }
  ]
}

Originally created by @antoinekh on GitHub (Jun 17, 2024). ### Deployment Type Self-hosted ### NetBox Version 4.0.5 ### Python Version 3.10 ### Steps to Reproduce 1. Create IP addresses on multiple VRF 2. Make a graphQL request to get IP addresse on a dedicated VRF Easy to test https://demo.netbox.dev/graphql/ as there is already IP not on dedicated VRF. ### Expected Behavior Filter the request with the VRF name and only display ### Observed Behavior GraphQL request ``` query GetIP { ip_address_list (filters: {vrf : "ABC"}){ id display vrf { id name } } } ``` I also tried with ``` query GetIP { ip_address_list (filters: {vrf :{name:{contains: "ABC"}}}){ id display vrf { id name } } } ``` But this seems not supported: ``` { "data": null, "errors": [ { "message": "String cannot represent a non string value: {name: {contains: \"ABC\"}}", "locations": [ { "line": 2, "column": 35 } ] } ] } ```

adam closed this issue

2025-12-29 21:23:35 +01:00

adam commented

2025-12-29 21:23:36 +01:00

@jeremystretch commented on GitHub (Jun 17, 2024):

The vrf filter references the VRF's route distinguisher value, not its name.

@jeremystretch commented on GitHub (Jun 17, 2024): The `vrf` filter references the VRF's [route distinguisher](https://netboxlabs.com/docs/netbox/en/stable/models/ipam/vrf/#route-distinguisher) value, not its name.

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#9853