ipify_facts - Retrieve the public IP of your internet gateway.

New in version 2.0.

Synopsis

  • If behind NAT and need to know the public IP of your internet gateway.

Parameters

Parameter Choices/Defaults Comments
api_url Default:
https://api.ipify.org
URL of the ipify.org API service.
?format=json will be appended per default.
timeout
(added in 2.3)
 Default:
10
HTTP connection timeout in seconds.
validate_certs
(added in 2.4)
 Default:
yes
When set to NO, SSL certificates will not be validated.

Notes

Note

Examples

# Gather IP facts from ipify.org
- name: get my public IP
  ipify_facts:

# Gather IP facts from your own ipify service endpoint with a custom timeout
- name: get my public IP
  ipify_facts:
    api_url: http://api.example.com/ipify
    timeout: 20

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ipify_public_ip
string
 success
Public IP of the internet gateway.

Sample:
1.2.3.4


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ipify_facts_module.html