This repository contains a collection of tools that I find useful in working with Ansible.
The ansible-role
script allows you to run a role from the command line.
For example, if you have a role roles/testrole
, you can run it like
this:
ansible-role testrole
This will target localhost
by default, but you can use --inventory
and --host
to modify the target of the role.
The ansible-task
script allows you to run a task list directly from
the command line.
If you have a tasklist mytasks.yml
, you can run it like this:
ansible-task mytasks.yml
The ansible-eval
script will return the result of evaluating a
Jinja2 template with ansible. For example, the result of running:
ansible-eval '{{ ansible_eth0.ipv4 }}'
Might look something like:
{"broadcast": "192.168.1.255", "netmask": "255.255.255.0", "network": "192.168.1.0", "address": "192.168.1.74"}
Of course, you can use filters to reformat that:
$ ansible-eval '{{ ansible_eth0.ipv4 | to_nice_json }}'
{
"address": "192.168.1.74",
"broadcast": "192.168.1.255",
"netmask": "255.255.255.0",
"network": "192.168.1.0"
}
--hosts
,-H
hosts -- The value of this argument will be applied to thehosts:
line in the generated playbook. Defaults tolocalhost
.--gather
,-g
-- Enable fact gathering (this is the default)--no-gather
,-G
-- Disable fact gathering
The following additional options are simply proxies to the equivalent
ansible-playbook
options:
--check
,-C
--verbose
,-v
--sudo
,-s
--become
,-b
--user
,-u
user--inventory
,-i
inventory--extra-vars
,-e
vars
You can install ansible-toolbox
directly from GitHub like this:
pip install git+https://github.com/larsks/ansible-toolbox
If you have a copy of the repository, you can run:
cd ansible-toolbox
pip install .
ansible-toolbox, a collection of ansible utilities
Copyright (C) 2017 Lars Kellogg-Stedman lars@oddbit.com
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.