4.20. template

template リソースタイプは、Red Hat Virtualization 環境の仮想マシンのテンプレートリソースをすべてグループ化します。--vm-id|name および --name のみが必須のパラメーターです。任意のパラメーターが指定された場合には、テンプレートはテンプレートの作成に使用した仮想マシンからの設定を継承します。

表4.50 テンプレートのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--vm-id|name
文字列
テンプレートのベースとして使う仮想マシンへの参照
はい
はい
いいえ
--name
文字列
仮想マシンのテンプレート名
はい
はい
はい
--memory
long
仮想マシンテンプレートのメモリーサイズ (バイト)
いいえ
はい
はい
--cpu-topology-cores
整数
仮想マシンテンプレートで利用可能な CPU コアの数
いいえ
はい
はい
--high_availability-enabled
ブール値
仮想マシンのテンプレートの高可用性を有効にするには true に設定します。
いいえ
はい
はい
--os-cmdline
文字列
定義されたカーネルも使用されるカーネルコマンドラインパラメーターの文字列。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接ブートをサポートしています。
いいえ
はい
はい
--origin
文字列
仮想マシンテンプレートのベース。rhev、vmware、あるいは xen を指定します。
いいえ
はい
はい
--high_availability-priority
整数
仮想マシンテンプレートの高可用性に関する優先度の値 (起動順位) を設定します。
いいえ
はい
はい
--timezone
文字列
Windows 仮想マシンテンプレートに設定する Sysrprep タイムゾーン。GMT+00:00 などの形式を指定します。
いいえ
はい
はい
--domain-name
文字列
仮想マシンテンプレートのドメイン名
いいえ
はい
はい
--type
文字列
仮想マシンタイプを定義します。desktop または server を指定します。
いいえ
はい
はい
--stateless
ブール値
作成した仮想マシンがステートレスの場合は true に設定します。ステートレスの仮想マシンには、ブート時に作成されたスナップショットが含まれ、シャットダウン時には削除されます。これは、再起動後に状態が永続化されないことを意味します。
いいえ
はい
はい
--delete_protected
ブール値
このテンプレートから作成された仮想マシンを削除できないようにするには true に設定します。
いいえ
はい
はい
--sso-methods-method
コレクション
使用するシングルサインオンメソッドを定義します (例: --sso-methods-method method.id=GUEST_AGENT)。
いいえ
はい
はい
--rng_device-rate-bytes
整数
指定した期間ごとに消費可能なバイト数を指定します。
いいえ
はい
はい
--rng_device-rate-period
整数
期間をミリ秒単位で指定します。このフィールドに値を指定する場合は、--rng_device-rate-bytes も指定する必要があります。
いいえ
はい
はい
--rng_device-source
文字列
乱数ジェネレーターのソース。random または hwrng のいずれかを指定します。
いいえ
はい
はい
--console-enabled
ブール値
VirtIO コンソールデバイス機能を有効にするには、true に設定します。
いいえ
はい
はい
--placement_policy-affinity
文字列
テンプレートより作成された各仮想マシンの移行アフィニティー。migratable、user_migratable または pinned を指定します。
いいえ
はい
はい
--description
文字列
仮想マシンのテンプレートの説明
いいえ
はい
はい
--comment
文字列
仮想マシンのテンプレートのコメント
いいえ
はい
はい
--custom_properties-custom_property
コレクション
パラメーターとしてカスタムスクリプトに渡されるユーザー定義の環境変数セット
いいえ
はい
はい
--os-type
文字列
仮想マシンテンプレートのオペレーティングシステム
いいえ
はい
はい
--os-boot
コレクション
仮想マシンテンプレートの起動デバイス。cdrom、hd、または network を指定します。例: --os-boot boot.dev=hd
いいえ
はい
はい
--cpu-topology-sockets
整数
仮想マシンテンプレートで利用可能な CPU ソケット数
いいえ
はい
はい
--cpu_shares
整数
仮想マシンが要求可能な CPU リソースのレベルを、他の仮想マシンに対して相対的に設定する値。たとえば、優先度の低い仮想マシンは 512、優先度が中程度の仮想マシンは 1024、優先度の高い仮想マシンは 2048 に設定します。
いいえ
はい
はい
--cpu-architecture
文字列
CPU アーキテクチャーを定義します。x86_64、ppc64、undefined のいずれかを選択します。
いいえ
はい
はい
--os-kernel
文字列
作成された仮想マシンの起動用に設定されたカーネルイメージへのパス。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接のブートをサポートしています。
いいえ
はい
はい
--display-type
文字列
ディスプレイタイプを定義します。spice または vnc のいずれかを指定します。
いいえ
はい
はい
--display-monitors
整数
利用可能なディスプレイ数を定義します。
いいえ
はい
はい
--display-single_qxl_pci
ブール値
1 つの仮想 PCI デバイスを使用して複数のモニターを動作させるには、true に設定します。
いいえ
はい
はい
--display-allow_override
ブール値
テンプレートのコンソール設定の上書きを許可するには、true と指定します。
いいえ
はい
はい
--display-smartcard_enabled
ブール値
仮想マシンのスマートカード機能を有効にするには、true と指定します。
いいえ
はい
はい
--display-file_transfer_enabled
ブール値
SPICE ファイル転送を有効にするには、true に設定します。
いいえ
はい
はい
--display-copy_paste_enabled
ブール値
SPICE クリップボードのコピー＆ペーストを有効にするには、true に設定します。
いいえ
はい
はい
--display-keyboard_layout
文字列
仮想マシンのキーボードレイアウトを定義します。このオプションは VNC プロトコルを使用する場合のみ使用できます。フォーマットを指定します (例: en-US)。
いいえ
はい
はい
--os-initRd
文字列
指定のカーネルで使用される initrd イメージへのパス。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接のブートをサポートしています。
いいえ
はい
はい
--usb-enabled
ブール値
仮想マシンで USB サポートを有効にするには true に設定します。このオプションを使用できるのは、SPICE プロトコルを使用する仮想マシンのみです。
いいえ
はい
はい
--usb-type
文字列
USB サポートが有効な場合には、USB タイプを定義します。Legacy または Native のいずれかを指定します。
いいえ
はい
はい
--tunnel_migration
ブール値
libvirt を介したデータ転送を有効にするには true に設定します。トンネル転送は、より強固な暗号化アルゴリズムを使用しますが、伝送中のデータ負荷が高くなります。
いいえ
はい
はい
--migration_downtime
整数
ライブマイグレーション中に仮想マシンを停止状態にできる最大時間をミリ秒単位で定義します。
いいえ
はい
はい
--virtio_scsi-enabled
ブール値
VirtIO コンソールデバイスを仮想マシンにアタッチするには、true に設定します。
いいえ
はい
はい
--soundcard_enabled:
ブール値
サウンドカードを有効にするには、true に設定します。
いいえ
はい
はい
--vm-disks-disk
コレクション
テンプレートにアタッチされたディスクへの参照
いいえ
はい
いいえ
id=
文字列
仮想マシンのテンプレートの ID
いいえ
はい
はい
--permissions-clone
ブール値
元の仮想マシンのパーミッションをテンプレートにコピーするには、true に設定します。
いいえ
はい
はい
--version-version_name
文字列
--version-base_template-id パラメーターとともに使用します。サブテンプレート名を定義します。
いいえ
はい
はい
--version-base_template-id
文字列
ルートテンプレートとして使用するテンプレートの ID を定義します。このテンプレートをルートテンプレートのサブテンプレートとして作成する場合に使用します。
いいえ
はい
はい
--cpu-cpu_tune-vcpu_pin
コレクション
ホストの物理 CPU にピニングする仮想マシンの仮想 CPU を定義します。
いいえ
はい
はい
--serial_number-policy
文字列
仮想マシンテンプレートのシリアル番号ポリシーを定義します。host、vm、 custom のいずれかを指定します。custom を使用する場合には、 --serial_number-value でシリアル番号の値も定義してください。
いいえ
はい
はい
--serial_number-value
文字列
仮想マシンテンプレートのシリアル番号を定義します。
いいえ
はい
はい
--bios-boot_menu-enabled
ブール値
ブートメニューを有効にするには true に設定します。
いいえ
はい
はい
--cluster-id
文字列
クラスター ID を指定して、使用するクラスターを定義します。
いいえ
はい
はい
--cluster-name
文字列
クラスター名を指定して、使用するクラスターを定義します。
いいえ
はい
はい
--cpu_profile-id
文字列
使用する CPU プロファイルを定義します。list cpuprofiles コマンドで CPU プロファイル ID の全一覧を取得します。
いいえ
はい
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクの完了前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
はい
はい
--correlation_id
文字列
システム共通ロギングのアクションに対するタグ識別子。クライアントが識別子を定義しない場合は生成されます。
いいえ
はい
はい
--sso-methods-method パラメーターは、以下の表にあるサブパラメーターを利用するコレクションです。

表4.51 --sso-methods-method parameters

名前タイプ説明
method.id
文字列
使用するシングルサインオンメソッド: GUEST_AGENT
--custom_properties-custom_property パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.52 --custom_properties-custom_property パラメーター

名前タイプ説明
custom_property.name
文字列
カスタムのプロパティー名
custom_property.value
文字列
カスタムのプロパティー値
--os-boot パラメーターは、以下の表のサブパラメーターを使用するコレクションです。

表4.53 --os-boot parameters

名前タイプ説明
boot.dev
文字列
仮想マシンテンプレート用のブートデバイス。cdrom、hd、network のいずれかを指定します。
--vm-disks-disk パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.54 --vm-disks-disk パラメーター

名前タイプ説明
disk.id
文字列
仮想マシンディスクへの参照
storage_domains.storage_domain
コレクション
ディスクのストレージドメインに対しサブパラメーターセットを定義します。
--cpu-cpu_tune-vcpu_pin パラメーターは、以下の表にあるサブパラメーターを利用するコレクションです。

表4.55 --cpu-cpu_tune-vcpu_pin parameters

名前タイプ説明
vcpu_pin.vcpu
整数
割り当てる仮想 CPU 数
vcpu_pin.cpu_set
文字列
ホスト上の物理 CPU 数

例4.41 テンプレートの作成

[RHEVM shell (connected)]# add template --name MyTemplate1 --vm-name MyVM1

例4.42 テンプレートの更新

[RHEVM shell (connected)]# update template MyTemplate1 --memory 1073741824

例4.43 テンプレートの削除

[RHEVM shell (connected)]# remove template MyTemplate1
以下の表には、仮想マシンのテンプレートリソースに対するアクションをまとめています。

表4.56 仮想マシンテンプレートのアクション

アクション説明
exportテンプレートをエクスポートストレージドメインにエクスポートします。