For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationRelease notes
DocumentationRelease notes
  • Itential Automation Gateway
    • Overview
    • Related terminology
    • Navigate UI
      • Inventory integration variables
      • Create and manage devices
      • Remove a device
      • Manage inventory via API
      • Inventory sources
      • Interactive devices
      • Inventory encryption
      • Device broker support
        • Overview
        • Nautobot
        • NetBox
        • ServiceNow
        • SolarWinds
        • ZPE Cloud
      • Interactive devices 2023.2
    • Automatic discovery in IAG
    • Use hidden keyword extension
    • Edit the description field
    • Edit JSON schema
    • Manage decorations
    • View audit logs
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • General workflow
Itential Automation GatewayInventory devicesDynamic device inventory

Dynamic device inventory

Was this page helpful?
Previous

Nautobot

Next
Built with

Dynamic inventory is the process of building the Ansible device inventory by programmatically querying a source of truth (SoT) system for all devices. Because the inventory is generated directly from the SoT, it always reflects the current state of your network, can be refreshed easily, and eliminates the need to maintain a static inventory file manually. The Ansible plugin you configure is responsible for generating the inventory and for any filtering or advanced querying capabilities.

IAG supports dynamic inventory through a variety of Ansible plugins available from the Ansible and open source communities. The following plugins are covered in this documentation:

  • ServiceNow
  • Nautobot
  • NetBox
  • SolarWinds
  • ZPE Cloud

General workflow

While the configuration details vary by plugin, setting up dynamic inventory in IAG follows the same general pattern for most plugins.

1

Install the plugin

Use ansible-galaxy to install the Ansible collection for your SoT system into IAG.

2

Configure Ansible to use the plugin

Update /etc/ansible/ansible.cfg to enable the plugin and set any required defaults such as interpreter_python, collections_path, and INVENTORY_ENABLED.

3

Configure the host file

Create an inventory file in the IAG inventory directory (typically /opt/automation-gateway/ansible/inventory/) and configure it to connect to and query your SoT system.

4

Confirm the plugin is working

Test the plugin directly from the command line before invoking it from IAG:

$ansible-inventory -vvv --list -i <path-to-plugin-host-file>

When executed correctly, this command returns a list of devices from your SoT system with their associated variables.

5

Restart IAG

Restart IAG to trigger the plugin to execute and populate the Ansible inventory:

$sudo systemctl restart automation-gateway

Some plugins require additional steps beyond this general workflow — for example, installing multiple collections, configuring a connection plugin, or setting up SSH keys. Refer to the plugin-specific documentation for details.