Edit

Disable-HcsNetInterface

  • Reference
Module:
HCS

Disables a network interface.

Syntax

Disable-HcsNetInterface
       [-InterfaceAlias] <HcsDisableNetInterfaces>
       [<CommonParameters>]

Description

The Disable-HcsNetInterface cmdlet disables a network interface. If you disable a network interface and then enable it, the IP address settings stay in place.

Note that you cannot disable the Data0 interface.

Examples

Example 1: Disable a network interface

PS C:\> Disable-HcsNetInterface Data2


InterfaceAlias         : Data2
Controller0IPv4Address :
Controller0IPv6Address :
Controller1IPv4Address :
Controller1IPv6Address :
IPv4Address            :
IPv4Gateway            :
IPv4Netmask            :
IPv6Address            :
IPv6Gateway            :
IPv6Prefix             :
IsEnabled              : False
IsCloudEnabled         : False
IsiSCSIEnabled         : False

This command specifies the InterfaceAlias parameter to disable the Data2 network interface.

Parameters

-InterfaceAlias

Specifies an interface alias. The acceptable values for this parameter are:

  • Data1
  • Data2
  • Data3
  • Data4
  • Data5
Type:HcsDisableNetInterfaces
Accepted values:Data1, Data2, Data3, Data4, Data5
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

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