Try SpotterGather facts 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.5.10
Gather facts about ec2 ENI interfaces in AWS
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about all ENIs - ec2_eni_facts:
# Gather facts about a particular ENI
- ec2_eni_facts:
filters:
network-interface-id: eni-xxxxxxx
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
filters:
default: null
description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter
value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html)
for possible filters.
required: false
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(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: Infor 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: string
description:
description: Description text for ENI
returned: always
sample: My favourite network interface
type: string
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: string
interface_type:
description: Type of the network interface
returned: always
sample: interface
type: string
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: string
network_interface_id:
description: The id of the ENI
returned: always
sample: eni-392fsdf
type: string
owner_id:
description: AWS account id of the owner of the ENI
returned: always
sample: '4415120123456'
type: string
private_dns_name:
description: Private DNS name for the ENI
returned: always
sample: ip-172-16-1-180.ec2.internal
type: string
private_ip_address:
description: Private IP address for the ENI
returned: always
sample: 172.16.1.180
type: string
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: string
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: string
subnet_id:
description: Subnet ID the ENI is in
returned: always
sample: subnet-7bbf01234
type: string
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: string
description: List of matching elastic network interfaces
returned: always
type: complex