ec2-describe-network-interfaces

Description

Gives you information about one or more network interfaces. The NETWORKINTERFACE parameters, if specified, are the IDs of the network interfaces to describe.

The short version of this command is ec2dnic.

You can filter the results to return information only about network interfaces that match criteria you specify. For example, you could get information about only network interfaces launched in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). A network interface must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the network interface is in a specific Availability Zone, and its owner ID matches a specific owner ID). A network interface must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name	Description
`association.association-id`	The association ID returned when the network interface was associated with an IP address. Type: String
`association.allocation-id`	The allocation ID that AWS returned when you allocated the Elastic IP address for your network interface. Type: String
`association.ip-owner-id`	The owner of the Elastic IP address associated with the network interface. Type: String
`association.public-ip`	The address of the Elastic IP address bound to the network interface. Type: String
`attachment.attachment-id`	The ID of the interface attachment. Type: String
`attachment.instance-id`	The ID of the instance to which the network interface is attached. Type: String
`attachment.instance-owner-id`	The owner ID of the instance to which the network interface is attached. Type: String
`attachment.device-index`	The device index to which the network interface is attached. Type: Integer
`attachment.status`	The status of the attachment. Type: String Valid values: `attaching \| attached \| detaching \| detached`
`attachment.attach.time`	The time that the network interface was attached to an instance. Type: Date
`attachment.delete-on-termination`	Indicates whether or not the attachment is deleted when an instance is terminated. Type: Boolean
`availability-zone`	Availability Zone of the network interface. Type: String
`description`	The description of the network interface. Type: String
`group-id`	ID of a VPC security group associated with the network interface. Type: String
`group-name`	Name of a VPC security group associated with the network interface. Type: String
`mac-address`	The MAC address of the network interface. Type: String
`network-interface-id`	The ID of the network interface. Type: String
`owner-id`	The AWS account ID of the network interface owner. Type: String
`private-ip-address`	The private IP address of the network interface. Type: String
`private-dns-name`	The private DNS name of the network interface. Type: String
`requester-id`	ID of the entity that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling, etc.). Type: String
`requester-managed`	Indicates whether the network interface is being managed by an AWS service (e.g., AWS Management Console, Auto Scaling, etc). Type: Boolean
`source-dest-check`	Whether the network interface performs source/destination checking. A value of `true` means checking is enabled, and `false` means checking is disabled. The value must be `false` for the network interface to perform Network Address Translation (NAT) in your VPC. Type: Boolean
`status`	The status of the network interface. If the network interface is not attached to an instance, the status shows `available`; if a network interface is attached to an instance the status shows `in-use`. Type: String Valid values: `available \| in-use`
`subnet-id`	The ID of the subnet that the network interface is in. Type: String
`tag-key`	Key of a tag assigned to the resource. This filter is independent of the `tag-value` filter. For example, if you use both the filter `tag-key=Purpose` and the filter `tag-value=X`, you get any resources assigned both the tag key `Purpose` (regardless of what the tag's value is), and the tag value `X` (regardless of what the tag's key is). If you want to list only resources where Purpose=X, see the `tag:key` filter later in this table. For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide. Type: String
`tag-value`	Value of a tag assigned to the resource. This filter is independent of the `tag-key` filter. Type: String
`tag:``key`	Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: `--filter tag:Purpose=X` Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: `--filter tag:Purpose=X --filter tag:Purpose=Y`
`vpc-id`	The ID of the VPC that the network interface is in. Type: String

Syntax

ec2-describe-network-interfaces --filter FILTER

Options

Name Description Required

Name	Description	Required
`-F, --filter name=value`	A filter for limiting the results. See the preceding table for a list of allowed filter names and values. You need to use quotation marks if the value string has a space (e.g., "name=value example"). If you're using the command line tools on a Windows system, you might need to use quotation marks, even when there is no space in the value string (e.g., "name=value"). Type: String Default: None Example: -F "description=My ENI"	No

-F, --filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. You need to use quotation marks if the value string has a space (e.g., "name=value example"). If you're using the command line tools on a Windows system, you might need to use quotation marks, even when there is no space in the value string (e.g., "name=value").

Type: String

Default: None

Example: -F "description=My ENI"

No

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command lists information about the specified network interfaces.

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example lists all network interfaces that you own.

PROMPT> ec2-describe-network-interfaces 
				NETWORKINTERFACE        eni-dc7f84b5            subnet-8404ffed vpc-8004ffe9    us-east-1b      089818748305            false   in-use  02:1a:81:a9:56:27       10.0.1.187              true
				GROUP   sg-8ea1bce2     default
				GROUP   sg-94a1bcf8     ACK
				ATTACHMENT      i-640a3c17      eni-attach-dc34d1b5     attached        false
				ASSOCIATION
				NETWORKINTERFACE        eni-b35da6da    My ENI        subnet-8404ffed vpc-8004ffe9    us-east-1b      089818748305            false   in-use  02:1a:81:b6:63:60       10.0.1.129              true
				GROUP   sg-8ea1bce2     default
				ATTACHMENT      i-640a3c17      eni-attach-673dd80e     attached        false
				ASSOCIATION

This example lists specified network interfaces.

PROMPT> ec2-describe-network-interfaces -F "description=My ENI"
				NETWORKINTERFACE        eni-b35da6da    My ENI        subnet-8404ffed vpc-8004ffe9    us-east-1b      089818748305            false   in-use  02:1a:81:b6:63:60       10.0.1.129              true
				GROUP   sg-8ea1bce2     default
				ATTACHMENT      i-640a3c17      eni-attach-673dd80e     attached        false
				ASSOCIATION