ec2_customer_gateway - Manage an AWS customer gateway

New in version 2.2.

Synopsis

  • Manage an AWS customer gateway

Requirements

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key Default:
None
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 Default:
None
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
bgp_asn Default:
None
Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present.
ec2_url Default:
None
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.
ip_address
required
Internet-routable IP address for customers gateway, must be a static address.
name
required
Name of the customer gateway.
profile
(added in 1.6)
 Default:
None
Uses a boto profile. Only works with boto >= 2.24.0.
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
routing
(added in 2.4)
    Choices:
  • static
  • dynamic ←
The type of routing.
security_token
(added in 1.6)
 Default:
None
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 terminate the Customer Gateway.
validate_certs
(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • You cannot create more than one customer gateway with the same IP address. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
  • Return values contain customer_gateway and customer_gateways keys which are identical dicts. You should use customer_gateway. See https://github.com/ansible/ansible-modules-extras/issues/2773 for details.
  • 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

Examples

# Create Customer Gateway
- ec2_customer_gateway:
    bgp_asn: 12345
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    region: us-east-1
  register: cgw

# Delete Customer Gateway
- ec2_customer_gateway:
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    state: absent
    region: us-east-1
  register: cgw

Return Values

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

Key Returned Description
gateway.customer_gateways
complex
 success
details about the gateway that was created.
state
string
 when gateway exists and is available.
state of gateway.
customer_gateway_id
string
 when exists and gateway is available.
gateway id assigned by amazon.

Sample:
cgw-cb6386a2
tags
string
 when gateway exists and is available, and when tags exist.
any tags on the gateway.
type
string
 when gateway exists and is available.
encryption type.

Sample:
ipsec.1
bgp_asn
string
 when exists and gateway is available.
The Border Gateway Autonomous System Number.

Sample:
65123
ip_address
string
 when exists and gateway is available.
ip address of your gateway device.

Sample:
1.2.3.4


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Michael Baydoun (@MichaelBaydoun)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ec2_customer_gateway_module.html