File: //lib/python3.9/site-packages/ansible_collections/amazon/aws/plugins/modules/ec2_eni_info.py
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: ec2_eni_info
version_added: 1.0.0
short_description: Gather information about EC2 ENI interfaces in AWS
description:
- Gather information about EC2 ENI interfaces in AWS.
author:
- "Rob White (@wimnat)"
options:
eni_id:
description:
- The ID of the ENI.
- This option is mutually exclusive of I(filters).
type: str
version_added: 1.3.0
filters:
description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter value.
See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) for possible filters.
- This option is mutually exclusive of I(eni_id).
type: dict
extends_documentation_fragment:
- amazon.aws.aws
- amazon.aws.ec2
- amazon.aws.boto3
'''
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 = '''
network_interfaces:
description: List of matching elastic network interfaces.
returned: always
type: complex
contains:
association:
description: Info of associated elastic IP (EIP).
returned: When an ENI is associated with an EIP
type: dict
sample: {
allocation_id: "eipalloc-5sdf123",
association_id: "eipassoc-8sdf123",
ip_owner_id: "123456789012",
public_dns_name: "ec2-52-1-0-63.compute-1.amazonaws.com",
public_ip: "52.1.0.63"
}
attachment:
description: Info about attached ec2 instance.
returned: When an ENI is attached to an ec2 instance
type: dict
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: "123456789012",
status: "attached"
}
availability_zone:
description: Availability zone of ENI.
returned: always
type: str
sample: "us-east-1b"
description:
description: Description text for ENI.
returned: always
type: str
sample: "My favourite network interface"
groups:
description: List of attached security groups.
returned: always
type: list
sample: [
{
group_id: "sg-26d0f1234",
group_name: "my_ec2_security_group"
}
]
id:
description: The id of the ENI (alias for network_interface_id).
returned: always
type: str
sample: "eni-392fsdf"
interface_type:
description: Type of the network interface.
returned: always
type: str
sample: "interface"
ipv6_addresses:
description: List of IPv6 addresses for this interface.
returned: always
type: list
sample: []
mac_address:
description: MAC address of the network interface.
returned: always
type: str
sample: "0a:f8:10:2f:ab:a1"
name:
description: The Name tag of the ENI, often displayed in the AWS UIs as Name.
returned: When a Name tag has been set
type: str
version_added: 1.3.0
network_interface_id:
description: The id of the ENI.
returned: always
type: str
sample: "eni-392fsdf"
owner_id:
description: AWS account id of the owner of the ENI.
returned: always
type: str
sample: "123456789012"
private_dns_name:
description: Private DNS name for the ENI.
returned: always
type: str
sample: "ip-172-16-1-180.ec2.internal"
private_ip_address:
description: Private IP address for the ENI.
returned: always
type: str
sample: "172.16.1.180"
private_ip_addresses:
description: List of private IP addresses attached to the ENI.
returned: always
type: list
sample: []
requester_id:
description: The ID of the entity that launched the ENI.
returned: always
type: str
sample: "AIDA12345EXAMPLE54321"
requester_managed:
description: Indicates whether the network interface is being managed by an AWS service.
returned: always
type: bool
sample: false
source_dest_check:
description: Indicates whether the network interface performs source/destination checking.
returned: always
type: bool
sample: false
status:
description: Indicates if the network interface is attached to an instance or not.
returned: always
type: str
sample: "in-use"
subnet_id:
description: Subnet ID the ENI is in.
returned: always
type: str
sample: "subnet-7bbf01234"
tags:
description: Dictionary of tags added to the ENI.
returned: always
type: dict
sample: {}
version_added: 1.3.0
tag_set:
description: Dictionary of tags added to the ENI.
returned: always
type: dict
sample: {}
vpc_id:
description: ID of the VPC the network interface it part of.
returned: always
type: str
sample: "vpc-b3f1f123"
'''
try:
from botocore.exceptions import ClientError
from botocore.exceptions import NoCredentialsError
except ImportError:
pass # Handled by AnsibleAWSModule
from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict
from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule
from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ansible_dict_to_boto3_filter_list
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict
def list_eni(connection, module):
params = {}
# Options are mutually exclusive
if module.params.get("eni_id"):
params['NetworkInterfaceIds'] = [module.params.get("eni_id")]
elif module.params.get("filters"):
params['Filters'] = ansible_dict_to_boto3_filter_list(module.params.get("filters"))
else:
params['Filters'] = []
try:
network_interfaces_result = connection.describe_network_interfaces(aws_retry=True, **params)['NetworkInterfaces']
except is_boto3_error_code('InvalidNetworkInterfaceID.NotFound'):
module.exit_json(network_interfaces=[])
except (ClientError, NoCredentialsError) as e: # pylint: disable=duplicate-except
module.fail_json_aws(e)
# Modify boto3 tags list to be ansible friendly dict and then camel_case
camel_network_interfaces = []
for network_interface in network_interfaces_result:
network_interface['TagSet'] = boto3_tag_list_to_ansible_dict(network_interface['TagSet'])
network_interface['Tags'] = network_interface['TagSet']
if 'Name' in network_interface['Tags']:
network_interface['Name'] = network_interface['Tags']['Name']
# Added id to interface info to be compatible with return values of ec2_eni module:
network_interface['Id'] = network_interface['NetworkInterfaceId']
camel_network_interfaces.append(camel_dict_to_snake_dict(network_interface, ignore_list=['Tags', 'TagSet']))
module.exit_json(network_interfaces=camel_network_interfaces)
def get_eni_info(interface):
# Private addresses
private_addresses = []
for ip in interface.private_ip_addresses:
private_addresses.append({'private_ip_address': ip.private_ip_address, 'primary_address': ip.primary})
interface_info = {'id': interface.id,
'subnet_id': interface.subnet_id,
'vpc_id': interface.vpc_id,
'description': interface.description,
'owner_id': interface.owner_id,
'status': interface.status,
'mac_address': interface.mac_address,
'private_ip_address': interface.private_ip_address,
'source_dest_check': interface.source_dest_check,
'groups': dict((group.id, group.name) for group in interface.groups),
'private_ip_addresses': private_addresses
}
if hasattr(interface, 'publicDnsName'):
interface_info['association'] = {'public_ip_address': interface.publicIp,
'public_dns_name': interface.publicDnsName,
'ip_owner_id': interface.ipOwnerId
}
if interface.attachment is not None:
interface_info['attachment'] = {'attachment_id': interface.attachment.id,
'instance_id': interface.attachment.instance_id,
'device_index': interface.attachment.device_index,
'status': interface.attachment.status,
'attach_time': interface.attachment.attach_time,
'delete_on_termination': interface.attachment.delete_on_termination,
}
return interface_info
def main():
argument_spec = dict(
eni_id=dict(type='str'),
filters=dict(default=None, type='dict')
)
mutually_exclusive = [
['eni_id', 'filters']
]
module = AnsibleAWSModule(
argument_spec=argument_spec,
supports_check_mode=True,
mutually_exclusive=mutually_exclusive,
)
connection = module.client('ec2', retry_decorator=AWSRetry.jittered_backoff())
list_eni(connection, module)
if __name__ == '__main__':
main()