Docs4dev
Docs
ansible / latest / collections / openstack / cloud / security_group_rule_info_module.html

openstack.cloud.security_group_rule_info – Querying security group rules

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • Querying security group rules

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
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
Filter the list result by the human-readable description of the resource.
direction
string
    Choices:
  • egress
  • ingress
Filter the security group rule list result by the direction in which the security group rule is applied.
ethertype
string
    Choices:
  • IPv4
  • IPv6
Filter the security group rule list result by the ethertype of network traffic. The value must be IPv4 or IPv6.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
port_range_max
integer
Ending port
port_range_min
integer
Starting port
project
string
Unique name or ID of the project.
protocol
string
    Choices:
  • any
  • tcp
  • udp
  • icmp
  • 112
  • 132
Filter the security group rule list result by the IP protocol.
region_name
string
Name of the region.
remote_group
string
Filter the security group rule list result by the name or ID of the remote group that associates with this security group rule.
remote_ip_prefix
string
Source IP address(es) in CIDR notation (exclusive with remote_group)
revision_number
integer
Filter the list result by the revision number of the resource.
rule
string
Filter the list result by the ID of the security group rule.
security_group
string
Name or ID of the security group
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 all security group rules
- openstack.cloud.security_group_rule_info:
    cloud: "{{ cloud }}"
  register: sg

# Filter security group rules for port 80 and name
- openstack.cloud.security_group_rule_info:
    cloud: "{{ cloud }}"
    security_group: "{{ rule_name }}"
    protocol: tcp
    port_range_min: 80
    port_range_max: 80
    remote_ip_prefix: 0.0.0.0/0

# Filter for ICMP rules
- openstack.cloud.security_group_rule_info:
    cloud: "{{ cloud }}"
    protocol: icmp

Return Values

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

Key Returned Description
security_group_rules
complex
On Success.
List of dictionaries describing security group rules.

description
string
success
Human-readable description of the resource.

Sample:
My description.
direction
string
success
The direction in which the security group rule is applied.

Sample:
egress
ethertype
string
success
One of IPv4 or IPv6.

Sample:
IPv4
id
string
success
Unique rule UUID.

port_range_max
integer
success
The maximum port number in the range that is matched by the security group rule.

Sample:
8000
port_range_min
integer
success
The minimum port number in the range that is matched by the security group rule.

Sample:
8000
project
string
success
Unique ID of the project.

Sample:
16d53a84a13b49529d2e2c3646691123
protocol
string
success
The protocol that is matched by the security group rule.

Sample:
tcp
remote_ip_prefix
string
success
The remote IP prefix to be associated with this security group rule.

Sample:
0.0.0.0/0
security_group_id
string
success
The security group ID to associate with this security group rule.

Sample:
729b9660-a20a-41fe-bae6-ed8fa7f69123


Authors

  • OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/security_group_rule_info_module.html