Set-HcsNetInterface

Set-HcsNetInterface

Sets the configuration for a single network interface by alias.

Syntax

Parameter Set: Alias
Set-HcsNetInterface [-InterfaceAlias] <HcsNetInterfaces> {Data0 | Data1 | Data2 | Data3 | Data4 | Data5} [-Controller0IPv4Address <IPAddress> ] [-Controller1IPv4Address <IPAddress> ] [-IPv4Address <IPAddress> ] [-IPv4Gateway <IPAddress> ] [-IPv4Netmask <IPAddress> ] [-IPv6Gateway <IPAddress> ] [-IPv6Prefix <String> ] [-IsCloudEnabled <Boolean]> ] [-IsiSCSIEnabled <Boolean]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Clear
Set-HcsNetInterface [-InterfaceAlias] <HcsNetInterfaces> {Data0 | Data1 | Data2 | Data3 | Data4 | Data5} [-ClearIPv4] [-ClearIPv6] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-HcsNetInterface cmdlet sets the configuration for a single network interface by alias. Controller-specific addresses, such as Controller0IPv4Address, apply only to Data0.

Parameters

-ClearIPv4

Indicates that the cmdlet removes all IPv4 addresses from a network interface. If the network interface is only configured for IPv4, this cmdlet also disables the interface.

-ClearIPv6

Indicates that the cmdlet removes all IPv6 addresses from a network interface. If the network interface is only configured for IPv6, this cmdlet also disables the interface.

-Controller0IPv4Address<IPAddress>

Specifies an IP address to directly target controller0. You can configure only the Data0 network interface with a fixed IP address for controller0. The Controller0IPv4 setting is ignored on all interfaces other than Data0.

-Controller1IPv4Address<IPAddress>

Specifies an IP address to directly target controller1. You can configure only the Data0 network interface with a fixed IP address for controller1. The Controller1IPv4 setting is ignored on all interfaces other than Data0.

-InterfaceAlias<HcsNetInterfaces>

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

-- Data0
-- Data1
-- Data2
-- Data3
-- Data4
-- Data5

-IPv4Address<IPAddress>

Specifies an IPv4 address.

-IPv4Gateway<IPAddress>

Specifies an IPv4 default gateway.

-IPv4Netmask<IPAddress>

Specifies the IPv4 prefix length in bits. This field also accepts subnet format (for example, 255.255.255.0)

-IPv6Gateway<IPAddress>

Specifies an IPv6 default gateway.

-IPv6Prefix<String>

Specifies an IPv6 prefix. When you specify this parameter, the cmdlet automatically generates an IPv6 address based on the prefix, ensures it does not have an IP conflict on the network, and sets that IPv6 address.

-IsCloudEnabled<Boolean]>

Indicates whether cloud access is enabled on an interface. If you enable cloud access, you can use an interface to send data to the cloud and communicate with the StorSimple Manager Service. Data0 must always be cloud-enabled.

-IsiSCSIEnabled<Boolean]>

Indicates whether iSCSI access is enabled on an interface.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<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: Set the IPv4 configuration for a network interface

This command sets the IPv4 configuration for the network interface specified by the InterfaceAlias parameter.

PS C:\> Set-HcsNetInterface Data2 -IPv4Address 10.1.1.30 -IPv4Gateway 10.1.1.1 -IPv4Netmask 192.168.255.0

Example 2: Set the IPv6 gateway address

This command sets the IPv6 gateway address for the network interface specified by the InterfaceAlias parameter. The IP address is automatically generated based on the IPv6Prefix parameter.

PS C:\> Set-HcsNetInterface Data2 -IPv6Prefix 2001:4898:4010:3015::/64 -IPv6Gateway 2001:4898:4010:3015::1

Example 3: Clear IPv6 settings for a network interface

This command removes IPv6 settings from the network interface specified by the InterfaceAlias parameter.

PS C:\> Set-HcsNetInterface Data2 -ClearIPv6

Example 4: Enable cloud access for a network interface

This command enables cloud access for the network interface specified by the InterfaceAlias parameter.

PS C:\> Set-HcsNetInterface Data2 -IsCloudEnabled $True

Example 5: Enable iSCSI access for a network interface

This command enables iSCSI access for the network interface specified by the InterfaceAlias parameter.

PS C:\> Set-HcsNetInterface Data2 -IsiSCSIEnabled $True

Related topics

Disable-HcsNetInterface

Enable-HcsNetInterface

Get-HcsNetInterface