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.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
.
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 |
Comments |
---|---|
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. |
|
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. |
|
A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
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. |
|
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:
|
|
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. |
|
The ID of the ENI. This option is mutually exclusive of filters. |
|
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. |
|
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. |
|
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 |
|
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. |
|
When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_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
orEC2_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 |
Description |
---|---|
List of matching elastic network interfaces Returned: always |
|
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”: “4415120123456”, “public_dns_name”: “ec2-52-1-0-63.compute-1.amazonaws.com”, “public_ip”: “52.1.0.63”} |
|
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”: “4415120123456”, “status”: “attached”} |
|
Availability zone of ENI Returned: always Sample: “us-east-1b” |
|
Description text for ENI Returned: always Sample: “My favourite network interface” |
|
List of attached security groups Returned: always Sample: [{“group_id”: “sg-26d0f1234”, “group_name”: “my_ec2_security_group”}] |
|
The id of the ENI (alias for network_interface_id) Returned: always Sample: “eni-392fsdf” |
|
Type of the network interface Returned: always Sample: “interface” |
|
List of IPv6 addresses for this interface Returned: always Sample: [] |
|
MAC address of the network interface Returned: always Sample: “0a:f8:10:2f:ab:a1” |
|
The Name tag of the ENI, often displayed in the AWS UIs as Name Returned: When a Name tag has been set |
|
The id of the ENI Returned: always Sample: “eni-392fsdf” |
|
AWS account id of the owner of the ENI Returned: always Sample: “4415120123456” |
|
Private DNS name for the ENI Returned: always Sample: “ip-172-16-1-180.ec2.internal” |
|
Private IP address for the ENI Returned: always Sample: “172.16.1.180” |
|
List of private IP addresses attached to the ENI Returned: always Sample: [] |
|
The ID of the entity that launched the ENI Returned: always Sample: “AIDAIONYVJQNIAZFT3ABC” |
|
Indicates whether the network interface is being managed by an AWS service. Returned: always Sample: false |
|
Indicates whether the network interface performs source/destination checking. Returned: always Sample: false |
|
Indicates if the network interface is attached to an instance or not Returned: always Sample: “in-use” |
|
Subnet ID the ENI is in Returned: always Sample: “subnet-7bbf01234” |
|
Dictionary of tags added to the ENI Returned: always Sample: {} |
|
Dictionary of tags added to the ENI Returned: always Sample: {} |
|
ID of the VPC the network interface it part of Returned: always Sample: “vpc-b3f1f123” |
Authors
Rob White (@wimnat)