amazon.aws.ec2_eni_info – Gather information about ec2 ENI interfaces in AWS

Note

This plugin is part of the amazon.aws collection (version 1.5.0).

To install it use: ansible-galaxy collection install amazon.aws.

To use it in a playbook, specify: amazon.aws.ec2_eni_info.

New in version 1.0.0: of amazon.aws

Synopsis

  • Gather information about ec2 ENI interfaces in AWS.

  • This module was called ec2_eni_facts before Ansible 2.9. The usage did not change.

Requirements

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

  • boto

  • boto3

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
eni_id
string
added in 1.3.0 of amazon.aws
The ID of the ENI.
This option is mutually exclusive of filters.
filters
dictionary
A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html for possible filters.
This option is mutually exclusive of eni_id.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
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
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE

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

# Gather information about all ENIs
- amazon.aws.ec2_eni_info:

# Gather information about a particular ENI
- amazon.aws.ec2_eni_info:
    filters:
      network-interface-id: eni-xxxxxxx

Return Values

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

Key Returned Description
network_interfaces
complex
always
List of matching elastic network interfaces

 
association
dictionary
When an ENI is associated with an EIP
Info of associated elastic IP (EIP)

Sample:
{'allocation_id': 'eipalloc-5sdf123', 'association_id': 'eipassoc-8sdf123', 'ip_owner_id': '4415120123456', 'public_dns_name': 'ec2-52-1-0-63.compute-1.amazonaws.com', 'public_ip': '52.1.0.63'}
 
attachment
dictionary
When an ENI is attached to an ec2 instance
Info about attached ec2 instance

Sample:
{'attach_time': '2017-08-05T15:25:47+00:00', 'attachment_id': 'eni-attach-149d21234', 'delete_on_termination': False, 'device_index': 1, 'instance_id': 'i-15b8d3cadbafa1234', 'instance_owner_id': '4415120123456', 'status': 'attached'}
 
availability_zone
string
always
Availability zone of ENI

Sample:
us-east-1b
 
description
string
always
Description text for ENI

Sample:
My favourite network interface
 
groups
list / elements=string
always
List of attached security groups

Sample:
[{'group_id': 'sg-26d0f1234', 'group_name': 'my_ec2_security_group'}]
 
id
string
always
The id of the ENI (alias for network_interface_id)

Sample:
eni-392fsdf
 
interface_type
string
always
Type of the network interface

Sample:
interface
 
ipv6_addresses
list / elements=string
always
List of IPv6 addresses for this interface

 
mac_address
string
always
MAC address of the network interface

Sample:
0a:f8:10:2f:ab:a1
 
name
string
added in 1.3.0 of amazon.aws
When a Name tag has been set
The Name tag of the ENI, often displayed in the AWS UIs as Name

 
network_interface_id
string
always
The id of the ENI

Sample:
eni-392fsdf
 
owner_id
string
always
AWS account id of the owner of the ENI

Sample:
4415120123456
 
private_dns_name
string
always
Private DNS name for the ENI

Sample:
ip-172-16-1-180.ec2.internal
 
private_ip_address
string
always
Private IP address for the ENI

Sample:
172.16.1.180
 
private_ip_addresses
list / elements=string
always
List of private IP addresses attached to the ENI

 
requester_id
string
always
The ID of the entity that launched the ENI

Sample:
AIDAIONYVJQNIAZFT3ABC
 
requester_managed
boolean
always
Indicates whether the network interface is being managed by an AWS service.

 
source_dest_check
boolean
always
Indicates whether the network interface performs source/destination checking.

 
status
string
always
Indicates if the network interface is attached to an instance or not

Sample:
in-use
 
subnet_id
string
always
Subnet ID the ENI is in

Sample:
subnet-7bbf01234
 
tag_set
dictionary
always
Dictionary of tags added to the ENI

 
tags
dictionary
added in 1.3.0 of amazon.aws
always
Dictionary of tags added to the ENI

 
vpc_id
string
always
ID of the VPC the network interface it part of

Sample:
vpc-b3f1f123


Authors

  • Rob White (@wimnat)