Try SpotterGather information about ec2 ENI interfaces in AWS
| "added in version" 2.0 of ansible.builtin"
Authors: Rob White (@wimnat)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Gather information about ec2 ENI interfaces in AWS
This module was called C(ec2_eni_facts) before Ansible 2.9. The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather information about all ENIs - ec2_eni_info:
# Gather information about a particular ENI
- ec2_eni_info:
filters:
network-interface-id: eni-xxxxxxx
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
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.
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
network_interfaces:
contains:
association:
description: Info of associated elastic IP (EIP)
returned: always, empty dict if no association exists
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
type: dict
attachment:
description: Info about attached ec2 instance
returned: always, empty dict if ENI is not attached
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
type: dict
availability_zone:
description: Availability zone of ENI
returned: always
sample: us-east-1b
type: str
description:
description: Description text for ENI
returned: always
sample: My favourite network interface
type: str
groups:
description: List of attached security groups
returned: always
sample:
- group_id: sg-26d0f1234
group_name: my_ec2_security_group
type: list
id:
description: The id of the ENI (alias for network_interface_id)
returned: always
sample: eni-392fsdf
type: str
interface_type:
description: Type of the network interface
returned: always
sample: interface
type: str
ipv6_addresses:
description: List of IPv6 addresses for this interface
returned: always
sample: []
type: list
mac_address:
description: MAC address of the network interface
returned: always
sample: 0a:f8:10:2f:ab:a1
type: str
network_interface_id:
description: The id of the ENI
returned: always
sample: eni-392fsdf
type: str
owner_id:
description: AWS account id of the owner of the ENI
returned: always
sample: '4415120123456'
type: str
private_dns_name:
description: Private DNS name for the ENI
returned: always
sample: ip-172-16-1-180.ec2.internal
type: str
private_ip_address:
description: Private IP address for the ENI
returned: always
sample: 172.16.1.180
type: str
private_ip_addresses:
description: List of private IP addresses attached to the ENI
returned: always
sample: []
type: list
requester_id:
description: The ID of the entity that launched the ENI
returned: always
sample: AIDAIONYVJQNIAZFT3ABC
type: str
requester_managed:
description: Indicates whether the network interface is being managed by an
AWS service.
returned: always
sample: false
type: bool
source_dest_check:
description: Indicates whether the network interface performs source/destination
checking.
returned: always
sample: false
type: bool
status:
description: Indicates if the network interface is attached to an instance or
not
returned: always
sample: in-use
type: str
subnet_id:
description: Subnet ID the ENI is in
returned: always
sample: subnet-7bbf01234
type: str
tag_set:
description: Dictionary of tags added to the ENI
returned: always
sample: {}
type: dict
vpc_id:
description: ID of the VPC the network interface it part of
returned: always
sample: vpc-b3f1f123
type: str
description: List of matching elastic network interfaces
returned: always
type: complex