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

スポンサーリンク
Microsoft Public Affiliate Program (JP)(マイクロソフトアフィリエイトプログラム)

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

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

Export-SCTemplate コマンドレット

名前

Export-SCTemplate

概要

VMM ライブラリから指定されたパスにテンプレートをエクスポートします。

構文

Export-SCTemplate
 [-ServiceTemplate] <ServiceTemplate>
 [-AllowUnencryptedTransfer]
 [-IncludeAllLibraryResources]
 [-IncludeLibraryResources <ItemBase[]>]
 [-Overwrite]
 [-Password <String>]
 -Path <String>
 [-SettingsIncludePrivate]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Export-SCTemplate
 [-VMTemplate] <Template>
 [-AllowUnencryptedTransfer]
 [-IncludeAllLibraryResources]
 [-IncludeLibraryResources <ItemBase[]>]
 [-Overwrite]
 [-Password <String>]
 -Path <String>
 [-SettingsIncludePrivate]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Export-SCTemplate コマンドレットは、Virtual Machine Manager (VMM) ライブラリから指定されたパスにテンプレートをエクスポートします。また、テンプレートが依存するライブラリ オブジェクトをエクスポートすることも可能です。

パラメーター

-AllowUnencryptedTransfer [<SwitchParameter>]

ネットワーク ファイル転送で暗号化が必要ない場合に指定します。暗号化されていないネットワーク ファイル転送を許可する場合、送信元ホストも宛先ホストも暗号化を必要としない場合にパフォーマンスが向上する可能性があります。

このパラメーターを使用するのは、次のとおり :

  • ライブラリへの暗号化されていないファイル転送を許可する。
  • 暗号化されていないファイル転送をホスト グループに、ホストグループ外に、もしくはホストグループ内で許可します。
必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-IncludeAllLibraryResources [<SwitchParameter>]

テンプレートのすべての依存関係が、テンプレートを使用して VMM ライブラリからエクスポートする場合に指定します。

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

-IncludeLibraryResources <ItemBase[]>

テンプレートと共にエクスポートされる依存ライブラリ リソースを指定します。

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

-Overwrite [<SwitchParameter>]

インポート、もしくはエクスポート操作が、同じ名前の既存のファイルを上書きする場合に指定します。もしくは、インポート操作では既存の仮想マシン テンプレートまたはサービス テンプレート オブジェクトが同じ名前で上書きする場合に指定します。

必須false
位置named
既定値False
パイプライン入力を許可する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]”
必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-ServiceTemplate <ServiceTemplate>

サービス テンプレート オブジェクトを指定します。

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

-SettingsIncludePrivate [<SwitchParameter>]

機密情報を含むテンプレート設定がインポート、もしくはエクスポート操作に含まれている場合に指定します。

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

-VMMServer <ServerConnection>

VMM サーバー オブジェクトを取得します。

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

-VMTemplate <Template>

仮想マシンを作成するために使用される VMM テンプレート オブジェクトを指定します。

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

<CommonParameters>

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

入力

出力

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

メモ

例 1 : すべての設定を含むサービス テンプレートをエクスポートする

コマンド
$ServiceTemplate = Get-SCServiceTemplate -Name "ServiceTemplate01"
Export-SCTemplate -ServiceTemplate $ServiceTemplate -Path "C:\TemplateExports" -SettingsIncludePrivate -Overwrite
コマンドの説明

最初のコマンドは、サービス テンプレート オブジェクト “ServiceTemplate01” を取得し、そのオブジェクトを $ServiceTemplate 変数に格納します。

2 番目のコマンドは、すべての設定を含む $ServiceTemplate に保存されているサービス テンプレートをエクスポートし、同じ名前の既存のテンプレート エクスポート パッケージを上書きします。

例 2 : すべての設定を含む複数のサービス テンプレートをエクスポートする

コマンド
Get-SCServiceTemplate | Export-SCTemplate -Path "C:\TemplateExports" -SettingsIncludePrivate -Overwrite
コマンドの説明

このコマンドは、Get-SCServiceTemplate コマンドレットを用いてすべてのサービス テンプレート オブジェクトを取得します。 次に、パイプライン演算子を使用してオブジェクトを Export-SCTemplateコマンドレット に送信します。このコマンドレットはテンプレートをエクスポートし、既存のファイルを上書きします。

例 3 : 依存ライブラ リリソースを含むサービステンプレートをエクスポートする

コマンド
$ServiceTemplate = Get-SCServiceTemplate -Name "ServiceTemplate01"
Export-SCTemplate -ServiceTemplate $ServiceTemplate -Path "C:\TemplateExports" -IncludeAllLibraryResources
コマンドの説明

最初のコマンドは、サービス テンプレート オブジェクト “ServiceTemplate01” を取得し、そのオブジェクトを $ServiceTemplate 変数に格納します。

2 番目のコマンドは、ServiceTemplate01 およびそれに依存するすべてのリソースを VMM ライブラリから “C:\TemplateExports” にエクスポートします。

関連するリンク

  • Get-SCServiceTemplate
  • Import-SCTemplate

参考