Get-HcsNetInterface
Get-HcsNetInterface
Gets configuration information for a network interface.
Syntax
Parameter Set: Default
Get-HcsNetInterface [[-InterfaceAlias] <HcsNetInterfaces]> ] [ <CommonParameters>]
Detailed Description
The Get-HcsNetInterface cmdlet gets configuration information for a network interface by specifying the InterfaceAlias parameter.
You can also use Get-HcsNetInterface with no parameter to get configuration information for all network interfaces on a device.
Parameters
-InterfaceAlias<HcsNetInterfaces]>
Specifies an interface alias. The acceptable values for this parameter are:
-- Data0
-- Data1
-- Data2
-- Data3
-- Data4
-- Data5
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.HCS.Management.Platform.Support.NetInterfaceInfo[]
The NetInterfaceInfo object has the following properties:
-- HcsNetInterfaces InterfaceAlias (Data0, Data1, Data2, Data3, Data4, or Data5)
-- IPAddress Controller 0 IPv4Address
-- IPAddress Controller 0 IPv6Address
-- IPAddress Controller 1 IPv4Address
-- IPAddress Controller 1 IPv6Address
-- IPAddress IPv4Address
-- IPAddress IPv4Gateway
-- IPAddress IPv4Netmask
-- IPAddress IPv6Address
-- IPAddress IPv6Gateway
-- String IPv6Prefix
-- IsEnabled
-- IsCloudEnabled
-- IsiSCSIEnabled
Examples
Example 1: Get network interface configuration information by alias
This command gets network interface configuration information for the network interface specified by the InterfaceAlias parameter.
PS C:\> Get-HcsNetInterface Data0
Example 2: Get network interface configuration information for all interfaces
This command gets network configuration information for all network interfaces on a device.
PS C:\> Get-HcsNetInterface :