Query IPAM data

Read the computed values on IP prefixes and addresses, or follow the hierarchy relationships. Use these patterns for reporting, automation, or verification.

Query a prefix's computed values

Every IpamIPPrefix exposes utilization, netmask, hostmask, network_address, and broadcast_address as read-only attributes, computed on read:

GraphQL

query {
  IpamIPPrefix(prefix__value: "192.0.2.0/24") {
    edges {
      node {
        prefix { value }
        utilization { value }
        netmask { value }
        hostmask { value }
        network_address { value }
        broadcast_address { value }
      }
    }
  }
}

Python SDK

prefix = await client.get(kind="IpamIPPrefix", prefix__value="192.0.2.0/24")
print(prefix.utilization.value, prefix.netmask.value, prefix.hostmask.value)
print(prefix.network_address.value, prefix.broadcast_address.value)

Query an address's computed values

IpamIPAddress has no equivalent sibling attributes — instead, the address attribute itself (kind IPHost) exposes computed sub-fields: ip, netmask, hostmask, prefixlen, and version.

GraphQL

query {
  IpamIPAddress(address__value: "192.0.2.10/24") {
    edges {
      node {
        address {
          value
          ip
          netmask
          hostmask
          prefixlen
          version
        }
      }
    }
  }
}

Python SDK

address = await client.get(kind="IpamIPAddress", address__value="192.0.2.10/24")
value = address.address.value  # an ipaddress.IPv4Interface or IPv6Interface
print(value.ip, value.netmask, value.hostmask, value.version)

The Python SDK maps an IPHost attribute's value to the standard library's ipaddress.IPv4Interface or IPv6Interface — netmask and hostmask come from that object, not from a separate attribute.

Navigate the hierarchy

IP prefixes expose parent, children, ancestors, and descendants relationships. They are read-only — Infrahub manages them automatically.

GraphQL

query {
  IpamIPPrefix(prefix__value: "10.0.0.0/16") {
    edges {
      node {
        prefix { value }
        parent {
          node { prefix { value } }
        }
        children {
          edges {
            node { prefix { value } }
          }
        }
        ancestors {
          edges {
            node { prefix { value } }
          }
        }
        descendants {
          edges {
            node { prefix { value } }
          }
        }
      }
    }
  }
}

Python SDK

prefix = await client.get(kind="IpamIPPrefix", prefix__value="10.0.0.0/16")
for child in await prefix.children.fetch():
    print(child.prefix.value)
for descendant in await prefix.descendants.fetch():
    print(descendant.prefix.value)

Next

• IP Address Management — the built-in generics and the hierarchy they participate in
• Use namespaces — isolating the prefixes and addresses these queries run against
• Allocate IPs and prefixes — creating prefixes and addresses instead of reading them