SCVMM 2016 UR5 で利用可能なコマンドレット (Update-SCVMConfiguration) について

ブログ エントリ内にアフィリエイト広告が含まれています
スポンサーリンク

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Update-SCVMConfiguration コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Update-SCVMConfiguration」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Update-SCVMConfiguration コマンドレット

名前

Update-SCVMConfiguration

概要

VMM 仮想マシンの構成オブジェクトのプロパティを更新します。

構文

Update-SCVMConfiguration
 [-VMConfiguration] <BaseVMConfiguration>
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-VMName <String>]
 [-ValidateOnly <Boolean>]
 [<CommonParameters>]

Update-SCVMConfiguration
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 -VMConfigurationList <System.Collections.Generic.List`1 [Microsoft.SystemCenter.VirtualMachineManager.BaseVMConfiguration]>
 [-VMName <String>]
 [-ValidateOnly <Boolean>]
 [<CommonParameters>]

説明

Update-SCVMConfiguration コマンドレットは、Virtual Machine Manager (VMM) 仮想マシンの構成オブジェクトのプロパティを更新します。

パラメーター

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-OnBehalfOfUser <String>

ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーとしてユーザーの代わりに設定します。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-OnBehalfOfUserRole <UserRole>

ユーザー ロールを指定します。このコマンドレットは、このパラメーターが指定するユーザー ロールの代わりに操作します。ユーザー ロール オブジェクトを取得するには、Get-SCUserRole コマンドレットを用います。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-PROTipID <Guid>

このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-RunAsynchronously [<SwitchParameter>]

ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。

必須 false
位置 named
既定値 False
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-VMConfiguration <BaseVMConfiguration>

仮想マシン構成オブジェクトを指定します。

必須 true
位置 0
既定値 None
パイプライン入力を許可する True (ByValue)
ワイルドカード文字を許可する false

-VMConfigurationList <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.BaseVMConfiguration]>

構成オブジェクト一覧を指定します。

必須 true
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-VMName <String>

物理ホスト サーバーに配置する仮想マシン名を指定します。このパラメーターを用いて、同じ名前の別の仮想マシンがそのホストにまだ展開されていないことを確認します。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-ValidateOnly <Boolean>

配置の検証が実行されているが、実際に配置が実行されていない場合に指定します。

必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

出力

  • ComputerConfig
    • このコマンドレットは、ComputerConfig オブジェクトを返します。

メモ

Get-SCVMConfiguration コマンドレットを用いて取得可能な VMM 仮想マシン構成オブジェクトが必要となります。

例

例 1 : 既存の仮想マシン構成を更新する

コマンド
$ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
$VMConfig = Get-SCVMConfiguration -ServiceConfiguration $ServiceConfig
Update-SCVMConfiguration -VMConfiguration $VMConfig[0] -ValidateOnly $True
コマンドの説明

最初のコマンドは、VMM ライブラリからサービス構成オブジェクト “Service01” を取得し、そのオブジェクトを $ServiceConfig 変数に格納します。

2 番目のコマンドは、$ServiceConfig に格納されているサービス構成の仮想マシン構成オブジェクトを取得し、その仮想マシン構成オブジェクトを $VMConfig に格納します。

最後のコマンドは、$VMConfig に格納されている最初の構成オブジェクトの ValidateOnly プロパティを True に設定します。

関連するリンク

  • Get-SCVMConfiguration
  • New-SCVMConfiguration
  • Remove-SCVMConfiguration
  • Set-SCVMConfiguration

参考

タイトルとURLをコピーしました