Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-IscsiServerTarget

Set-IscsiServerTarget

microsoft.iscsi.target.commands.dll

Synopsis

Modifies settings for the specified iSCSI target.

Syntax

Set-IscsiServerTarget [-TargetName] [-Chap] [-ComputerName] [-Credential] [-Description] [-Enable] [-EnableChap] [-EnableReverseChap] [-EnforceIdleTimeoutDetection] [-FirstBurstLength] [-InitiatorIds] [-MaxBurstLength] [-MaxReceiveDataSegmentLength] [-PassThru] [-ReceiveBufferCount] [-ReverseChap] [-TargetIqn] [<CommonParameters>]

Set-IscsiServerTarget [-Chap] [-ComputerName] [-Credential] [-Description] [-Enable] [-EnableChap] [-EnableReverseChap] [-EnforceIdleTimeoutDetection] [-FirstBurstLength] [-InitiatorIds] [-MaxBurstLength] [-MaxReceiveDataSegmentLength] [-PassThru] [-ReceiveBufferCount] [-ReverseChap] [-TargetIqn] [-InputObject] [<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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Credential <PSCredential>

Specifies the credentials when connecting to a remote computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies a description for the iSCSI target.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EnableChap <Boolean>

Sets whether CHAP is enabled for the iSCSI target.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EnableReverseChap <Boolean>

Sets whether reverse CHAP is enabled for the iSCSI target.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EnforceIdleTimeoutDetection <Boolean>

Sets whether to enforce idle timeout detection.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-FirstBurstLength <Int32>

Sets the length of the first burst.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-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 this parameter is IdType:Value. The acceptable values for this parameter are:  DNSName, IPAddress, IPv6Address, IQN, or MACAddress.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <IscsiServerTarget>

Accepts an iSCSI target object from the input pipeline.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxBurstLength <Int32>

Specifies the maximum burst length.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MaxReceiveDataSegmentLength <Int32>

Specifies the maximum receiver data segment length.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ReceiveBufferCount <Int32>

Specifies the receiver buffer count.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TargetIqn <Iqn>

Specifies the target iSCSI Qualified Name (IQN).

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

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

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

Microsoft.Iscsi.Target.Commands.IscsiServerTarget

Return Type

Microsoft.Iscsi.Target.Commands.IscsiServerTarget

Notes

None

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:*"

Online Version
ConvertTo-SecureString
New-Object
Get-IscsiServerTarget
New-IscsiServerTarget
Remove-IscsiServerTarget