Share your favorite GraphQL Query

[itdependsnetworks]

Wanted to have a place for everyone to share their favorite GraphQL query.

[itdependsnetworks]

query ($device_id: ID!) {
  device(id: $device_id) {
    config_context
    hostname: name
    position
    serial
    primary_ip4 {
      id
      primary_ip4_for {
        id
        name
      }
    }
    tenant {
      name
    }
    tags {
      name
      slug
    }
    device_role {
      name
    }
    platform {
      name
      slug
      manufacturer {
        name
      }
      napalm_driver
    }
    site {
      name
      slug
      vlans {
        id
        name
        vid
      }
      vlan_groups {
        id
      }
    }
    interfaces {
      description
      mac_address
      enabled
      name
      ip_addresses {
        address
        tags {
          id
        }
      }
      connected_circuit_termination {
        circuit {
          cid
          commit_rate
          provider {
            name
          }
        }
      }
      tagged_vlans {
        id
      }
      untagged_vlan {
        id
      }
      cable {
        termination_a_type
        status {
          name
        }
        color
      }
      tagged_vlans {
        site {
          name
        }
        id
      }
      tags {
        id
      }
    }
  }
}

[GuillaumeWrz]

Hi,
I tried to use the query, however i have this error:
Variable "device" of type "String !" used in position expecting type "[String]"
It's the same problem on demo.nautobot.com.
Do you know how I Can solve it?

[itdependsnetworks]

Hi the current branch is based on the nautobot alpha build, I am about 3 weeks behind, your best bet is to follow the pull request #50. The updated documentation will provide the new standard for the graphql query.

[jrpell]

So I'm using mostly what's in the docs for the GraphQL Query but added information about the primary IP address. I'm wanting to pull out the interface that is assigned to the primary IP address in the Jinja2 templates when the intended config is created. Is that possible? I basically would want to do a series of for loops and an if statement in the Jinja template to pull out that interface as that is what should be used for several things in the templates. If there's a better way to do this, please let me know. Thanks!

Here's my query (sorry, the code marking is not working for some reason):

  device(id: $device_id) {
    config_context
    hostname: name
    position
    serial
    primary_ip4 {
      mgmt_id: id
      address
    }
    tenant {
      name
    }
    tags {
      name
      slug
    }
    device_role {
      name
    }
    platform {
      name
      slug
      manufacturer {
        name
      }
      napalm_driver
    }
    site {
      name
      slug
      vlans {
        id
        name
        vid
      }
      vlan_groups {
        id
      }
    }
    interfaces {
      description
      mac_address
      enabled
      name
      ip_addresses {
        address
        primary_ip4_for {
          id
          name
        }
        tags {
          id
        }
      }
      connected_circuit_termination {
        circuit {
          cid
          commit_rate
          provider {
            name
          }
        }
      }
      tagged_vlans {
        id
      }
      untagged_vlan {
        id
      }
      cable {
        termination_a_type
        status {
          name
        }
        color
      }
      tagged_vlans {
        site {
          name
        }
        id
      }
      tags {
        id
      }
    }
  }
}```

[itdependsnetworks]

Until other changes are made in core, there is no other workaround.
Sorry, this should be in nautbot_config.py.

[jrpell]

Just to be clear, do I need to do this with the ansible filter? I just found that in a blog but didn't catch that it was ansible. Is there a different method outside of using the ansible collections? I'm not using it anywhere else so that's of course not installed. Thanks -- appreciate the help here!

[itdependsnetworks]

No, you just need "a filter", you seemed to be using the filter that Ansible uses. You can simply copy the code or re-create the code on your local installation.

Any further convo may be better on our Slack (review readme for details)

[jrpell]

Sure thing -- have a link to the Slack? I've searched the readme and don't see it. Looked at multiple branches too. Thanks!

[itdependsnetworks]

sorry, I need to add that, check out here https://github.com/nautobot/nautobot/blame/develop/README.md#L13