W3cubDocs

/Ansible

ec2_group - maintain an ec2 VPC security group.

New in version 1.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status
- Maintenance Info

Synopsis

maintains ec2 security groups. This module has a dependency on python-boto >= 2.5

Requirements (on host that executes module)

boto
boto3
python >= 2.6

Options

parameter	required	default	choices	comments
aws_access_key	no			AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key	no			AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
description	no			Description of the security group. Required when `state` is `present`.
ec2_url	no			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.
group_id (added in 2.4)	no			Id of group to delete (works only with absent). One of and only one of name or group_id is required.
name	no			Name of the security group. One of and only one of name or group_id is required. Required if state=present.
profile (added in 1.6)	no			Uses a boto profile. Only works with boto >= 2.24.0.
purge_rules (added in 1.8)	no	true		Purge existing rules on security group that are not found in rules
purge_rules_egress (added in 1.8)	no	true		Purge existing rules_egress on security group that are not found in rules_egress
purge_tags (added in 2.4)	no	True	yes no	If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
region	no			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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
rules	no			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.
rules_egress (added in 1.6)	no			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.
security_token (added in 1.6)	no			AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
state (added in 1.4)	no	present	present absent	Create or delete a security group
tags (added in 2.4)	no			A dictionary of one or more tags to assign to the security group.
validate_certs (added in 1.5)	no	yes	yes no	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_id	no			ID of the VPC to create the group in.

Examples

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

- name: "Delete group by its id"
  ec2_group:
    group_id: sg-33b4ee5b
    state: absent

Return Values

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

name	description	returned	type	sample
ip_permissions	Inbound rules associated with the security group.	on create/update	list	[{'from_port': 8182, 'ip_protocol': 'tcp', 'ipv6_ranges': [], 'to_port': 8182, 'ip_ranges': [{'cidr_ip': '1.1.1.1/32'}], 'user_id_group_pairs': [], 'prefix_list_ids': []}]
description	Description of security group	on create/update	string	My Security Group
tags	Tags associated with the security group	on create/update	dict	{'Name': 'My Security Group', 'Purpose': 'protecting stuff'}
group_name	Security group name	on create/update	string	My Security Group
vpc_id	ID of VPC to which the security group belongs	on create/update	string	vpc-abcd1234
group_id	Security group id	on create/update	string	sg-abcd1234
ip_permissions_egress	Outbound rules associated with the security group.	on create/update	list	[{'ip_protocol': -1, 'ip_ranges': [{'ipv6_ranges': [], 'cidr_ip': '0.0.0.0/0', 'user_id_group_pairs': [], 'prefix_list_ids': []}]}]
owner_id	AWS Account ID of the security group	on create/update	int	123456789012

Notes

Note

If a rule declares a group_name and that group doesn’t exist, it will be automatically created. In that case, group_desc should be provided as well. The module will refuse to create a depended-on group without a description.
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ec2_group_module.html