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

スポンサーリンク
Windows ストア限定

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

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

Register-SCVMHost コマンドレット

名前

Register-SCVMHost

概要

仮想マシン ホストとして Vmware ESX ホストを VMM を関連付け、ホストを管理するために資格情報を指定します。

構文

Register-SCVMHost
 [-VMHost] <Host>
 [-Certificate <ClientCertificate>]
 [-Credential <VMMCredential>]
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-SshPublicKey <ClientSshPublicKey>]
 [-SshPublicKeyFile <String>]
 [-SshTcpPort <UInt32>]
 [-TCPPort <UInt32>]
 [<CommonParameters>]

説明

Register-SCVMHost コマンドレットは、VMware ESX ホストを仮想マシン ホストとして Virtual Machine Manager (VMM) に関連付け、この ESX ホストで使用する資格情報を指定します。

パラメーター

-Certificate <ClientCertificate>

セキュリティ証明書オブジェクトを指定します。

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

-Credential <VMMCredential>

資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。

PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。

Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。

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

-JobVariable <String>

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

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

-PROTipID <Guid>

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

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

-RunAsynchronously [<SwitchParameter>]

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

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

-SshPublicKey <ClientSshPublicKey>

Secure Shell (SSH) 通信で使用する公開鍵を指定します。

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

-SshPublicKeyFile <String>

ターゲット ホストとのセキュアな SSH チャネルを確立するための公開鍵ファイルへのパスを指定します。

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

-SshTcpPort <UInt32>

SSH プロトコルで使用される TCP ポート番号を指定します。

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

-TCPPort <UInt32>

TCP ポートを表す数値を指定します。

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

-VMHost <Host>

仮想マシン ホスト オブジェクトを指定します。VMM は、Hyper-V ホスト、VMware ESX ホスト、および Citrix XenServer ホストをサポートします。

各ホストの種類に関する情報について、Add-SCVMHost コマンドレットを参照してください。

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

<CommonParameters>

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

入力

出力

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

メモ

例 1 : 特定の VMware ESX ホストの資格情報を設定する

コマンド
$RunAsAccount = Get-SCRunAsAccount -Name "ESX Host Computer Acct"
$ESXHost = Get-SCVMHost -ComputerName "ESXHost02.Contoso.com"
Register-SCVMHost -VMHost $ESXHost -Credential $RunAsAccount
コマンドの説明

最初のコマンドは、Run As アカウント オブジェクト “ESX Host Computer Acct” を取得し、そのオブジェクトを $RunAsAccount 変数に格納します。

2 番目のコマンドは、ESX ホスト オブジェクト “ESXHost02.Contoso.com” を取得し、オブジェクトを $ESXHost 変数に格納します。

最後のコマンドは、VMware ESX ホストを VMM と管理対象ホストとして関連付け、$Credential に格納されている実行アカウントを使用して ESXHost02 にアクセスするように指定します。

例 2 : 特定の VMware ESX ホストの資格情報と証明書を設定する

コマンド
$RunAsAccount = Get-SCRunAsAccount -Name "ESX Host Computer Acct"
$ESXHost = Get-SCVMHost -ComputerName "ESXHost03.contoso.com"
$Cert = Get-SCCertificate -ComputerName "ESXHost03.contoso.com"
Register-SCVMHost -VMHost $ESXHost -Credential $RunAsAccount -Certificate $Cert
コマンドの説明

最初のコマンドは、Run As アカウント オブジェクト “ESX Host Computer Acct” を取得し、そのオブジェクトを $RunAsAccount 変数に格納します。この操作に必要な資格情報は、root アカウント (root/<password>)、もしくはこの ESX ホストの VirtualCenter Server で以前定義した VMware 代理管理者のアカウントです。

2 番目のコマンドは、VMware ESX ホスト オブジェクト “ESXHost03.contoso.com” を取得し、そのオブジェクトを $ESXHost 変数に格納します。

3 番目のコマンドは、Get-SCCertificate コマンドレットを用いて ESXHost03 から証明書オブジェクトを取得し、オブジェクトを $Cert 変数に格納します。

最後のコマンドは、この VMware ESX Server を VMM と管理対象ホストとして関連付け、ESXHost03 にアクセスするための資格情報が $RunAsAccount に格納されているものであることを指定します。

関連するリンク

  • Add-SCVMHost
  • Disable-SCVMHost
  • Enable-SCVMHost
  • Get-SCRunAsAccount
  • Get-SCVMHost
  • Move-SCVMHost
  • Read-SCVMHost
  • Remove-SCVMHost
  • Repair-SCVMHost
  • Restart-SCVMHost
  • Set-SCVMHost
  • Start-SCVMHost
  • Stop-SCVMHost

参考