Documentation

ec2_vpc_subnet - Manage subnets in AWS virtual private clouds

New in version 2.0.

Synopsis

  • Manage subnets in AWS virtual private clouds

Requirements

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

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
assign_instances_ipv6
bool

(added in 2.5)
    Choices:
  • no ←
  • yes
Specify yes to indicate that instances launched into the subnet should be automatically assigned an IPv6 address.
aws_access_key
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
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
az
The availability zone for the subnet.
cidr
The CIDR block for the subnet. E.g. 192.0.2.0/24.
ec2_url
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.
ipv6_cidr
(added in 2.5)
The IPv6 CIDR block for the subnet. The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range.
Required if assign_instances_ipv6=true
map_public
bool

(added in 2.4)
    Choices:
  • no ←
  • yes
Specify yes to indicate that instances launched into the subnet should be assigned public IP address by default.
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
purge_tags
bool

(added in 2.5)
    Choices:
  • no
  • yes ←
Whether or not to remove tags that do not appear in the tags list.
region
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
security_token
(added in 1.6)
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
    Choices:
  • present ←
  • absent
Create or remove the subnet
tags
A dict of tags to apply to the subnet. Any tags currently applied to the subnet and not present here will be removed.

aliases: resource_tags
validate_certs
bool

(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_id
required
VPC ID of the VPC in which to create or delete the subnet.
wait
bool

(added in 2.5)
    Choices:
  • no
  • yes ←
When specified,state=present module will wait for subnet to be in available state before continuing.
wait_timeout
(added in 2.5)
Default:
300
Number of seconds to wait for subnet to become available wait=True.

Notes

Note

  • 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 https://boto.readthedocs.io/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

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create subnet for database servers
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28
    resource_tags:
      Name: Database Subnet
  register: database_subnet

- name: Remove subnet for database servers
  ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

- name: Create subnet with IPv6 block assigned
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: 2001:db8:0:102::/64

- name: Remove IPv6 block assigned to subnet
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: ''

Return Values

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

Key Returned Description
subnet
complex
state=present
Dictionary of subnet values

  availability_zone
string
state=present
Availability zone of the Subnet

Sample:
us-east-1a
  assign_ipv6_address_on_creation
boolean
state=present
whether IPv6 address is auto-assigned to new instances

  state
string
state=present
state of the Subnet

Sample:
available
  id
string
state=present
Subnet resource id

Sample:
subnet-b883b2c4
  default_for_az
boolean
state=present
indicates whether this is the default Subnet for this Availability Zone

  ipv6_association_id
string
state=present
The IPv6 association ID for the currently associated CIDR

Sample:
subnet-cidr-assoc-b85c74d2
  ipv6_cidr_block_association_set
complex
state=present
An array of IPv6 cidr block association set information.

    association_id
string
always
The association ID

    ipv6_cidr_block
string
always
The IPv6 CIDR block that is associated with the subnet.

    ipv6_cidr_block_state
dict
always
A hash/dict that contains a single item. The state of the cidr block association.

      state
string
always
The CIDR block association state.

  vpc_id
string
state=present
the id of the VPC where this Subnet exists

Sample:
vpc-67236184
  cidr_block
string
state=present
The IPv4 CIDR of the Subnet

Sample:
10.0.0.0/16
  available_ip_address_count
string
state=present
number of available IPv4 addresses

Sample:
251
  ipv6_cidr_block
string
state=present
The IPv6 CIDR block actively associated with the Subnet

Sample:
2001:db8:0:102::/64
  tags
dict
state=present
tags attached to the Subnet, includes name

Sample:
{'Name': 'My Subnet', 'env': 'staging'}
  map_public_ip_on_launch
boolean
state=present
whether public IP is auto-assigned to new instances



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

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Robert Estelle (@erydo)
  • Brad Davidson (@brandond)

Hint

If you notice any issues in this documentation you can edit this document to improve it.