On this page
scaleway_security_group_facts – Gather facts about the Scaleway security groups available
New in version 2.7.
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
         | 
      
        
        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
        
       
        added in 2.8
         | 
      
       
  | 
      
        
        Scaleway region to use (for example par1).
         | 
     
| validate_certs
        
        boolean
         | 
      
       
  | 
      
        
        Validate SSL certs of the Scaleway API.
         | 
     
Notes
Note
- Also see the API documentation on https://developer.scaleway.com/
 - If 
api_tokenis not set within the module, the following environment variables can be used in decreasing order of precedenceSCW_TOKEN,SCW_API_KEY,SCW_OAUTH_TOKENorSCW_API_TOKEN. - If one wants to use a different 
api_urlone can also set theSCW_API_URLenvironment variable. 
Examples
- name: Gather Scaleway security groups facts
  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 is not guaranteed to have a backwards compatible interface. [preview]
 - This module is maintained by the Ansible Community. [community]
 
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.8/modules/scaleway_security_group_facts_module.html