openstack.cloud.security_group_rule_info module – Querying security group rules
Note
This module is part of the openstack.cloud collection (version 1.10.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
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.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
|---|---|
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. |
|
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. |
|
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. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Filter the list result by the human-readable description of the resource. |
|
Filter the security group rule list result by the direction in which the security group rule is applied. Choices:
|
|
Filter the security group rule list result by the ethertype of network traffic. The value must be IPv4 or IPv6. Choices:
|
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Ending port |
|
Starting port |
|
Unique name or ID of the project. |
|
Filter the security group rule list result by the IP protocol. Choices:
|
|
Name of the region. |
|
Filter the security group rule list result by the name or ID of the remote group that associates with this security group rule. |
|
Source IP address(es) in CIDR notation (exclusive with remote_group) |
|
Filter the list result by the revision number of the resource. |
|
Filter the list result by the ID of the security group rule. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Name or ID of the security group |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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 |
Description |
|---|---|
List of dictionaries describing security group rules. Returned: On Success. |
|
Human-readable description of the resource. Returned: success Sample: |
|
The direction in which the security group rule is applied. Returned: success Sample: |
|
One of IPv4 or IPv6. Returned: success Sample: |
|
Unique rule UUID. Returned: success |
|
The maximum port number in the range that is matched by the security group rule. Returned: success Sample: |
|
The minimum port number in the range that is matched by the security group rule. Returned: success Sample: |
|
Unique ID of the project. Returned: success Sample: |
|
The protocol that is matched by the security group rule. Returned: success Sample: |
|
The remote IP prefix to be associated with this security group rule. Returned: success Sample: |
|
The security group ID to associate with this security group rule. Returned: success Sample: |