community.general.scaleway_security_group_facts – Gather facts about the Scaleway security groups available.

Note

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

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

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

DEPRECATED

Removed in

version 3.0.0

Why

Deprecated in favour of _info module.

Alternative

Use community.general.scaleway_security_group_info instead.

Synopsis

  • Gather facts about the Scaleway security groups 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"
Scaleway API URL.

aliases: base_url
query_parameters
dictionary
Default:
{}
List of parameters passed to the query string.
region
string / required
    Choices:
  • 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
    Choices:
  • 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 security groups facts
  community.general.scaleway_security_group_facts:
    region: par1

Return Values

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

Key Returned Description
scaleway_security_group_facts
complex
success
Response from Scaleway API

Sample:
{'scaleway_security_group_facts': [{'description': 'test-ams', 'enable_default_security': True, 'id': '7fcde327-8bed-43a6-95c4-6dfbc56d8b51', 'name': 'test-ams', 'organization': '3f709602-5e6c-4619-b80c-e841c89734af', 'organization_default': False, 'servers': [{'id': '12f19bc7-108c-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)