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

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

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

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

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

■名前

Update-IscsiTarget

■概要

接続されているiSCSIターゲット オブジェクトに関する情報を更新します。

■構文

■説明

Update-IscsiTargetコマンドレットは、存在する接続しているiSCSIターゲットに関するキャッシュされた情報を更新します。

■パラメーター

-AsJob
バックグラウンド ジョブとして、コマンドレットを実行します。完了するまでに長時間要するコマンドを実行する場合、このパラメーターを使用します。 コマンドレットは、ジョブとして扱われるオブジェクトを返し、コマンドプロンプト上に表示します。ジョブが完了する間、セッション中で実行し続けることが可能です。ジョブを管理するために、*-Jobコマンドレットを使用済ます。ジョブの結果を得るためには、Receive-Jobコマンドレットを使用します。Windows PowerShellバックグランド ジョブに関する詳細な情報は、about_Jobsを参照してください。

-CimSession <CimSession[]>
リモート セッション内、もしくはリモート コンピューター上でコマンドレットを実行します。New-CimSessionコマンドレット、もしくはGet-CimSessionコマンドレットの出力のようなコンピューター名、もしくはセッション オブジェクトをに入力します。 既定ではローカル コンピューター上のカレント セッションとなります。

-InitiatorPort <CimInstance#MSFT_InitiatorPort>
入力として、MSFTイニシエーター ポート オブジェクトを許可します。MSFTイニシエーター ポート オブジェクトは、Get-InitiatorPortコマンドレットからの出力です。

-InputObject <CimInstance#MSFT_iSCSITarget[]>
パイプラインからのオプジェクトを入力として許可します。

-iSCSIConnection <CimInstance#MSFT_iSCSIConnection>
入力として、MSFT iSCSI接続オブジェクトを許可します。 MSFT iSCSI接続オブジェクトは、Get-IscsiConnectionコマンドレットからの出力です。

-iSCSISession <CimInstance#MSFT_iSCSISession>
入力として、MSFT iSCSIセッション オブジェクトを許可します。MSFT iSCSIセッション オブジェクトは、Get-IscsiSessionコマンドレットからの出力です。

-iSCSITargetPortal <CimInstance#MSFT_iSCSITargetPortal>
入力として、MSFT iSCSIターゲット ポータル オブジェクトを許可します。MSFT iSCSIターゲット ポータル オブジェクトは、Get-IscsiTargetPortalコマンドレットからの出力です。

-NodeAddress <string>
検索されるターゲットのIQNを指定します。

-PassThru

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

-ThrottleLimit <int>
コマンドレットを実行するために設定することができる並列実行の最大数を指定します。このパラメータが省略される、もしくは値に0が入力される場合、Windows PowerShellは、コンピューター上で動作しているCIMコマンドレットの数に基づいて、コマンドレットに対する最適のスロットル制限を計算します。スロットル制限は、現在のコマンドレットのみに適用され、セッションもしくはコンピューターには適用されません。

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

■入力

System.String[]
Microsoft.Management.Infrastructure.CimInstance
Microsoft.Management.Infrastructure.CimInstance[]

■出力

Microsoft.Management.Infrastructure.CimInstance
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_iSCSITarget

■エイリアス

なし

■メモ

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

■関連するリンク

• Get-IscsiConnection
• Get-IscsiSession
• Get-IscsiTargetPortal
• Get-InitiatorPort
• MPIO
• Storage

[参考]

• Update-IscsiTarget – Windows Server 2012
  http://technet.microsoft.com/en-us/library/hh826109.aspx
• Windows PowerShell Support for Windows Server 2012
  http://technet.microsoft.com/en-us/library/hh801904.aspx
• iSCSI Cmdlets in Windows PowerShell – Windows Server 2012
  http://technet.microsoft.com/en-us/library/hh826099.aspx