RHEVM シェルガイド


Red Hat Virtualization 4.1

Red Hat Virtualization のコマンドラインシェルのインストールおよび使用

概要

本ガイドでは、Red Hat Virtualization Manager コマンドラインシェルをインストールして使用する方法を説明します。

第1章 CLI の使用

Red Hat Virtualization スイートはコマンドラインインターフェイス(CLI)を備えています。この CLI は、標準の Web インターフェイス以外で Red Hat Virtualization Manager に接続する手段をユーザーに提供します。CLI にはスクリプトシステムも含まれており、システム管理者がクライアントマシンを介して仮想化環境で定期的なメンテナーンスまたは反復タスクを実行するのに役立ちます。
重要
Red Hat Virtualization Manager のバージョン 4 には、Red Hat Enterprise Linux 7 用の CLI のバージョン 3.6 のビルドが含まれています。このバージョンの CLI は、Python SDK のバージョン 3.6 と、REST API のバージョン 3 の互換性モードを使用します。

1.1. CLI のインストール

Red Hat Virtualization CLI をクライアントマシンにインストールします。
  1. root ユーザーとしてクライアントマシンにログインします。
  2. コンテンツ配信ネットワークにシステムを登録します。プロンプトが表示されたら、カスタマーポータルのユーザー名とパスワードを入力します。
    # subscription-manager register
  3. Red Hat Virtualization のサブスクリプションプールを見つけ、プール ID をメモします。
    # subscription-manager list --available
  4. 前の手順で確認したプール識別子を使用して、Red Hat Virtualization のエンタイトルメントをシステムに割り当てます。
    # subscription-manager attach --pool=pool_id
  5. 必要なリポジトリーを有効にします。
    # subscription-manager repos --enable=rhel-7-server-rhv-4.1-rpms
    
  6. CLI パッケージおよび依存関係をインストールします。
    # yum install ovirt-engine-cli
    

1.2. TLS/SSL 証明書

Red Hat Virtualization Manager API には Hypertext Transfer Protocol Secure (HTTPS)が必要です。 [1] Manager の SDK や CLI コンポーネントなどのクライアントソフトウェアとの安全な対話のために。これには、Red Hat Virtualization Manager から証明書を取得し、クライアントの証明書ストアにインポートするプロセスが必要です。
重要
セキュアなネットワーク接続を使用して、Red Hat Virtualization Manager から証明書を取得します。

手順1.1 証明書の取得

以下の 3 つの方法のいずれかを使用して、Red Hat Virtualization Manager から証明書を取得し、クライアントマシンに転送することができます。
  1. 方法 1: コマンドラインツールを使用して、Manager から証明書をダウンロードします。コマンドラインツールの例には、cURLWget などがあります。これらはいずれも複数のプラットフォームで利用できます。
    1. cURL を使用している場合:
      $ curl -o rhvm.cer http://[manager-fqdn]/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA
    2. Wget を使用している場合は、以下を行います。
      $ wget -O rhvm.cer http://[manager-fqdn]/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA
  2. 方法 2: Web ブラウザーを使用して、にある証明書に移動します。
    http://[manager-fqdn]/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA
    選択したブラウザーに応じて、証明書はブラウザーのキーストアにダウンロードまたはインポートします。
    1. ブラウザーが証明書をダウンロードする場合 は、ファイルを rhvm.cer として保存します。
      ブラウザーが証明書をインポートする場合: ブラウザーの認証オプションからエクスポートし、rhvm.cer として保存します。
  3. 方法 3 - Manager にログインし、トラストストアから証明書をエクスポートし、クライアントマシンにコピーします。
    1. Manager に root ユーザーとしてログインします。
    2. Java keytool 管理ユーティリティーを使用して、トラストストアから証明書をエクスポートします。
      $ keytool -exportcert -keystore /etc/pki/ovirt-engine/.truststore -alias cacert -storepass mypass -file rhvm.cer
      これにより、rhvm.cer という名前の証明書ファイルが作成されます。
    3. scp コマンドを使用して、証明書をクライアントマシンにコピーします。
      $ scp rhvm.cer [username]@[client-machine]:[directory]
これらの各メソッドにより、クライアントマシンに rhvm.cer という名前の証明書ファイルが作成されます。API ユーザーはこのファイルをクライアントの証明書ストアにインポートします。

手順1.2 クライアントへの証明書のインポート

  • クライアントへの証明書のインポートは、クライアント自体が証明書を保存し、解釈する方法に依存します。本ガイドでは、証明書のインポート例を紹介します。Network Security Services (NSS)または Java KeyStore (JKS)を使用しないクライアントについては、証明書のインポートに関する詳細は、クライアントのドキュメントを参照してください。


[1] HTTPS は、RFC 2818 HTTP over TLS で説明されています。

1.3. .ovirtshellrc 設定

.ovirtshellrc ファイルは、ユーザーが最初に ovirt-shell に接続する際に自動的に作成され、設定される設定ファイルです。これにより、ユーザーは Red Hat Virtualization 環境に接続するためのオプションを設定できます。.ovirtshellrc ファイルは、デフォルトで /home/[user name]/.ovirtshellrc にあります。
.ovirtshellrc ファイルの設定情報は、[cli][ovirt-shell] の 2 つのセクション見出し下に置かれます。これらの見出しは、設定ファイルを解析するために必要です。
表1.1 [CLI] パラメーター
Name 説明
autoconnect
boolean
ovirt-shell セッションに自動的に接続するかどうかを切り替えます。ステータスは True または False のいずれかです。
autopage
boolean
シェルでページネーションを切り替えます。ステータスは True または False のいずれかです。
表1.2 [ovirt-shell] Parameters
Name 説明
username
string
ログインに使用するユーザー名。
timeout
integer
リクエストのタイムアウトを指定します。デフォルトは 1 です。
extended_prompt
boolean
拡張プロンプトオプションを切り替えます。これにより、シェルプロンプトのホスト名が表示されます。
url
string
Red Hat Virtualization 環境のアドレス。
insecure
boolean
CA 証明書要件を切り替えます。ステータスは True または False のいずれかです。
renew_session
boolean
期限が切れるとセッションの自動更新を切り替えます。ステータスは True または False のいずれかです。
filter
boolean
オブジェクトのフィルターリングを切り替えます。オブジェクトのフィルターリングにより、ユーザーはパーミッションに応じてオブジェクトを取得できます。管理ロールのみがフィルターリングをオフにできます。ステータスは True または False のいずれかです。
session_timeout
integer
認証セッションのタイムアウト(分単位)を指定します。正の数でなければなりません。
ca_file
string
使用するサーバー CA 証明書を指定します。
dont_validate_cert_chain
boolean
サーバー CA 証明書の検証を切り替えます。ステータスは True または False のいずれかです。
key_file
string
クライアント PEM キーファイルを指定します。
password
string
ユーザー名に使用するパスワード。
cert_file
string
クライアント PEM 証明書ファイルを指定します。

1.4. CLI の実行

以下のコマンドを使用して CLI アプリケーションを起動します。
# ovirt-shell
この ovirt-shell アプリケーションは、Red Hat Virtualization 環境のインタラクティブなシェルです。
Red Hat Virtualization Manager に接続するための URL、ユーザー名、認証局ファイル、およびパスワードは、.ovirtshellrc ファイルで設定できます。ovirt-shell コマンドは、このファイルのパラメーターを使用して Manager に接続するため、ユーザーが毎回オプションを指定する必要はありません。
または、以下の追加オプションを使用して、ユーザーは Red Hat Virtualization Manager に自動的に接続できます。
# ovirt-shell -c -l "https://[server]/ovirt-engine/api" -P [port] -u "[user@domain]" -A "[certificate]"
以下の値を置き換えてください。
  • サーバー - Red Hat Virtualization Manager のホスト名または IP アドレス。CLI は、REST API 経由で Red Hat Virtualization Manager に接続します。
  • user@domain: Red Hat Virtualization Manager にログインするユーザーのユーザー名およびディレクトリーサービスドメイン。
  • 証明書 - 認証局ファイルのパス名。
シェルによりパスワードの入力が求められます。まだ指定されていない場合は、Red Hat Virtualization Manager のユーザー名および URL の入力が求められます。
注記
.ovirtshellrc ファイルにユーザー名、パスワード、URL、および認証局ファイルを設定した場合は、追加のオプションを指定する必要はありません。
注記
この例で使用されている他のオプションは、シェルによってプロンプトが表示されるため、証明書は obligatory のみです。証明書を指定する代わりに、認証なしで接続するために--insecure オプションを使用できますが、中間者(MITM)攻撃者がサーバーのアイデンティティーを偽装できる可能性があるため、この方法は推奨されません。

ovirt-shell のオプション

-h, --help
ovirt-shell のヘルプを表示します。
-d, --debug
デバッグを有効にします。
-L URL, --url=URL
API エントリーポイント URL を指定します。
-u USERNAME, --username=USERNAME
このユーザーとして接続します。
-K KEY_FILE, --key-file=KEY_FILE
キーファイルを指定します。
-C CERT_FILE, --cert-file=CERT_FILE
証明書ファイルを指定します。
-A CA_FILE, --ca-file=CA_FILE
サーバー認証局ファイルを指定します。
-I, --insecure
CLI が認定なしで SSL 経由で接続できるようにします。このオプションは、中間者(MITM)攻撃者がサーバーのアイデンティティーを偽装できるため、注意して使用してください。
-F, --filter
ユーザーパーミッションに基づいてフィルターリングを有効にします。
-P PORT, --port=PORT
port を指定します。
-T TIMEOUT, --timeout=TIMEOUT
timeout を指定します。
-c, --connect
自動接続。
-e, --extended-prompt
シェルの拡張プロンプトオプションを有効にします。このオプションは、コマンドプロンプトに環境のホスト名を表示します。デフォルトは false です。
-e "command resource", --execute-command="command resource"
Manager に接続して、指定したコマンドだけをcommand resource;command resourceの形式で実行し、出力を STDIO に出力します。
-f FILE, --file=FILE
stdin の代わりに FILE からコマンドを読み取ります。
--kerberos
有効な Kerberos チケットを使用して、シェルへの接続を認証します。
注記
非対話型シェルを持つユーザーは、--password オプションを使用できるシェル内から Red Hat Virtualization Manager に接続できます。

1.5. CLI との対話

CLI は、コマンドラインから Red Hat Virtualization 環境を制御するためのインタラクティブなシェルです。必要なコマンドと追加のパラメーターを入力します。

例1.1 シェルコマンドの入力

[RHEVM shell (connected)]# show vm RHEL6-Server
コマンドおよびパラメーターの組み合わせの構築をサポートするため、CLI には、bash シェルと同様に TAB キーを 2 回押してコマンドとパラメーターを一覧表示および自動補完する機能が含まれています。

例1.2 コマンドおよびパラメーターの一覧表示および自動補完

空のプロンプトで double TAB を押して、利用可能なすべてのコマンドを一覧表示します。
[RHEVM shell (connected)]# TAB TAB
EOF           clear         echo          history       remove        summary       
action        connect       exit          info          shell         update        
add           console       file          list          show          
capabilities  disconnect    help          ping          status
コマンドを選択し、double TAB を押して、コマンドで利用可能な次のパラメーターセットを表示します。add コマンドでは、すべてのリソースが一覧表示されます。
[RHEVM shell (connected)]# add TAB TAB
affinitygroup  datacenter     event          group          nic
quota          label          template       vmpool         cdrom
disk           filter         host           permission     role
storagedomain  user           cluster        qos            glustervolume
network        permit         snapshot       tag            vm
double TAB は、コマンドおよびパラメーターも完了します。
[RHEVM shell (connected)]# add vm TAB TAB
comment      console-enabled     cpu-architecture  delete_protected 
description  disks-clone         display-type      io-threads
memory       name                os-type           rng_device-source 
stateless    soundcard_enabled   start_paused      timezone
[RHEVM shell (connected)]# add vm naTAB TAB
[RHEVM shell (connected)]# add vm --name
また、二重 TAB は、接頭辞を含む --name パラメーターに na を自動的にフォーマットすることに注意してください。
不完全なパラメーターが複数のパラメーターと一致する場合は、TAB を二重に一覧表示します。
[RHEVM shell (connected)]# add vTAB TAB
vmpool        vm
CLI は、shell コマンドまたは bang (!)文字のいずれかを使用して Linux コマンドを実行する機能を提供します。

例1.3 Linux シェルコマンドの実行

シェル コマンドを使用します。
[RHEVM shell (connected)]# shell ls -la
または、bang (!)文字を使用します。
[RHEVM shell (connected)]# !ls -la
Linux シェルと同様に、CLI はデータを他のコマンドやソースにパイプできます。

例1.4 CLI コマンドのパイプ

CLI データを Linux シェルコマンドにパイプします。
[RHEVM shell (connected)]# list vms --show-all | grep "Example"
name                      : Example1
name                      : Example2
name                      : ExampleEngineering
description               : An Example description
name                      : BestExampleVM
CLI データをファイルにパイプします。
[RHEVM shell (connected)]# list vms --show-all > list vms --show-all > VM_List.txt
CLI には、help コマンドを使用して各コマンドの説明と構文を提供するオンライン ヘルプ システムも含まれています。

例1.5 show コマンドのオンラインヘルプの使用

[RHEVM shell (connected)]# help show
Linux シェルから Manager に接続して、コマンドリソース " の形式で特定のコマンドを実行したり、STDIO に出力することもできます。

例1.6 Manager に接続して特定のコマンドを実行する

--execute または -E パラメーターを使用して Manager に接続し、特定のコマンドを実行します。
# ovirt-shell -c -l "https://[server]/ovirt-engine/api" -P [port] -u "[user@domain]" -A "[certificate]" -E "list vms;list hosts"
[RHEVM shell (connected)]# list vms

id         : 9e6977f4-4351-4feb-bba0-dc7c22adec30                                                                                                                                      
name       : desktop-01                                                                                                                                                                   

id         : 60b12e28-7965-4296-86bf-c991aa32c2d5                                                                                                                                      
name       : server-01                                                                                                                                                                     

[RHEVM shell (connected)]# list hosts

id         : 3598cdb9-d21b-49bd-9491-59faff89b113                                                                                                                                      
name       : Gluster                                                                                                                                                                   

id         : a0c384f9-0940-4562-9c42-4ceaadf8f1f1                                                                                                                                      
name       : Host-01                                                                                                                                                                  

id         : 593ec966-c3ea-4bdc-84ad-5dc3f9fe64c7                                                                                                                                      
name       : Host-03

1.6. コレクション

コマンドパラメーターによっては、コレクションが必要です。コレクションは、サブパラメーターデータのセットです。コレクションは、以下の構文を使用して定義されます。
[RHEVM shell (connected)]# command --param-collection {subparam1=value1;subparam2=value2;subparam3=value3;...},{subparam1=value1;subparam2=value2;subparam3=value3;...},...
コレクションのサブパラメーターは、各リソースページのリソースパラメーターリストの後に一覧表示されます。

第2章 クイックスタートの例

2.1. CLI を使用した基本的な仮想化環境の作成

本章では、基本的な Red Hat Virtualization 環境内に仮想マシンを追加する CLI の機能を示す例を紹介します。この例では、以下の前提条件を使用します。
  • ハイパーバイザーとして使用するネットワークおよび設定された Red Hat Enterprise Linux ホスト。
  • 2 つの共有を持つネットワーク化および設定された NFS ストレージサーバー:
    • /exports/data : データストレージドメイン。
    • /exports/iso : ISO ストレージドメイン。
  • ネットワークされ設定された Red Hat Virtualization Manager。
  • Red Hat Virtualization Manager またはクライアントマシンへの CLI のインストール
  • インストールする仮想マシンオペレーティングシステムを含む ISO ファイル。本章では、インストール ISO の例に Red Hat Enterprise Linux Server 6 を使用します。
注記
Red Hat Virtualization Manager は、リソースごとにグローバルに一意の識別子(GUID)を生成します。この例の識別子コードは、お使いの Red Hat Virtualization 環境の識別子コードとは異なる場合があります。

手順2.1 クイックスタートの例

  1. CLI シェルをロードし、Red Hat Virtualization Manager に接続します。
    # ovirt-shell -c --url https://[rhevm-host]/ovirt-engine/api --username [user]@[domain] --ca-file certificate/authority/path/name
  2. 環境内の全データセンターを一覧表示します。この例では、Default データセンターを使用します。
    [RHEVM shell (connected)]# list datacenters 
    
    id         : 5e3b55d8-c585-11e1-a7df-001a4a400e0d
    name       : Default
    description: The default Data Center
    
  3. すべてのホストクラスターを一覧表示し、関連するクラスター ID またはクラスター名を書き留めます。これは、ホストの追加および仮想マシンの作成時に必要になります。この例では、Default クラスターを使用して Red Hat Virtualization 環境のリソースをグループ化します。
    [RHEVM shell (connected)]# list clusters
    
    id         : 99408929-82cf-4dc7-a532-9d998063fa95
    name       : Default
    description: The default server cluster
    
  4. すべての CPU プロファイルを一覧表示し、関連する CPU プロファイル ID をメモします。これは、仮想マシンの作成時に必要になります。この例では、Default CPU プロファイルを使用します。
    [RHEVM shell (connected)]# list cpuprofiles 
    
    id         : 0000001a-001a-001a-001a-00000000035e
    name       : Default
    
  5. show-all オプションを使用してすべての論理ネットワークを一覧表示し、環境内の論理ネットワークの詳細を表示します。Red Hat Virtualization Manager は、管理トラフィック用に ovirtmgmt と呼ばれるデフォルトの論理ネットワークを作成します。この例では、Default データセンターで ovirtmgmt 論理ネットワークを使用します。
    [RHEVM shell (connected)]# list networks --show-all
    
    id            : 00000000-0000-0000-0000-000000000009
    name          : ovirtmgmt
    description   : Management Network
    data_center-id: 5e3b55d8-c585-11e1-a7df-001a4a400e0d
    mtu           : 0
    required      : True
    status-state  : operational
    stp           : False
    usages-usage  : VM
    
    
    data_center- id の値は、Default データセンターの ID と一致することに注意してください。
  6. 新しいハイパーバイザーとして、Red Hat Enterprise Linux ホストを仮想化環境に追加します。ホストは自動的にアクティベートされます。
    [RHEVM shell (connected)]# add host --name MyHost --address host.example.com --cluster-name Default --root_password p@55w0rd!
  7. NFS 共有を作成、アタッチ、およびアクティブ化することで、NFS 共有をデータストレージドメインとして追加します。NFS データストレージドメインは、データセンターに接続されたエクスポートされた NFS 共有です。仮想マシン用のストレージを提供します。storage-address および storage-path を、NFS サーバーの正しい値に置き換えてください。
    1. データストレージドメインを作成します。
      [RHEVM shell (connected)]# add storagedomain --host-name MyHost --type data --storage-type nfs --storage_format v3 --storage-address x.x.x.x --storage-path /exports/data --name DataStorage
    2. 作成したストレージドメインが利用可能であることを確認します。作成プロセスには数分かかる場合があります。status-stateアタッチされていない になったら、次のステップに進むことができます。
      [RHEVM shell (connected)]# show storagedomain DataStorage
      id             : xxxx
      name           : DataStorage
      master         : False
      status-state   : unattached
      ...
      
    3. データストレージドメインをデータセンターに接続します。ストレージドメインは自動的にアクティブ化されます。
      [RHEVM shell (connected)] # add storagedomain --datacenter-identifier Default --name DataStorage
      注記
      ストレージドメインがアクティブ化されていない場合は、以下のコマンドを使用して手動でアクティブ化します。
      [RHEVM shell (connected)]# action storagedomain DataStorage --datacenter-identifier Default activate
      
  8. NFS 共有を作成し、アタッチし、アクティベートして、ISO ストレージドメインとして NFS 共有を追加します。NFS ISO ストレージドメインは、データセンターに接続されたエクスポートされた NFS 共有です。DVD/CD-ROM ISO および仮想フロッピーディスク(VFD)イメージファイル用のストレージを提供します。storage-address および storage-path を、NFS サーバーの正しい値に置き換えてください。
    1. ISO ストレージドメインを作成します。
      [RHEVM shell (connected)]# add storagedomain --host-name MyHost --type iso --storage-type nfs --storage_format v3 --storage-address x.x.x.x --storage-path /exports/iso --name ISOStorage
    2. 作成したストレージドメインが利用可能であることを確認します。作成プロセスには時間がかかる場合があります。status-stateアタッチされていない になったら、次のステップに進むことができます。
      [RHEVM shell (connected)]# show storagedomain --name ISOStorage
      id             : xxxx
      name           : ISOStorage
      master         : False
      status-state   : unattached
      ...
      
    3. ISO ストレージドメインをデータセンターに接続します。ストレージドメインは自動的にアクティブ化されます。
      [RHEVM shell (connected)] # add storagedomain --datacenter-identifier Default --name ISOStorage
  9. 新しい仮想マシンを作成します。
    [RHEVM shell (connected)]# add vm --name MyVM --cluster-name Default --template-name Blank --memory 536870912 --os-boot boot.dev=hd --cpu_profile-id 0000001a-001a-001a-001a-00000000035e
  10. add nic コマンドを使用して、新しいネットワークインターフェイスを追加します。vm-identifier オプションを追加して、インターフェイスを MyVM のサブリソースとして、および ovirtmgmt ネットワークに接続するための network-name オプションを追加します。
    [RHEVM shell (connected)]# add nic --vm-identifier MyVM --name nic1 --network-name ovirtmgmt --bootable true
    
  11. add disk コマンドを使用して、新しい仮想ハードディスクを追加します。vm-identifier オプションを追加して、ディスクを MyVM のサブリソースとしてアタッチします。
    [RHEVM shell (connected)]# add disk --vm-identifier MyVM --provisioned_size 8589934592 --interface virtio --format cow --storage_domains-storage_domain storage_domain.name=DataStorage
  12. Manager で、仮想マシンで使用する ISO Storage ドメインに ISO イメージをアップロードします。Red Hat Virtualization Manager は、正しいユーザーパーミッションでイメージが正しいディレクトリーパスにアップロードされるように ISO アップローダーツールを提供します。
    # engine-iso-uploader --iso-domain=ISOStorage upload rhel-server-6.6-x86_64-dvd.iso
    Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
  13. CLI シェルで、list files コマンドを使用して、ストレージドメインで利用可能な ISO ファイルを一覧表示します。
    [RHEVM shell (connected)]# list files --storagedomain-identifier ISOStorage
  14. インストールメディア用の仮想 CD-ROM ドライブを追加します。vm-identifier オプションを追加して、CD-ROM を MyVM のサブリソースとしてアタッチします。
    [RHEVM shell (connected)]# add cdrom --vm-identifier MyVM --file-id rhel-server-6.6-x86_64-dvd.iso
  15. 仮想マシンを起動します。仮想環境が完了し、仮想マシンには正常に動作させるのに必要なすべてのコンポーネントが含まれます。
    [RHEVM shell (connected)]# action vm MyVM start --vm-os-boot boot.dev=cdrom
    
    vm-os-boot オプションの使用に注意してください。これにより、この最初の起動セッションでブートデバイスが cdrom に変更されます。インストール後に、仮想マシンは再起動し、ブートデバイスを hd に戻します。
  16. 特定の イベントタイプを表示するには、追加の クエリー オプションと共に list イベント を使用します。仮想マシンの start アクションは、events コレクションに複数のエントリーを追加します。
    [RHEVM shell (connected)]# list events --query "type=153"
    
    id         : 105
    description: MyVM was started by admin (Host: MyHost).
    
    type=153 クエリーは、 ユーザーが仮想マシンを起動するイベントを参照します。
  17. show event コマンドを使用して、イベントの包括的な情報を表示します。このコマンドを使用して、タイプ名前、および ID でイベントを表示でき ます
    [RHEVM shell (connected)]# show event '60'
    
    id            : 60
    description   : New Tag foo was created by admin@internal.
    code          : 432
    correlation_id: 3e4d4350
    custom_id     : -1
    flood_rate    : 30
    origin        : oVirt
    severity      : normal
    time          : 2013-07-03 10:57:43.257000+03:00
    user-id       : fdfc627c-d875-11e0-90f0-83df133b58cc
    
  18. console コマンドを使用して仮想マシンにアクセスします。
    [RHEVM shell (connected)]# console MyVM
    重要
    クライアントマシンに、仮想マシンの ディスプレイタイプ と一致するコンソールアプリケーションがインストールされていることを確認します。利用可能なプロトコルには、SPICE (デフォルト)および VNC が含まれます。

第3章 コマンド

3.1. RHEVM への接続

3.1.1. RHEVM への接続(接続)

connect コマンドは Red Hat Virtualization Manager に接続します。Red Hat Virtualization Manager に接続するための URL、ユーザー名、認証局ファイル、およびパスワードは、.ovirtshellrc ファイルで設定できます。connect コマンドは、ユーザーが毎回オプションを指定する必要がないように、このファイルのパラメーターを使用して Manager に接続します。

構文

connect [options]

注記
.ovirtshellrc ファイルにユーザー名、パスワード、URL、および認証局ファイルを設定した場合は、追加のオプションを指定する必要はありません。
表3.1 connectのオプション
オプション 説明 必須
--url Red Hat Virtualization Manager の REST API への URL。これは https://[server]/ovirt-engine/api の形式を取ります。 はい
--username Red Hat Virtualization Manager へのアクセスを試みるユーザーのユーザー名とディレクトリーサービスドメイン。これは、[username]@[domain] の形式を取ります。 はい
--password Red Hat Virtualization Manager へのアクセスを試みるユーザーのパスワード。 はい
--key-file SSL 経由で接続するためのキーファイル。 いいえ
--cert-file SSL 経由で接続するための証明書ファイル。 いいえ
--ca-file SSL 経由で接続するための認証局ファイル。 はい(--insecure が使用されていない限り)
--insecure CLI が認定なしで SSL 経由で接続できるようにします。このオプションは、中間者(MITM)攻撃者がサーバーのアイデンティティーを偽装できるため、注意して使用してください。 はい(ただし認証局が指定されていない場合のみ)
--filter ユーザーパーミッションに基づいてフィルターリングを有効にします。 いいえ
--port REST API へのコネクションのポート番号(- url の一部として指定されていない場合)。 いいえ
--timeout 接続のタイムアウト時間。 いいえ

例3.1 .ovirtshellrc が設定されていない場合の 接続 の例

[RHEVM shell (disconnected)]# connect --url "https://rhevm.example.com/ovirt-engine/api" --username "admin@exampleids.com" --password "p@55w0rd!" --ca-file "/home/user/ca.crt"

 ==========================================
 >>> connected to RHEVM manager 4.0.0.0 <<<
 ==========================================

[RHEVM shell (connected)]#
注記
証明書を指定する代わりに、認証なしで接続するために--insecure オプションを使用できますが、中間者(MITM)攻撃者がサーバーのアイデンティティーを偽装できる可能性があるため、この方法は推奨されません。

3.1.2. RHEVM からの切断(disconnect)

disconnect コマンドは、Red Hat Virtualization Manager から切断されます。

構文

disconnect

例3.2 接続解除の例

[RHEVM shell (connected)]# disconnect

  =======================================
  >>> disconnected from RHEVM manager <<<
  =======================================

[RHEVM shell (disconnected)]#

3.2. リソース

3.2.1. コレクション内のリソースの一覧表示(リスト)

list コマンドを使用して、特定タイプのリソースをすべて表示します。リストには、結果のフィルターリングを行うためのオプションの検索クエリーも含まれます。

構文

list [collection] [options]

表3.2 標準オプション の一覧 を表示します。
オプション 説明
--show-all リストされた各リソースの空でないプロパティーをすべて表示します。このオプションを指定しないと、idname、および description プロパティーのみが表示されます。
--query [QUERY] Red Hat Virtualization Manager クエリー言語に基づいてサーバー側のクエリーを使用してリストをフィルターします。
--kwargs [QUERY] クライアント側のクエリーを使用してリストをフィルターします。
--case_sensitive true|false 大文字小文字の機密性を使用して検索クエリーを照合します。
--max 表示することのできる最大結果数。
注記
リソースタイプに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.3 listの例

仮想マシンを一覧表示します。
[RHEVM shell (connected)]# list vms
すべてのプロパティーがリストされた仮想マシンを一覧表示します。
[RHEVM shell (connected)]# list vms --show-all
ステータスが 'up' の仮想マシンを一覧表示します。
[RHEVM shell (connected)]# list vms --query "status=up"
ワイルドカードを使用して、すべてのドメインの指定されたユーザー名に一致するユーザーを一覧表示します。
[RHEVM shell (connected)]# list users --query "usrname=jsmith@*"  --case_sensitive false
リスト検索構文に関するヘルプを取得します。
[RHEVM shell (connected)]# list --help

3.2.2. リソースの表示(表示)

show コマンドを使用して、リソースプロパティーを表示します。

構文

show [resource] [id|name] [options]

注記
リソースタイプに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.4 showの例

ID に基づいて仮想マシンを表示 ます。
[RHEVM shell (connected)]# show vm fcadfd5f-9a12-4a1e-bb9b-2b9d5c2e04c3
名前 に基づいて仮想マシンを表示します。
[RHEVM shell (connected)]# show vm RHEL6-Server

3.2.3. リソースの追加(追加)

add コマンドを使用して、新しいリソースを追加します。

構文

add [resource] [options]

注記
リソースタイプに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.5 追加の例

仮想マシンを作成します。
[RHEVM shell (connected)]# add vm [vm-options]
ユーザーを作成します。
[RHEVM shell (connected)]# add user [user-options]
add コマンドは、expect オプションを使用して同期(サポートされている場合)にすることができます。
[RHEVM shell (connected)]# add vm [vm-options] --expect '201-created'

3.2.4. リソースの更新(更新)

update コマンドを使用して、既存のリソースを変更します。

構文

update [resource] [id|name] [options]

注記
リソースタイプに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.6 更新の例

仮想マシンを更新します。
[RHEVM shell (connected)]# update vm RHEL6-Server [vm-options]

3.2.5. リソースの作成(削除)

remove コマンドを使用してリソースを削除します。

構文

remove [resource] [id|name] [options]

表3.3 標準オプションの 削除
オプション 説明
--async リソースの非同期削除を実行します。
--force リソースの強制削除を実行します。これにより、特定リソースのデータベースエントリーと関連付けがすべて削除されます。このアクションは、datacenter および vm リソースにのみ適用されます。
注記
リソースタイプに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.7 削除の例

仮想マシンを削除します。
[RHEVM shell (connected)]# remove vm RHEL6-Server
仮想マシンの非同期削除:
[RHEVM shell (connected)]# remove vm RHEL6-Server --async true
仮想マシンを強制的に削除します。
[RHEVM shell (connected)]# remove vm RHEL6-Server --force

3.2.6. リソースに対するアクションの実行(アクション)

action コマンドを使用して、リソースタイプに関連する特別な機能を実行します。

構文

action [resource] [id|name] [action] [options]

注記
リソースアクションに固有のオプションは、各リソースタイプの定義ページに一覧表示されます。

例3.8 アクションの例

仮想マシンの起動
[RHEVM shell (connected)]# action vm RHEL6-Server start
仮想マシンを停止します。
[RHEVM shell (connected)]# action vm RHEL6-Server stop
action コマンドは、async オプションを使用して同期(サポートされている場合)にすることができます。
[RHEVM shell (connected)]# action vm [vm-options] --async false

3.2.7. サブリソースの使用(--RESOURCE-identifier)

特定のリソースは、他のリソースのサブリソースとして機能します。つまり、サブリソースとその親リソースとの間に依存関係があることを意味します。--RESOURCE-identifier [name] オプションを使用します。ここで、RESOURCE は親リソースタイプで、親リソースのサブリソース部分をターゲットにします。

例3.9 addでサブリソースを作成する例

仮想マシンに NIC を作成します。
[RHEVM shell (connected)]# add nic --vm-identifier RHEL6-Server [nic-options]
--vm-identifier RHEL6-Server オプションを使用することに注意してください。これにより、RHEL6-Server 仮想マシンに NIC が追加されます。
仮想マシンにストレージディスクを作成します。
[RHEVM shell (connected)]# add disk --vm-identifier RHEL6-Server [user-options]
--vm-identifier RHEL6-Server オプションを使用することに注意してください。これにより、RHEL6-Server 仮想マシンにストレージディスクが追加されます。

3.3. その他のコマンド

3.3.1. ファイルの最後(EOF)

EOF コマンドを使用して、CLI シェルを Ctrl+D シーケンスで残します。

構文

EOF

例3.10 EOFの例

CLI シェルを終了します。
[RHEVM shell (connected)]# EOF

3.3.2. システム機能(ケイパビリティー)を一覧表示します。

capabilties --features コマンドを使用して、現在のバージョンのすべてのバージョン機能と新機能を一覧表示します。

構文

capabilities --features

例3.11 capabilitiesの例

現在のバージョンのシステム機能を一覧表示します。
[RHEVM shell (connected)]# capabilities --features

name                                : Search - Case Sensitivity
description                         : Ability to specify whether a search query should ignore case, by providing a URL parameter
url-parameters_set-parameter-name   : case_sensitive
url-parameters_set-parameter-context: matrix
url-parameters_set-parameter-type   : boolean
:

3.3.3. 画面の消去(clear)

clear コマンドを使用して CLI 画面をクリアします。

構文

clear

例3.12 クリアの例

画面をクリアします。
[RHEVM shell (connected)]# clear

3.3.4. 仮想マシンへの接続(コンソール)

console コマンドを使用して、仮想マシンへのグラフィカルコンソールを開きます。このコマンドは、仮想マシンの display-type パラメーターに基づいて外部 VNC または SPICE クライアントを開きます。

構文

console [vm-id|vm-name]

例3.13 コンソールの例

仮想マシンに対してグラフィカルコンソールを開きます。
[RHEVM shell (connected)]# console RHEL6-Server

3.3.6. CLI を終了します(終了)。

exit コマンドを使用して CLI を終了します。

構文

exit

例3.15 exitの例

CLI のままにしておきます。
[RHEVM shell (connected)]# exit

3.3.7. スクリプトの実行(ファイル)

file コマンドを使用して CLI スクリプトファイルを実行します。スクリプトは、実行するコマンドの一覧が含まれるプレーンテキストファイルです。

構文

file [file-location]

例3.16 ファイルの例

スクリプトファイルを実行します。
[RHEVM shell (connected)]# file /example/example-script

3.3.8. ヘルプの表示(ヘルプ)

help コマンドを使用して、CLI コマンドおよびリソースの組み合わせのヘルプを表示します。

構文

help [command] [resource] [options]

例3.17 ヘルプの例

CLI のヘルプを表示します。
[RHEVM shell (connected)]# help
add コマンドのヘルプを取得します。
[RHEVM shell (connected)]# help add
vm リソース種別で add コマンドのヘルプを取得します。
[RHEVM shell (connected)]# help add vm

3.3.9. ユーザーコマンド履歴(history)の表示

history コマンドを使用して、CLI シェルのユーザーコマンドの履歴を表示します。

構文

history

例3.18 履歴の例

ユーザーコマンド履歴を表示します。
[RHEVM shell (connected)]# history

例3.19 history --firstの例

--first n パラメーターを使用して、ユーザーコマンド履歴の最初のエントリーを表示します。
[RHEVM shell (connected)]# history --first 5

例3.20 history --lastの例

--last n パラメーターを使用して、ユーザーコマンド履歴で最後に指定したエントリーを表示します。
[RHEVM shell (connected)]# history --last 5

3.3.10. CLI 情報の表示(情報)

info コマンドを使用して、環境接続の詳細とバージョン情報を表示します。

構文

info

例3.21 infoの例

CLI 情報を表示します。
[RHEVM shell (connected)]# info

backend version: 3.1
sdk version    : 3.1.0.4
cli version    : 3.1.0.6
python version : 2.7.3.final.0

entry point    : https://www.example.com:8443/ovirt-engine/api

3.3.11. テスト接続(ping)

ping コマンドを使用して、Red Hat Virtualization Manager への接続をテストします。コマンドはリモートリソースを取得し、接続の URL、ユーザー名、およびパスワードが正しいことを確認します。

構文

ping

例3.22 pingの例

接続をテストします。
[RHEVM shell (connected)]# ping

success: RHEVM manager could be reached OK.

3.3.12. シェルコマンドの実行(シェル)

shell コマンドを使用して、Linux シェルからコマンドを実行します。このコマンドは、Red Hat Virtualization Manager シェルとともにファイル管理タスクを実行するのに役立ちます。

構文

shell [vm-id|vm-name]

例3.23 シェルの例

現在の作業ディレクトリー内のファイルを一覧表示します。
[RHEVM shell (connected)]# shell ls
ファイルを作成します。
[RHEVM shell (connected)]# shell touch example.txt
ファイルをコピーします。
[RHEVM shell (connected)]# shell cp example.txt /example-dir/.
注記
CLI は、bang (!)文字を使用して シェル の代替を提供します。以下に例を示します。
[RHEVM shell (connected)]# !touch example.txt

3.3.13. 最終ステータスの表示(ステータス)

status コマンドを使用して、最近実行したコマンドのステータスを表示します。

構文

status

例3.24 statusの例

最後のステータスを表示します。
[RHEVM shell (connected)]# status

last command status: 0 (OK)

3.3.14. システムの概要を表示します(要約)

summary コマンドを使用して、システムステータスの概要を表示します。

構文

summary

例3.25 概要の例

システムの状態を表示します。
[RHEVM shell (connected)]# summary

hosts-active          : 1
hosts-total           : 2
storage_domains-active: 2
storage_domains-total : 3
users-active          : 1
users-total           : 1
vms-active            : 1
vms-total             : 1

第4章 リソースタイプ

4.1. brick

brick リソースタイプは、Red Hat Virtualization 環境のすべての Gluster ブリックをグループ化します。
表4.1 Gluster ブリックパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--server_id
string
Gluster サーバーのアドレス。
はい
はい
いいえ
--brick_dir
string
Gluster サーバーのブリックのディレクトリー。
はい
はい
いいえ
--replica_count
integer
複製されたボリュームのファイルレプリケーション数を定義します。
いいえ
はい
いいえ
--stripe_count
Integer
ストライプ化ボリュームのストライプ数を定義します。
いいえ
はい
いいえ
以下の表は、リソースベースのコマンドの追加 glustervolume オプションを示しています。
表4.2 追加のコマンドオプション
オプション 説明
--cluster-identifier glustervolume サブリソースが含まれる クラスター への参照。
--glustervolume-identifier ブリックをサブリソースとして glustervolume に追加します。

例4.1 ブリックの作成

[RHEVM shell (connected)]# add brick --cluster-identifier Default --glustervolume-identifier GlusterVol1 --server_id="server1" --brick_dir="/exp1"

4.2. cdrom

cdrom リソースタイプは、Red Hat Virtualization 環境のすべての仮想 CD-ROM ドライブリソースをグループ化します。
表4.3 CD-ROM パラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--file-id
string
ISO ストレージドメインに存在する ISO のファイル名を定義します。
はい
はい
はい

例4.2 新規 CD-ROM の作成

[RHEVM shell (connected)]# add cdrom --vm-identifier MyVM --file-id rhel-server-6.2-x86_64-dvd.iso.iso

例4.3 CD-ROM の更新

[RHEVM shell (connected)]# update cdrom --vm-identifier MyVM --file-id rhel-server-6.3-x86_64-dvd.iso.iso

例4.4 CD-ROM の削除

[RHEVM shell (connected)]# remove cdrom --vm-identifier MyVM rhel-server-6.3-x86_64-dvd.iso.iso

4.3. cluster

クラスター リソースタイプは、Red Hat Virtualization 環境のすべてのホストクラスターリソースをグループ化します。
表4.4 クラスターパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--cpu-id
string
すべてのホストがクラスターでサポートする必要のある CPU タイプを定義するサーバー CPU 参照。
はい
はい
はい
--data_center-id|name
string
ホストクラスターのデータセンターへの参照。
はい
はい
いいえ
--name
string
ホストクラスターの名前。
はい
はい
はい
--version-major
int
クラスターのメジャーバージョン番号です。たとえば、Red Hat Virtualization 4.1 の場合、メジャーバージョンは 4 です。
はい
はい
はい
--version-minor
int
クラスターのマイナーバージョン番号。たとえば、Red Hat Virtualization 4.1 の場合、マイナーバージョンは 0 になります。
はい
はい
はい
--description
string
ホストクラスターの説明。
いいえ
はい
はい
--error_handling-on_error
string
移行do_not_migrate、および migrate_highly_available など、クラスター内のホストが動作しなくなる場合の仮想マシン処理を定義します。
いいえ
はい
はい
--gluster_service
ブール値
ステータスは true または false のいずれかです。
いいえ
はい
はい
--memory_policy-overcommit-percent
double
ホストが仮想マシンを実行できなくなる前に使用が許可されているホストメモリーの割合。KSM 下のメモリー共有により、仮想マシンは利用可能なホストメモリーよりも多くのものを使用できます。推奨値には、100 (None)、150 (サーバーロード)、および 200 (デスクトップロード)が含まれます。
いいえ
はい
はい
--memory_policy-transparent_hugepages-enabled
ブール値
THP の有効なステータスを定義します。ステータスは true または false のいずれかです。
いいえ
はい
はい
--scheduling_policy-policy
string
evenly_distributedpower_saving、または none の場合は空白など、クラスター内のホストの仮想マシンスケジューリングモード。
いいえ
はい
はい
--scheduling_policy-thresholds-duration
int
スケジューラーが起動し、負荷を別のホストに移動する前にホストがオーバーロードできる秒数。
いいえ
はい
はい
--scheduling_policy-thresholds-high
int
過負荷とみなされるまで、ホストが持つことができる最大 CPU 使用率を制御します。
いいえ
はい
はい
--scheduling_policy-thresholds-low
int
ホストの使用率が低いと見なされる前に確保できる最小の CPU 使用率を制御します。
いいえ
はい
はい
--threads_as_cores
ブール値
ホストはスレッドをコアとして扱い、ホストがホスト内のコア数よりも大きいプロセッサーコアの合計数で仮想マシンを実行できるようにします。ステータスは true または false のいずれかです。
いいえ
いいえ
いいえ
--trusted_service
ブール値
OpenAttestation サーバーを使用してホストを検証するかどうかを定義します。
いいえ
はい
はい
--virt_service
ブール値
ステータスは true または false のいずれかです。
いいえ
はい
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
string
システム間のロギングに対するアクションのタグ付け識別子。クライアントが識別子を定義しない場合は、生成されます。
いいえ
はい
いいえ

例4.5 新規クラスターの作成

[RHEVM shell (connected)]# add cluster --name Engineering --cpu-id "Intel Penryn Family" --datacenter-name Default --version-major 3 --version-minor 2

例4.6 クラスターの更新

[RHEVM shell (connected)]# update cluster Engineering --name Finance

例4.7 クラスターの削除

[RHEVM shell (connected)]# remove cluster Engineering

4.4. datacenter

datacenter リソース種別は、Red Hat Virtualization 環境内の全データセンターリソースをグループ化します。
表4.5 データセンターパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
データセンターの名前。
はい
はい
はい
--storage_type
string
iscsifcpnfslocalfsposixfs など、データセンターのストレージのタイプ。
はい
はい
はい
--version-major
int
データセンターのメジャーバージョン番号です。たとえば、Red Hat Virtualization 4.1 の場合、メジャーバージョンは 4 です。
はい
はい
はい
--version-minor
int
データセンターのマイナーバージョン番号。たとえば、Red Hat Virtualization 4.1 の場合、マイナーバージョンは 0 になります。
はい
はい
はい
--description
string
データセンターの説明。
いいえ
はい
はい
--storage_format
string
データセンターのメタデータ形式( v1v2v3 など)。
いいえ
はい
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
string
システム間のロギングに対するアクションのタグ付け識別子。クライアントが識別子を定義しない場合は、生成されます。
いいえ
はい
いいえ

例4.8 新規データセンターの作成

[RHEVM shell (connected)]# add datacenter --name Boston --storage-type nfs --version-major 3 --version-minor 2

例4.9 データセンターの更新

[RHEVM shell (connected)]# update datacenter Boston --name India

例4.10 データセンターの削除

[RHEVM shell (connected)]# remove datacenter Boston

4.5. disk

disk リソースタイプは、Red Hat Virtualization 環境のすべての仮想ハードディスクリソースをグループ化します。
表4.6 ディスクパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--provisioned_size
 int
ディスク用に予約されたストレージ容量。この領域は、ディスク サイズprovisioned_size未満であっても、ディスクが使用するために事前に割り当てられます。
はい
はい
はい
--interface
 string
ディスクのインターフェイスタイプ。ide または virtio のいずれか。
はい
はい
はい
--format
 string
基礎となるストレージフォーマット。Copy On Write (cow)は、パフォーマンスのオーバーヘッドが小さいスナップショットを許可します。Raw (raw)はスナップショットを許可しませんが、パフォーマンスが向上します。
はい
はい
はい
--size
 int
ディスクの実際のサイズ。
いいえ
はい
はい
--sparse
 ブール値
ディスクの物理ストレージを事前に割り当てない場合は True。
いいえ
はい
はい
--bootable
 ブール値
このディスクを起動可能としてマークする場合は True。
いいえ
はい
はい
--shareable
 ブール値
このディスクが共有可能な場合は True。
いいえ
はい
はい
--allow_snapshot
 ブール値
このディスクがスナップショットを許可する場合は true
いいえ
はい
はい
--propagate_errors
 ブール値
ディスクエラーによって仮想マシンを一時停止してはならない場合は True。代わりに、ディスクエラーをゲスト OS に伝播する必要があります。
いいえ
はい
はい
--wipe_after_delete
 boolean
ディスクの削除時に、ディスクの基礎となる物理ストレージがゼロにする必要がある場合は True。これによりセキュリティーが向上しますが、操作がより多くなり、削除時間が長くなる可能性があります。
いいえ
はい
はい
--storage_domains-storage_domain
 コレクション
ディスク用の特定のストレージドメインを定義します。
いいえ
はい
いいえ
--storage_domains-storage_domain パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.7 --storage_domains-storage_domain parameters
Name 説明
storage_domain.id|name
string
ディスクのストレージドメインへの参照。
以下の表は、リソースベースのコマンドの追加ディスクオプションを示しています。
表4.8 追加のコマンドオプション
オプション 説明
--vm-identifier ディスクをサブリソースとし 仮想マシンに追加します。
--alias show コマンドの使用時にディスク名を識別します。ディスク固有のクエリーには、--name パラメーターの代わりに --alias を使用します。

例4.11 新規ディスクの作成

[RHEVM shell (connected)]# add disk --name MyDisk --provisioned_size 8589934592 --interface virtio --format cow

例4.12 ストレージドメインの更新

[RHEVM shell (connected)]# update disk MyDisk --shareable true

例4.13 ストレージドメインの削除

[RHEVM shell (connected)]# remove disk MyDisk
以下の表は、仮想ディスクリソースのアクションの一覧です。
表4.9 仮想ディスクの動作
アクション 説明
activate 仮想マシンでディスクをアクティベートします。
deactivate 仮想マシンのディスクを非アクティブにします。

4.6. glustervolume

glustervolume リソースタイプは、Red Hat Virtualization 環境のすべての Gluster ストレージボリュームリソースをグループ化します。
表4.10 Gluster ボリュームパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
Gluster ボリュームの名前。
はい
はい
いいえ
--volume_type
string
Gluster ボリュームタイプを定義します。DISTRIBUTE、 REPLICA TEDISTRIBUTED_REPLICATE、STRIPE、DISTRIBUTED_STRIPE から選択します。
はい
はい
いいえ
--bricks-brick
コレクション
新しい Gluster ボリュームでは、追加および管理を行うために Gluster ブリックのセットが必要です。このパラメーターは、ブリックの詳細のコレクションを参照します。1 つ以上のブリックを指定しますが、複数の ブリックに対して複数の brick-brick パラメーターを一覧表示します。コレクションの詳細は、以下を参照してください。
はい
はい
いいえ
--transport_types
コレクション
Gluster ボリュームで利用可能なトランスポートメソッドへの参照。コレクションの詳細は、以下を参照してください。
いいえ
はい
いいえ
--replica_count
integer
複製されたボリュームのファイルレプリケーション数を定義します。
いいえ
はい
いいえ
--stripe_count
Integer
ストライプ化ボリュームのストライプ数を定義します。
いいえ
はい
いいえ
--options-option
コレクション
Gluster ボリュームのオプションへの参照。コレクションの詳細は、以下を参照してください。
いいえ
はい
いいえ
--bricks-brick パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.11 bricks-brick パラメーター
Name 説明
brick.server_id
string
Gluster サーバーのアドレス。
brick.brick_dir
string
Gluster サーバーのブリックのディレクトリー。
--transport_types パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.12 transport_types parameters
Name 説明
transport_type
string
使用するトランスポートタイプを定義します。複数のタイプに複数の transport_type パラメーターを指定します。TCP および RDMA から選択します。
--options-option パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.13 options-option parameters
Name 説明
option.name
string
Gluster オプション名。
option.value
string
Gluster オプションの値。
以下の表は、リソースベースのコマンドの追加 glustervolume オプションを示しています。
表4.14 追加のコマンドオプション
オプション 説明
--cluster-identifier Gluster ボリュームをサブリソースとして クラスター に追加します。

例4.14 2 つのブリックを持つ Gluster ボリュームの作成

[RHEVM shell (connected)]# add glustervolume --cluster-identifier Default --name GlusterVol1 --volume-type DISTRIBUTE --bricks-brick "brick.server_id=UUID,brick.brick_dir=filepath"--bricks-brick "brick.server_id=UUID,brick.brick_dir=filepath"

例4.15 Gluster ボリュームの削除

[RHEVM shell (connected)]# remove glustervolume --cluster-identifier Default --name GlusterVol1
以下の表は、Gluster ボリュームリソースのアクションの一覧です。
表4.15 Gluster ボリュームのアクション
アクション 説明
start Gluster ボリュームを使用できるようにします。
stop Gluster ボリュームを非アクティブにします。
setOption Gluster ボリュームオプションを設定します。
resetOption Gluster ボリュームオプションをデフォルトにリセットします。
resetAllOptions すべての Gluster ボリュームオプションをデフォルトにリセットします。

4.7. group

グループ リソースタイプは、Red Hat Virtualization 環境のすべての ID サービスグループを定義します。
表4.16 グループパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
グループの名前。通常は identity ディレクトリーサービス内の完全なグループパスです。
いいえ
いいえ
いいえ

例4.16 グループの作成

[RHEVM shell (connected)]# add group --name www.example.com/accounts/groups/mygroup --domain-name example.com

4.8. host

host リソース種別は、Red Hat Virtualization 環境のすべてのホストリソースをグループ化します。
表4.17 ホストパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
ホストの名前。
はい
はい
はい
--address
string
ホストの IP アドレスまたはホスト名。
はい
はい
はい
--root_password
string
ホストの root ユーザーのパスワード。
はい
はい
はい
--cluster-id|name
string
ホストを含むクラスターを定義します。
はい
はい
はい
--port
int
ホストで実行している VDSM デーモンと通信するためのポート。
いいえ
はい
はい
--storage_manager-priority
int
ストレージプールマネージャー(SPM)のホスト順序の優先度を設定します。
いいえ
はい
はい
--power_management-type
string
ホストの電源管理デバイスのタイプ。
いいえ
はい
はい
--power_management-enabled
boolean
電源管理設定が有効か無効かを示します。
いいえ
はい
はい
--power_management-address
string
電源管理デバイスのホスト名または IP アドレス。
いいえ
はい
はい
--power_management-user_name
string
電源管理用の有効なユーザー名。
いいえ
はい
はい
--power_management-password
string
電源管理用の有効で堅牢なパスワード。
いいえ
はい
はい
--power_management-options-option
コレクション
選択した power_management-type のフェンシングオプション。
いいえ
はい
はい
--reboot_after_installation
boolean
VDSM のインストール後にホストが再起動するかどうかを定義します。
いいえ
はい
いいえ
--power_management-options-option パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.18 --power_management-options-option parameters
Name 説明
option.name
string
電源管理オプション名。
option.value
string
電源管理オプションの値。

例4.17 新規ホストの作成

[RHEVM shell (connected)]# add host --name Host1 --address host1.example.com --root_password p@55w0rd! --cluster-name Default

例4.18 ホストの更新

[RHEVM shell (connected)]# update host Host1 --name Host2

例4.19 ホストの削除

[RHEVM shell (connected)]# remove host Host1
以下の表は、ホストリソースのアクションの一覧です。
表4.19 ホストアクション
アクション 説明
activate ホストをアクティブ化します。
approve ホストを承認します。
commitnetconfig ネットワーク設定を保存します。
deactivate ホストを無効にします。
fence ホストのフェンス
forceselectspm Storage Pool Manager にホストを選択します。
install ホストに VDSM をインストールします。
iscsidiscover iSCSI 検出コマンドを実行します。
iscsilogin iSCSI login コマンドを実行します。
次の表は、フェンス アクションの追加オプションを示しています。
表4.20 フェンシングオプション
オプション 説明
manual ホストを手動でフェンスします。このアクションを使用して、ホストが応答しなくなり、手動で再起動されたことを Manager に対して確認します。
restart stop、wait、status、start、wait、status、status として実装されたホストを再起動します。
start ホストの電源をオンにします。
stop ホストの電源をオフにします。
status ホストの稼働ステータスを確認します。

例4.20 ホストの再起動の確認

[RHEVM shell (connected)]# action host Host1 fence --fence_type manual

4.9. network

network リソースタイプは、Red Hat Virtualization 環境内の全論理ネットワークリソースをグループ化します。
表4.21 論理ネットワークパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--data_center-id|name
string
論理ネットワークのデータセンターへの参照。
はい
はい
いいえ
--name
string
論理ネットワークのプレーンテキスト名。
はい
はい
いいえ
--description
string
論理ネットワークの説明。
いいえ
はい
はい
--vlan-id
string
VLAN タグ。
いいえ
はい
はい
--ip-address
string
論理ネットワークのブリッジの IP アドレス。
いいえ
はい
はい
--ip-gateway
string
論理ネットワークのブリッジのゲートウェイ。
いいえ
はい
はい
--ip-netmask
string
論理ネットワークのブリッジのネットマスク。
いいえ
はい
はい
--display
boolean
論理ネットワークがディスプレイ通信の使用に使用されるかどうかを示します。true または false のいずれかに設定します。
いいえ
はい
はい
--stp
boolean
このネットワークでスパニングツリープロトコルが有効な場合は true に設定します。
いいえ
はい
はい
--mtu
int
論理ネットワークの最大伝送単位にユーザー定義の値を設定します。
いいえ
はい
はい
--usages-usage
コレクション
論理ネットワークの使用パラメーターを定義します。
いいえ
いいえ
はい
--usages-usage パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.22 usages-usage パラメーター
Name 説明
使用方法
string
ネットワークの使用種別。オプションには、VM および DISPLAY が含まれます。
以下の表は、リソースベースのコマンドの追加 ネットワーク オプションを示しています。
表4.23 追加のコマンドオプション
オプション 説明
--cluster-identifier ネットワークをサブリソースとして クラスター に追加します。

例4.21 新規ネットワークの作成

[RHEVM shell (connected)]# add network --name WebNetwork --datacenter-name Default

例4.22 既存ネットワークのクラスターへの割り当て

[RHEVM shell (connected)]# add network --name WebNetwork --datacenter-name Default --cluster-identifier Default

例4.23 ネットワークの更新

[RHEVM shell (connected)]# update network WebNetwork --name DataNetwork

例4.24 ネットワークの削除

[RHEVM shell (connected)]# remove network WebNetwork

4.10. nic

nic リソース種別は、Red Hat Virtualization 環境のネットワークインターフェイスリソースをグループ化します。これらのリソースは、ホスト と仮想マシンリソースの両方のサブリソースとして機能しますが、それぞれに対して異なる定義されます。このセクションには、それぞれのパラメーターが含まれる 2 つのテーブルが含まれます。
表4.24 ホストネットワークインターフェイスパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--network-id|name
 string
ネットワークへの参照(ある場合)。
はい
はい
はい
--name
 string
ホストネットワークインターフェイスの名前(例: eth0 )。
はい
はい
はい
--bonding-slaves-host_nic
 コレクション
ボンディングされたインターフェイスを形成するスレーブネットワークインターフェイスのコレクション。
いいえ
はい
はい
--bonding-options-option
 コレクション
ボンディングされたインターフェイスのオプション一覧。各オプションには、プロパティー の属性が含まれます。
いいえ
はい
はい
--ip-gateway
 string
ネットワークのゲートウェイの IP アドレス。
いいえ
はい
はい
--boot_protocol
 string
dhcp静的 などのホストの起動時に IP アドレスの割り当てのプロトコル。
いいえ
はい
はい
--mac
 string
インターフェイスの MAC アドレス。
いいえ
はい
はい
--ip-address
 string
インターフェイスの IP アドレス。
いいえ
はい
はい
--ip-netmask
 string
インターフェイスの IP アドレスのネットマスク。
いいえ
はい
はい
--ip-mtu
int
インターフェイスの最大伝送単位。
いいえ
いいえ
はい
表4.25 仮想マシンのネットワークインターフェイスパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--network-id|name
 string
ネットワークへの参照(ある場合)。
はい
はい
はい
--name
 string
インターフェイス名(例: eth0 )。
はい
はい
はい
--mac-address
 string
インターフェイスの MAC アドレス。
いいえ
はい
はい
--interface
 string
e1000、virtio、rtl8139、rtl8139、 rtl8139 _virtio などのインターフェイスタイプを定義します。
いいえ
はい
はい
--port_mirroring-networks-network
 コレクション
ネットワークインターフェイスからコピー(ミラー)ネットワークデータをコピーするネットワークのセットを定義します。
いいえ
はい
はい
--bonding-slaves-host_nic パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.26 --bonding-slaves-host_nic
Name 説明
host_nic.id|name
string
ボンドへの別のホスト NIC への参照。
--bonding-options-option パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.27 --bonding-options-option
Name 説明
option.name
string
ボンディングオプション名。
option.value
string
ボンディングオプションの値。
type
string
ボンディングオプションのタイプ。
--port_mirroring-networks-network パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.28 --port_mirroring-networks-network
Name 説明
network.id
string
ミラーリングするネットワークへの参照。
以下の表には、リソースベースのコマンドの追加 NIC オプションをまとめています。
表4.29 追加のコマンドオプション
オプション 説明
--host-identifier NIC をサブリソースとして ホスト に追加します。
--vm-identifier NIC をサブリソースとし 仮想マシンに追加します。

例4.25 仮想マシンでの新規ネットワークインターフェイスの作成

[RHEVM shell (connected)]# add nic --vm-identifier MyVM1 --name eth0 --network-name MyNetwork

例4.26 仮想マシンのネットワークインターフェイスの更新

[RHEVM shell (connected)]# update nic eth0 --vm-identifier MyVM1 --ip-address 10.5.68.123

例4.27 仮想マシン上のネットワークインターフェイスの削除

[RHEVM shell (connected)]# remove nic eth0 --vm-identifier MyVM1

例4.28 ホストでのネットワークボンディングの設定

[RHEVM shell (connected)]# add nic --host-identifier MyHost1 --name bond1 --network-name MyNetwork --bonding-slaves-host_nic host_nic.name=eth0 --bonding-slaves-host_nic host_nic.name=eth1

例4.29 ホストネットワークインターフェイスへの論理ネットワークの割り当て

[RHEVM shell (connected)]# action nic eth0 attach --host-identifier MyHost1 --network-name MyNetwork
以下の表には、ホスト NIC リソースのアクションをまとめています。
表4.30 ホスト NIC のアクション
アクション 説明
attach NIC をホストに接続します。
detach NIC をホストから切断します。
以下の表は、仮想マシンの NIC リソースのアクションの一覧です。
表4.31 仮想マシンの NIC アクション
アクション 説明
activate 仮想マシンで NIC をアクティベートします。
deactivate 仮想マシンの NIC を非アクティブにします。

4.11. permission

パーミッション リソースタイプは、Red Hat Virtualization 環境のすべてのパーミッションリソースをグループ化します。
表4.32 パーミッションパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--user-id, --group-id
string
パーミッションを使用したユーザーまたはグループへの参照。
はい
はい
いいえ
--role-id
string
パーミッションに割り当てるロールへの参照。
はい
はい
いいえ
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
以下の表は、リソースベースのコマンドの追加 パーミッション オプションを示しています。
表4.33 追加のコマンドオプション
オプション 説明
--cluster-identifier
パーミッションをクラスターに追加します。
--correlation-id
システム間のロギングのタグ付け識別子。
--cpuprofile-identifier
CPU プロファイルにパーミッションを追加します。
--datacenter-identifier
パーミッションをデータセンターに追加します。
--disk-identifier
パーミッションをディスクに追加します。
--diskprofile-identifier
ディスクプロファイルにパーミッションを追加します。
--host-identifier
パーミッションをホストに追加します。
--iscsibond-identifier
iSCSI ボンディングにパーミッションを追加します。
--network-identifier
パーミッションをネットワークに追加します。
--storagedomain-identifier
ストレージドメインにパーミッションを追加します。
--template-identifier
パーミッションをテンプレートに追加します。
--vm-identifier
パーミッションを仮想マシンに追加します。
--vmpool-identifier
パーミッションを仮想マシンプールに追加します。
--vnicprofile-identifier
VNIC プロファイルにパーミッションを追加します。

例4.30 新規パーミッションの作成

[RHEVM shell (connected)]# add permission --role-id 00000000-0000-0000-0000-000000000001 --user-id 8b9456ae-e2c8-426e-922d-b01bb8a805fb

4.12. permit

permit リソース種別は、Red Hat Virtualization 環境のロールの個々の permits をすべてグループ化します。
表4.34 パーミッションパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--id
string
追加する permit への参照。
はい
はい
いいえ
以下の表は、リソースベースのコマンドの追加 permit オプションを示しています。
表4.35 追加のコマンドオプション
オプション 説明
--role-identifier
permit をロールに追加します。

例4.31 新規パーミッションの作成

[RHEVM shell (connected)]# add permit --role-identifier MyRole --id 1

4.13. quotas

クォータ リソースタイプは、Red Hat Virtualization 環境のすべてのデータセンタークォータをグループ化します。
表4.36 クォータパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
クォータの名前。
はい
はい
はい
--description
string
クォータの説明。
はい
はい
はい

4.14. role

ロール リソースタイプは、Red Hat Virtualization 環境のすべての個別ロールをグループ化します。
表4.37 ロールパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
ロールの名前。
はい
はい
はい
--permits-permit
コレクション
ロールの最初の組み込むための permits のリスト。permit リソース種別に含まれる追加の permits。
はい
はい
いいえ
--description
string
ロールの説明。
いいえ
はい
はい
--administrative
ブール値
これが管理ロールの場合は true に設定します。
いいえ
はい
はい
--permits-permit パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.38 --permits-permit パラメーター
Name 説明
permit.id
string
ロールの permits に追加する permit への参照。

例4.32 新規ロールの作成

[RHEVM shell (connected)]# add role --name MyRole --permits-permit {permit.id: 1;},{permit.id: 2;)

4.15. snapshot

スナップショット リソースタイプは、Red Hat Virtualization 環境のすべての仮想マシンスナップショットリソースをグループ化します。
表4.39 スナップショットパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--description
string
スナップショットの説明。
はい
はい
いいえ
以下の表は、リソースベースのコマンドの追加スナップショットオプションを示しています。
表4.40 追加のコマンドオプション
オプション 説明
--vm-identifier ディスクをサブリソースとし 仮想マシンに追加します。

例4.33 新規スナップショットの作成

[RHEVM shell (connected)]# add snapshot --vm-identifier MyVM --description 'My Snapshot'

例4.34 ストレージドメインの削除

[RHEVM shell (connected)]# remove snapshot [snapshot_id]
以下の表は、仮想マシンスナップショットリソースのアクションの一覧です。
表4.41 仮想マシンのスナップショットアクション
アクション 説明
restore スナップショットを復元します。

4.16. 統計

統計リソース 種別 は、Red Hat Virtualization 環境のリソースの統計をグループ化します。リソース統計は、リソース識別子に基づいて一覧表示されます。
表4.42 統計的リソース識別子
オプション 説明
--brick-identifier 指定されたブリックの統計を表示するリソース識別子。
--cluster-identifier 指定されたクラスターの統計を表示するリソース識別子。
--datacenter-identifier 指定したデータセンターの統計を表示するリソース識別子。
--disk-identifier 指定された仮想ディスクの統計を表示するリソース識別子。
--glustervolume-identifier 指定された gluster ボリュームの統計を表示するリソース識別子。
--host-identifier 指定されたホストの統計を表示するリソース識別子。
--job-identifier 指定されたジョブの統計を表示するリソース識別子。
--nic-identifier 指定された NIC の統計を表示するリソース識別子。
--numanode-identifier 指定された NUMA ノードの統計を表示するリソース識別子。
--step-identifier 指定されたステップの統計を表示するリソース識別子。
--storagedomain-identifier 指定されたストレージドメインの統計を表示するリソース識別子。
--vm-identifier 指定された仮想マシンの統計を表示するリソース識別子。
list コマンドおよび関連するリソース識別子を使用して、各リソースの統計のコレクションを表示します。以下の例は、指定されたホストで利用可能な統計一覧を示しています。
[RHEVM shell (connected)]# list statistics --host-identifier Host_name|id
提供された統計 名前 または ID は、show コマンドおよびリソース識別子とともに使用して、指定された統計に関する詳細情報を表示できます。以下の例は、ホストに指定された統計の詳細を示しています。
[RHEVM shell (connected)]# show statistic statistic_name|id --host-identifier Host name|id

4.17. storageconnection

storageconnection リソースタイプを使用すると、ストレージ接続の追加、編集、および削除を行うことができます。
表4.43 ストレージ接続パラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--address
string
ストレージドメインのホスト名または IP アドレス。
はい(NFS および iSCSI のみ)
はい
はい
--correlation_id
string
ストレージ接続のタグ付け識別子。
いいえ
いいえ
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
--iqn
string
ストレージデバイスのターゲット IQN。
はい(iSCSI のみ)
はい
はい
--mount_options
string
PosixFS 共有をマウントするオプション。
いいえ
はい
はい
--nfs_retrans
integer
NFS クライアントがリクエストを完了しようとする再送信の数。
いいえ
はい
はい
--nfs_timeo
integer
NFS クライアントがリクエストが完了するまで待機する時間(デシ秒単位)。
いいえ
はい
はい
--nfs_version
string
使用される NFS のバージョン。
いいえ
はい
はい
--password
string
iSCSI ストレージドメインのターゲットにログインするための CHAP パスワード。
いいえ
はい
はい
--path
string
ストレージドメインのマウントされたファイルパス。パスは、ストレージ接続ですでに使用されているものに更新できません。
はい(NFS、ローカル、および PosixFS のみ)
はい
はい
--port
integer
iSCSI ストレージドメインに使用される TCP ポート。
はい(iSCSI のみ)
はい
はい
--storagedomain-identifier
string
ディスクのストレージドメインへの参照。
いいえ
いいえ
いいえ
--type
string
ストレージドメインのタイプ。
はい
はい
いいえ
--username
string
iSCSI ストレージドメインのターゲットにログインするための CHAP ユーザー名
いいえ
はい
はい
--vfs_type
string
PosixFS 共有の Linux 対応ファイルシステムタイプ。
はい(PosixFS のみ)
はい
はい

例4.35 新しいストレージコネクションの作成

[RHEVM shell (connected)]# add storageconnection --address storage.example.com --path /storage/nfs --type nfs

4.18. storagedomain

storagedomain リソースタイプは、Red Hat Virtualization 環境のすべてのストレージドメインリソースをグループ化します。
表4.44 ストレージドメインパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
ストレージドメインの名前。
いいえ
はい
はい
--format
ブール値
データセンターのメタデータ形式( v1v2v3 など)。
はい
はい
いいえ
--host-id|name
string
このストレージドメインを初期化するホストへの参照。このホストの唯一の制限は、指定された物理ストレージにアクセスできる必要があることです。
はい
はい
いいえ
--storage-address
string
ストレージデバイスの IP アドレスまたはホスト名。
はい
はい
いいえ
--storage-logical_unit
コレクション
ストレージデバイスの論理ユニット情報。
以下を参照してください。
はい
いいえ
--storage-mount_options
string
ストレージドメインをマウントするためのオプション。
以下を参照してください。
はい
いいえ
--storage-override_luns
ブール値
論理ユニット番号をオーバーライドするかどうかを定義します。ステータスは true または false のいずれかです。
以下を参照してください。
はい
いいえ
--storage-path
string
ストレージドメインに使用するストレージデバイスのパス。
以下を参照してください。
はい
いいえ
--storage-type
string
iscsifcpnfsglusterfslocalfsposixfs など、データセンターのストレージのタイプ。
はい
はい
いいえ
--storage-vfs_type
string
ストレージドメインのファイルシステムタイプを定義します。
以下を参照してください。
はい
いいえ
--type
string
データiso、および エクスポート を含むストレージドメインのタイプ。
はい
はい
いいえ
--storage-logical_unit パラメーターは、以下の表のすべてのサブパラメーターを必要とするコレクションです。
表4.45 storage-logical_unit parameters
Name 説明
logical_unit.address
string
ストレージデバイスを含むサーバーのアドレス。
logical_unit.port
integer
サーバーのポート番号。
logical_unit.target
string
ストレージデバイスのターゲット IQN。
logical_unit.username
string
ターゲットにログインするための CHAP ユーザー名
logical_unit.password
string
ターゲットにログインするための CHAP パスワード。
logical_unit.serial
string
ターゲットのシリアル ID。
logical_unit.vendor_id
string
ターゲットのベンダー名。
logical_unit.product_id
string
ターゲットの製品コード。
logical_unit.lun_mapping
integer
ターゲットの論理ユニット番号 デバイスマッピング。
logical_unit.portal
string
論理ユニットポータル。
logical_unit.paths
integer
論理ユニットパス。
logical_unit.id
string
論理ユニット ID への参照。
ストレージタイプ に応じて、以下のパラメーターを使用します。
表4.46 ストレージタイプのパラメーター
タイプ パラメーター
nfs
--storage-address, --storage-path
iSCSI または fcp
--storage-address, --storage-logical_unit, --storage-override_luns
glusterfs
--storage-address, --storage-path, --storage-vfs_type
local
--storage-path
posixfs
--storage-path,--storage-vfs_type,--storage-address,--storage-mount_options
以下の表は、リソースベースのコマンドの追加 storagedomain オプションを示しています。
表4.47 追加のコマンドオプション
オプション 説明
--datacenter-identifier ストレージドメインをサブリソースとして データセンター に追加します。

例4.36 ストレージボリュームの新規作成

[RHEVM shell (connected)]# add storagedomain --name DataStorage --datacenter-name Default -type data

例4.37 gluster ストレージドメインの追加

[RHEVM shell (connected)]# add storagedomain --type data --storage-type glusterfs --name RHS_01 --storage-address 192.0.2.0 --storage-path Vol_ONE --storage-vfs_type glusterfs

例4.38 ストレージドメインの更新

[RHEVM shell (connected)]# update storagedomain DataStorage --name DataStorageOld

例4.39 ストレージドメインの削除

[RHEVM shell (connected)]# remove storagedomain DataStorage
次の表に、ストレージドメインリソースのアクションを示します。
表4.48 ストレージドメインアクション
アクション 説明
activate データセンターでストレージドメインをアクティブ化します。
deactivate データセンターのストレージドメインを非アクティブにします。

4.19. tag

tag リソース種別は、Red Hat Virtualization 環境のすべてのタグをグループ化します。
表4.49 タグパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
タグの名前。
はい
はい
はい
--description
string
文字列の説明。
はい
はい
はい
--parent-name
string
タグが割り当てられている親タグへの参照。
はい
はい
はい

例4.40 新しいタグの作成

[RHEVM shell (connected)]# add tag --name MyTag --description "A virtual machine tag" --parent MyParentTag

4.20. template

テンプレート リソースタイプは、Red Hat Virtualization 環境のすべての仮想マシンテンプレートをグループ化します。--vm-id|name および --name のみが必要です。オプションのパラメーターが指定されていない場合、テンプレートはテンプレートの作成に使用される仮想マシンから設定を継承します。
表4.50 テンプレートパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--vm-id|name
string
テンプレートの基礎として使用される仮想マシンへの参照。
はい
はい
いいえ
--name
string
仮想マシンテンプレートの名前。
はい
はい
はい
--memory
long
仮想マシンテンプレートのメモリー量(バイト単位)。
いいえ
はい
はい
--cpu-topology-cores
int
仮想マシンテンプレートで利用可能な CPU コアの数。
いいえ
はい
はい
--high_availability-enabled
ブール値
仮想マシンテンプレートの高可用性を有効にするには、true に設定します。
いいえ
はい
はい
--os-cmdline
string
定義されたカーネルで使用するカーネルコマンドラインパラメーター文字列。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--origin
string
仮想マシンテンプレートの起点。2009、 vmware 、または xen を指定します。
いいえ
はい
はい
--high_availability-priority
int
各仮想マシンテンプレートの高可用性の優先度の値(つまりブート順序)を設定します。
いいえ
はい
はい
--timezone
string
Windows 仮想マシンテンプレートの Sysprep タイムゾーン設定。GMT+00:00 などの形式を指定します。
いいえ
はい
はい
--domain-name
string
仮想マシンテンプレートのドメイン名。
いいえ
はい
はい
--type
string
仮想マシンのタイプを定義します。desktop または server のいずれかを指定します。
いいえ
はい
はい
--stateless
boolean
結果の仮想マシンがステートレスの場合は true に設定します。ステートレス仮想マシンには、起動時に取得され、シャットダウン時に削除されるディスクイメージのスナップショットが含まれます。これは、再起動後の状態の変更は維持されないことを意味します。
いいえ
はい
はい
--delete_protected
boolean
このテンプレートで作成された仮想マシンを削除できないようにするには、true に設定します。
いいえ
はい
はい
--sso-methods-method
コレクション
使用されるシングルサインオンメソッドを定義します。例: --sso-methods-method method.id=GUEST_AGENT
いいえ
はい
はい
--rng_device-rate-bytes
int
期間ごとに使用できるバイト数を指定します。
いいえ
はい
はい
--rng_device-rate-period
int
期間をミリ秒単位で指定します。指定した場合は、--rng_device-rate-bytes も指定する必要があります。
いいえ
はい
はい
--rng_device-source
string
乱数ジェネレーターのソース。random または hwrng のいずれかを指定します。
いいえ
はい
はい
--console-enabled
boolean
VirtIO コンソールデバイス機能を有効にするには true に設定します。
いいえ
はい
はい
--placement_policy-affinity
string
テンプレートから作成される各仮想マシンの移行アフィニティー。migratableuser_migratable、または pin を指定し ます
いいえ
はい
はい
--description
string
仮想マシンテンプレートの説明。
いいえ
はい
はい
--comment
string
仮想マシンテンプレートのコメント。
いいえ
はい
はい
--custom_properties-custom_property
コレクション
カスタムスクリプトへのパラメーターとして渡されるユーザー定義の環境変数のセット。
いいえ
はい
はい
--os-type
string
仮想マシンテンプレートのオペレーティングシステムタイプ。
いいえ
はい
はい
--os-boot
コレクション
仮想マシンテンプレートのブートデバイス。cdromhd、または network を指定します。例: --os-boot boot.dev=hd
いいえ
はい
はい
--cpu-topology-sockets
int
仮想マシンテンプレートで利用可能な CPU ソケットの数。
いいえ
はい
はい
--cpu_shares
int
仮想マシンが他の仮想マシンと比較して要求できる CPU リソースのレベル。たとえば、優先度の低い仮想マシンの場合は 512、中優先度の仮想マシンの場合は 1024、優先度の高い仮想マシンの場合は 2048 です。
いいえ
はい
はい
--cpu-architecture
string
CPU アーキテクチャーを定義します。x86_ 64、ppc64、または undefined を指定します。
いいえ
はい
はい
--os-kernel
string
作成される仮想マシンが起動するように設定されているカーネルイメージへのパス。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--display-type
string
表示タイプを定義します。spice または vnc のいずれかを指定します。
いいえ
はい
はい
--display-monitors
int
利用可能な表示数を定義します。
いいえ
はい
はい
--display-single_qxl_pci
boolean
1 つの仮想 PCI デバイスを使用して複数のモニターを駆動するには、true に設定します。
いいえ
はい
はい
--display-allow_override
boolean
テンプレートコンソール設定の上書きを許可するには、true に設定します。
いいえ
はい
はい
--display-smartcard_enabled
boolean
仮想マシンのスマートカード機能を有効にするには true に設定します。
いいえ
はい
はい
--display-file_transfer_enabled
boolean
SPICE ファイルの転送を有効にするには true に設定します。
いいえ
はい
はい
--display-copy_paste_enabled
boolean
SPICE クリップボードのコピーと貼り付けを有効にするには true に設定します。
いいえ
はい
はい
--display-keyboard_layout
string
仮想マシンのキーボードレイアウトを定義します。このオプションは、VNC プロトコルを使用する場合にのみ使用できます。en-US などの形式を指定します。
いいえ
はい
はい
--os-initRd
string
指定したカーネルで使用する initrd イメージへのパス。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--usb-enabled
ブール値
仮想マシンで USB サポートを有効にするには、true に設定します。このオプションは、SPICE プロトコルを使用する仮想マシンでのみ利用できます。
いいえ
はい
はい
--usb-type
string
USB サポートが有効な場合は、USB タイプを定義します。Legacy または Native のいずれかを指定します。
重要
Legacy USB オプションは非推奨となり、Red Hat Virtualization 4.1 で削除されます。
いいえ
はい
はい
--tunnel_migration
boolean
libvirt デーモンでデータトランスポートを有効にするには、true に設定します。トンネル化されたトランスポートは強力な暗号化アルゴリズムを使用しますが、トランスポート時のデータ負荷を増やします。
いいえ
はい
はい
--migration_downtime
int
ライブマイグレーション中に仮想マシンがダウンできる最大ミリ秒数を定義します。
いいえ
はい
はい
--virtio_scsi-enabled
boolean
VirtIO コンソールデバイスを仮想マシンにアタッチできるようにするには、true に設定します。
いいえ
はい
はい
--soundcard_enabled:
boolean
サウンドカードを有効にするには true に設定します。
いいえ
はい
はい
--vm-disks-disk
コレクション
テンプレートに割り当てられたディスクへの参照。
いいえ
はい
いいえ
--id
string
仮想マシンテンプレートの ID。
いいえ
はい
はい
--permissions-clone
boolean
ソース仮想マシンのパーミッションをテンプレートにコピーするには、true に設定します。
いいえ
はい
はい
--version-version_name
string
--version-base_template-id パラメーターで使用されます。サブテンプレートの名前を定義します。
いいえ
はい
はい
--version-base_template-id
string
root テンプレートとして使用するテンプレート ID を定義します。このテンプレートをルートテンプレートのサブテンプレートとして作成する場合に使用します。
いいえ
はい
はい
--cpu-cpu_tune-vcpu_pin
コレクション
ホストの物理 CPU に固定する仮想マシンの仮想 CPU を定義します。
いいえ
はい
はい
--serial_number-policy
string
仮想マシンテンプレートのシリアル番号ポリシーを定義します。ホスト、仮想マシンまたカスタム を指定します。custom を使用する場合は、--serial_number-value を使用してシリアル番号の値も定義します。
いいえ
はい
はい
--serial_number-value
string
仮想マシンテンプレートのシリアル番号を定義します。
いいえ
はい
はい
--bios-boot_menu-enabled
boolean
ブートメニューを有効にするには true に設定します。
いいえ
はい
はい
--cluster-id
string
クラスター ID を指定して、使用するクラスターを定義します。
いいえ
はい
はい
--cluster-name
string
クラスター名を指定して、使用するクラスターを定義します。
いいえ
はい
はい
--cpu_profile-id
string
使用する CPU プロファイルを定義します。list cpuprofiles コマンドを使用して、 CPU プロファイル ID の完全なリストを取得します。
いいえ
はい
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
はい
はい
--correlation_id
string
システム間のロギングに対するアクションのタグ付け識別子。クライアントが識別子を定義しない場合は、生成されます。
いいえ
はい
はい
--sso-methods-method パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.51 --sso-methods-method parameters
Name 説明
method.id
string
使用されるシングルサインオンメソッド: GUEST_AGENT
--custom_properties-custom_property パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.52 --custom_properties-custom_property parameters
Name 説明
custom_property.name
string
カスタムプロパティー名。
custom_property.value
string
カスタムプロパティーの値。
--os-boot パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.53 --os-boot パラメーター
Name 説明
boot.dev
string
仮想マシンテンプレートのブートデバイス。cdromhd、または network を指定します。
--vm-disks-disk パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.54 --vm-disks-disk parameters
Name 説明
disk.id
string
仮想ディスクへの参照。
storage_domains.storage_domain
コレクション
ディスクのストレージドメインのサブパラメーターのセットを定義します。
--cpu-cpu_tune-vcpu_pin パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.55 --cpu-cpu_tune-vcpu_pin parameters
Name 説明
vcpu_pin.vcpu
int
割り当てる仮想 CPU。
vcpu_pin.cpu_set
string
ホスト上の物理 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 テンプレートをエクスポートストレージドメインにエクスポートします。

4.21. user

ユーザー リソースタイプは、Red Hat Virtualization 環境のすべてのユーザーをグループ化します。
表4.57 ユーザーパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--user_name
string
ディレクトリーサービスからのユーザー名。
はい
はい
いいえ
--domain-id|name
string
ディレクトリーサービスドメインへの参照。
はい
はい
いいえ

例4.44 新規ユーザーの作成

[RHEVM shell (connected)]# add user --user_name jsmith --domain-name example.com

4.22. vm

vm リソース種別は、Red Hat Virtualization 環境内のすべての仮想マシンリソースをグループ化します。
表4.58 仮想マシンのパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
仮想マシンの名前
はい
はい
はい
--template-id|name
string
仮想マシンのベースとして使用されるテンプレートへの参照。
はい
はい
いいえ
--cluster-id|name
string
この仮想マシンを含むクラスターへの参照。
はい
はい
はい
--instance_type-id|name
string
インスタンスタイプを定義します。カスタム,large,medium,small,tiny, xlarge を指定します。
いいえ
はい
はい
--quota-id
string
仮想マシンのクォータ使用状況への参照。
いいえ
はい
いいえ
--timezone
string
Windows 仮想マシンの Sysprep タイムゾーン設定。
いいえ
はい
はい
--os-boot
コレクション
仮想マシンのブートデバイス。cdromhd、または network を指定します。
いいえ
はい
はい
--custom_properties-custom_property
コレクション
カスタムスクリプトへのパラメーターとして渡されるユーザー定義の環境変数のセット。
いいえ
はい
はい
--os-type
string
この仮想マシンのオペレーティングシステムタイプ。
いいえ
はい
はい
--usb-enabled
boolean
仮想マシンの USB ポリシーを定義します。仮想マシンで USB を有効にするには、true に設定します。
いいえ
はい
はい
--usb-type
string
有効な場合は USB タイプを定義します。
いいえ
はい
はい
--type
string
仮想マシンのタイプを定義します。desktop または server のいずれかを指定します。
いいえ
はい
はい
--os-initRd
string
指定したカーネルで使用する initrd イメージへのパス。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--display-monitors
int
利用可能な表示数を定義します。
いいえ
はい
はい
--display-single_qxl_pci
boolean
1 つの仮想 PCI デバイスを使用して複数のモニターを駆動するには、true に設定します。
いいえ
はい
はい
--display-type
string
表示タイプを定義します。spice または vnc のいずれかを指定します。
いいえ
はい
はい
--display-allow_override
boolean
仮想マシンのコンソール設定の上書きを許可するには、true に設定します。
いいえ
はい
はい
--display-smartcard_enabled
boolean
スマートカード機能を有効にするには true に設定します。
いいえ
はい
はい
--display-file_transfer_enabled
boolean
SPICE ファイルの転送を有効にするには true に設定します。
いいえ
はい
はい
--display-copy_paste_enabled
boolean
SPICE クリップボードのコピーと貼り付けを有効にするには true に設定します。
いいえ
はい
はい
--display-keyboard_layout
string
仮想マシンのキーボードレイアウトを定義します。このオプションは、VNC プロトコルを使用する場合にのみ使用できます。en-US などの形式を指定します。
いいえ
はい
はい
--os-cmdline
string
定義されたカーネルで使用するカーネルコマンドラインパラメーター文字列。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--cpu-topology-cores
int
仮想マシンで利用可能な CPU コアの数。
いいえ
はい
はい
--cpu-architecture
string
CPU アーキテクチャーを定義します。x86_ 64、ppc64、または undefined を指定します。
いいえ
はい
はい
--memory
long
仮想マシンのメモリーサイズ(バイト単位)。
いいえ
はい
はい
--memory_policy-guaranteed
long
仮想マシンを実行するためにホストで保証されるメモリーの最小量(バイト単位)。
いいえ
はい
はい
--memory_policy-ballooning
boolean
メモリーバルーンデバイスを有効にするには true に設定します。
いいえ
はい
はい
--high_availability-priority
int
高可用性を使用して、各仮想マシンの優先度の値(移行および再起動の順序)を設定します。
いいえ
はい
はい
--high_availability-enabled
boolean
仮想マシンに対して高可用性を有効にするかどうかを定義します。
いいえ
はい
はい
--domain-name
string
仮想マシンのドメイン名。
いいえ
はい
はい
--description
string
仮想マシンの説明。
いいえ
はい
はい
--comment
string
仮想マシンのコメント。
いいえ
はい
はい
--stateless
boolean
仮想マシンがステートレスの場合は true に設定します。ステートレス仮想マシンには、起動時に取得され、シャットダウン時に削除されるディスクイメージのスナップショットが含まれます。これは、再起動後の状態の変更は維持されないことを意味します。
いいえ
はい
はい
--permissions-clone
boolean
ソース仮想マシンのパーミッションをテンプレートにコピーするには、true に設定します。
いいえ
はい
はい
--delete_protected
boolean
このテンプレートで作成された仮想マシンを削除できないようにするには、true に設定します。
いいえ
はい
はい
--sso-methods-method
コレクション
使用されるシングルサインオンメソッドを定義します。例: --sso-methods-method method.id=GUEST_AGENT
いいえ
はい
はい
--rng_device-rate-bytes
int
期間ごとに使用できるバイト数を指定します。
いいえ
はい
はい
--rng_device-rate-period
int
期間をミリ秒単位で指定します。指定した場合は、--rng_device-rate-bytes も指定する必要があります。
いいえ
はい
はい
--rng_device-source
string
乱数ジェネレーターのソース。random または hwrng のいずれかを指定します。
いいえ
はい
はい
--console-enabled
boolean
VirtIO コンソールデバイス機能を有効にするには true に設定します。
いいえ
はい
はい
--cpu-mode
string
CPU モードを定義します。カスタムhost_model、または host_passthrough を指定します。
いいえ
はい
はい
--cpu-topology-sockets
int
仮想マシンで利用可能な CPU ソケットの数。
いいえ
はい
はい
--cpu_shares
int
仮想マシンが他の仮想マシンと比較して要求できる CPU リソースのレベル。たとえば、優先度の低い仮想マシンの場合は 512、中優先度の仮想マシンの場合は 1024、優先度の高い仮想マシンの場合は 2048 です。
いいえ
はい
はい
--placement_policy-affinity
string
各仮想マシンの移行アフィニティー。migratableuser_migratable、または pin を指定し ます
いいえ
はい
はい
--placement_policy-host-id|name
string
移行アフィニティーの優先ホストへの参照。
いいえ
はい
はい
--origin
string
仮想マシンの起点。2009、 vmware 、または xen を指定します。
いいえ
はい
はい
--os-kernel
string
仮想マシンが起動するように設定されているカーネルイメージへのパス。このオプションは、BIOS ブートローダー経由ではなく、Linux カーネルを直接起動することに対応します。
いいえ
はい
はい
--disks-clone
boolean
定義された テンプレート からディスクのクローンを作成するかどうかを定義します。
いいえ
はい
いいえ
--disks-disk
コレクション
仮想マシンに接続されているディスクへの参照。
いいえ
はい
はい
--tunnel_migration
boolean
libvirt デーモンでデータトランスポートを有効にするには、true に設定します。トンネル化されたトランスポートは強力な暗号化アルゴリズムを使用しますが、トランスポート時のデータ負荷を増やします。
いいえ
はい
はい
--migration_downtime
int
ライブマイグレーション中に仮想マシンがダウンできる最大ミリ秒数を定義します。
いいえ
はい
はい
--virtio_scsi-enabled
boolean
VirtIO コンソールデバイスを仮想マシンにアタッチできるようにするには、true に設定します。
いいえ
はい
はい
--soundcard_enabled:
boolean
サウンドカードを有効にするには true に設定します。
いいえ
はい
はい
--payloads-payload
コレクション
起動時に仮想マシンに送信するコンテンツを定義します。
いいえ
はい
はい
--initialization-configuration-type
string
仮想マシンのフォーマットを定義します。ovf のみを受け入れます。
いいえ
はい
はい
--initialization-configuration-data
string
このパラメーターは、--initialization-configuration-type パラメーターと一致する必要があります。ovf のみを受け入れます。
いいえ
はい
はい
--cpu-cpu_tune-vcpu_pin
コレクション
ホストの物理 CPU に固定する仮想マシンの仮想 CPU を定義します。
いいえ
はい
はい
--serial_number-policy
string
仮想マシンテンプレートのシリアル番号ポリシーを定義します。ホスト、仮想マシンまたカスタム を指定します。custom を使用する場合は、--serial_number-value を使用してシリアル番号の値も定義します。
いいえ
はい
はい
--serial_number-value
string
仮想マシンテンプレートのシリアル番号を定義します。
いいえ
はい
はい
--bios-boot_menu-enabled
boolean
ブートメニューを有効にするには true に設定します。
いいえ
はい
はい
--numa_tune_mode
string
NUMA ホスト上のドメインプロセスにメモリーを割り当てる方法を定義します。interleavestrict、または preferred を指定します。値が指定されていない場合、パラメーターはデフォルトで strict に設定されます。
いいえ
はい
はい
--cpu_profile-id
string
使用する CPU プロファイルを定義します。list cpuprofiles コマンドを使用して、 CPU プロファイル ID の完全なリストを取得します。
いいえ
はい
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
string
システム間のロギングに対するアクションのタグ付け識別子。クライアントが識別子を定義しない場合は、生成されます。
いいえ
はい
いいえ
--os-boot パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.59 --os-boot パラメーター
Name 説明
boot.dev
string
仮想マシンテンプレートのブートデバイス。cdromhd、または network を指定します。
--custom_properties-custom_property パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.60 --custom_properties-custom_property parameters
Name 説明
custom_property.name
string
カスタムプロパティー名。
custom_property.value
string
カスタムプロパティーの値。
--sso-methods-method パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.61 --sso-methods-method parameters
Name 説明
method.id
string
使用されるシングルサインオンメソッド: GUEST_AGENT
--disks-disk パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.62 --disks-disk パラメーター
Name 説明
disk.id
string
仮想ディスクへの参照。
storage_domains.storage_domain
コレクション
ディスクのストレージドメインのサブパラメーターのセットを定義します。
--payloads-payload パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.63 --payloads-payload パラメーター
Name 説明
payload.type
string
ペイロード配信タイプ。cdrom または フロッピー のいずれかを指定します。
payload.file.name
string
仮想マシンのルートファイルシステム上のペイロードファイル名および場所。
payload.file.content
string
ファイルに配信するコンテンツ。
--cpu-cpu_tune-vcpu_pin パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.64 --cpu-cpu_tune-vcpu_pin
Name 説明
vcpu_pin.vcpu
int
割り当てる仮想 CPU。
vcpu_pin.cpu_set
string
ホスト上の物理 CPU。

例4.45 新規仮想マシンの作成

[RHEVM shell (connected)]# add vm --name MyVM --template-name Blank --cluster-name Default --memory 536870912

例4.46 仮想マシンの更新

[RHEVM shell (connected)]# update vm MyVM --memory 1073741824

例4.47 仮想マシンの削除

[RHEVM shell (connected)]# remove vm MyVM
以下の表は、仮想マシンリソースのアクションの一覧です。
表4.65 仮想マシンのアクション
アクション 説明
start 仮想マシンを起動します。
stop 仮想マシンを停止します。
shutdown 仮想マシンをシャットダウンします。
suspend 仮想マシンを一時停止します。
detach プールから仮想マシンをデタッチします。
migrate 仮想マシンを別のホストに移行します。
cancelmigration 進行中の移行を停止します。
export 仮想マシンをエクスポートストレージドメインにエクスポートします。
move 仮想ディスクを別のストレージドメインに移動します。
ticket コンソールアクセスのチケットを作成します。
logon サードパーティーアプリケーションを使用したコンソールアクセスのユーザーログオンを有効にします。

4.23. vmpool

vmpool リソースタイプは、Red Hat Virtualization 環境内のすべての仮想マシンプールリソースをグループ化します。
表4.66 仮想マシンプールパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--cluster-id|name
string
仮想マシンプールのクラスターへの参照。
はい
はい
はい
--template-id|name
string
仮想マシンプールのテンプレートへの参照。
はい
はい
はい
--name
string
仮想マシンプールの名前。
はい
はい
はい
--size
integer
プール内の仮想マシンの数。
はい
はい
はい

例4.48 新しい仮想マシンプールの作成

[RHEVM shell (connected)]# add vmpool --cluster-name MyCluster --template-name MyTemplate --name MyPool --size 3

例4.49 仮想マシンプールの更新

[RHEVM shell (connected)]# update vmpool MyPool --size 4

例4.50 仮想マシンプールの削除

[RHEVM shell (connected)]# remove vmpool MyPool

4.24. vnicprofile

vnicprofile リソースタイプは、Red Hat Virtualization 環境で、すべての VNIC (仮想ネットワークインターフェイスコントローラー)プロファイル(VM (仮想マシン)インターフェイスプロファイルとも呼ばれます)をグループ化します。
表4.67 仮想ネットワークインターフェイスコントローラープロファイルパラメーター
Name 説明 必須 User Creatable ユーザーアップデータ可能
--name
string
VNIC プロファイルの名前。
はい
はい
はい
--network-id
string
プロファイルが適用される論理ネットワークへの参照。
はい
いいえ
いいえ
--correlation_id
string
システム間のロギングに対するアクションのタグ付け識別子。クライアントが識別子を定義しない場合は、生成されます。
いいえ
はい
いいえ
--description
string
プロファイルの説明。
いいえ
はい
はい
--expect
'201-created'
リクエストは予想される HTTP ヘッダーが返されるまで非同期になります。タスクの完了前に成功として返される長時間実行されるタスクに役立ちます。
いいえ
いいえ
いいえ
--custom_properties-custom_property
コレクション
カスタムスクリプトへのパラメーターとして渡されるユーザー定義の環境変数のセット。
いいえ
はい
はい
--port_mirroring
ブール値
プロファイルにポートミラーリングを使用するかどうかを切り替えます。ステータスは True または False のいずれかです。デフォルトは Falses です。
いいえ
いいえ
いいえ
--custom_properties-custom_property パラメーターは、以下の表のサブパラメーターを使用するコレクションです。
表4.68 --custom_properties-custom_property parameters
Name 説明
custom_property.name
string
カスタムプロパティー名。
custom_property.value
string
カスタムプロパティーの値。

例4.51 新しい vnic プロファイルの作成

[RHEVM shell (connected)]# add vnicprofile --name Gold --network-id 08305a2f-6952-4999-9646-c16137dc6d42

例4.52 vnic プロファイルの更新

[RHEVM shell (connected)]# update vnicprofile Gold --port_mirroring true

例4.53 vnic プロファイルの削除

[RHEVM shell (connected)]# remove vnicprofile Gold

第5章 CLI クエリー

5.1. クエリーの構文

CLI list コマンドは --query 属性を使用してサーバー側のクエリーを実行します。これは、Red Hat Virtualization Manager 検索クエリー言語と同じ形式を使用します。
表5.1 検索クエリーの例
コレクション 基準 結果
hosts vms.status=up 稼働 している仮想マシンを実行しているすべてのホストの一覧を表示します。
vms domain=qa.company.com 指定されたドメインで稼働しているすべての仮想マシンの一覧を表示します。
vms users.name=mary ユーザー名が mary のユーザーに属するすべての仮想マシンの一覧を表示します。
events severity>normal sortby time 重大度が normal よりも高いすべての イベント のリストを表示し、time 要素の値で並べ替えます。
events severity>normal sortby time desc 重大度が normal よりも高いすべての イベント のリストを表示し、time 要素の値で降順でソートします。

5.2. ワイルドカード

検索クエリーは、値の一部をワイルドカードとしてアスタリスクに置き換えます。

例5.1 name=vm* のワイルドカード検索クエリー

[RHEVM shell (connected)]# list vms --query "name=vm*"
このクエリーにより、vm1vm2vma vm -webserver などの VM で始まる名前を持つすべての仮想マシンが作成されます。

例5.2 name=v*1 のワイルドカード検索クエリー

[RHEVM shell (connected)]# list vms --query "name=v*1"
このクエリーにより、名前が v で始まり、1 で終わるすべての仮想マシン( vm 1 vr1、または virtualmachine1 など)が発生します。
Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.