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

スポンサーリンク

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

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

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

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

■名前

Register-IscsiSession

■概要

入力としてセッション識別子を用いている恒久的なアクティブiSCSIセッションを登録します。

■構文

Register-IscsiSession -SessionIdentifier <string[]> [-IsMultipathEnabled <bool>]
     [-ChapUsername <string>] [-ChapSecret <string>] [-CimSession <CimSession[]>]
     [-ThrottleLimit <int>] [-AsJob] [-PassThru] [<CommonParameters>]

Register-IscsiSession -InputObject <CimInstance#MSFT_iSCSISession[]>
     [-IsMultipathEnabled <bool>] [-ChapUsername <string>] [-ChapSecret <string>]
     [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob] [-PassThru]
     [<CommonParameters>]

■説明

Register-IscsiSessionコマンドレットは、 恒久的にするために存在するiSCSIセッションを登録します。一度iSCSIセッションが登録されると、再起動時に自動で再接続を試みます。

■パラメーター

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

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名なし
動的false

-ChapSecret <string>

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名なし
動的false

-ChapUsername <string>

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名なし
動的false

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

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名Session
動的false

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

必須true
位置名前付き
パイプライン入力を許可するtrue (ByValue)
パラメーター セット名InputObject (cdxml)
エイリアス名なし
動的false

-IsMultipathEnabled <bool>
イニシエーターがMultipath I/O (MPIO)を有効にし、そしてターゲット ポータルにログイン際する際にそれらを使用するようにします。

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名Session
動的false

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

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名なし
動的false

-SessionIdentifier <string>
セッション識別子を指定します。

必須true
位置名前付き
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名BySessionIdentifier
エイリアス名なし
動的false

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

必須false
位置名前付き
パイプライン入力を許可するfalse
パラメーター セット名InputObject (cdxml), BySessionIdentifier
エイリアス名なし
動的false

<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#ROOT/Microsoft/Windows/Storage/MSFT_iSCSISession

■エイリアス

なし

■メモ

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

■関連するリンク

  • MPIO
  • Storage

[参考]