How To Access System Information (Facts) in Ansible Playbooks

Configuration ManagementAnsible
Part of the Series: How To Write Ansible Playbooks

Ansible is a modern configuration management tool that doesn’t require the use of an agent software on remote nodes, using only SSH and Python to communicate and execute commands on managed servers. This series will walk you through the main Ansible features that you can use to write playbooks for server automation. At the end, we’ll see a practical example of how to create a playbook to automate setting up a remote Nginx web server and deploy a static HTML website to it.

By default, before executing the set of tasks defined in a playbook, Ansible will take a few moments to gather information about the systems that are being provisioned. This information, referred to as facts, contain details such as network interfaces and addresses, the operating system running on remote nodes, and available memory, among other things.

Ansible stores facts in JSON format, with items grouped in nodes. To check what kind of information is available for the systems you’re provisioning, you can run the setup module with an ad hoc command:

  • ansible all -i inventory -m setup -u sammy

This command will output an extensive JSON containing information about your server. To obtain a subset of that data, you can use the filter parameter and provide a pattern. For instance, if you’d like to obtain information about all IPv4 addresses in the remote nodes, you can use the following command:

  • ansible all -i inventory -m setup -a "filter=*ipv4*" -u sammy

You’ll see output like this:

Output | SUCCESS => { "ansible_facts": { "ansible_all_ipv4_addresses": [ "", "" ], "ansible_default_ipv4": { "address": "", "alias": "eth0", "broadcast": "", "gateway": "", "interface": "eth0", "macaddress": "06:c7:91:16:2e:b7", "mtu": 1500, "netmask": "", "network": "", "type": "ether" } }, "changed": false }

Once you have found the facts that will be useful for your play, you can update your playbook accordingly. As an example, the following playbook will print out the IPv4 address of the default network interface. From the previous command output, we can see that this value is available through ansible_default_ipv4.address in the JSON provided by Ansible.

Create a new file called playbook-03.yml in your ansible-practice directory:

  • nano ~/ansible-practice/playbook-03.yml

Then add the following lines to the new playbook file:

- hosts: all
    - name: print facts
        msg: "IPv4 address: {{ ansible_default_ipv4.address }}"

Save and close the file when you’re done.

To try this playbook on servers from your inventory file, run ansible-playbook with the same connection arguments you’ve used before when running our first example. Again, we’ll be using an inventory file named inventory and the sammy user to connect to the remote servers:

  • ansible-playbook -i inventory playbook-03.yml -u sammy

When you run the playbook, you’ll see your remote server’s IPv4 address in the output as expected:

... TASK [print facts] *************************************************************************************************************************************************************************** ok: [server1] => { "msg": "IPv4 address:" } ...

Facts encapsulate important data that you can leverage to better customize your playbooks. To learn more about all the information you can obtain through facts, please refer to the official Ansible documentation.

Creative Commons License