openstack.cloud.security_group module – Manage Neutron security groups of an OpenStack cloud.
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.
Synopsis
Add or remove Neutron security groups to/from an OpenStack cloud.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
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. |
|
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. |
|
Long description of the purpose of the security group. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name that has to be given to the security group. This module requires that security group names be unique. |
|
Unique name or ID of the project. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
List of security group rules. When security_group_rules is not defined, Neutron might create this security group with a default set of rules. Security group rules which are listed in security_group_rules but not defined in this security group will be created. When security_group_rules is not set, existing security group rules which are not listed in security_group_rules will be deleted. When updating a security group, one has to explicitly list rules from Neutron’s defaults in security_group_rules if those rules should be kept. Rules which are not listed in security_group_rules will be deleted. |
|
Description of the security group rule. |
|
The direction in which the security group rule is applied. Not all providers support Choices:
|
|
Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. Not all providers support IPv6. Choices:
|
|
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. |
|
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. |
|
The IP protocol can be represented by a string, an integer, or null. Valid string or integer values are Additionally, any integer value between 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. |
|
Name or ID of the security group to link. Mutually exclusive with remote_ip_prefix. |
|
Source IP address(es) in CIDR notation. When a netmask such as Mutually exclusive with remote_group. |
|
Should the resource be present or absent. Choices:
|
|
Should the resource be stateful or stateless. Choices:
|
|
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
- name: Create a security group
openstack.cloud.security_group:
cloud: mordred
state: present
name: foo
description: security group for foo servers
- name: Create a stateless security group
openstack.cloud.security_group:
cloud: mordred
state: present
stateful: false
name: foo
description: stateless security group for foo servers
- name: Update the existing 'foo' security group description
openstack.cloud.security_group:
cloud: mordred
state: present
name: foo
description: updated description for the foo security group
- name: Create a security group for a given project
openstack.cloud.security_group:
cloud: mordred
state: present
name: foo
project: myproj
- name: Create (or update) a security group with security group rules
openstack.cloud.security_group:
cloud: mordred
state: present
name: foo
security_group_rules:
- ether_type: IPv6
direction: egress
- ether_type: IPv4
direction: egress
- name: Create (or update) security group without security group rules
openstack.cloud.security_group:
cloud: mordred
state: present
name: foo
security_group_rules: []
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary describing the security group. Returned: On success when state is |
|
Creation time of the security group Returned: success Sample: |
|
Description of the security group Returned: success Sample: |
|
ID of the security group Returned: success Sample: |
|
Name of the security group. Returned: success Sample: |
|
Project ID where the security group is located in. Returned: success Sample: |
|
The revision number of the resource. Returned: success |
|
Specifies the security group rule list Returned: success Sample: |
|
Indicates if the security group is stateful or stateless. Returned: success |
|
The list of tags on the resource. Returned: success |
|
Tenant ID where the security group is located in. Deprecated Returned: success Sample: |
|
Update time of the security group Returned: success Sample: |