community.general.ipify_facts module – Retrieve the public IP of your internet gateway
Note
This module is part of the community.general collection (version 12.6.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.ipify_facts.
Synopsis
- If behind NAT and need to know the public IP of your internet gateway.
Parameters
Parameter | Comments |
|---|---|
api_url string | URL of the ipify.org API service.
Default: |
timeout integer | HTTP connection timeout in seconds. Default: |
validate_certs boolean | When set to Choices:
|
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full This action does not modify state. | Can run in |
diff_mode | Support: N/A This action does not modify state. | Returns details on what has changed (or possibly needs changing in |
facts | Support: full | Action returns an |
Notes
Note
- Visit https://www.ipify.org to get more information.
Examples
# Gather IP facts from ipify.org
- name: Get my public IP
community.general.ipify_facts:
# Gather IP facts from your own ipify service endpoint with a custom timeout
- name: Get my public IP
community.general.ipify_facts:
api_url: http://api.example.com/ipify
timeout: 20
Returned Facts
Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
Key | Description |
|---|---|
ipify_public_ip string | Public IP of the internet gateway. Returned: success Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/ipify_facts_module.html
