openstack.cloud.security_group_rule module – Manage security group rules in OpenStack network (Neutron)

Note

This module is part of the openstack.cloud collection (version 2.2.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.

Synopsis

  • Add or remove security group rule to/from OpenStack network (Neutron) service.

  • Use security_group_rules in openstack.cloud.security_group to define a set of security group rules. It will be much faster than using this module when creating or removing several security group rules because the latter will do individual calls to OpenStack network (Neutron) API for each security group rule.

Requirements

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

Parameters

Parameter

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.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

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 rule.

direction

string

The direction in which the security group rule is applied.

Not all providers support egress.

Choices:

  • "egress"

  • "ingress" ← (default)

ether_type

aliases: ethertype

string

Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. Not all providers support IPv6.

Choices:

  • "IPv4" ← (default)

  • "IPv6"

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

port_range_max

integer

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

If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the port_range_min attribute value.

If the protocol is ICMP, this value must be an ICMP code.

port_range_min

integer

The minimum port number in the range that is matched by the security group rule.

If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the port_range_max attribute value.

If the protocol is ICMP, this value must be an ICMP type.

project

string

Unique name or ID of the project.

protocol

string

The IP protocol can be represented by a string, an integer, or null.

Valid string or integer values are any or 0, ah or 51, dccp or 33, egp or 8, esp or 50, gre or 47, icmp or 1, icmpv6 or 58, igmp or 2, ipip or 4, ipv6-encap or 41, ipv6-frag or 44, ipv6-icmp or 58, ipv6-nonxt or 59, ipv6-opts or 60, ipv6-route or 43, ospf or 89, pgm or 113, rsvp or 46, sctp or 132, tcp or 6, udp or 17, udplite or 136, vrrp or 112.

Additionally, any integer value between [0-255] is also valid.

The string any (or integer 0) means all IP protocols.

See the constants in neutron_lib.constants for the most up-to-date list of supported strings.

region_name

string

Name of the region.

remote_group

string

Name or ID of the security group to link.

Mutually exclusive with remote_ip_prefix.

remote_ip_prefix

string

Source IP address(es) in CIDR notation.

When a netmask such as /32 is missing from remote_ip_prefix, then this module will fail on updates with OpenStack error message Security group rule already exists..

Mutually exclusive with remote_group.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

security_group

string / required

Name or ID of the security group.

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to true.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

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

- name: Create a security group rule
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: tcp
    port_range_min: 80
    port_range_max: 80
    remote_ip_prefix: 0.0.0.0/0

- name: Create a security group rule for ping
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: icmp
    remote_ip_prefix: 0.0.0.0/0

- name: Another way to create the ping rule
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: icmp
    port_range_min: -1
    port_range_max: -1
    remote_ip_prefix: 0.0.0.0/0

- name: Create a TCP rule covering all ports
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: tcp
    port_range_min: 1
    port_range_max: 65535
    remote_ip_prefix: 0.0.0.0/0

- name: Another way to create the TCP rule above (defaults to all ports)
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: tcp
    remote_ip_prefix: 0.0.0.0/0

- name: Create a rule for VRRP with numbered protocol 112
  openstack.cloud.security_group_rule:
    security_group: loadbalancer_sg
    protocol: 112
    remote_group: loadbalancer-node_sg

- name: Create a security group rule for a given project
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: icmp
    remote_ip_prefix: 0.0.0.0/0
    project: myproj

- name: Remove the default created egress rule for IPv4
  openstack.cloud.security_group_rule:
    cloud: mordred
    security_group: foo
    protocol: any
    remote_ip_prefix: 0.0.0.0/0

Return Values

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

Key

Description

rule

dictionary

Dictionary describing the security group rule

Returned: On success when state is present.

created_at

string

Timestamp when the resource was created

Returned: success

description

string

Description of the resource

Returned: success

direction

string

The direction in which the security group rule is applied.

Returned: success

Sample: "egress"

ether_type

string

Either IPv4 or IPv6

Returned: success

id

string

Unique rule UUID.

Returned: success

name

string

Name of the resource.

Returned: success

port_range_max

integer

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

Returned: success

Sample: 8000

port_range_min

integer

The minimum port number in the range that is matched by the security group rule.

Returned: success

Sample: 8000

project_id

string

ID of the project the resource belongs to.

Returned: success

protocol

string

The protocol that is matched by the security group rule.

Returned: success

Sample: "tcp"

remote_address_group_id

string

The remote address group ID to be associated with this security group rule.

Returned: success

Sample: "0.0.0.0/0"

remote_group_id

string

The remote security group ID to be associated with this security group rule.

Returned: success

Sample: "0.0.0.0/0"

remote_ip_prefix

string

The remote IP prefix to be associated with this security group rule.

Returned: success

Sample: "0.0.0.0/0"

revision_number

integer

Revision number

Returned: success

Sample: 0

security_group_id

string

The security group ID to associate with this security group rule.

Returned: success

tags

list / elements=string

Tags associated with resource.

Returned: success

tenant_id

string

ID of the project the resource belongs to. Deprecated.

Returned: success

updated_at

string

Timestamp when the security group rule was last updated.

Returned: success

Authors

  • OpenStack Ansible SIG