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

スポンサーリンク
Surface Pro 4

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

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

Join-SCVirtualMachine コマンドレット

名前

Join-SCVirtualMachine

概要

孤立した仮想マシンをそのサービス、もしくは仮想マシン ロールに再度関連付けします。

構文

Join-SCVirtualMachine
 [-VM] <VM>
 -ComputerTier <ComputerTier>
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [<CommonParameters>]

Join-SCVirtualMachine
 [-VM] <VM>
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 -VMRole <CloudVmRole>
 [<CommonParameters>]

説明

Join-SCVirtualMachine コマンドレットは、孤立した仮想マシンをそのサービス、もしくは仮想マシン ロールに再度関連付けします。

ホスト、もしくはクラスターが Virtual Machine Manager (VMM) から削除されると、ホストに展開されているサービス、もしくは仮想マシン ロールに所属する仮想マシンは機能し続けます。ただし、VMM にホスト、もしくはクラスターを追加すると、仮想マシンはサービスや仮想マシン ロールとの関連付けがなくなるという意味で孤立してしまいます。

このコマンドレットを使用すると、仮想マシンとそのサービス、もしくは仮想マシン ロールの関連付けを復元することができます。Join-SCVirtualMachine コマンドレットは、仮想マシンとサービス テンプレートとの互換性を確認する一連の検証を実行する VMM で再関連付けタスクを実行します。

コマンドレットが仮想マシンとコンピューター層テンプレートとの互換性を検証すると、データベースのみの操作が実行され、仮想マシンは調整されません。仮想マシンが実行されており、その上で実行されているすべてのゲスト アプリケーションとサービスが損なわれていないことが前提となります。

仮想マシンに参加するコンピューター層は、最大インスタンス数を下回る必要があります。結合操作のアップグレード ドメインはスケールアウトに似ています。

最適な結果を得るには、サービス、もしくは仮想マシン ロール展開の一部であって変更されていない仮想マシンでこのコマンドレットを使用します。

パラメーター

-ComputerTier <ComputerTier>

コンピューター層オブジェクトを指定します。

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

-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

-VM <VM>

VM オブジェクトを指定します。

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

-VMRole <CloudVmRole>

CloudVMRole オブジェクトを指定します。

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

<CommonParameters>

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

入力

出力

メモ

例 1 : 孤立した仮想マシンをサービス層に結合する

コマンド
$VM = Get-SCVirtualMachine -Name "PS-Web-001" 
$CT = Get-SCComputerTier -Name "MyService-WebTier" 
Join-SCVirtualMachine -VM $VM -ComputerTier $CT
コマンドの説明

最初のコマンドは、仮想マシン “PS-Web-001” を取得し、$VM 変数に格納します。

2 番目のコマンドは、コンピュータ層 “MyService-WebTier” を取得し、$CT 変数に格納します。

最後のコマンドは、$VM の仮想マシンを $CT のコンピュータ層に結合します。

例 2 : 孤立した仮想マシンを仮想マシン ロールに結合する

コマンド
$VM = Get-SCVirtualMachine -Name "PS-Web-001" 
$VmRole = Get-CloudResource -Name "ContosoShop" 
Join-SCVirtualMachine -VM $VM -VMRole $VmRole
コマンドの説明

最初のコマンドは、仮想マシン “PS-Web-001” を取得し、$VM 変数に格納します。

2 番目のコマンドは、クラウド リソース “ContosoShop” を取得し、$VmRole 変数に格納します。

最後のコマンドは、$VM 内の仮想マシンを $VMRole 内のロールに結合します。

関連するリンク

  • Get-SCVirtualMachine
  • Move-SCVirtualMachine
  • New-SCVirtualMachine
  • Read-SCVirtualMachine
  • Register-SCVirtualMachine
  • Remove-SCVirtualMachine
  • Repair-SCVirtualMachine
  • Reset-SCVirtualMachine
  • Resume-SCVirtualMachine
  • Save-SCVirtualMachine
  • Set-SCVirtualMachine
  • Start-SCVirtualMachine
  • Stop-SCVirtualMachine
  • Suspend-SCVirtualMachine

参考