Try Spottermaintain an ec2 VPC security group.
| "added in version" 1.3 of ansible.builtin"
Authors: Andrew de Quincey (@adq)
stableinterface | supported by core
pipInstall with pip install ansible==2.9.17
maintains ec2 security groups. This module has a dependency on python-boto >= 2.5
- name: example using security group rule descriptions
ec2_group:
name: "{{ name }}"
description: sg with rule descriptions
vpc_id: vpc-xxxxxxxx
profile: "{{ aws_profile }}"
region: us-east-1
rules:
- proto: tcp
ports:
- 80
cidr_ip: 0.0.0.0/0
rule_desc: allow all on port 80
- name: example ec2 group
ec2_group:
name: example
description: an example EC2 group
vpc_id: 12345
region: eu-west-1
aws_secret_key: SECRET
aws_access_key: ACCESS
rules:
- proto: tcp
from_port: 80
to_port: 80
cidr_ip: 0.0.0.0/0
- proto: tcp
from_port: 22
to_port: 22
cidr_ip: 10.0.0.0/8
- proto: tcp
from_port: 443
to_port: 443
# this should only be needed for EC2 Classic security group rules
# because in a VPC an ELB will use a user-account security group
group_id: amazon-elb/sg-87654321/amazon-elb-sg
- proto: tcp
from_port: 3306
to_port: 3306
group_id: 123412341234/sg-87654321/exact-name-of-sg
- proto: udp
from_port: 10050
to_port: 10050
cidr_ip: 10.0.0.0/8
- proto: udp
from_port: 10051
to_port: 10051
group_id: sg-12345678
- proto: icmp
from_port: 8 # icmp type, -1 = any type
to_port: -1 # icmp subtype, -1 = any subtype
cidr_ip: 10.0.0.0/8
- proto: all
# the containing group name may be specified here
group_name: example
- proto: all
# in the 'proto' attribute, if you specify -1, all, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6),
# traffic on all ports is allowed, regardless of any ports you specify
from_port: 10050 # this value is ignored
to_port: 10050 # this value is ignored
cidr_ip: 10.0.0.0/8
rules_egress:
- proto: tcp
from_port: 80
to_port: 80
cidr_ip: 0.0.0.0/0
cidr_ipv6: 64:ff9b::/96
group_name: example-other
# description to use if example-other needs to be created
group_desc: other example EC2 group
- name: example2 ec2 group
ec2_group:
name: example2
description: an example2 EC2 group
vpc_id: 12345
region: eu-west-1
rules:
# 'ports' rule keyword was introduced in version 2.4. It accepts a single port value or a list of values including ranges (from_port-to_port).
- proto: tcp
ports: 22
group_name: example-vpn
- proto: tcp
ports:
- 80
- 443
- 8080-8099
cidr_ip: 0.0.0.0/0
# Rule sources list support was added in version 2.4. This allows to define multiple sources per source type as well as multiple source types per rule.
- proto: tcp
ports:
- 6379
- 26379
group_name:
- example-vpn
- example-redis
- proto: tcp
ports: 5665
group_name: example-vpn
cidr_ip:
- 172.16.1.0/24
- 172.16.17.0/24
cidr_ipv6:
- 2607:F8B0::/32
- 64:ff9b::/96
group_id:
- sg-edcd9784
diff: True
- name: "Delete group by its id"
ec2_group:
region: eu-west-1
group_id: sg-33b4ee5b
state: absent
name:
description:
- Name of the security group.
- One of and only one of I(name) or I(group_id) is required.
- Required if I(state=present).
required: false
tags:
description:
- A dictionary of one or more tags to assign to the security group.
required: false
version_added: '2.4'
version_added_collection: ansible.builtin
rules:
description:
- List of firewall inbound rules to enforce in this group (see example). If none are
supplied, no inbound rules will be enabled. Rules list may include its own name
in `group_name`. This allows idempotent loopback additions (e.g. allow group to
access itself). Rule sources list support was added in version 2.4. This allows
to define multiple sources per source type as well as multiple source types per
rule. Prior to 2.4 an individual source is allowed. In version 2.5 support for rule
descriptions was added.
required: false
state:
aliases: []
choices:
- present
- absent
default: present
description:
- Create or delete a security group
required: false
version_added: '1.4'
version_added_collection: ansible.builtin
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
vpc_id:
description:
- ID of the VPC to create the group in.
required: false
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
group_id:
description:
- Id of group to delete (works only with absent).
- One of and only one of I(name) or I(group_id) is required.
required: false
version_added: '2.4'
version_added_collection: ansible.builtin
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
purge_tags:
default: true
description:
- If yes, existing tags will be purged from the resource to match exactly what is
defined by I(tags) parameter. If the I(tags) parameter is not set then tags will
not be modified.
required: false
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
description:
description:
- Description of the security group. Required when C(state) is C(present).
required: false
purge_rules:
aliases: []
default: 'true'
description:
- Purge existing rules on security group that are not found in rules
required: false
type: bool
version_added: '1.8'
version_added_collection: ansible.builtin
rules_egress:
description:
- List of firewall outbound rules to enforce in this group (see example). If none
are supplied, a default all-out rule is assumed. If an empty list is supplied, no
outbound rules will be enabled. Rule Egress sources list support was added in version
2.4. In version 2.5 support for rule descriptions was added.
required: false
version_added: '1.6'
version_added_collection: ansible.builtin
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
purge_rules_egress:
aliases: []
default: 'true'
description:
- Purge existing rules_egress on security group that are not found in rules_egress
required: false
type: bool
version_added: '1.8'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
description:
description: Description of security group
returned: on create/update
sample: My Security Group
type: str
group_id:
description: Security group id
returned: on create/update
sample: sg-abcd1234
type: str
group_name:
description: Security group name
returned: on create/update
sample: My Security Group
type: str
ip_permissions:
description: Inbound rules associated with the security group.
returned: on create/update
sample:
- from_port: 8182
ip_protocol: tcp
ip_ranges:
- cidr_ip: 1.1.1.1/32
ipv6_ranges: []
prefix_list_ids: []
to_port: 8182
user_id_group_pairs: []
type: list
ip_permissions_egress:
description: Outbound rules associated with the security group.
returned: on create/update
sample:
- ip_protocol: -1
ip_ranges:
- cidr_ip: 0.0.0.0/0
ipv6_ranges: []
prefix_list_ids: []
user_id_group_pairs: []
type: list
owner_id:
description: AWS Account ID of the security group
returned: on create/update
sample: 123456789012
type: int
tags:
description: Tags associated with the security group
returned: on create/update
sample:
Name: My Security Group
Purpose: protecting stuff
type: dict
vpc_id:
description: ID of VPC to which the security group belongs
returned: on create/update
sample: vpc-abcd1234
type: str