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

スポンサーリンク

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

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

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

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

■名前

Set-IscsiVirtualDisk

■概要

指定したiSCSI仮想ディスクに対しての設定を修正します。

■構文

Set-IscsiVirtualDisk [-Path] <string> [-Description <string>] [-PassThru]
     [-Enable <bool>] [-ComputerName <string>] [-Credential <pscredential>]
     [<CommonParameters>]

Set-IscsiVirtualDisk -InputObject <IscsiVirtualDisk> [-Description <string>] [-PassThru]
     [-Enable <bool>] [-ComputerName <string>] [-Credential <pscredential>]
     [<CommonParameters>]

■説明

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

■パラメーター

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

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

-Credential <pscredential>

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

-Description <string>
iSCSI仮想ディスクに関する説明を指定します。

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

-Enable <bool>
指定されたiSCSI仮想ディスクが有効か無効かのどちらかを指定します。

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

-InputObject <IscsiVirtualDisk>
入力パイプラインからのiSCSI仮想ディスク オブジェクトを許可します。

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

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

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

-Path <string>
iSCSI仮想ディスクを関連付けている仮想ハードディスク (VHD) ファイルのパスを指定します。
このパラメーターを用いてiSCSI仮想ディスク オプジェクトをフィルターします。

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

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

■入力

System.String
System.Boolean
System.Management.Automation.PSCredential

■出力

System.Object

■エイリアス

なし

■メモ

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

■例

例1

 Set-IscsiVirtualDisk –Path &quot;E:Tempvhd1.vhd&quot; -Description &quot;disk for data&quot; 

例1:説明

この例では、「disk for data」にVHDの説明を変更しています。

例2

 Set-IscsiVirtualDisk –Path &quot;E:Tempvhd1.vhd&quot; -Enable $false 

例2:説明

この例では、パス「E:Tempvhd1.vhd」のVHDを無効にしています。

[参考]

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