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

スポンサーリンク

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

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

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

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

■名前

Get-IscsiTargetPortal

■概要

検索するために指定したターゲット ポータルのリストを取得します。

■構文

Get-IscsiTargetPortal [[-TargetPortalAddress] <string[]>]
     [-InitiatorPortalAddress <string[]>] [-InitiatorInstanceName <string[]>]
     [-TargetPortalPortNumber <uint16[]>] [-IsHeaderDigest <bool[]>]
     [-IsDataDigest <bool[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <int>]
     [-AsJob] [<CommonParameters>]

Get-IscsiTargetPortal [-iSCSISession <CimInstance#MSFT_iSCSISession>]
     [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob]
     [<CommonParameters>]

Get-IscsiTargetPortal [-iSCSIConnection <CimInstance#MSFT_iSCSIConnection>]
     [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob]
     [<CommonParameters>]

Get-IscsiTargetPortal [-iSCSITarget <CimInstance#MSFT_iSCSITarget>]
     [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob]
     [<CommonParameters>]

■説明

Get-IscsiTargetPortalコマンドレットは、iSCSIターゲット ポータルに関する情報を取得します。

■パラメーター

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

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

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

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

-InitiatorInstanceName <string[]>
イニシエーター インスタンスを指定します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

■入力

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

■出力

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

■エイリアス

なし

■メモ

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

■関連するリンク

  • Get-IscsiConnection
  • Get-IscsiSession
  • Get-IscsiTarget
  • MPIO
  • Storage

[参考]