Set-Iscsi Server Target

Module:
iscsitarget
Modifies settings for the specified iSCSI target.

Syntax 

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

Description

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

Examples

Example 1: Remove all initiators associated with a target 

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

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

Example 2: Modify a description for a target 

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

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

Example 3: Configure forward CHAP 

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

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

Example 4: Assign initiator IDs to a target 

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

This example assigns more IDs to the same target.

Example 5: Assigns a target to all initiators that attempt to connect to it 

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

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 you use this configuration. It is most useful when troubleshooting connection issues, because it removes the risk of Target-Initiator assignment errors.

Required Parameters

-InputObject

Accepts an iSCSI target object from the input pipeline.

Type: IscsiServerTarget
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetName

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

Type: String
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-Chap

Specifies the settings for Challenge Handshake Authentication Protocol (CHAP) user name and secret. Use this parameter in combination with the EnableChap parameter if the CHAP is not enabled.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Credential

Specifies the credentials when connecting to a remote computer.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Description

Specifies a description for the iSCSI target.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Enable

Determines whether the specified iSCSI target is enabled or disabled.

If you specify a value of $True, the target is enabled. If the target is already enabled, no action occurs.

If you specify a value of $False, the target is disabled. If the target is already disabled, no action occurs.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-EnableChap

Specifies whether CHAP is enabled for the iSCSI target.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableReverseChap

Specifies whether reverse CHAP is enabled for the iSCSI target.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnforceIdleTimeoutDetection

Specifies whether to enforce idle time-out detection.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FirstBurstLength

Specifies the length of the first burst.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InitiatorIds

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, a LUN is associated with the target. The format of this parameter is IdType:Value. The acceptable values for this parameter are: DNSName, IPAddress, IPv6Address, IQN, and MACAddress.

Type: InitiatorId[]
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MaxBurstLength

Specifies the maximum burst length.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MaxReceiveDataSegmentLength

Specifies the maximum receiver data segment length.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReceiveBufferCount

Specifies the receiver buffer count.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ReverseChap

Specifies the reverse CHAP user name and secret. Use this parameter in combination with the EnableReverseChap parameter if the Reverse CHAP is not enabled.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetIqn

Specifies the target iSCSI Qualified Name (IQN).

Type: Iqn
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Inputs

Microsoft.Iscsi.Target.Commands.IscsiServerTarget

Outputs

Microsoft.Iscsi.Target.Commands.IscsiServerTarget