community.general.scaleway_ip_facts – Gather facts about the Scaleway ips available.

community.general.scaleway_ip_facts – Gather facts about the Scaleway ips available.

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.scaleway_ip_facts.

• DEPRECATED
• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

DEPRECATED

Removed in

version 3.0.0

Why

Deprecated in favour of _info module.

Alternative

Use community.general.scaleway_ip_info instead.

Synopsis

• Gather facts about the Scaleway ips available.

Parameters

Parameter	Choices/Defaults	Comments
api_timeout integer	Default: 30	HTTP timeout to Scaleway API in seconds. aliases: timeout
api_token string / required		Scaleway OAuth token. aliases: oauth_token
api_url string	Default: "https://api.scaleway.com%22	Scaleway API URL. aliases: base_url
query_parameters dictionary	Default: {}	List of parameters passed to the query string.
region string / required	ams1 EMEA-NL-EVS par1 EMEA-FR-PAR1 par2 EMEA-FR-PAR2 waw1 EMEA-PL-WAW1	Scaleway region to use (for example par1).
validate_certs boolean	no yes ←	Validate SSL certs of the Scaleway API.

Notes

Note

• Also see the API documentation on https://developer.scaleway.com/
• If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.
• If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- name: Gather Scaleway ips facts
  community.general.scaleway_ip_facts:
    region: par1

Return Values

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

Key	Returned	Description
scaleway_ip_facts complex	success	Response from Scaleway API Sample: {'scaleway_ip_facts': [{'address': '163.172.170.243', 'id': 'ea081794-a581-8899-8451-386ddaf0a451', 'organization': '3f709602-5e6c-4619-b80c-e324324324af', 'reverse': None, 'server': {'id': '12f19bc7-109c-4517-954c-e6b3d0311363', 'name': 'scw-e0d158'}}]}

Status

• This module will be removed in version 3.0.0. [deprecated]
• For more information see DEPRECATED.

Authors

• Yanis Guenane (@Spredzy)
• Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_ip_facts_module.html