RHEVM Shell ガイド

Red Hat Enterprise Virtualization 3.6

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

Red Hat Enterprise Virtualization Documentation Team

Red Hat Customer Content Services

概要

本ガイドには、Red Hat Enterprise Virtualization Manager のコマンドラインシェルのインストールおよび使用に関する情報を記載しています。

第1章 CLI の使用

Red Hat Enterprise Virtualization スイートには、コマンドラインインターフェース (CLI) の機能があります。この CLI により、ユーザーは標準の Web インターフェース以外から Red Hat Enterprise Virtualization Manager へ接続できるようになります。この CLI には、システム管理者がクライアントマシンから仮想環境の定期的なメンテナンスや反復タスクを行うのに役立つスクリプトシステムが含まれています。

1.1. CLI のインストール

Red Hat Enterprise Virtualization の CLI をクライアントマシンにインストールします。
  1. root ユーザーでクライアントマシンにログインします。
  2. コンテンツ配信ネットワークにシステムを登録します。プロンプトが表示されたら、カスタマーポータルのユーザー名とパスワードを入力します。
    # subscription-manager register
  3. Red Hat Enterprise Virtualization のサブスクリプションプールを見つけて、プール ID を書き留めておきます。
    # subscription-manager list --available
  4. 上記のステップで特定したプール ID を使用して、Red Hat Enterprise Virtualization のエンタイトルメントをシステムにアタッチします。
    # subscription-manager attach --pool=pool_id
  5. 必要なリポジトリーを有効にします。
    # subscription-manager repos --enable=rhel-6-server-rhevm-rpms
  6. CLI パッケージと依存関係をインストールします。
    # yum install rhevm-cli

1.2. TLS/SSL 証明書

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

重要

セキュアなネットワーク接続を使用して Red Hat Enterprise Virtualization Manager から証明書を取得します。

手順1.1 証明書の取得

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

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

  • クライアントへの証明書インポートの方法は、クライアント自体が証明書をどのように格納し、解釈するかによって異なります。本ガイドには、証明書のインポートの例をいくつか記載しています。Network Security Services (NSS) または Java keystore (JKS) を使用しないクライアントでの証明書インポートに関する詳細情報は、そのクライアントのマニュアルを参照してください。

1.3. .rhevmshellrc の設定

.rhevmshellrc は、ユーザーが rhevm-shell に初めて接続する際に自動的に作成され、データが投入される設定ファイルです。このファイルにより、ユーザーが Red Hat Enterprise Virtualization 環境への接続時のオプションを設定することができます。.rhevmshellrc ファイルは、デフォルトで /home/[user name]/.rhevmshellrc に配置されます。
.rhevmshellrc ファイルの設定情報は、[cli][ovirt-shell] の 2 つのセクションヘッダーの下に記載されます。これらのヘッダーは、設定ファイルの解析に必要です。

表1.1 [cli] のパラメーター

名前タイプ説明
autoconnect
ブール値
rhevm-shell セッションに自動接続するかどうかの設定を切り替えます。ステータスは True または False のいずれかです。
autopage
ブール値
シェル内のページネーションのオン/オフを切り替えます。ステータスは True または False のいずれかです。

表1.2 [ovirt-shell] のパラメーター

名前タイプ説明
username
文字列
ログインに使用するユーザー名
timeout
整数
要求のタイムアウトを指定します。デフォルトは「-1」です。
extended_prompt
ブール値
シェルのコマンドプロンプトにホスト名を表示する拡張プロンプトオプションを切り替えます。
url
文字列
Red Hat Enterprise Virtualization 環境のアドレス
insecure
ブール値
CA 証明書の要件を切り替えます。ステータスは True または False のいずれかです。
renew_session
ブール値
有効期限が切れた際のセッションの自動更新の設定を切り替えます。ステータスは True または False のいずれかです。
filter
ブール値
オブジェクトフィルタリングのオン/オフを切り替えます。オブジェクトフィルタリングを使用すると、パーミッションに従いオブジェクトを取得することができます。オン/オフの切り替えが可能なのは、admin ロールのみとなっています。ステータスは TrueFalse のいずれかとなります。
session_timeout
整数
認証セッションのタイムアウト (分単位) を指定します。正数である必要があります。
ca_file
文字列
使用するサーバー CA 証明書を指定します。
dont_validate_cert_chain
ブール値
サーバー CA 証明書の検証の設定を切り替えます。ステータスは True または False のいずれかです。
key_file
文字列
クライアントの PEM キーファイルを指定します。
password
文字列
ユーザー名で使用するパスワード
cert_file
文字列
クライアントの PEM 証明書ファイルを指定します。

1.4. CLI の実行

次のコマンドを用いて CLI アプリケーションを起動します。
# rhevm-shell
この rhevm-shell アプリケーションは、Red Hat Enterprise Virtualization 環境でインタラクティブシェルとして機能します。
.rhevmshellrc ファイルでは Red Hat Enterprise Virtualization Manager へ接続するための URL、ユーザー名、認証局、パスワードを設定することができます。connect コマンドは、ユーザーが毎回オプションを指定する必要なしに、このファイルのパラメーターを使用して Manager に接続します。
または、以下の追加オプションを使用して Red Hat Enterprise Virtualization Manager へ自動的に接続することができます。
# rhevm-shell -c -l "https://[server]/api" -P [port] -u "[user@domain]" -A "[certificate]"
以下の値を必ず置き換えるようにしてください。
  • server - Red Hat Enterprise Virtualization Manager のホスト名または IP アドレス。CLI は REST API 経由で Red Hat Enterprise Virtualization Manager に接続します。
  • user@domain - Red Hat Enterprise Virtualization Manager にログインするユーザーのユーザ名とディレクトリーサービス。
  • certificate - 認証局ファイルのパス名
シェルで、パスワードと、まだ提示していない場合は Red Hat Enterprise Virtualization Manager のユーザー名と URL の入力が求められます。

注記

.rhevmshellrc ファイルでユーザー名、パスワード、URL、認証局ファイルを設定した場合は、追加オプションを指定する必要はありません。

注記

この例では、証明書以外のオプションはシェルのプロンプトで入力が求められるため、証明書のみが必須オプションとなっています。証明書を指定せずに「--insecure」オプションを使用して証明書なしに接続することができますが、中間者攻撃によるサーバーのなりすましが可能になる場合があるため、このオプションの使用は推奨していません。

rhevm-shell のオプション

-h, --help
rhevm-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
ポートを指定します。
-T 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
標準入力ではなく FILE からのコマンドを読み込みます。
--kerberos
有効な Kerberos チケットを使用してシェルへの接続を認証します。

注記

お使いのシェルがインタラクティブシェルではない場合は、--password オプションを使用してシェルから Red Hat Enterprise Virtualization Manager に接続することができます。

1.5. CLI との対話

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

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

[RHEVM shell (connected)]# show vm --name desktop_vms
コマンドとパラメーターの適切な組み合わせを入力するため、CLI には bash シェルと同様に TAB キーを 2 回押してコマンドとパラメーターを表示し、自動補完する機能が含まれています。

例1.2 コマンドとパラメーターの表示と自動補完

空のプロンプトで TAB を 2 回押すと利用可能なコマンドがすべて表示されます。
[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
コマンドを選択して TAB を 2 回押すと、次にそのコマンドで利用可能なパラメーターが表示されます。show の場合は、全リソースを表示します。
[RHEVM shell (connected)]# show TAB TAB
brick          datacenter     event          group          nic
quota          statistic      template       vmpool         cdrom
disk           file           host           permission     role
storagedomain  user           cluster        domain         glustervolume
network        permit         snapshot       tag            vm
また、TAB を 2 回押すと、コマンドやパラメーターが補完されます。
[RHEVM shell (connected)]# show vm TAB TAB
kwargs         name           show-all       storagedomain  
[RHEVM shell (connected)]# show vm naTAB TAB
[RHEVM shell (connected)]# show vm --name
また、TAB を 2 回押すと、na--name パラメーターに自動変換されます。この補完は接頭辞にも対応しています。
未完のパラメーターに複数のパラメーターがマッチする場合には、TAB を 2 回押すことでそれらの該当パラメーターが表示されます。
[RHEVM shell (connected)]# show vTAB TAB
vmpool        vm
CLI には、shell コマンドと感嘆符 (!) のいずれかを使用して Linux コマンドを実行できる機能が含まれています。

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

shell コマンドを使います。
[RHEVM shell (connected)]# shell ls -la
または感嘆符 (!) を使います。
[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
Linx シェルから Manager に接続して、「command resource」の形式で指定のコマンドを実行して STDIO に出力することも可能です。

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

--execute または -E パラメーターを使用して、Manager に実行し指定のコマンドを実行します。
# rhevm-shell -c -l "https://[server]/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;...},...
コレクションのサブパラメーターは、各リソースページのリソースパラメーター一覧の後にリストします。


[1] HTTPS についての説明は RFC 2818 HTTP Over TLS を参照してください。

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

2.1. CLI を使った基本的な仮想環境の構築

本章では、Red Hat Enterprise Virtualization の基本環境内で仮想マシンを追加する CLI の機能を実例をあげて説明します。この例では以下の前提条件を使用します。
  • ハイパーバイザーとして使用するための Red Hat Enterprise Linux ホスト。このホストはネットワーク接続があり設定済みであること。
  • 以下の 2 つのシェアがある NFS ストレージサーバー。この NFS ストレージサーバーはネットワーク接続があり設定済みであること。
    • /exports/data - データストレージドメイン
    • /exports/iso - ISO ストレージドメイン
  • ネットワーク接続があり設定済みの Red Hat Enterprise Virtualization Manager
  • Red Hat Enterprise Virtualization Manager またはクライアントマシンのいずれかに CLI がインストールされていること
  • 仮想マシンにインストールする任意のオペレーティングシステムを格納した ISO ファイル。本章では、インストール ISO の例に Red Hat Enterprise Linux Server を使用しています。

注記

Red Hat Enterprise Virtualization Manager は、各リソースのグローバル一意識別子 (GUID) を生成します。以下の例に記載の識別子コードは、お使いの Red Hat Enterprise Virtualization 環境の識別子コードとは異なる場合があります。

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

  1. CLI シェルをロードして、Red Hat Enterprise Virtualization Manager に接続します。
    # rhevm-shell -c --url https://[rhevm-host]/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 Enterprise Virtualization 環境内のリソースをグループ化しています。
    [RHEVM shell (connected)]# list clusters
    
    id         : 99408929-82cf-4dc7-a532-9d998063fa95
    name       : Default
    description: The default server cluster
  4. 全 CPU プロファイルを一覧表示し、対象の CPU プロファイルを書き留めておきます。この情報は、仮想マシンの作成時に必要となります。以下の例では Default の CPU プロファイルを使用しています。
    [RHEVM shell (connected)]# list cpuprofiles 
    
    id         : 0000001a-001a-001a-001a-00000000035e
    name       : Default
    
  5. show-all オプションを使用して全論理ネットワークを一覧表示し、環境内の論理ネットワークの詳細情報を表示します。 Red Hat Enterprise 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 共有で、仮想マシン用のストレージを提供します。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-stateunattached に切り替わったら、次のステップに進むことができます。
      [RHEVM shell (connected)]# show storagedomain --name 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 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-stateunattached に切り替わったら、次のステップに進むことができます。
      [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 のサブリソースとしてアタッチします。また、network-name オプションを追加し、ovirtmgmt ネットワークへ接続します。
    [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 イメージを ISOStorage ドメインにアップロードして、仮想マシンが使用できるようにします。Red Hat Enterprise 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 events コマンドに追加の query オプションを使用して実行します。仮想マシンの 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 コマンドを使用します。このコマンドで、typenameid 別にイベントを表示することができます。
    [RHEVM shell (connected)]# show event --id '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

    重要

    仮想マシンの display-type と一致するように、コンソールアプリケーションがクライアントマシンにインストールされていることを確認してください。使用可能なプロトコルには、SPICE (デフォルト) や VNC などがあります。

第3章 コマンド

3.1. RHEVM への接続

3.1.1. RHEVM への接続 (connect)

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

connect [options]

注記

.rhevmshellrc ファイルでユーザー名、パスワード、URL、認証局ファイルを設定した場合は、追加オプションを指定する必要はありません。

表3.1 connect のオプション

オプション説明必須
--urlRed Hat Enterprise Virtualization Manager の REST API への URL です。形式は https://[server]/api となります。はい
--usernameRed Hat Enterprise Virtualization Manager へアクセスを試行するユーザーのユーザー名およびディレクトリーサービスドメイン。形式は [username]@[domain] となります。はい
--passwordRed Hat Enterprise Virtualization Manager へアクセスを試行するユーザーのパスワードはい
--key-fileSSL 経由で接続するための鍵ファイルです。いいえ
--cert-fileSSL 経由で接続するための証明書ファイルです。いいえ
--ca-fileSSL 経由で接続するための認証局ファイルです。はい (--insecure の使用時は除く)
--insecureCLI から認証なしに SSL 経由で接続することができるようになります。このオプションにより、中間者 (MITM) 攻撃によるサーバーのなりすましが可能となってしまう場合があるため、細心の注意を払って使用してください。はい (認証局が提示されていない場合のみ)
--filterユーザーのパーミッションに基づいたフィルタリングを有効にします。いいえ
--port--url の一部として指定されていない場合の REST API への接続ポート番号です。いいえ
--timeout接続のタイムアウトの期間です。いいえ

例3.1 .rhevmshellrc が設定されていない場合の connect の例

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

 ==========================================
 >>> connected to RHEVM manager 3.5.0.0 <<<
 ==========================================

[RHEVM shell (connected)]#

注記

証明書を指定せずに「--insecure」オプションを使用して証明書なしに接続することができますが、中間者攻撃によるサーバーのなりすましが可能になる場合があるため、このオプションの使用は推奨していません。

3.1.2. RHEVM からの接続解除 (disconnect)

disconnect コマンドで Red Hat Enterprise Virtualization Manager への接続を解除します。
構文

disconnect

例3.2 disconnect の例

[RHEVM shell (connected)]# disconnect

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

[RHEVM shell (disconnected)]#

3.2. リソース

3.2.1. コレクション内のリソースを表示 (list)

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

list [collection] [options]

表3.2 list の標準オプション

オプション説明
--show-allリストしたリソース別に、空でないプロパティーをすべて表示します。このオプションを指定しなかった場合は、idnamedescription プロパティーのみが表示されます。
--query [QUERY]Red Hat Enterprise 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
list の検索構文に関するヘルプを取得します。
[RHEVM shell (connected)]# list --help

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

show コマンドを使ってリソースのプロパティーを表示します。
構文

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

表3.3 show の標準オプション

オプション説明
--id [UUID]リソースの UUID 値でリソースを識別します。
--name [NAME]name の値でリソースを識別します。

注記

リソースタイプ固有のオプションは、各リソースタイプの定義のページに記載されています。

例3.4 show の例

id ベースで仮想マシンを表示します。
[RHEVM shell (connected)]# show vm fcadfd5f-9a12-4a1e-bb9b-2b9d5c2e04c3
name ベースで仮想マシンを表示します。
[RHEVM shell (connected)]# show vm RHEL6-Server

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

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

add [resource] [options]

注記

リソースタイプ固有のオプションは、各リソースタイプの定義のページに記載されています。

例3.5 add の例

仮想マシンを作成します。
[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 コマンドを使って既存のリソースを変更します。
構文

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

注記

オプション固有のリソースタイプについては、各リソースタイプの定義ページに記載されています。

例3.6 update の例

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

3.2.5. リソースの削除 (remove)

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

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

表3.4 remove の標準オプション

オプション説明
--asyncリソースの非同期削除を行います。
--forceリソースの強制削除を行います。これにより、データベースのエントリーと特定のリソースへの関連性すべてを削除します。このアクションは、datacentervm リソースのみに適用されます。

注記

リソースタイプ固有のオプションは、各リソースタイプの定義のページに記載されています。

例3.7 remove の例

仮想マシンを削除します。
[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 コマンドを使い、リソースタイプに関連する特別な関数を実行します。
構文

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

注記

オプション固有のリソースアクションについては、各リソースタイプの定義ページに記載されています。

例3.8 action の例

仮想マシンを起動します。
[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. Sub-Resources の使用方法 (--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. End of File (EOF)

EOF コマンドを使って Ctrl+D シーケンスを用いて CLI シェルを終了します。
構文

EOF

例3.10 EOF の例

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

3.3.2. システム機能の表示 (capabilities)

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 clear の例

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

3.3.4. 仮想マシンへの接続 (console)

console コマンドで、仮想マシンへのグラフィックコンソールを開きます。このコマンドは、仮想マシンの display-type パラメーターに従って、外部の VNC クライアントまたは SPICE クライアントのいずれかを開きます。
構文

console [vm-id|vm-name]

例3.13 console の例

仮想マシンへのグラフィックコンソールを開きます。
[RHEVM shell (connected)]# console RHEL6-Server

3.3.6. CLI の終了 (exit)

exit コマンドを使って CLI を終了します。
構文

exit

例3.15 exit の例

CLI を終了します。
[RHEVM shell (connected)]# exit

3.3.7. スクリプトの実行 (file)

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

file [file-location]

例3.16 file の例

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

3.3.8. ヘルプの表示 (help)

help コマンドを使って CLI コマンドとリソースのヘルプを表示します。
構文

help [command] [resource] [options]

例3.17 help の例

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 history の例

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

例3.19 history --first の例

--firstn パラメーターで、最初から n 番目までのユーザーコマンド履歴を表示します。
[RHEVM shell (connected)]# history --first 5

例3.20 history --last の例

--lastn パラメーターで、最後から n 番目までのユーザーコマンド履歴を表示します。
[RHEVM shell (connected)]# history --last 5

3.3.10. CLI 情報の表示 (info)

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/api

3.3.11. 接続のテスト (ping)

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

ping

例3.22 ping の例

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

success: RHEVM manager could be reached OK.

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

shell コマンドを使って Linux シェルからコマンドを実行します。このコマンドは Red Hat Enterprise Virtualization Manager シェルと連携してファイル管理タスクを実行できるようにします。
構文

shell [vm-id|vm-name]

例3.23 shell の例

現在の作業ディレクトリーのファイルを表示します。
[RHEVM shell (connected)]# shell ls
ファイルを作成します。
[RHEVM shell (connected)]# shell touch example.txt
ファイルをコピーします。
[RHEVM shell (connected)]# shell cp example.txt /example-dir/.

注記

感嘆符 (!) を使用すると、shell の代替となります。例は次の通りです。
[RHEVM shell (connected)]# !touch example.txt

3.3.13. 直前のステータス表示 (status)

status コマンドを使用して、直近に実行されたコマンドの状況を表示します。
構文

status

例3.24 status の例

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

last command status: 0 (OK)

3.3.14. システムサマリーの表示 (summary)

summary コマンドを使用してシステムステータスのサマリーを表示します。
構文

summary

例3.25 summary の例

システムのステータスを表示します。
[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 Enterprise Virtualization 環境の Gluster ブリックをすべてグループ化します。

表4.1 Gluster ブリックパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--server_id
文字列
Gluster サーバーのアドレス
はい
はい
いいえ
--brick_dir
文字列
Gluster サーバー上のブリックのディレクトリー
はい
はい
いいえ
--replica_count
整数
複製ボリュームのファイルレプリケーション数を定義します。
いいえ
はい
いいえ
--stripe_count
整数
ストライプボリュームのストライプ数を定義します。
いいえ
はい
いいえ
次の表には、リソースベースのコマンドのその他の glustervolume オプションをまとめています。

表4.2 その他のコマンドオプション

オプション説明
--cluster-identifierglustervolume サブリソースが含まれる cluster への参照
--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 Enterprise Virtualization 環境の仮想 CD-ROM ドライブリソースをすべてグループ化します。

表4.3 CD-ROM のパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--file-id
文字列
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

cluster リソースタイプは、Red Hat Enterprise Virtualization 環境のホストクラスターリソースをすべてグループ化します。

表4.4 クラスターのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--cpu-id
文字列
クラスター内で全ホストがサポートする必要のある CPU タイプを定義するサーバーの CPU 参照
はい
はい
はい
--data_center-id|name
文字列
ホストクラスターのデータセンターへの参照
はい
はい
いいえ
--name
文字列
ホストクラスター名
はい
はい
はい
--version-major
整数
クラスターのメジャーバージョン番号。たとえば、Red Hat Enterprise Virtualization 3.2 はメジャーバージョンが 3 となります。
はい
はい
はい
--version-minor
整数
データセンターのマイナーバージョン番号。たとえば、Red Hat Enterprise Virtualization 3.2 はマイナーバージョンが 2 となります。
はい
はい
はい
--description
文字列
ホストクラスターの説明
いいえ
はい
はい
--error_handling-on_error
文字列
クラスター内のホストが非稼働状態になった場合の仮想マシンの処理 (例:migratedo_not_migratemigrate_highly_available) を定義します。
いいえ
はい
はい
--gluster_service
ブール値
The status is either true or false.
いいえ
はい
はい
--memory_policy-overcommit-percent
double
ホストでこれ以上仮想マシンを起動できなくなる前に、使用が許可されるホストメモリーの使用率 (パーセントで表示)。KSM ではメモリーを共有するため、仮想マシンは使用可能な容量以上のホストメモリーを使用することができます。推奨値は、 100 (なし)、 150 (サーバー負荷) および 200 (デスクトップ負荷) になります。
いいえ
はい
はい
--memory_policy-transparent_hugepages-enabled
ブール値
Transparent Hugepages のステータスを有効にするかどうかを定義します。このステータスは true または false のいずれかです。
いいえ
はい
はい
--scheduling_policy-policy
文字列
クラスター内のホストの仮想マシンスケジューリングモード。evenly_distributedpower_saving、空白 (指定なし) などを指定できます。
いいえ
はい
はい
--scheduling_policy-thresholds-duration
整数
ホストが過負荷となってから、スケジューラーが起動してその負荷を別のホストに移動するまでの時間 (秒単位)
いいえ
はい
はい
--scheduling_policy-thresholds-high
整数
過負荷とみなされるまでにホストが許容できる最高 CPU 使用率を制御します。
いいえ
はい
はい
--scheduling_policy-thresholds-low
整数
十分に活用されていないとみなされるまでにホストが許容できる最低 CPU 使用率を制御します。
いいえ
はい
はい
--threads_as_cores
ブール値
ホストはスレッドをコアとして処理するため、ホスト内のコア数よりもプロセッサーコアの合計数が多い仮想マシンをホストで実行できるようになります。ステータスは true または false のいずれかです。
いいえ
いいえ
いいえ
--trusted_service
ブール値
ホストの検証に OpenAttestation サーバーを使用するかどうかを定義します。
いいえ
はい
はい
--virt_service
ブール値
The status is either true or false.
いいえ
はい
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクの完了前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
文字列
システム共通ロギングのアクションに対するタグ識別子。クライアントが識別子を定義しない場合は生成されます。
いいえ
はい
いいえ

例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 Enterprise Virtualization 環境のデータセンターリソースをすべてグループ化します。

表4.5 データセンターのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
データセンターの名前
はい
はい
はい
--storage_type
文字列
iscsifcpnfslocalfs または posixfs など、データセンターのストレージタイプ
はい
はい
はい
--version-major
整数
データセンターのメジャーバージョン番号。たとえば、Red Hat Enterprise Virtualization 3.2 はメジャーバージョンが 3 となります。
はい
はい
はい
--version-minor
整数
データセンターのマイナーバージョン番号。たとえば、Red Hat Enterprise Virtualization 3.2 はマイナーバージョンが 2 となります。
はい
はい
はい
--description
文字列
データセンターの説明
いいえ
はい
はい
--storage_format
文字列
v1v2v3 など、データセンターのメタデータ形式
いいえ
はい
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクの完了前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
文字列
システム共通ロギングのアクションに対するタグ識別子。クライアントが識別子を定義しない場合は生成されます。
いいえ
はい
いいえ

例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 Enterprise Virtualization 環境の仮想ハードディスクリソースをすべてグループ化します。

表4.6 ディスクのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--provisioned_size
整数
ディスク用に確保したストレージ領域。ディスクの sizeprovisioned_size 未満の場合でも、この領域はディスクが使用できるように事前に割り当てられます。
はい
はい
はい
--interface
文字列
ディスクのインターフェースタイプ。idevirtio のいずれか。
はい
はい
はい
--format
文字列
下層のストレージ形式。Copy On Write (cow) は少しのパフォーマンスオーバーヘッドでスナップショットの作成が可能になります。Raw (raw) はスナップショットを作成できませんが、パフォーマンスが向上します。
はい
はい
はい
--size
整数
ディスクの実際のサイズ
いいえ
はい
はい
--sparse
ブール値
true: 物理ストレージの場合に指定します。ディスクを事前割り当てすべきではないためです。
いいえ
はい
はい
--bootable
ブール値
true: ディスクがブート可能とマークされている場合に指定します。
いいえ
はい
はい
--shareable
ブール値
true: ディスクが共有可能な場合に指定します。
いいえ
はい
はい
--allow_snapshot
ブール値
true: ディスクがスナップショットを作成できる場合に指定します。
いいえ
はい
はい
--propagate_errors
ブール値
true: ディスクエラーによって仮想マシンが一時停止せず、代わりにディスクエラーがゲスト OS に伝達される必要がある場合に指定します。
いいえ
はい
はい
--wipe_after_delete
ブール値
true: ディスクが削除される時に下層の物理ストレージがゼロ処理される必要がある場合に指定します。これにより、セキュリティーが強化されますが、より負荷の高い操作であるため、削除に要する時間が伸びる可能性があります。
いいえ
はい
はい
--storage_domains-storage_domain
コレクション
ディスク固有のストレージドメインを定義します。
いいえ
はい
いいえ
--storage_domains-storage_domain パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.7 --storage_domains-storage_domain parameters

名前タイプ説明
storage_domain.id|name
文字列
ディスクのストレージドメインへの参照
以下の表には、リソースベースのコマンドのその他のディスクオプションをまとめています。

表4.8 その他のコマンドオプション

オプション説明
--vm-identifierサブリソースとして vm にディスクを追加します。
--aliasshow コマンドを使用する時にディスク名を識別します。ディスク固有のクエリーには --alias ではなく --name パラメーターを使用します。

例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 Enterprise Virtualization 環境の Gluster ストレージボリュームリソースをすべてグループ化します。

表4.10 Gluster ボリュームのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
Gluster ボリュームの名前
はい
はい
いいえ
--volume_type
文字列
Gluster ボリュームタイプを定義します。DISTRIBUTEREPLICATEDISTRIBUTED_REPLICATESTRIPEDISTRIBUTED_STRIPE の中から選択します。
はい
はい
いいえ
--bricks-brick
コレクション
新しい Gluster ボリュームには、追加および管理する Gluster ブリックのセットが必要です。このパラメーターは、ブリックの詳細のコレクションを参照します。1 つ以上のブリックを指定しますが、複数のブリックには複数の bricks-brick パラメーターを一覧で指定します。コレクションの詳細は以下を参照してください。
はい
はい
いいえ
--transport_types
コレクション
Gluster ボリュームの利用可能なトランスポートメソッドへの参照。コレクションの詳細は以下を参照してください。
いいえ
はい
いいえ
--replica_count
整数
複製ボリュームのファイルレプリケーション数を定義します。
いいえ
はい
いいえ
--stripe_count
整数
ストライプボリュームのストライプ数を定義します。
いいえ
はい
いいえ
--options-option
コレクション
Gluster ボリュームのオプションへの参照。コレクションの詳細は下記を参照してください。
いいえ
はい
いいえ
--bricks-brick パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.11 bricks-brick パラメーター

名前タイプ説明
brick.server_id
文字列
Gluster サーバーのアドレス
brick.brick_dir
文字列
Gluster サーバー上のブリックのディレクトリー
--transport_types パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.12 transport_types パラメーター

名前タイプ説明
transport_type
文字列
使用するトランスポートタイプを定義します。複数のタイプには複数の transport_type パラメーターを指定します。TCPRDMA より選択します。
--options-option パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.13 options-option パラメーター

名前タイプ説明
option.name
文字列
Gluster オプション名
option.value
文字列
Gluster オプションの値
次の表には、リソースベースのコマンドのその他の glustervolume オプションをまとめています。

表4.14 その他のコマンドオプション

オプション説明
--cluster-identifierGluster ボリュームをサブリソースとして cluster に追加します。

例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 ボリュームのアクション

アクション説明
startGluster ボリュームを使用可能にします。
stopGluster ボリュームを無効にします。
setOptionGluster ボリュームのオプションを設定します。
resetOptionGluster ボリュームのオプションをデフォルトに再設定します。
resetAllOptionsGluster ボリュームのすべてのオプションをデフォルトに再設定します。

4.7. group

group リソースタイプは Red Hat Enterprise Virtualization 環境のアイデンティティーサービスグループをすべて定義します。

表4.16 グループのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
グループ名。通常はアイデンティティーディレクトリーサービス内の完全なグループパスです。
いいえ
いいえ
いいえ

例4.16 グループの作成

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

4.8. host

host リソースタイプは、Red Hat Enterprise Virtualization 環境のホストリソースをすべてグループ化します。

表4.17 ホストのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
ホスト名
はい
はい
はい
--address
文字列
ホストの IP アドレスあるいホスト名
はい
はい
はい
--root_password
文字列
ホストの root ユーザーのパスワード
はい
はい
はい
--cluster-id|name
文字列
ホストが含まれるクラスターを定義します。
はい
はい
はい
--port
整数
ホストで実行する VDSM デーモンと通信するポート
いいえ
はい
はい
--storage_manager-priority
整数
Storage Pool Manager (SPM) のホストの優先順位を設定します。
いいえ
はい
はい
--power_management-type
文字列
ホストの電源管理デバイスのタイプ
いいえ
はい
はい
--power_management-enabled
ブール値
電源管理設定が有効化または無効化されているかを示します。
いいえ
はい
はい
--power_management-address
文字列
電源管理デバイスのホスト名または IP アドレス
いいえ
はい
はい
--power_management-user_name
文字列
電源管理の有効なユーザー名
いいえ
はい
はい
--power_management-password
文字列
電源管理用の有効かつ堅固なパスワード
いいえ
はい
はい
--power_management-options-option
コレクション
選択した power_management-type 用のフェンシングオプション
いいえ
はい
はい
--reboot_after_installation
ブール値
VDSM インストール後にホストが再起動するかをどうかを定義します。
いいえ
はい
いいえ
--power_management-options-option パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.18 --power_management-options-option パラメーター

名前タイプ説明
option.name
文字列
電源管理のオプション名
option.value
文字列
電源管理のオプション値

例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 host アクション

アクション説明
activateホストをアクティブ化します。
approveホストを承認します。
commitnetconfigネットワーク設定を保存します。
deactivateホストを非アクティブ化します。
fenceホストをフェンスします。
forceselectspmStorage Pool Manager に設定するホストを選択します。
installホストで VDSM をインストールします。
iscsidiscoveriSCSI 検出コマンドを実行します。
iscsiloginiSCSI ログインコマンドを実行します。
以下の表では、fence アクションのその他のオプションを表示しています。

表4.20 Fencing オプション

オプション説明
manualホストを手動でフェンスします。このアクションを使用して、ホストの応答がなくなり手動でリブートされたことを Manager に確認します。
restartホストを再起動します (停止、待機、ステータス、開始、待機、ステータスとして実装)。
startホストの電源を入れます。
stopホストの電源を切ります。
statusホストの実行ステータスを確認します。

例4.20 ホストが再起動されていることの確認

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

4.9. network

network リソースタイプは、Red Hat Enterprise Virtualization 環境の論理ネットワークリソースをすべてグループ化します。

表4.21 論理ネットワークのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--data_center-id|name
文字列
論理ネットワークのデータセンターへの参照
はい
はい
いいえ
--name
文字列
論理ネットワークのプレーンテキスト名
はい
はい
いいえ
--description
文字列
論理ネットワークの説明
いいえ
はい
はい
--vlan-id
文字列
VLAN タグ
いいえ
はい
はい
--ip-address
文字列
論理ネットワークのブリッジの IP アドレス
いいえ
はい
はい
--ip-gateway
文字列
論理ネットワークのブリッジのゲートウェイ
いいえ
はい
はい
--ip-netmask
文字列
論理ネットワークのブリッジのネットマスク
いいえ
はい
はい
--display
ブール値
論理ネットワークをディスプレイ通信に使用するかを指定します。true または false のいずれかに設定します。
いいえ
はい
はい
--stp
ブール値
このネットワークで Spanning Tree Protocol を有効にする場合は true に設定します。
いいえ
はい
はい
--mtu
整数
ユーザー定義による、論理ネットワークの最大転送単位の値を設定します。
いいえ
はい
はい
--usages-usage
コレクション
論理ネットワークの usage パラメーターを定義します。
いいえ
いいえ
はい
--usages-usage パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.22 usages-usage パラメーター

名前タイプ説明
usage
文字列
ネットワークの使用タイプ。オプションには VMDISPLAY などがあります。
以下の表には、リソースベースのコマンドのその他の network オプションをまとめています。

表4.23 その他のコマンドオプション

オプション説明
--cluster-identifierサブリソースとして cluster にネットワークを追加します。

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

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

例4.22 ネットワークの更新

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

例4.23 ネットワークの削除

[RHEVM shell (connected)]# remove network WebNetwork

4.10. nic

nic リソースタイプは Red Hat Enterprise Virtualization 環境のネットワークインターフェースリソースをグループ化します。これらのリソースは、 hostvmリソース両方のサブリソースとして機能しますが、それぞれ別に定義されます。このセクションには、リソース毎にパラメーターの表が 2 つ含まれています。

表4.24 ホストのネットワークインターフェースのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--network-id|name
文字列
インターフェースがアタッチされたネットワークがある場合は、そのネットワークへの参照
はい
はい
はい
--name
文字列
ホストのネットワークインターフェース名 (例: eth0)
はい
はい
はい
--bonding-slaves-host_nic
コレクション
ボンドインターフェースを形成するスレーブネットワークインターフェースのコレクション
いいえ
はい
はい
--bonding-options-option
コレクション
ボンドインターフェースのオプション一覧。各オプションにはプロパティーの namevalue の属性が含まれます。
いいえ
はい
はい
--ip-gateway
文字列
ネットワークゲートウェイの IP アドレス
いいえ
はい
はい
--boot_protocol
文字列
ホスト起動時に IP アドレスを割り当てるプロトコル (dhcp または static など)
いいえ
はい
はい
--mac
文字列
インターフェースの MAC アドレス
いいえ
はい
はい
--ip-address
文字列
インターフェースの IP アドレス
いいえ
はい
はい
--ip-netmask
文字列
インターフェースの IP アドレスに対するネットマスク
いいえ
はい
はい
--ip-mtu
整数
インターフェースの最大伝送単位
いいえ
いいえ
はい

表4.25 仮想マシンのネットワークインターフェースパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--network-id|name
文字列
インターフェースがアタッチされたネットワークがある場合は、そのネットワークへの参照
はい
はい
はい
--name
文字列
インターフェース名 (例: eth0)
はい
はい
はい
--mac-address
文字列
インターフェースの MAC アドレス
いいえ
はい
はい
--interface
文字列
e1000virtiortl8139 rtl8139_virtio など、インターフェースタイプを定義します。
いいえ
はい
はい
--port_mirroring-networks-network
コレクション
ネットワークインターフェースよりネットワークデータをコピー (ミラーリング) するネットワークのセットを定義します。
いいえ
はい
はい
--bonding-slaves-host_nic パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.26 --bonding-slaves-host_nic

名前タイプ説明
host_nic.id|name
文字列
ボンディングする別のホストの NIC への参照
--bonding-options-option パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.27 --bonding-options-option

名前タイプ説明
option.name
文字列
ボンディングオプション名
option.value
文字列
ボンディングのオプション値
type
文字列
ボンディングのオプションタイプ
--port_mirroring-networks-network パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.28 --port_mirroring-networks-network

名前タイプ説明
network.id
文字列
ミラーリングするネットワークへの参照
以下の表には、リソースベースのコマンドのその他の NIC オプションをまとめています。

表4.29 その他のコマンドオプション

オプション説明
--host-identifierサブリソースとして host に NIC を追加します。
--vm-identifierサブリソースとして vm に NIC を追加します。

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

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

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

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

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

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

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

[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.28 ホストのネットワークインターフェースへの論理ネットワークの割り当て

[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仮想マシンのディスクを非アクティブ化にします。

4.11. permission

permission リソースタイプは、Red Hat Enterprise Virtualization 環境のパーミッションリソースをすべてグループ化します。

表4.32 パーミッションのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--user-id--group-id
文字列
パーミッションを使ったユーザーやグループへの参照
はい
はい
いいえ
--role-id
文字列
パーミッションを割り当てるロールへの参照
はい
はい
いいえ
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクが完了する前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
以下の表には、リソースベースのコマンドのその他の permission オプションをまとめています。

表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
仮想 NIC プロファイルにパーミッションを追加します。

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

[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 Enterprise Virtualization 環境のロールに対する個別パーミットをすべてグループ化します。

表4.34 パーミッションのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--id
文字列
追加するパーミットへの参照
はい
はい
いいえ
以下の表には、リソースベースのコマンドのその他の permit オプションをまとめています。

表4.35 その他のコマンドオプション

オプション説明
--role-identifier
ロールにパーミットを追加します。

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

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

4.13. quota

quota リソースタイプは、Red Hat Enterprise Virtualization 環境のデータセンタークォータをすべてグループ化します。

表4.36 クォータのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
クォータ名
はい
はい
はい
--description
文字列
クォータの説明
はい
はい
はい

4.14. role

role リソースタイプは、Red Hat Enterprise Virtualization 環境の個別ロールをすべてグループ化します。

表4.37 ロールのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
ロール名
はい
はい
はい
--permits-permit
コレクション
ロールに最初から含まれているパーミット一覧。permit リソースタイプに含まれている追加パーミット。
はい
はい
いいえ
--description
文字列
ロールの説明
いいえ
はい
はい
--administrative
ブール値
管理者ロールの場合は true に設定します。
いいえ
はい
はい
--permits-permi パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

表4.38 --permits-permit パラメーター

名前タイプ説明
permit.id
文字列
ロールのパーミットに追加するパーミットへの参照

例4.31 新規ロールの作成

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

4.15. snapshot

snapshot リソースタイプは、Red Hat Enterprise Virtualization 環境の仮想マシンのスナップショットリソースをすべてグループ化します。

表4.39 スナップショットのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--description
文字列
スナップショットの説明です。
はい
はい
いいえ
以下の表には、リソースベースのコマンドのその他のスナップショットオプションをまとめています。

表4.40 その他のコマンドオプション

オプション説明
--vm-identifierサブリソースとして vm にディスクを追加します。

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

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

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

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

表4.41 仮想マシンのスナップショットアクション

アクション説明
restoreスナップショットを使用して復元します。

4.16. statistic

statistic リソースタイプ は、Red Hat Enterprise Virtualization 環境内のリソースの統計をグループ化します。リソースの統計は、リソース識別子に基づいてリストされます。

表4.42 statistic のリソース識別子

オプション説明
--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
上記のコマンドで表示された統計の name または idshow コマンドおよびリソース識別子とともに使用すると、指定した統計のさらに詳しい情報を表示することができます。以下の例のコマンドを実行すると、ホストの指定した統計の詳細が表示されます。
[RHEVM shell (connected)]# show statistic statistic_name|id --host-identifier Host name|id

4.17. storageconnection

storageconnection リソースタイプにより、ストレージ接続の追加、編集、削除が可能になります。

表4.43 ストレージ接続のパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--address
文字列
ストレージドメインのホスト名または IP アドレス
はい (NFS および iSCSI のみ)
はい
はい
--correlation_id
文字列
ストレージ接続のタグ識別子
いいえ
いいえ
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションを指定しないとタスクが完了する前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
--iqn
文字列
ストレージデバイスのターゲット IQN
はい (iSCSI のみ)
はい
はい
--mount_options
文字列
PosixFS 共有のマウントオプション
いいえ
はい
はい
--nfs_retrans
整数
NFS クライアントが 1 つの要求を完了するのに試みる再送信の回数
いいえ
はい
はい
--nfs_timeo
整数
NFS クライアントが要求の完了を待機する時間 (デシ秒単位)
いいえ
はい
はい
--nfs_version
文字列
使用する NFS のバージョン
いいえ
はい
はい
--password
文字列
iSCSI ストレージドメインのターゲットにログインする際の CHAP パスワード
いいえ
はい
はい
--path
文字列
ストレージドメインがマウントされたファイルパス。このパスはストレージ接続によりすでに使用されているパスには更新することができません。
はい (NFS、ローカル、PosixFS のみ)
はい
はい
--port
整数
iSCSI ストレージドメインに使用する TCP ポート
はい (iSCSI のみ)
はい
はい
--storagedomain-identifier
文字列
ディスクのストレージドメインへの参照
いいえ
いいえ
いいえ
--type
文字列
ストレージドメインのタイプ
はい
はい
いいえ
--username
文字列
iSCSI ストレージドメインのターゲットにログインする際の CHAP ユーザー名
いいえ
はい
はい
--vfs_type
文字列
PosixFS 共有の Linux 対応ファイルシステムのタイプ
はい (PosixFS のみ)
はい
はい

例4.34 新規ストレージ接続の作成

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

4.18. storagedomain

stuoredomain リソースタイプは、Red Hat Enterprise Virtualization 環境のストレージドメインリソースをすべてグループ化します。

表4.44 ストレージドメインのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
ストレージドメイン名
いいえ
はい
はい
--format
ブール値
v1v2v3 など、データセンターのメタデータ形式
はい
はい
いいえ
--host-id|name
文字列
ストレージドメインの初期化を行うホストへの参照。このホストの唯一の制約は、指定した物理ストレージにアクセス可能である必要があることです。
はい
はい
いいえ
--storage-address
文字列
ストレジデバイスの IP アドレスまたはホスト名
はい
はい
いいえ
--storage-logical_unit
コレクション
ストレージデバイスの論理ユニット情報
下記参照
はい
いいえ
--storage-mount_options
文字列
ストレージドメインのマウントオプション
下記参照
はい
いいえ
--storage-override_luns
ブール値
論理ユニット番号をオーバーライドするかどうかを定義します。このステータスは true または false のいずれかです。
下記参照
はい
いいえ
--storage-path
文字列
ストレージドメインを使用するストレージデバイスのパス
下記参照
はい
いいえ
--storage-type
文字列
iscsifcpnfsglusterfslocalfs または posixfs など、データセンターのストレージタイプ
はい
はい
いいえ
--storage-vfs_type
文字列
ストレージドメインのファイルシステムタイプを定義します。
下記参照
はい
いいえ
--type
文字列
dataisoexport などのストレージドメインタイプ
はい
はい
いいえ
--storage-logical_unit パラメーターは、以下の表にあるすべてのサブパラメーターを必要とするコレクションです。

表4.45 storage-logical_unit パラメーター

名前タイプ説明
logical_unit.address
文字列
ストレージデバイスを格納しているサーバーのアドレス
logical_unit.port
整数
サーバーのポート番号
logical_unit.target
文字列
ストレージデバイスのターゲット IQN
logical_unit.username
文字列
ターゲットにログインするための CHAP ユーザー名
logical_unit.password
文字列
ターゲットにログインするための CHAP パスワード
logical_unit.serial
文字列
ターゲットのシリアル ID
logical_unit.vendor_id
文字列
ターゲットのベンダー名
logical_unit.product_id
文字列
ターゲットの製品コード
logical_unit.lun_mapping
整数
ターゲットの論理ユニット番号デバイスマッピング
logical_unit.portal
文字列
論理ユニットポータル
logical_unit.paths
整数
論理ユニットパス
logical_unit.id
文字列
論理ユニット ID への参照
storage-type に応じて以下のパラメーターを使用します。

表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サブリソースとして datacenter にストレージドメインを追加します。

例4.35 新規ストレージドメインの作成

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

例4.36 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.37 ストレージドメインの更新

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

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

[RHEVM shell (connected)]# remove storagedomain DataStorage
以下の表には、ストレージドメインリソースに対するアクションをまとめています。

表4.48 ストレージドメインのアクション

アクション説明
activateデータセンター上でストレージドメインをアクティブ化します。
deactivateデータセンター上でストレージドメインを非アクティブ化します。

4.19. tag

tag リソースタイプは、 Red Hat Enterprise Virtualization 環境のタグをすべてグループ化します。

表4.49 タグのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
タグ名
はい
はい
はい
--description
文字列
文字列の説明
はい
はい
はい
--parent-name
文字列
タグをアタッチする親タグへの参照
はい
はい
はい

例4.39 新規タグの作成

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

4.20. template

template リソースタイプは、Red Hat Enterprise 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
文字列
仮想マシンテンプレートのベース。rhevvmware、あるいは 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
文字列
テンプレートより作成された各仮想マシンの移行アフィニティー。migratableuser_migratable または pinned を指定します。
いいえ
はい
はい
--description
文字列
仮想マシンのテンプレートの説明
いいえ
はい
はい
--comment
文字列
仮想マシンのテンプレートのコメント
いいえ
はい
はい
--custom_properties-custom_property
コレクション
パラメーターとしてカスタムスクリプトに渡されるユーザー定義の環境変数セット
いいえ
はい
はい
--os-type
文字列
仮想マシンテンプレートのオペレーティングシステム
いいえ
はい
はい
--os-boot
コレクション
仮想マシンテンプレートの起動デバイス。cdromhd、または network を指定します。例: --os-boot boot.dev=hd
いいえ
はい
はい
--cpu-topology-sockets
整数
仮想マシンテンプレートで利用可能な CPU ソケット数
いいえ
はい
はい
--cpu_shares
整数
仮想マシンが要求可能な CPU リソースのレベルを、他の仮想マシンに対して相対的に設定する値。たとえば、優先度の低い仮想マシンは 512、優先度が中程度の仮想マシンは 1024、優先度の高い仮想マシンは 2048 に設定します。
いいえ
はい
はい
--cpu-architecture
文字列
CPU アーキテクチャーを定義します。x86_64ppc64undefined のいずれかを選択します。
いいえ
はい
はい
--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
文字列
仮想マシンテンプレートのシリアル番号ポリシーを定義します。hostvmcustom のいずれかを指定します。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
文字列
仮想マシンテンプレート用のブートデバイス。cdromhdnetwork のいずれかを指定します。
--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.40 テンプレートの作成

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

例4.41 テンプレートの更新

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

例4.42 テンプレートの削除

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

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

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

4.21. user

user リソースタイプは、Red Hat Enterprise Virtualization 環境のユーザーをすべてグループ化します。

表4.57 ユーザーのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--user_name
文字列
ディレクトリーサービスからのユーザー名
はい
はい
いいえ
--domain-id|name
文字列
ディレクトリーサービスドメインへの参照
はい
はい
いいえ

例4.43 新規ユーザーの作成

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

4.22. vm

vm リソースタイプは、Red Hat Enterprise Virtualization 環境の仮想マシンのリソースをすべてグループ化します。

表4.58 仮想マシンのパラメーター

名前 タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
仮想マシン名
はい
はい
はい
--template-id|name
文字列
仮想マシンのベースとして使うテンプレートへの参照
はい
はい
いいえ
--cluster-id|name
文字列
仮想マシンが属するクラスターへの参照
はい
はい
はい
--instance_type-id|name
文字列
インスタンスタイプを定義します。customlargemediumsmalltinyxlarge のいずれかの値を指定します。
いいえ
はい
はい
--quota-id
文字列
仮想マシンのクォータ使用率への参照
いいえ
はい
いいえ
--timezone
文字列
Windows 仮想マシンに設定する Sysrprep タイムゾーン
いいえ
はい
はい
--os-boot
コレクション
仮想マシンのブートデバイス。cdromhdnetwork のいずれかの値を指定します。
いいえ
はい
はい
--custom_properties-custom_property
コレクション
パラメーターとしてカスタムスクリプトに渡されるユーザー定義の環境変数セット
いいえ
はい
はい
--os-type
文字列
その仮想マシンのオペレーティングシステム
いいえ
はい
はい
--usb-enabled
ブール値
仮想マシンの USB ポリシーを定義します。仮想マシンで USB を有効にするには true に設定します。
いいえ
はい
はい
--usb-type
文字列
有効な場合は USB タイプを定義します。
いいえ
はい
はい
--type
文字列
仮想マシンタイプを定義します。desktop または server のいずれかを指定します。
いいえ
はい
はい
--os-initRd
文字列
指定のカーネルで使用される initrd イメージへのパス。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接のブートをサポートしています。
いいえ
はい
はい
--display-monitors
整数
利用可能なディスプレイ数を定義します。
いいえ
はい
はい
--display-single_qxl_pci
ブール値
1 つの仮想 PCI デバイスを使用して複数のモニターを動作させるには、true に設定します。
いいえ
はい
はい
--display-type
文字列
ディスプレイタイプを定義します。spice または vnc のいずれかを指定します。
いいえ
はい
はい
--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-cmdline
文字列
定義されたカーネルも使用されるカーネルコマンドラインパラメーターの文字列。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接ブートをサポートしています。
いいえ
はい
はい
--cpu-topology-cores
整数
仮想マシンで利用可能な CPU コア数
いいえ
はい
はい
--cpu-architecture
文字列
CPU アーキテクチャーを定義します。x86_64ppc64undefined のいずれかを選択します。
いいえ
はい
はい
--memory
long
仮想マシンのメモリーサイズ (バイト)
いいえ
はい
はい
--memory_policy-guaranteed
long
仮想マシンを実行するためにホストで確保すべき最小メモリーサイズ (バイト)
いいえ
はい
はい
--memory_policy-ballooning
ブール値
メモリーバルーンデバイスを有効にするには、true に設定します。
いいえ
はい
はい
--high_availability-priority
整数
高可用性を使用する各仮想マシンの優先度の値 (移行および再起動の順序) を設定します。
いいえ
はい
はい
--high_availability-enabled
ブール値
仮想マシンに高可用性を有効にするかどうかを定義します。
いいえ
はい
はい
--domain-name
文字列
仮想マシンのドメイン名
いいえ
はい
はい
--description
文字列
仮想マシンの説明
いいえ
はい
はい
--comment
文字列
仮想マシンのコメント
いいえ
はい
はい
--stateless
ブール値
仮想マシンがステートレスの場合は true に設定します。ステートレスの仮想マシンには、ブート時に作成されたスナップショットが含まれ、シャットダウン時には削除されます。これは、再起動後に状態が永続化されないことを意味します。
いいえ
はい
はい
--permissions-clone
ブール値
元の仮想マシンのパーミッションをテンプレートにコピーするには、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 に設定します。
いいえ
はい
はい
--cpu-mode
文字列
CPU モードを定義します。customhost_modelhost_passthrough のいずれかを指定します。
いいえ
はい
はい
--cpu-topology-sockets
整数
仮想マシンで利用可能な CPU ソケット数
いいえ
はい
はい
--cpu_shares
整数
仮想マシンが要求可能な CPU リソースのレベルを、他の仮想マシンに対して相対的に設定する値。たとえば、優先度の低い仮想マシンは 512、優先度が中程度の仮想マシンは 1024、優先度の高い仮想マシンは 2048 に設定します。
いいえ
はい
はい
--placement_policy-affinity
文字列
各仮想マシンの移行アフィニティー。migratableuser_migratablepinned のいずれかを指定します。
いいえ
はい
はい
--placement_policy-host-id|name
文字列
移行アフィニティーに指定するホストへの参照
いいえ
はい
はい
--origin
文字列
仮想マシンのベース。rhevvmwarexen のいずれかを指定します。
いいえ
はい
はい
--os-kernel
文字列
仮想マシンの起動用に設定されたカーネルイメージへのパス。このオプションは BIOS ブートローダーを介さない、Linux カーネルの直接のブートをサポートしています。
いいえ
はい
はい
--disks-clone
ブール値
定義済みの template からディスクのクローンを作成するかどうか定義します。
いいえ
はい
いいえ
--disks-disk
コレクション
仮想マシンにアタッチされたディスクへの参照
いいえ
はい
はい
--tunnel_migration
ブール値
libvirt を介したデータ転送を有効にするには true に設定します。トンネル転送は、より強固な暗号化アルゴリズムを使用しますが、伝送中のデータ負荷が高くなります。
いいえ
はい
はい
--migration_downtime
整数
ライブマイグレーション中に仮想マシンを停止状態にできる最大時間をミリ秒単位で定義します。
いいえ
はい
はい
--virtio_scsi-enabled
ブール値
VirtIO コンソールデバイスを仮想マシンにアタッチするには、true に設定します。
いいえ
はい
はい
--soundcard_enabled:
ブール値
サウンドカードを有効にするには、true に設定します。
いいえ
はい
はい
--payloads-payload
コレクション
起動時に仮想マシンへ送信するコンテンツを定義します。
いいえ
はい
はい
--initialization-configuration-type
文字列
仮想マシンのフォーマットを定義します。許容される値は、ovf のみです。
いいえ
はい
はい
--initialization-configuration-data
文字列
このパラメーターは --initialization-configuration-type パラメーターと一致する必要があります。許容される値は ovf のみです。
いいえ
はい
はい
--cpu-cpu_tune-vcpu_pin
コレクション
ホストの物理 CPU にピニングする仮想マシンの仮想 CPU を定義します。
いいえ
はい
はい
--serial_number-policy
文字列
仮想マシンテンプレートのシリアル番号ポリシーを定義します。hostvmcustom のいずれかを指定します。custom を使用する場合には、 --serial_number-value でシリアル番号の値も定義してください。
いいえ
はい
はい
--serial_number-value
文字列
仮想マシンテンプレートのシリアル番号を定義します。
いいえ
はい
はい
--bios-boot_menu-enabled
ブール値
ブートメニューを有効にするには true に設定します。
いいえ
はい
はい
--numa_tune_mode
文字列
NUMA ホスト上のドメインプロセスにメモリーを割り当てる方法を定義します。interleavestrictpreferred のいずれかを指定します。このパラメーターに値が指定されていない場合には、デフォルトで strict が適用されます。
いいえ
はい
はい
--cpu_profile-id
文字列
使用する CPU プロファイルを定義します。list cpuprofiles コマンドで CPU プロファイル ID の全一覧を取得します。
いいえ
はい
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクの完了前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
--correlation_id
文字列
システム共通ロギングのアクションに対するタグ識別子。クライアントが識別子を定義しない場合は生成されます。
いいえ
はい
いいえ
--os-boot パラメーターは、以下の表のサブパラメーターを使用するコレクションです。

表4.59 --os-boot parameters

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

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

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

表4.61 --sso-methods-method parameters

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

表4.62 --disks-disk parameters

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

表4.63 --payloads-payload パラメーター

名前 タイプ説明
payload.type
文字列
ペイロードデリバリータイプ。cdrom または floppy のいずれかを指定します。
payload.file.name
文字列
仮想マシンの root ファイルシステムにあるペイロードファイル名と場所です。
payload.file.content
文字列
ファイルに送るコンテンツ
--cpu-cpu_tune-vcpu_pin パラメーターは、以下の表にあるサブパラメーターを利用するコレクションです。

表4.64 --cpu-cpu_tune-vcpu_pin

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

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

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

例4.45 仮想マシンの更新

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

例4.46 仮想マシンの削除

[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 Enterprise Virtualization 環境の仮想マシンのプールリソースをすべてグループ化します。

表4.66 仮想マシンプールのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--cluster-id|name
文字列
仮想マシンプールに関するクラスターへの参照
はい
はい
はい
--template-id|name
文字列
仮想マシンプールのテンプレートへの参照
はい
はい
はい
--name
文字列
仮想マシンプール名
はい
はい
はい
--size
整数
プールにある仮想マシンの数
はい
はい
はい

例4.47 新規仮想マシンプールの作成

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

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

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

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

[RHEVM shell (connected)]# remove vmpool MyPool

4.24. vnicprofile

vnicprofile リソースタイプは、仮想ネットワークインターフェースコントローラー (vNIC または仮想 NIC) プロファイル (Red Hat Enterprise Virtualization 環境では仮想マシンインターフェースプロファイルとも呼ばれる) をグループ化します。

表4.67 仮想ネットワークインターフェースコントローラーのパラメーター

名前タイプ説明必須ユーザーが作成可能ユーザーが更新可能
--name
文字列
仮想 NIC プロファイルの名前
はい
はい
はい
--network-id
文字列
プロファイルが適用される論理ネットワークへの参照
はい
いいえ
いいえ
--correlation_id
文字列
システム共通ロギングのアクションに対するタグ識別子。クライアントが識別子を定義しない場合は生成されます。
いいえ
はい
いいえ
--description
文字列
プロファイルの説明
いいえ
はい
はい
--expect
'201-created'
必要とされる HTTP ヘッダーが返されるまで、要求は非同期になります。このオプションは、指定しないとタスクの完了前に「成功」と返されてしまうような実行時間の長いタスクに役立ちます。
いいえ
いいえ
いいえ
--custom_properties-custom_property
コレクション
パラメーターとしてカスタムスクリプトに渡されるユーザー定義の環境変数
いいえ
はい
はい
--port_mirroring
ブール値
プロファイルにポートミラーリングを使用するかどうかを切り替えます。ステータスは True または False のいずれかです。デフォルトは False です。
いいえ
いいえ
いいえ
--custom_properties-custom_property パラメーターは、以下の表に記載したサブパラメーターを使用するコレクションです。

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

名前タイプ説明
custom_property.name
文字列
カスタムのプロパティー名
custom_property.value
文字列
カスタムのプロパティー値

例4.50 新規仮想 NIC プロファイルの作成

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

例4.51 仮想 NIC プロファイルの更新

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

例4.52 仮想 NIC プロファイルの削除

[RHEVM shell (connected)]# remove vnicprofile Gold

第5章 CLI クエリー

5.1. クエリーの構文

CLI の list コマンドは --query 属性を使用してサーバー側のクエリーを実行します。このコマンドは、Red Hat Enterprise Virtualization Manager の検索クエリー言語と同じ形式を使用します。

表5.1 検索クエリーの例

コレクション条件結果
hostsvms.status=upup 状態の仮想マシンを実行中の全ホストの一覧を表示
vmsdomain=qa.company.com指定したドメインで稼働中の全仮想マシンの一覧を表示
vmsusers.name=maryユーザー名が mary のユーザーに属する全仮想マシンの一覧を表示
eventsseverity>normal sortby time重大度が normal を超えるすべての events の一覧を表示し、time 要素値でソート
eventsseverity>normal sortby time desc重大度が normal を超えるすべての events の一覧を表示し、time 要素値の降順にソート

5.2. ワイルドカード

検索クエリーは、値の一部の代わりに、アスタリスクをワイルドカードとして使用します。

例5.1 ワイルドカードを使用した name=vm* の検索クエリー

[RHEVM shell (connected)]# list vms --query "name=vm*"
このクエリーは、vm1vm2vmavm-webserver など vm で始まる仮想マシン名をすべて表示します。

例5.2 ワイルドカードを使用した name=v*1 の検索クエリー

[RHEVM shell (connected)]# list vms --query "name=v*1"
このクエリーは、vm1vr1virtualmachine1 など v で始まり 1 で終わる仮想マシン名をすべて表示します。

付録A 改訂履歴

改訂履歴
改訂 3.6-5.1Sat Jan 23 2016Red Hat Localization Services
翻訳ファイルを XML ソースバージョン 3.6-5 と同期
改訂 3.6-5Fri 11 Dec 2015Red Hat Enterprise Virtualization Documentation Team
BZ#1284288: 「rhevm」管理ネットワークと記載されていた箇所を「ovirtmgmt」に変更
改訂 3.6-4Mon 23 Nov 2015Red Hat Enterprise Virtualization Documentation Team
BZ#978709: Gluster Storage ドメインのパラメーターおよび例を追加
改訂 3.6-3Wed 18 Nov 2015Red Hat Enterprise Virtualization Documentation Team
Red Hat Enterprise Virtualization 3.6 ベータリリースの最終版作成
改訂 3.6-2Wed 18 Nov 2015Red Hat Enterprise Virtualization Documentation Team
BZ#1252761: rhem-shell への認証に Kerberos オプションを追加
3.6 ベータ版の RHEVM CLI インストールリポジトリーを更新
改訂 3.6-1Mon 10 Aug 2015Red Hat Enterprise Virtualization Documentation Team
Red Hat Enterprise Virtualization 3.6 リリースの初版作成

法律上の通知

Copyright © 2016 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.