Netbox dynamic inventory script
This is a Netbox dynamic inventory script for Ansible. Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. It's nice, modern, and has good APIs ... so it's a pretty nice option to serve as a "Source of Truth".
You can group servers as you want and based on what you have in Netbox, you can select fields as groups or as vars for hosts. And you can use default fields or custom fields.
The script tested with
netbox = v1.6 and
netbox = v2.0.4,
but most probably it will work with all netbox v1.0 and above.
Servers could be grouped by any section in Netbox. e.g. you can group hosts by "site, "rack", "role", "platform", or any other section in Netbox. Please remember: For grouping, API names should be used not UI names.
So if you have a "site" called "US-East", in Ansible you will get a hosts group is called "US-East" has all hosts in that site.
If that section is a default section you need to put it under
group_by.default if it's a custom section (custom fields), then
put it under
Here is an example how servers will be grouped based on their
group_by: default: - platform
So if you have "Ubuntu" and "CentOS" as platforms in Netbox, you will have 2 groups of servers that using that systems.
Netbox sections could be used as variables for hosts! e.g. you could use
the IP of the host in Netbox as
ansible_ssh_host, or use a custom
field as well.
There are 3 sections here, first type is
IP, second one is
General, and finally
Variables are defined as
Key: Value. The key is what will be in
Ansible and value comes from Netbox.
hosts_vars: ip: ansible_ssh_host: primary_ip
primary_ip will be used as value for
$ ansible-netbox-inventory -h usage: ansible-netbox-inventory [-h] [-c CONFIG_FILE] [--list] [--host HOST] optional arguments: -h, --help show this help message and exit -c CONFIG_FILE, --config-file CONFIG_FILE Path for script's configuration. Also "NETBOX_CONFIG_FILE" could be used as env var to set conf file path. (default: netbox.yml) --list Print all hosts with vars as Ansible dynamic inventory syntax. (default: False) --host HOST Print specific host vars as Ansible dynamic inventory syntax. (default: None)
You can also set config file path through environment variable
$ ansible all -i netbox.py -m ping