source/ansible-netbox-inventory
1
0
Fork 0
Code Issues Pull Requests Releases Activity

docs: ip_version option documentation

Browse Source
This commit is contained in:
Bryan Joshua Pedini
2026-08-25 14:53:24 +02:00
parent 927bcabc97
commit 8f70476888
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -15,6 +15,8 @@ in a config file, overridable per-run through environment variables.
machines** (`virtualization/virtual-machines`) machines** (`virtualization/virtual-machines`)
- Filter by tenant name, VRF name, cluster name, site name, hostname domain, - Filter by tenant name, VRF name, cluster name, site name, hostname domain,
or restrict IP addresses to the ones that have a DNS name (deduplicated) or restrict IP addresses to the ones that have a DNS name (deduplicated)
- Restrict either source to one IP family (`ip_version: v4` or `v6`),
combinable with any filter
- Name-based filters are resolved server-side (name → id) so NetBox does the - Name-based filters are resolved server-side (name → id) so NetBox does the
narrowing, not the script narrowing, not the script
- Hosts land in a single `netbox` group with host variables delivered through - Hosts land in a single `netbox` group with host variables delivered through
@@ -72,6 +74,7 @@ inventory:
| `inventory.source` | `ip-addresses` | `ip-addresses` or `virtual-machines` | | `inventory.source` | `ip-addresses` | `ip-addresses` or `virtual-machines` |
| `inventory.filter` | none | Filter option, see the table below | | `inventory.filter` | none | Filter option, see the table below |
| `inventory.filter_value` | none | Value for the filter option | | `inventory.filter_value` | none | Value for the filter option |
| `inventory.ip_version` | `both` | `both`, `v4` or `v6`; on IP addresses only that family is fetched, on virtual machines it selects which primary IP becomes `ansible_host` |
Every relevant key can be overridden through the environment, which is how you Every relevant key can be overridden through the environment, which is how you
run several differently-filtered inventories off one config file: run several differently-filtered inventories off one config file:
@@ -84,6 +87,7 @@ run several differently-filtered inventories off one config file:
| `NETBOX_INVENTORY_SOURCE` | `inventory.source` | | `NETBOX_INVENTORY_SOURCE` | `inventory.source` |
| `NETBOX_INVENTORY_FILTER` | `inventory.filter` | | `NETBOX_INVENTORY_FILTER` | `inventory.filter` |
| `NETBOX_INVENTORY_FILTER_VALUE` | `inventory.filter_value` | | `NETBOX_INVENTORY_FILTER_VALUE` | `inventory.filter_value` |
| `NETBOX_INVENTORY_IP_VERSION` | `inventory.ip_version` |
## Filters ## Filters
@@ -129,6 +133,11 @@ NETBOX_INVENTORY_FILTER=domain NETBOX_INVENTORY_FILTER_VALUE=example.com \
is set to the primary IP when the VM has one, otherwise Ansible falls back is set to the primary IP when the VM has one, otherwise Ansible falls back
to resolving the name. Host variables: `netbox_status`, `netbox_cluster`, to resolving the name. Host variables: `netbox_status`, `netbox_cluster`,
`netbox_site`, `netbox_tenant`. `netbox_site`, `netbox_tenant`.
- **IP version**: with `ip_version: both` (the default) virtual machines use
NetBox's combined primary IP, which **prefers IPv6** when a VM has both
(NetBox's `PREFER_IPV4` setting); set `v4` or `v6` to pin the family. On the
IP address source the family is filtered server-side, and a VM without a
primary IP of the requested family simply gets no `ansible_host`.
- Duplicate inventory names (two IPs sharing a DNS name, outside the `named` - Duplicate inventory names (two IPs sharing a DNS name, outside the `named`
filter) keep both hosts: the second one falls back to its bare address as filter) keep both hosts: the second one falls back to its bare address as
the inventory name. the inventory name.