scaleway_security_group_info – Gather information about the Scaleway security groups available

New in version 2.9.

Synopsis

  • Gather information 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
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
- / required
    Choices:
  • ams1
  • EMEA-NL-EVS
  • par1
  • EMEA-FR-PAR1
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 information
  scaleway_security_group_info:
    region: par1
  register: result

- debug:
    msg: "{{ result.scaleway_security_group_info }}"

Return Values

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

Key Returned Description
scaleway_security_group_info
complex
success
Response from Scaleway API

Sample:
{'scaleway_security_group_info': [{'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

Authors

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

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.9/modules/scaleway_security_group_info_module.html