skip to navigation
skip to content

bosh_inventory 0.2.2

Ansible dynamic inventory for bosh deployments

# bosh-ansible-inventory

Ansible 2 dynamic inventory

# Usage

You can install it by running ``:
$ python install

Also, you can copy and run it directly by calling the program
`` instead of `bosh-inventory`.

Once it is installed:

$ bosh-inventory --help
usage: bosh-inventory [-h] [--list]

Program to create an ansible inventory from all the deployments, jobs and
instances managed by a BOSH Director.

optional arguments:
-h, --help show this help message and exit
--list Enable JSON output for dynamic ansible inventory

In order to use it, you have to define BOSH_CONFIG environment variable
pointing to the configuration file used by Bosh. It will read the credentials
from the file. You can define additional inventory parameters with
BOSH_ANSIBLE_INVENTORY_PARAMS environment variable, for example:
BOSH_ANSIBLE_INVENTORY_PARAMS="ansible_user=vcap ansible_ssh_pass=blabla"

The program will include the IP of each vm if DNS is not defined. To force
always the inclusion of the IP in the inventory, just define the variable
BOSH_ANSIBLE_INVENTORY_IP as a positive integer indicating the index (starting
from 1) of the IP which will be taken (for VMs with multiple IPs), 0 will
disable the feature.

You can also limit the inventory to one deployment by setting the value
of the environment variable BOSH_ANSIBLE_DEPLOYMENT to the name of it.

0.2.2, 2016 Jose Riguera <>

To use it, just point the env variable `BOSH_CONFIG` to your
bosh configuration. It will read all parameters from there.

By default, it will return an INI format inventory:
$ export BOSH_CONFIG=~/.bosh-dev
$ bosh-inventory > ansible-inventory

Or using directly with ansible:
$ export BOSH_CONFIG=~/.bosh-dev
$ export BOSH_ANSIBLE_INVENTORY_PARAMS="ansible_user=vcap"
$ ansible "runner_z*" -i $(which bosh-inventory) -a "sudo /sbin/reboot"

You can also point to one deployment by using `BOSH_ANSIBLE_DEPLOYMENT`,
and only those instances will appear:
$ export BOSH_ANSIBLE_DEPLOYMENT=concourse
$ bosh-inventory


web-0 ansible_host= ansible_user=vcap

worker-0 ansible_host= ansible_user=vcap
worker-1 ansible_host= ansible_user=vcap

db-0 ansible_host= ansible_user=vcap


Be aware that python is not present in the default location, but you can
define it by using `BOSH_ANSIBLE_INVENTORY_PARAMS="ansible_python_interpreter=/path/to/python"`

# Example: apply a playbook to all CF runners

First of all, make sure your bosh client is targeting the correct Bosh Director!!!!

bosh status


Name devBosh2
URL https://x.x.x.x:25555
Version 1.3232.6.0 (00000000)
User admin
UUID c4f5c583-1bc3-427f-8ded-b3f5e107f970
CPI vsphere
dns enabled (domain_name: microbosh)
compiled_package_cache disabled
snapshots disabled

not set

Type `bosh vms --details` to confirm!

`bosh-inventory` needs some variables to work:

# Point to the bosh config targeting the desired director!
export BOSH_CONFIG=~/.bosh_config
# Define the name of the deployment (to avoid getting other vms)
# Foce the use of IPs (instead of DNS names if bosh has enabled dns)
# Define the ssh user and other ansible parameters
export BOSH_ANSIBLE_INVENTORY_PARAMS="ansible_user=nsaadmin host_key_checking=false"

Check if it is working:

ansible runner_z1 -i /usr/local/bin/bosh-inventory -m ping

If so, just run the playbook.

ansible-playbook -i /usr/local/bin/bosh-inventory cf-warden.yml

# Author

Springer Nature Platform Engineering, Jose Riguera Lopez (  
File Type Py Version Uploaded on Size
bosh_inventory-0.2.2.tar.gz (md5) Source 2016-12-02 7KB