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

スポンサーリンク

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

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

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

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

■名前

Connect-IscsiTarget

■概要

ローカルiSCSIイニシエーター間の接続を確立し、iSCSIターゲット デバイスを指定します。

■構文

Connect-IscsiTarget -NodeAddress <string> [-TargetPortalAddress <string>]
     [-TargetPortalPortNumber <uint16>] [-InitiatorPortalAddress <string>]
     [-IsDataDigest <bool>] [-IsHeaderDigest <bool>] [-IsPersistent <bool>]
     [-ReportToPnP <bool>] [-AuthenticationType <string>]
     [-IsMultipathEnabled <bool>] [-InitiatorInstanceName <string>]
     [-ChapUsername <string>] [-ChapSecret <string>] [-CimSession <CimSession[]>]
     [-ThrottleLimit <int>] [-AsJob]  [<CommonParameters>]

Connect-IscsiTarget -InputObject <ciminstance[]> [-TargetPortalAddress <string>]
     [-TargetPortalPortNumber <uint16>] [-InitiatorPortalAddress <string>]
     [-IsDataDigest <bool>] [-IsHeaderDigest <bool>] [-ReportToPnP <bool>]
     [-AuthenticationType <string>] [-IsMultipathEnabled <bool>]
     [-InitiatorInstanceName <string>] [-ChapUsername <string>]
     [-ChapSecret <string>] [-CimSession <CimSession[]>] [-ThrottleLimit <int>]
     [-AsJob]  [<CommonParameters>]

■説明

Connect-IscsiTargetコマンドレットは、指定したiSCSIターゲット デバイスの接続を開始します。

■パラメーター

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

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

-AuthenticationType <string>
ターゲットにログインするとき、使用するための認証タイプを指定します。

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

-ChapSecret <string>

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

-ChapUsername <string>

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

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

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

-InitiatorInstanceName <string>
SendTargets操作を実行されるイニシエーターの名前を指定します。指定しない場合、使用されるイニシエーターはiSCSIイニシエーター サービスをによって選択されます。

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

-InitiatorPortalAddress <string>
ポータルと関連したIPアドレス、またはDNS名を指定します。

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

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

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

-IsDataDigest <bool>
イニシエーターがターゲット ポータルへログインする際、データ ダイジェストを有効にします。このパラメーターを指定しないと、ダイジェスト設定は、イニシエーター カーネル モード ドライバーで測定されます。

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

-IsHeaderDigest <bool>
イニシエーターがターゲット ポータルへログインする際、ヘッダー ダイジェストを有効にします。このパラメーターを指定しないと、ダイジェスト設定は、イニシエーター カーネル モード ドライバーで測定されます。

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

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

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

-IsPersistent <bool>

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

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

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

-ReportToPnP <bool>
操作がPNPにレポートされることを指定します。

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

-TargetPortalAddress <string>
ターゲット ポータルのIPアドレス、もしくはDNS名を指定します。

必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 ByObject, ByNodeAddress
エイリアス名 TA
動的 false

-TargetPortalPortNumber <uint16>
ターゲット ポータルのTCP/IPポート番号を指定します。既定では、ポート番号は3260となります。

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

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

必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 ByObject, ByNodeAddress
エイリアス名 なし
動的 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#MSFT_iSCSISession
Microsoft.Management.Infrastructure.CimInstance
Microsoft.Management.Infrastructure.CimInstance#MSFT_iSCSISession

■エイリアス

なし

■メモ

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

■関連するリンク

  • MPIO
  • Storage

[参考]

スポンサーリンク
スポンサーリンク
スポンサーリンク