openstack.cloud.security_group_info – Lists security groups

Note

This plugin is part of the openstack.cloud collection (version 1.5.0).

To install it use: ansible-galaxy collection install openstack.cloud.

To use it in a playbook, specify: openstack.cloud.security_group_info.

Synopsis

  • List security groups

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.12.0

  • python >= 3.6

Parameters

Parameter Choices/Defaults Comments
any_tags
list / elements=string
A list of tags to filter the list result by.
Resources that match any tag in this list will be returned.
api_timeout
integer
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth
dictionary
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type
string
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
availability_zone
string
Ignored. Present for backwards compatibility
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
description
string
Description of the security group
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
name
string
Name or id of the security group.
not_any_tags
list / elements=string
A list of tags to filter the list result by.
Resources that match any tag in this list will be excluded.
not_tags
list / elements=string
A list of tags to filter the list result by.
Resources that match all tags in this list will be excluded.
project_id
string
Specifies the project id as filter criteria
region_name
string
Name of the region.
revision_number
integer
Filter the list result by the revision number of the
resource.
tags
list / elements=string
A list of tags to filter the list result by.
Resources that match all tags in this list will be returned.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get specific security group
- openstack.cloud.security_group_info:
    cloud: "{{ cloud }}"
    name: "{{ my_sg }}"
  register: sg
# Get all security groups
- openstack.cloud.security_group_info:
    cloud: "{{ cloud }}"
  register: sg

Return Values

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

Key Returned Description
security_groups
complex
On Success.
List of dictionaries describing security groups.

 
created_at
string
success
Creation time of the security group

Sample:
yyyy-mm-dd hh:mm:ss
 
description
string
success
Description of the security group

Sample:
My security group
 
id
string
success
ID of the security group

Sample:
d90e55ba-23bd-4d97-b722-8cb6fb485d69
 
name
string
success
Name of the security group.

Sample:
my-sg
 
project_id
string
success
Project ID where the security group is located in.

Sample:
25d24fc8-d019-4a34-9fff-0a09fde6a567
 
security_group_rules
list / elements=string
success
Specifies the security group rule list

Sample:
[{'description': None, 'direction': 'ingress', 'ethertype': 'IPv4', 'id': 'd90e55ba-23bd-4d97-b722-8cb6fb485d69', 'port_range_max': None, 'port_range_min': None, 'protocol': None, 'remote_group_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'remote_ip_prefix': None, 'security_group_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'tenant_id': 'bbfe8c41dd034a07bebd592bf03b4b0c'}, {'description': None, 'direction': 'egress', 'ethertype': 'IPv4', 'id': 'aecff4d4-9ce9-489c-86a3-803aedec65f7', 'port_range_max': None, 'port_range_min': None, 'protocol': None, 'remote_group_id': None, 'remote_ip_prefix': None, 'security_group_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'tenant_id': 'bbfe8c41dd034a07bebd592bf03b4b0c'}]
 
updated_at
string
success
Update time of the security group

Sample:
yyyy-mm-dd hh:mm:ss


Authors

  • OpenStack Ansible SIG