Windows Server 2012のiSCSI Targetで使用できるPowerShellコマンドレット (Set-IscsiServerTarget) について

スポンサーリンク

Windows Server 2012では、Windows Server 2008 R2からActive Directory (AD)やフェールオーバー クラスタリング (WSFC) といったサーバー管理におけるPowerShellコマンドレットが強化、および追加されました。

各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、現時点では主に英語のみで日本語の情報はあまり公開されていないようです。

ここでは、Windows Server 2012のiSCSI Targetに関するPowerShellコマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみることにしました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集、補足したものとなります)。

この記事では、「Set-IscsiServerTarget」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2012のiSCSI Targetで使用できるPowerShellコマンドレットについて」を参照)。

■名前

Set-IscsiServerTarget

■概要

指定したiSCSIターゲットに対しての設定を修正します。

■構文

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

Set-IscsiServerTarget -InputObject <IscsiServerTarget> [-TargetIqn <Iqn>]
     [-Description <string>] [-Enable <bool>] [-EnableChap <bool>]
     [-Chap <pscredential>] [-EnableReverseChap <bool>]
     [-ReverseChap <pscredential>] [-MaxReceiveDataSegmentLength <int>]
     [-FirstBurstLength <int>] [-MaxBurstLength <int>] [-ReceiveBufferCount <int>]
     [-EnforceIdleTimeoutDetection <bool>] [-InitiatorIds <InitiatorId[]>] [-PassThru]
     [-ComputerName <string>] [-Credential <pscredential>] [<CommonParameters>]

■説明

Set-IscsiServerTargetコマンドレットは、指定したiSCSIターゲットに対しての設定を修正します。 また、-PassThruパラメーターが指定された場合、対応するiSCSIターゲット オブジェクトを返します。

■パラメーター

-Chap <pscredential>
CHAPのユーザー名およびシークレットを指定します。このパラメーターはCHAPが有効でない場合、-EnableChapパラメーターを同時に使用する必要があります。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-ComputerName <string>
このコマンドレットをリモート コンピューター上を実行する場合、リモート コンピューターのコンピューター名、もしくはIPアドレスを指定します。
このコマンドレットをクラスター構成上で実行する場合、クラスター リソース グループ ネットワーク名、もしくはクラスター ノード名を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-Credential <pscredential>

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-Description <string>
iSCSIターゲットに対する説明を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-Enable <bool>

指定したiSCSIターゲットを有効にするか、無効にするかを指定します。
このパラメータが「True」で指定した場合、ターゲットは有効になります。ターゲットが既に有効にされている場合、何も実施しません。
このパラメータが「False」で指定した場合、ターゲットは無効になります。 ターゲットが既に無効にされている場合、何も実施しません。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-EnableChap <bool>
CHAPがiSCSIターゲットに対して有効にするかどうか指定します。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-EnableReverseChap <bool>
リバースCHAPがiSCSIターゲットに対して有効にするかどうか指定します。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-EnforceIdleTimeoutDetection <bool>
強制アイドル タイムアウト指定を実施するかどうかを指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-FirstBurstLength <int>
初期バースト長を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-InitiatorIds <InitiatorId[]>
iSCSIターゲットが関連付けられたiSCSIイニシエーター識別子 (ID) を指定します。
iSCSIイニシエーターによって割り当てられたiSCSI仮想ディスク オブジェクトを除外するためにこのパラメーターを使用します。
このパラメーターのフォーマットはIdType:Valueとなります。
このパラメーターで使用可能な値はDNSName、IPAddress、IPv6Address、IQN、MACAddressとなります。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-InputObject <IscsiServerTarget>
入力パイプラインからのiSCSIターゲット オブジェクトを許可します。

必須true
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject
エイリアスなし
ワイルドカード文字を許可するfalse

-MaxBurstLength <int>
最大バースト長を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-MaxReceiveDataSegmentLength <int>
受信者データ セグメント長を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-PassThru
他のコマンドレットへの入力として、パイプライン経由でインタラクティブ ウインドウからアイテムを送ります。 既定では、このコマンドレットから出力結果を取得することができません。
パイプライン経由でインタラクティブ ウインドウからアイテムを送るために、アイテムを選択、クリックし、「OK」をクリックしてください。 Shift-クリックとCtrl-クリックについては、サポートされます。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-ReceiveBufferCount <int>
受信者バッファ サイズを指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-ReverseChap <pscredential>
リザーブCHAPのユーザー名およびシークレットを指定します。このパラメーターは、 リバースCHAPが有効でない場合、-EnableReverseChapパラメーターを同時に使用する必要があります。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-TargetIqn <Iqn>
ターゲットiSCSI Qualified Name (IQN) を指定します。

必須false
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(すべて)
エイリアスなし
ワイルドカード文字を許可するfalse

-TargetName <string>
iSCSIターゲット名を指定します。
: ターゲット名はここで変更することができません。このパラメーターは、iSCSIターゲット オブジェクトを除去するために使用することが可能です。

必須true
位置1
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名TargetName
エイリアスなし
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose-Debug-ErrorAction-ErrorVariable-WarningAction-WarningVariable-OutBuffer、および-OutVariable。詳細については、「about_commonparameters」と入力してヘルプを参照してください。

■入力

System.String
Microsoft.Iscsi.Target.Commands.Iqn
System.Boolean
System.Int32
Microsoft.Iscsi.Target.Commands.InitiatorId[]
System.Management.Automation.PSCredential

■出力

System.Object

■エイリアス

なし

■メモ

このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Helpを使用してください。

■例

例1

 Set-IscsiServerTarget -TargetName Test -InitiatorId @() 

例1:説明

この例では、ターゲット名「Test」に関連付けられたイニシエーターのすべてを削除します。

例2

 Set-IscsiServerTarget –TargetName &quot;TargetOne&quot; -Description &quot;Target for initiator Appsvr&quot; 

例2:説明

この例では、ターゲット名「TargetOne」に対する説明を「Target for initiator Appsvr」として追加します。

例3

 $password = ConvertTo-SecureString -String &quot;passwordpass&quot; -AsPlainText –Force&lt;br&gt;$chap = New-Object -ComObject System.Management.Automation.PSCredential(&quot;user&quot;, $password)&lt;br&gt;Set-IscsiServerTarget –TargetName &quot;T1&quot; -EnableChap $true -Chap $chap 

例3:説明

この例では、証明書ユーザーおよびパスワードで、ターゲット名「T1」上にあるCHAPを有効化、および設定します。

例4

 Set-IscsiServerTarget -TargetName Test -InitiatorId &quot;IPAddress:10.10.1.10&quot;,&quot;IPAddress:10.10.1.11&quot; 

例4:説明

この例では、より多くのIDを同じターゲットに割り当てます。

例5

 Set-IscsiServerTarget -TargetName Test -InitiatorId &quot;IQN:*&quot; 

例5:説明

この例では、すべてのイニシエーターへターゲットを接続することを試みます。イニシエーターが接続を行う際確認がiSCSIターゲットで行えないため、この構成を行う際は注意してください。これは接続に関するトラブルシューティング、およびターゲット-イニシエーター間の割り当てエラーの可能性を除去するのにとても有用です。

[参考]