Skip to main content

Ansible simplified yaml inventory

Project description

documentation python

Ansible Roster Plugin

This repository contains an Ansible Inventory Plugin to generate inventory from a subjectively simpler inventory description file, here within called a roster while having more possibilities.

It supports host ranges, eg: "[0:9]", but also regex hostnames, eg: "(dev|prd)-srv". It handles variables declared as lists by appending the values instead of replacing them.

This inventory plugin has been written with debops in mind.


Install latest version:

python3 -mpip install -U ansible-roster


The roster is a file in yaml format and 'yml' or 'yaml' file extension.

In order for Ansible to use the plugin and parse your roster file, several conditions must be met:

  • Your yaml file must contain a line indicating that the file is in the roster format.

  • You must activate plugins and enable the roster inventory plugin in your ansible.cfg, or in your .debops.cfg if using debops

Sample ansible.cfg

# The following line prevents having to pass -i to ansible-inventory.
# Filename can be anything as long as it has a 'yml' or 'yaml' extension although
inventory = roster.yml

# You must enable the roster plugin if 'auto' does not work for you
enable_plugins = roster

Sample .debops.cfg

[ansible inventory]
enabled = roster
enable_plugins = roster

Simpler syntax

A roster inventory has a subjectively simpler syntax than a Ansible yaml inventory file. Instead of specifing children which have to be known in advance, you specify the parents of your host.

A roster inventory is, at least, a single yaml file where the plugin to be used is declared, and groups and hosts declared in yaml syntax.

A sample, commented, and minimal file named 'roster.yml.tpl' is located at the root of the git repository.

File inclusion

Instead of including every file found in a inventory folder, a roster inventory will only include explicitly specified files. Globbing is supported.

plugin: roster

  # include an exact file match
  - distrib/debian.yml

  # include with wildcard:
  - hosts/*.yml

Ranges and Regex support

plugin: roster

  # Generate 10 hosts: to

  # Generate 2 hosts: and

Variable merging and priority

TODO, lorem ipsum


To run unit tests, you can simply run the make target:

# run all tests:
make check

It's also possible to quickly check the output inventory:

ANSIBLE_INVENTORY_ENABLED=roster ansible-inventory --list -i roster.yml


This project is licensed under the MIT License - see the LICENSE file for details


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible-roster-0.7.2.tar.gz (13.9 kB view hashes)

Uploaded source

Built Distribution

ansible_roster-0.7.2-py2.py3-none-any.whl (12.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page