System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Import-SCTemplate コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Import-SCTemplate」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Import-SCTemplate コマンドレット
名前
Import-SCTemplate
概要
VMM ライブラリに仮想マシン テンプレート、もしくはサービス テンプレートをインポートします。
構文
| Import-SCTemplate [-AllowUnencryptedTransfer] [-Name <String>] [-Overwrite] [-PackageMapping <PackageMapping[]>] [-Password <String>] -Path <String> [-Release <String>] [-SettingsIncludePrivate] [-SharePath <String>] [-VMMServer <ServerConnection>] [<CommonParameters>] Import-SCTemplate |
説明
Import-SCTemplate コマンドレットは、 Virtual Machine Manager (VMM) ライブラリに仮想マシン テンプレート、もしくはサービス テンプレートをインポートします。ライブラリからテンプレートをエクスポートするには、Export-SCTemplate を用います。
パラメーター
-AllowUnencryptedTransfer [<SwitchParameter>]
ネットワーク ファイル転送で暗号化が必要ない場合に指定します。暗号化されていないネットワーク ファイル転送を許可する場合、送信元ホストも宛先ホストも暗号化を必要としない場合にパフォーマンスが向上する可能性があります。
このパラメーターを使用するのは、次のとおり :
- ライブラリへの暗号化されていないファイル転送を許可する。
- 暗号化されていないファイル転送をホスト グループに、ホストグループ外に、もしくはホストグループ内で許可します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Name <String>
VMM オブジェクト名を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Overwrite [<SwitchParameter>]
インポート、もしくはエクスポート操作が、同じ名前の既存のファイルを上書きする場合に指定します。もしくは、インポート操作では既存の仮想マシン テンプレートまたはサービス テンプレート オブジェクトが同じ名前で上書きする場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PackageMapping <PackageMapping[]>
パッケージ マッピング オブジェクトの配列を返します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Password <String>
パスワードに含まれるセキュリティで保護された文字列を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Path <String>
操作に対するターゲット パスを指定します。
- フォーマット例 :
- ローカル パス : -Path “F:\”
- UNC パス : -Path “\\Library\Templates”
- ボリューム GUID パス : -Path “\\?\Volume{4703c1ea-8ae7-11db-b473-00123f7603e3}\”
- VMware ESX パス : -Path “[storage1]\MyVMwareFolderForVMs\MyVM.vmx”
- Citrix XenServer パス : -Path “Local storage[99b6212f-b63d-c676-25f9-d6c460992de7]”
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Release <String>
ライブラリ リソースのリリースを表す文字列を指定します。VMM は、ライブラリにインポートされたすべてのリソースのリリース値を自動的に作成します。リソースがインポートされた後、文字列をカスタマイズすることが可能です。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-SettingsIncludePrivate [<SwitchParameter>]
機密情報を含むテンプレート設定がインポート、もしくはエクスポート操作に含まれている場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-SharePath <String>
UNC (Universal Naming Convention) パスを使用する既存のライブラリ サーバー上の有効なライブラリ共有へのパスを指定します。
フォーマット例 : -SharePath “\\LibServer01\LibShare”
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-TemplatePackage <Package>
サービス テンプレート、仮想マシン テンプレートのシリアル化された設定を含む、エクスポートされたテンプレート パッケージを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- SCTemplate
- このコマンドレットは、SCTemplate オブジェクトを返します。
メモ
例
例 1 : エクスポートされたテンプレート パッケージをインポートする
コマンド
$Package = Get-SCTemplatePackage -Path "C:\TemplateExports\ServiceTemplate01.new.xml" Import-SCTemplate -TemplatePackage $Package -SettingsIncludePrivate
コマンドの説明
最初のコマンドは、指定されたパス “C:\TemplateExports\ServiceTemplate01.new.xml” でエクスポートされたテンプレート パッケージ オブジェクトを取得し、そのオブジェクトを $Package 変数に格納します。
2 番目のコマンドは、すべてのテンプレート設定を含め、$Package に格納されているテンプレート パッケージ オブジェクトをインポートします。
例 2 : エクスポート パッケージをインポートし、インポートされたテンプレートの新しい名前とリリースを指定する
コマンド
Import-SCTemplate -Path "C:\TemplateExports\ServiceTemplate01.new.xml" -SettingsIncludePrivate -Name "New Service Name" -Release "1.0"
コマンドの説明
このコマンドは、テンプレートのすべての設定を含む指定されたテンプレート エクスポート パッケージ “C:\TemplateExports\ServiceTemplate01.new.xml” をインポートし、インポートされたテンプレートの新しい名前 “New Service Name” とリリース “1.0” を指定しています。
例 3 : マッピングを変更している間に、エクスポートされたパッケージの一部またはすべてのリソースを持つテンプレートをインポートする
コマンド
$Mappings = New-SCPackageMapping -Path "C:\TemplateExports\VMTemplate01.xml" -PreferPackageResources
$Mapping = $Mappings | where {$_.PackageID -eq "VHD01.vhd"}
$Resource = Get-SCVirtualHardDisk -Name "VHD01.vhd"
Set-SCPackageMapping -PackageMapping $Mapping -TargetObject $Resource
Set-SCPackageMapping -PackageMapping $Mapping -PackageFile "C:\TemplateExports\Resources\VHD01.vhd"
Import-SCTemplate -Path C:\TemplateExports\VMTemplate01.xml -PackageMapping $Mapping -SharePath "\\LibServer01\Share01"
コマンドの説明
最初のコマンドは、指定されたパス “C:\TemplateExports\VMTemplate01.xml” に格納されているパッケージのパッケージ マッピング オブジェクトを作成し、そのパッケージ マッピング オブジェクトを $Mappings 変数に格納します。
2 番目のコマンド、はパッケージ ID でマッピング オブジェクトを取得し、そのオブジェクトを $Mapping 変数に格納します。
3 番目のコマンドは仮想ハード ディスク オブジェクト “VHD01.vhd” を取得し、そのオブジェクトを $Resource 変数に格納します。
4 番目のコマンドは、$Mapping に格納されているマッピングを $Resource (VHD01) に格納されているオブジェクトにバインドします。
5 番目のコマンドは、$Mapping に格納されているマッピングのパッケージ ファイルを設定します。
最後のコマンドは、指定されたパスでテンプレートをインポートします (この場合、VHD01 は “\\LibServer01\Share01” にインポートされます)。
関連するリンク
- Export-SCTemplate
- Get-SCTemplatePackage
- Get-SCVirtualHardDisk
- New-SCPackageMapping
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Import-SCTemplate (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/import-sctemplate?view=systemcenter-ps-2016