Note
This plugin is part of the community.digitalocean collection.
To install it use: ansible-galaxy collection install community.digitalocean.
To use it in a playbook, specify: community.digitalocean.digital_ocean_floating_ip_info.
digital_ocean_floating_ip_facts before Ansible 2.9. The usage did not change.The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| oauth_token string | DigitalOcean OAuth token. There are several other environment variables which can be used to provide this value. i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN' aliases: api_token | |
| timeout integer | Default: 30 | The timeout in seconds used for polling DigitalOcean's API. |
| validate_certs boolean |
| If set to no, the SSL certificates will not be validated.This should only set to no used on personally controlled sites using self-signed certificates. |
Note
- name: "Gather information about all Floating IPs"
community.digitalocean.digital_ocean_floating_ip_info:
register: result
- name: "List of current floating ips"
debug:
var: result.floating_ips
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| floating_ips list / elements=string | success and no resource constraint | a DigitalOcean Floating IP resource Sample: [{'droplet': None, 'ip': '45.55.96.47', 'locked': False, 'region': {'available': True, 'features': ['private_networking', 'backups', 'ipv6', 'metadata'], 'name': 'New York 3', 'sizes': ['512mb', '1gb', '2gb', '4gb', '8gb', '16gb', '32gb', '48gb', '64gb'], 'slug': 'nyc3'}}] |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_floating_ip_info_module.html