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

Note

This module is part of the amazon.aws collection (version 5.5.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

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

New in amazon.aws 1.0.0

Synopsis

  • Gather information about EC2 ENI interfaces in AWS.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 access_key will always fall back to the environment variables if set.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

eni_id

string

added in amazon.aws 1.3.0

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

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used. Prior to release 6.0.0 the AWS_PROFILE environment variable will be ignored if any of access_key, secret_key, or session_token are passed. After release 6.0.0 profile will always fall back to the AWS_PROFILE environment variable if set.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 secret_key will always fall back to the environment variables if set.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 session_token will always fall back to the environment variables if set.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

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

Description

network_interfaces

complex

List of matching elastic network interfaces.

Returned: always

association

dictionary

Info of associated elastic IP (EIP).

Returned: When an ENI is associated with an EIP

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

dictionary

Info about attached ec2 instance.

Returned: When an ENI is attached to an 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": "123456789012", "status": "attached"}

availability_zone

string

Availability zone of ENI.

Returned: always

Sample: "us-east-1b"

description

string

Description text for ENI.

Returned: always

Sample: "My favourite network interface"

groups

list / elements=string

List of attached security groups.

Returned: always

Sample: [{"group_id": "sg-26d0f1234", "group_name": "my_ec2_security_group"}]

id

string

The id of the ENI (alias for network_interface_id).

Returned: always

Sample: "eni-392fsdf"

interface_type

string

Type of the network interface.

Returned: always

Sample: "interface"

ipv6_addresses

list / elements=string

List of IPv6 addresses for this interface.

Returned: always

Sample: []

mac_address

string

MAC address of the network interface.

Returned: always

Sample: "0a:f8:10:2f:ab:a1"

name

string

added in amazon.aws 1.3.0

The Name tag of the ENI, often displayed in the AWS UIs as Name.

Returned: When a Name tag has been set

network_interface_id

string

The id of the ENI.

Returned: always

Sample: "eni-392fsdf"

owner_id

string

AWS account id of the owner of the ENI.

Returned: always

Sample: "123456789012"

private_dns_name

string

Private DNS name for the ENI.

Returned: always

Sample: "ip-172-16-1-180.ec2.internal"

private_ip_address

string

Private IP address for the ENI.

Returned: always

Sample: "172.16.1.180"

private_ip_addresses

list / elements=string

List of private IP addresses attached to the ENI.

Returned: always

Sample: []

requester_id

string

The ID of the entity that launched the ENI.

Returned: always

Sample: "AIDA12345EXAMPLE54321"

requester_managed

boolean

Indicates whether the network interface is being managed by an AWS service.

Returned: always

Sample: false

source_dest_check

boolean

Indicates whether the network interface performs source/destination checking.

Returned: always

Sample: false

status

string

Indicates if the network interface is attached to an instance or not.

Returned: always

Sample: "in-use"

subnet_id

string

Subnet ID the ENI is in.

Returned: always

Sample: "subnet-7bbf01234"

tag_set

dictionary

Dictionary of tags added to the ENI.

Returned: always

Sample: {}

tags

dictionary

added in amazon.aws 1.3.0

Dictionary of tags added to the ENI.

Returned: always

Sample: {}

vpc_id

string

ID of the VPC the network interface it part of.

Returned: always

Sample: "vpc-b3f1f123"

Authors

  • Rob White (@wimnat)