Set-IscsiServerTarget

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-IscsiServerTarget

Modifies settings for the specified iSCSI target.

Syntax

Parameter Set: TargetName
Set-IscsiServerTarget [-TargetName] <String> [-Chap <PSCredential> ] [-ComputerName <String> ] [-Description <String> ] [-Enable <Boolean> ] [-EnableChap <Boolean> ] [-EnableReverseChap <Boolean> ] [-EnforceIdleTimeoutDetection <Boolean> ] [-FirstBurstLength <Int32> ] [-InitiatorIds <InitiatorId> ] [-MaxBurstLength <Int32> ] [-MaxReceiveDataSegmentLength <Int32> ] [-PassThru] [-ReceiveBufferCount <Int32> ] [-ReverseChap <PSCredential> ] [-TargetIqn <Iqn> ] [ <CommonParameters>]

Parameter Set: InputObject
Set-IscsiServerTarget -InputObject <IscsiServerTarget> [-Chap <PSCredential> ] [-ComputerName <String> ] [-Description <String> ] [-Enable <Boolean> ] [-EnableChap <Boolean> ] [-EnableReverseChap <Boolean> ] [-EnforceIdleTimeoutDetection <Boolean> ] [-FirstBurstLength <Int32> ] [-InitiatorIds <InitiatorId> ] [-MaxBurstLength <Int32> ] [-MaxReceiveDataSegmentLength <Int32> ] [-PassThru] [-ReceiveBufferCount <Int32> ] [-ReverseChap <PSCredential> ] [-TargetIqn <Iqn> ] [ <CommonParameters>]

Detailed Description

The Set-IscsiServerTarget cmdlet modifies settings for the iSCSi target and returns the corresponding iSCSI Target object if the PassThru parameter is specified.

Parameters

-Chap<PSCredential>

Specifies the settings for CHAP user name and secret. This parameter should be used in combination with the EnableChap parameter if the Chap is not enabled.

-ComputerName<String>

Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer.
Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration.

-Description<String>

Specifies a description for the iSCSI target.

-Enable<Boolean>

Determines whether the specified iSCSI target is enabled or disabled.
If this parameter is set to True is specified, then the target is enabled. If the target is already enabled, no action occurs.
If this parameter is set to False is specified, then the target is disabled. If the target is already disabled, no action occurs.

-EnableChap<Boolean>

Sets whether CHAP is enabled for the iSCSI target.

-EnableReverseChap<Boolean>

Sets whether reverse CHAP is enabled for the iSCSI target.

-EnforceIdleTimeoutDetection<Boolean>

Sets whether to enforce idle timeout detection.

-FirstBurstLength<Int32>

Sets the length of the first burst.

-InitiatorIds<InitiatorId>

Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned.
To assign a LUN or VHD to an iSCSI initiator, an iSCSI target is first created. After the target is assigned to the initiator, then a LUN is associated with the target.
The format of the this parameter is IdType:Value.
The acceptable values for this parameter are:DNSName, IPAddress, IPv6Address, IQN, MACAddress.

-InputObject<IscsiServerTarget>

Accepts an iSCSI target object from the input pipeline.

-MaxBurstLength<Int32>

Specifies the maximum burst length.

-MaxReceiveDataSegmentLength<Int32>

Specifies the maximum receiver data segment length.

-PassThru

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.
To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

-ReceiveBufferCount<Int32>

Specifies the receiver buffer count.

-ReverseChap<PSCredential>

Sets the reverse CHAP user name and secret. This parameter should be used in combination with the EnableReverseChap parameter if the Reverse Chap is not enabled.

-TargetIqn<Iqn>

Specifies the target iSCSI Qualified Name (IQN).

-TargetName<String>

Specifies the name of the iSCSI target.
Note: The target name cannot be changed here. This parameter can be used to filter out the iSCSI Target objects.

<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.

• Microsoft.Iscsi.Target.Commands.IscsiServerTarget

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Iscsi.Target.Commands.IscsiServerTarget

Examples

EXAMPLE 1

This example removes all of the initiators that are associated with the target named Test.

PS C:\> Set-IscsiServerTarget -TargetName Test -InitiatorId @()

EXAMPLE 2

This example sets the description for a target named TargetOne to Target for initiator Appsvr.

PS C:\> Set-IscsiServerTarget –TargetName "TargetOne" -Description "Target for initiator Appsvr"

EXAMPLE 3

This example enables and sets the forward CHAP on a target named T1 with the credentials user and password.

PS C:\> $password = ConvertTo-SecureString -String "passwordpass" -AsPlainText -Force


PS C:\> $chap = New-Object -ComObject System.Management.Automation.PSCredential("user", $password)


PS C:\> Set-IscsiServerTarget –TargetName "T1" -EnableChap $true -Chap $chap

EXAMPLE 4

This example assigns more IDs to the same target.

PS C:\> Set-IscsiServerTarget -TargetName Test -InitiatorId "IPAddress:10.10.1.10","IPAddress:10.10.1.11"

EXAMPLE 5

This example assigns the target to all initiators that attempt to connect to it. Because no validation is performed the iSCSI target when an initiator makes a connection, be very cautious when using this configuration. It is most useful when troubleshooting connection issues─removing the possibility of Target-Initiator assignment errors.

PS C:\> Set-IscsiServerTarget -TargetName Test -InitiatorId "IQN:*"

Related topics

ConvertTo-SecureString

New-Object