Skip to main content

An Ansible dynamic inventory for locating and categorising Raspberry Pis on the LAN.

Project description

Pinventory is an Ansible Dynamic Inventory for locating and categorising Raspberry Pi computers on the local network.

Installation

In the Python environment which you are using:

$ python setup.py install

A wrapper script called simply pinventory will be installed which can be used to invoke the Python package.

Direct usage

To obtain an Ansible inventory of Raspberry Pi computers on the LAN:

$ pinventory --list --pretty
{
    "_meta": {
        "hostvars": {
            "10.0.0.149": {
                "hostname": "lime",
                "ip": "10.0.0.149",
                "mac": "b8:27:eb:a5:93:c5"
            },
            "10.0.0.186": {
                "hostname": "raspberrypi",
                "ip": "10.0.0.186",
                "mac": "b8:27:eb:73:9d:67"
            }
        }
    },
    "raspberries": {
        "hosts": [
            "10.0.0.149",
            "10.0.0.186"
        ]
    }
}

To obtain the host variables for a particular host:

$ pinventory --host 10.0.0.149 --pretty
{
    "hostname": "lime",
    "ip": "10.0.0.149",
    "mac": "b8:27:eb:a5:93:c5"
}

Invocation from Ansible

Pass the pinventory executable using the -i inventory option, and Ansible will execute it as a dynamic inventory. For example, assuming pinventory is available on the PATH, to run an ad hoc Ansible command on all Raspberry Pi devices on the LAN, use:

$ ansible raspberries -i `which pinventory` <command>

Customisation

By default the returned inventory includes all Raspberry Pi computers on the local network. The contents of the inventory and variables associated with each host can be customised by providing pluggable functions at two pkg_resources entry points capable of transforming the default inventory and host variables respectively. Example functions can be found in the pinventory.transforms.hostsvars and pinventory.transforms.inventory sub-modules.

Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pinventory-0.5.0-py3-none-any.whl (9.0 kB) Copy SHA256 hash SHA256 Wheel py3
pinventory-0.5.0.tar.gz (6.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page