Set-IscsiServerTarget
Set-IscsiServerTarget
Modifies settings for the specified iSCSI target.
Sintaxis
Parameter Set: TargetName
Set-IscsiServerTarget [-TargetName] <String> [-Chap <PSCredential> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-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> ] [-Credential <PSCredential> ] [-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>]
Descripción detallada
The Set-IscsiServerTarget cmdlet modifies settings for the iSCSi target and returns the corresponding iSCSI Target object if the PassThru parameter is specified.
Parámetros
-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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Credential<PSCredential>
Specifies the credentials when connecting to a remote computer.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Description<String>
Specifies a description for the iSCSI target.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-EnableChap<Boolean>
Sets whether CHAP is enabled for the iSCSI target.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EnableReverseChap<Boolean>
Sets whether reverse CHAP is enabled for the iSCSI target.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EnforceIdleTimeoutDetection<Boolean>
Sets whether to enforce idle timeout detection.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-FirstBurstLength<Int32>
Sets the length of the first burst.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Los valores aceptables para este parámetro son los siguientes: DNSName, IPAddress, IPv6Address, IQN, or MACAddress.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-InputObject<IscsiServerTarget>
Accepts an iSCSI target object from the input pipeline.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MaxBurstLength<Int32>
Specifies the maximum burst length.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-MaxReceiveDataSegmentLength<Int32>
Specifies the maximum receiver data segment length.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ReceiveBufferCount<Int32>
Specifies the receiver buffer count.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-TargetIqn<Iqn>
Specifies the target iSCSI Qualified Name (IQN).
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
1 |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
- Microsoft.Iscsi.Target.Commands.IscsiServerTarget
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
- Microsoft.Iscsi.Target.Commands.IscsiServerTarget
Ejemplos
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:*"