AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the DescribeNetworkInterfaces operation against Amazon Elastic Compute Cloud.

Syntax

Get-EC2NetworkInterface
-NetworkInterfaceId <String[]>
-Filter <Filter[]>

Description

Describes one or more of your network interfaces.

Parameters

-Filter <Filter[]>
One or more filters.
  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
  • association.public-dns-name - The public DNS name for the network interface (IPv4).
  • attachment.attachment-id - The ID of the interface attachment.
  • attachment.attach.time - The time that the network interface was attached to an instance.
  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
  • attachment.device-index - The device index to which the network interface is attached.
  • attachment.instance-id - The ID of the instance to which the network interface is attached.
  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.
  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).
  • availability-zone - The Availability Zone of the network interface.
  • description - The description of the network interface.
  • group-id - The ID of a security group associated with the network interface.
  • group-name - The name of a security group associated with the network interface.
  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
  • mac-address - The MAC address of the network interface.
  • network-interface-id - The ID of the network interface.
  • owner-id - The AWS account ID of the network interface owner.
  • private-ip-address - The private IPv4 address or addresses of the network interface.
  • private-dns-name - The private DNS name of the network interface (IPv4).
  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
  • source-desk-check - Indicates 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.
  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
  • subnet-id - The ID of the subnet for the network interface.
  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
  • tag-key - The 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 is X, see the tag:key=value filter.
  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
  • vpc-id - The ID of the VPC for the network interface.
Required?False
Position?2
Accept pipeline input?False
-NetworkInterfaceId <String[]>
One or more network interface IDs.Default: Describes all your network interfaces.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String[] object to this cmdlet for the NetworkInterfaceId parameter.

Outputs

This cmdlet returns a collection of NetworkInterface objects. The service call response (type Amazon.EC2.Model.DescribeNetworkInterfacesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Get-EC2NetworkInterface -NetworkInterfaceId eni-12345678

Association :
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
AvailabilityZone : us-west-2c
Description :
Groups : {my-security-group}
MacAddress : 0a:e9:a6:19:4c:7f
NetworkInterfaceId : eni-12345678
OwnerId : 123456789012
PrivateDnsName : ip-10-0-0-107.us-west-2.compute.internal
PrivateIpAddress : 10.0.0.107
PrivateIpAddresses : {ip-10-0-0-107.us-west-2.compute.internal}
RequesterId :
RequesterManaged : False
SourceDestCheck : True
Status : in-use
SubnetId : subnet-1a2b3c4d
TagSet : {}
VpcId : vpc-12345678
This example describes the specified network interface.

Example 2

PS C:\> Get-EC2NetworkInterface
This example describes all your network interfaces.

Supported Version

AWS Tools for PowerShell: 2.x.y.z