コマンドラインインターフェイス

xe CLIを使用すると、システム管理タスクをスクリプト化して自動化できます。CLIを使用することで、を既存のITインフラストラクチャに統合できます。

xeコマンドラインインターフェイスは、ホストにデフォルトでインストールされ、にも含まれています。Linuxの場合、スタンドアロンのリモートCLIも使用できます。

Windowsでは、 xe.exeコマンドがと一緒にインストールされています。

xe.exeコマンドを使用するには、Windowsのコマンドプロンプトを開き、ディレクトリをxe.exeファイルが保存されているディレクトリに変更します(通常はC:\Program Files\\)。xe.exeのインストール先をシステムパスに追加する場合は、ディレクトリを変更することなくコマンドを使用できます。

RPMベースのディストリビューション(Red Hatなど)では、メインのインストールISOイメージの「xe-cli-6.00-BUILD.i386.rpm」という名前のRPMからスタンドアロンxeコマンドをインストールできます。次のコマンドを使用します:

rpm -ivh xe-cli-6.00-BUILD.i386.rpm

ホスト上のCLIの基本ヘルプを表示するには、次のコマンドを実行します。

xe help command

使用頻度の高いxeコマンドの一覧を表示するには、次のコマンドを実行します:

xe help

また、すべてのxeコマンドの一覧を表示するには、次のコマンドを実行します:

xe help --all

xeの基本構文

のすべてのxeコマンドの基本構文は、次のとおりです。

xe command-name argument=value argument=value

各コマンドには、argument=valueという形式で指定する引数のセットがあります。一部のコマンドには必須の引数があり、多くのコマンドにはオプションの引数があります。通常、オプションの引数を指定せずにコマンドを実行すると、各引数のデフォルト値が適用されます。

xeコマンドがリモートで実行されると、接続と認証に追加の引数が使用されます。これらの引数も、argument=argument_value形式で指定します。

server引数では、コマンドの実行先のホスト名またはIPアドレスを指定します。username引数とpassword引数では、認証情報(ユーザー名とパスワード)を指定します。password-file引数は、パスワードを直接入力する代わりに指定できます。この場合、xeコマンドは指定されたファイルからパスワードの読み取りを試み、そのパスワードを使用して接続します(ファイルの末尾にあるCRとLFはすべて削除されます)。この方法は、コマンドラインで直接パスワードを指定するよりも安全です。

オプションのport引数を使用して、リモートののエージェントポート(デフォルトで443)を指定できます。

例:ローカルのホストに対するコマンド:

xe vm-list

例:リモートのホストに対するコマンド:

xe vm-list -user username -password password -server hostname

リモート接続用の引数では、以下の省略構文も使用できます。

  • -u:ユーザー名
  • -pw:パスワード
  • -pwf:パスワードファイル
  • -p:ポート
  • -s:サーバー

例:リモートのホストに対するコマンド:

xe vm-list -u myuser -pw mypassword -s hostname

また、引数は、環境変数XE_EXTRA_ARGSからコンマ区切りのキー/値ペアの形式でも取得されます。たとえば、リモートのホストで実行されるコマンドを入力するには、まず次のコマンドを実行します:

export XE_EXTRA_ARGS="server=jeffbeck,port=443,username=root,password=pass"

このコマンドを実行した後は、実行する各xeコマンドでリモートのホストパラメーターを指定する必要はありません。

また、環境変数XE_EXTRA_ARGSを使用すると、リモートのホストにxeコマンドを実行するときに、Tabキーによる自動補完機能を使用できるようになります。この機能はデフォルトでは無効になっています。

特殊文字と構文

xeコマンドで引数/値ペアを指定するには、以下の形式を使用します:

argument=value

値にスペースが含まれている場合を除き、引用符を使用しないでください。また、引数名、等号(=)、および値の間にスペースを挿入しないでください。この形式に従っていない引数はすべて無視されます。

値にスペースが含まれる場合は、以下の形式を使用します。

argument="value with spaces"

ホストでCLIを使用する場合、標準のLinux bashシェルの機能に類似したTabキーによる自動補完機能を使用できます。たとえば、「xe vm-l」と入力してからTabキーを押すと、コマンドの残りの部分が表示されます。ただし、vm-lで始まるコマンドが複数ある場合は、Tabキーをもう1回押すと、それらのコマンドが一覧表示されます。この機能は、コマンド内でオブジェクトのUUIDを指定する場合に便利です。

注:

リモートのホストに対してコマンドを実行する場合、通常この自動補完機能は無効です。ただし、コマンドを入力するマシンでXE_EXTRA_ARGS変数を設定すると、自動補完機能が有効になります。詳しくは、「xeの基本構文」を参照してください。

コマンドの種類

CLIコマンドは2つに分けることができます。低レベルコマンドは、APIオブジェクトのリスティングとパラメーター操作に関係しています。高レベルコマンドは、より抽象的なレベルの仮想マシンまたはホストと対話するために使用されます。

低レベルコマンドは、以下のとおりです。

  • class-list

  • class-param-get

  • class-param-set

  • class-param-list

  • class-param-add

  • class-param-remove

  • class-param-clear

ここで、classは以下のいずれかです:

  • bond

  • console

  • host

  • host-crashdump

  • host-cpu

  • network

  • patch

  • pbd

  • pif

  • pool

  • sm

  • sr

  • task

  • template

  • vbd

  • vdi

  • vif

  • vlan

  • vm

これらのclass値ですべてのclass-param-actionコマンドを使用できるわけではありません。class値の一部には、コマンドセットがより小さいものもあります。

パラメーターの種類

xeコマンドで操作するオブジェクトには、それを識別したり状態を定義したりするためのパラメータセットがあります。

ほとんどのパラメータでは、1つの値を取ります。たとえば、仮想マシンのname-labelパラメーターでは、1つの文字列値を指定します。xe vm-param-listのようなパラメーターリストコマンドからの出力では、かっこ内の値は、パラメーターが読み取り/書き込み(RW)か読み取り専用(RO)かを示します。 特定の仮想マシンに対するxe vm-param-listコマンドによる出力には、以下の行が含まれることがあります:

user-version ( RW): 1
is-control-domain ( RO): false

1つ目のパラメーターuser-versionは書き込み可能であり、値は1です。2つ目のis-control-domainは読み取り専用で、値はfalseです。

パラメーターにはこのほかにも2つの種類があり、これらは複数の値を取ります。setパラメーターには、値の一覧が含まれます。mapパラメーターには、キー/値ペアのセットが含まれます。たとえば、以下は、特定の仮想マシンに対する xe vm-param-listコマンドのサンプル出力の一部です

platform (MRW): acpi: true; apic: true; pae: true; nx: false
allowed-operations (SRO): pause; clean_shutdown; clean_reboot; \
hard_shutdown; hard_reboot; suspend

platformパラメーターには、キー/値ペアを表す項目のリストがあります。キー名の後にはコロン文字(:)が付きます。キー/値の各ペアは、セミコロン文字(;)で区切られます。MRWのMはマップパラメーターであることを示し、RWは読み取りと書き込みが可能であることを示します。allowed-operationsパラメーターには、項目セットを構成するリストがあります。SROのSはセットパラメータであることを示し、ROは読み取り専用であることを示します。

マップパラメーターをフィルターする、つまりマップパラメーターを設定する場合は、区切り文字のコロン(:)をマップパラメーター名とキー/値ペアの間に挿入します。たとえば、仮想マシンのother-configパラメーターのfooキーの値をbaaに設定する場合、コマンドは次のようになります。

xe vm-param-set uuid=VM uuid other-config:foo=baa

注:

以前のリリースでは、ハイフン文字(-)を使用してマップパラメーターを指定していました。このバージョンでも従来の構文を使用できますが、将来廃止予定です。

低レベルパラメーターコマンド

class-param-get、class-param-set、class-param-add、class-param-remove、class-param-clear、およびclass-param-listは、オブジェクトのパラメータを操作するコマンドです。これらのコマンドは、uuidパラメーターを取って、特定のオブジェクトを指定します。これらのコマンドは低レベルのコマンドとみなされるため、仮想マシンの名前ラベルではなく、UUIDを指定する必要があります。

  • class-param-list uuid=uuid

    すべてのパラメータとその値のリストを出力します。class-listコマンドとは異なり、「expensive」フィールドの値のリストが出力されます。

  • class-param-get uuid=uuid param-name=parameter param-key=key

    特定のパラメーターの値を返します。マップパラメーターの場合、param-keyを指定すると、マップのキーに対応する値が取得されます。param-keyを指定しない場合、またはパラメーターがセットの場合は、セットまたはマップの文字列表現が返されます。

  • class-param-set uuid=uuid param=value

    1つまたは複数のパラメータの値を設定します。

  • class-param-add uuid=uuid param-name=parameter key=value param-key=key

    マップまたはセットパラメータに値を追加します。マップパラメーターの場合は、key=value構文を使用してキー/値ペアを追加します。パラメーターがセットの場合は、param-key=key構文でキーを追加します。

  • class-param-remove uuid=uuid param-name=parameter param-key=key

    マップパラメータのキー/値ペアまたはセットパラメータのキーを削除します。

  • class-param-clear uuid=uuid param-name=parameter

    セットまたはマップを完全にクリアします。

低レベルリストコマンド

class-listコマンドでは、classで指定する種類のオブジェクトのリストが出力されます。デフォルトでは、このタイプのコマンドはすべてのオブジェクトをリストし、パラメーターのサブセットを出力します。この動作は、次の方法で変更できます:

  • サブセットのみを出力するようにオブジェクトをフィルタリングできます。
  • 出力されるパラメーターは変更できます。

出力されるパラメーターを変更するには、必要なパラメーターのコンマ区切り一覧として引数paramsを指定します。例:

xe vm-list params=name-label,other-config

すべてのパラメータのリストを出力するには、次の構文を使用します。

xe vm-list params=all

計算のために多くのリソースを消費するパラメーターは、listコマンドで表示されない場合があります。この場合、そのパラメーターは次のように示されます:

allowed-VBD-devices (SRO): <expensive field>

これらのフィールドを取得するには、class-param-listコマンドまたはclass-param-getコマンドを使用します。

特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルターする)には、そのパラメーターおよび値をコマンドラインで指定します。例:

xe vm-list HVM-boot-policy="BIOS order" power-state=halted

この例では、power-stateフィールドに値haltedを持ち、さらにHVM-boot-policyフィールドに値BIOS orderを持つ仮想マシンだけが出力されます。

マップのキーの値、またはセットの値が存在するかどうかによってリストをフィルタすることもできます。マップのキーに基づくフィルタリングの構文は、map-name:key=valueです。セットに存在する値に基づくフィルタリングの構文は、set-name:contains=valueです。

スクリプトを作成する場合は、コマンドラインに--minimalを渡すことで、xeで最初のフィールドだけをコンマ区切りで出力できます。たとえば、3つの仮想マシンがインストールされたホスト上でxe vm-list --minimalを実行すると、次のように3つの仮想マシンのUUIDがコンマ区切りで出力されます:

a85d6717-7264-d00e-069b-3b1d19d56ad9,aaa3eec5-9499-bcf3-4c03-af10baea96b7, \
42c044de-df69-4b30-89d9-2c199564581d

xeコマンドリファレンス

このセクションでは、コマンドが扱うオブジェクトによってコマンドをグループ化します。これらのオブジェクトはアルファベット順に表示されます。

アプライアンスコマンド

vAppとも呼ばれる仮想アプライアンス(applianceオブジェクト)を作成または変更します。詳しくは、「vApps」を参照してください。

applianceオブジェクトのパラメーター

applianceオブジェクトには、以下のパラメーターがあります:

パラメーター名 説明 種類
uuid アプライアンスのUUID 必須
name-description アプライアンスの説明文字列 オプション
paused   オプション
force 強制シャットダウン オプション

appliance-assert-can-be-recovered

appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid

この仮想アプライアンス/vAppを回復するためのストレージが使用可能かどうかをテストします。

appliance-create

appliance-create name-label=name-label [name-description=name-description]

仮想アプライアンス/vAppを作成します。例:

xe appliance-create name-label=my_appliance

アプライアンスに仮想マシンを追加します。

xe vm-param-set uuid=VM-UUID appliance=appliance-uuid \
xe vm-param-set uuid=VM-UUID appliance=appliance-uuid

appliance-destroy

appliance-destroy uuid=appliance-uuid

仮想アプライアンス/vAppを破棄します。例:

xe appliance-destroy uuid=appliance-uuid

appliance-recover

appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [paused=true|false]

指定したVDIのデータベースから仮想アプライアンス/vAppを回復します。

appliance-shutdown

appliance-shutdown uuid=appliance-uuid [force=true|false]

仮想アプライアンス/vAppのすべての仮想マシンをシャットダウンします。例:

xe appliance-shutdown uuid=appliance-uuid

appliance-start

appliance-start uuid=appliance-uuid [paused=true|false]

仮想アプライアンス/vAppを起動します。例:

xe appliance-start uuid=appliance-uuid

監査コマンド

リソースプールのRBAC監査ファイルのすべての記録をファイルとしてダウンロードします。オプションのsinceパラメーターを指定すると、その日時以降の記録のみがダウンロードされます。

audit-log-getパラメーター

audit-log-getには次のパラメーターがあります

パラメーター名 説明 種類
filename プールの監査ログをfilenameで指定するファイルに書き込みます 必須
since 特定の日時以降の記録のみをダウンロードします オプション

audit-log-get

audit-log-get [since=timestamp] filename=filename

指定した日時(ミリ秒単位)以降の監査ログをダウンロードします。

次のコマンドを実行します。

xe audit-log-get since=2009-09-24T17:56:20.530Z filename=/tmp/auditlog-pool-actions.out

ボンディングコマンド

物理インターフェイスのフェールオーバーによる障害許容力のために、ネットワークボンドを操作します。詳しくは、「ネットワーク」を参照してください。

bondオブジェクトは、mastermemberのPIFを結合する参照オブジェクトです。master PIFは、bondオブジェクトを参照するために総体的なPIFとして使用されるボンディングインターフェイスです。member PIFは、2つ以上の物理インターフェイスのセットであり、高レベルのボンディングインターフェイスとして結束されています。

bondオブジェクトのパラメーター

bondオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid ボンディングの一意の識別子/オブジェクト参照 読み取り専用
master ボンドマスタPIFのUUID 読み取り専用
members ボンディングを構成するPIFのUUIDのセット 読み取り専用

bond-create

bond-create network-uuid=network_uuid pif-uuids=pif_uuid_1,pif_uuid_2,...

既存のPIFオブジェクトをリストで指定して、指定したネットワーク上にボンディングネットワークインターフェイスを作成します。コマンドは、次のいずれかの場合に失敗します:

  • PIFが既に別のボンドにある場合
  • いずれかのメンバーにVLANタグが設定されている場合
  • 参照されるPIFが同じホストにない場合
  • PIFが2個未満の場合

bond-destroy

bond-destroy uuid=bond_uuid

UUIDで指定したボンディングインターフェイスをホストから削除します。

bond-set-mode

bond-set-mode uuid=bond_uuid mode=bond_mode

ボンディングモードを変更します。

CD(仮想ネットワーク)コマンド

ホスト上の物理CD/DVDドライブ(cdオブジェクト)を操作します。

cdオブジェクトのパラメーター

cdオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid CDの一意の識別子/オブジェクト参照 読み取り専用
name-label CDの名前 読み取り/書き込み
name-description CDの説明文字列 読み取り/書き込み
allowed-operations このCD上で実行できる操作のリスト 読み取り専用のセットパラメータ
current-operations このCD上で現在処理中の操作のリスト 読み取り専用のセットパラメータ
sr-uuid このCDが属しているストレージリポジトリの一意の識別子/オブジェクト参照 読み取り専用
sr-name-label このCDが属しているストレージリポジトリの名前 読み取り専用
vbd-uuids このCDに接続している仮想マシン上のVBDの一意の識別子のリスト 読み取り専用のセットパラメータ
crashdump-uuids CDでは使用されません。クラッシュダンプはCDに書き込むことができないため 読み取り専用のセットパラメータ
virtual-size 仮想マシンに表示されたCDのサイズ(バイト数) 読み取り専用
physical-utilisation ストレージリポジトリ上でのCDイメージの物理スペース(バイト数) 読み取り専用
type CDのユーザーに設定 読み取り専用
sharable CDドライブが共有可能かどうか。デフォルトはfalseです。 読み取り専用
read-only CDが読み取り専用かどうか。falseの場合は書き込み可能。CDでは常にtrue 読み取り専用
storage-lock このディスクがストレージレベルでロックされている場合はtrue 読み取り専用
parent このCDがチェーンの一部である場合は、親ディスクへの参照 読み取り専用
missing ストレージリポジトリのスキャン操作によりこのCDがディスク上に存在しないと認識された場合値はtrue 読み取り専用
other-config CDの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
location このデバイスがマウントされているパス 読み取り専用
managed デバイスが管理されている場合はtrue 読み取り専用
xenstore-data xenstoreツリーに挿入されるべきデータ 読み取り専用のマップパラメータ
sm-config ストレージマネージャーデバイス設定キーの名前と説明 読み取り専用のマップパラメータ
is-a-snapshot このテンプレートがCDスナップショットの場合はtrue 読み取り専用
snapshot_of このテンプレートのスナップショット元のCDのUUID 読み取り専用
snapshots このCDから作成されたすべてのスナップショットのUUID 読み取り専用
snapshot_time スナップショット作成日時 読み取り専用

cd-list

cd-list [params=param1,param2,...] [parameter=parameter_value]

ホストまたはリソースプール上のCDとISO(CDイメージファイル)のリストを、オプションの引数paramsに基づいてフィルタして出力します。

オプションの引数paramsを使用して特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルタする)場合は、そのオブジェクトのパラメーターのリストを含む文字列を値として指定します。または、キーワードallを指定してすべてのパラメーターのリストを出力することもできます。paramsを使用しない場合、使用可能なすべてのパラメーターのうち、デフォルトのサブセットが出力されます。

オプションの引数には、本セクションに記載されているCDパラメーターから任意の数を指定できます。

クラスターコマンド

クラスター化されたプールを操作します。

クラスター化されたプールは、クラスタリング機能が有効になっているリソースプールです。GFS2ストレージリポジトリと共にこれらのプールを使用します。詳しくは、「クラスター化されたプール」を参照してください。

クラスターおよびクラスターホストのオブジェクトのリストは、標準オブジェクトリストコマンド(xe cluster-listおよびxe cluster-host-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。 クラスター化されたプールを操作します。

クラスターパラメーター

クラスターには次のパラメーターがあります:

パラメーター名 説明 種類
uuid クラスターの一意の識別子/オブジェクト参照 読み取り専用
cluster-hosts クラスター内のホストの一意の識別子/オブジェクト参照のリスト 読み取り専用のセットパラメータ
cluster-token xapi-clusterdが他のホスト上で自身と通信するときに使用する秘密キー 読み取り専用
cluster-stack クラスタリング機能を提供するテクノロジスタック。使用できる値はcorosyncです。 読み取り専用
allowed-operations 現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でクラスターの状態が変更されている可能性もあります。 読み取り専用のセットパラメータ
current-operations 現在処理中の操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でクラスターの状態が変更されている可能性もあります。 読み取り専用のセットパラメータ
token-timeout corosyncトークンのタイムアウト(秒単位) 読み取り専用
token-timeout-coefficient corosyncトークンのタイムアウト係数(秒単位) 読み取り専用
pool-auto-join 新しいプールメンバーをクラスターに自動的に参加させる場合はtrue。これはtrueに設定されています。 読み取り専用
cluster-config クラスターの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り専用のマップパラメータ
other-config クラスターの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ

cluster-host-create

cluster-host-create cluster-uuid=cluster_uuid host-uuid=host_uuid pif-uuid=pif_uuid

既存のクラスターにホストを追加します。

cluster-host-destroy

cluster-host-destroy uuid=host_uuid

クラスターホストを破棄して、クラスターを効果的に残します。

cluster-host-disable

cluster-host-disable uuid=cluster_uuid

有効なクラスターホストのクラスターメンバーシップを無効にします。

cluster-host-enable

cluster-host-enable uuid=cluster_uuid

無効になっているクラスターホストのクラスターメンバーシップを有効にします。

cluster-host-force-destroy

cluster-host-force-destroy uuid=cluster_host

クラスターホストオブジェクトを強制的に破棄して、クラスターを効果的に残します。

cluster-pool-create

cluster-pool-create network-uuid=network_uuid [cluster-stack=cluster_stack] [token-timeout=token_timeout] [token-timeout-coefficient=token_timeout_coefficient]

プール全体のクラスターを作成します。

cluster-pool-destroy

cluster-pool-destroy cluster-uuid=cluster_uuid

プール全体のクラスターを破棄します。プールは引き続き存在しますが、クラスター化されなくなり、GFS2ストレージリポジトリを使用できなくなります。

cluster-pool-force-destroy

cluster-pool-force-destroy cluster-uuid=cluster_uuid

プール全体のクラスターを強制的に破棄します。

cluster-pool-resync

cluster-pool-resync cluster-uuid=cluster_uuid

プール全体でクラスターを再同期します。

コンソールコマンド

コンソール(consoleオブジェクト)を操作します。

consoleオブジェクトのリストは、標準オブジェクトリストコマンド(xe console-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

consoleオブジェクトのパラメーター

consoleオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid コンソールの一意の識別子/オブジェクト参照 読み取り専用
vm-uuid このコンソールを開いているVMの一意の識別子/オブジェクト参照 読み取り専用
vm-name-label このコンソールを開いているVMの名前 読み取り専用
protocol このコンソールが使用するプロトコル。vt100:VT100ターミナル、rfb:Remote Framebufferプロトコル(VNCで使用)、またはrdp:Remote Desktop Protocol(RDP)のいずれか 読み取り専用
location このコンソールのサービスのURI 読み取り専用
other-config コンソールの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ

console

console

特定のコンソールに接続します。

診断コマンド

診断情報をから収集するためのコマンドです。

diagnostic-compact

diagnostic-compact

主要なGC収集とヒープの圧縮を実行します。

diagnostic-db-log

diagnostic-db-log

データベース操作のロギングを開始します。警告:一度起動すると停止できません。

diagnostic-db-stats

diagnostic-db-stats

データベース統計を出力します。

diagnostic-gc-stats

diagnostic-gc-stats

GC統計を出力します。

diagnostic-license-status

diagnostic-license-status

プール全体のライセンス問題を診断するのに役立ちます。

diagnostic-net-stats

diagnostic-net-stats [uri=uri] [method=method] [params=param1,param2...]

ネットワーク統計を出力します。

diagnostic-timing-stats

diagnostic-timing-stats

タイミング統計を出力する。

diagnostic-vdi-status

diagnostic-vdi-status uuid=vdi_uuid

VDIのロックおよび共有状態を照会します。

diagnostic-vm-status

diagnostic-vm-status uuid=vm_uuid

VMが起動できるホストを照会し、すべてのVBDの共有/ロック状態を確認します。

障害回復コマンド

障害発生後に仮想マシンを回復するコマンドです。

drtask-create

drtask-create type=type sr-whitelist=sr-white-list device-config=device-config

障害回復タスクを作成します。たとえば、障害回復の準備タスクとして特定のiSCSIストレージリポジトリに接続するには、次のコマンドを実行します。

xe drtask-create type=lvmoiscsi device-config:target=target-ip-address \
device-config:targetIQN=targetIQN device-config:SCSIid=SCSIid \
sr-whitelist=sr-uuid-list

注:

コマンドsr-whitelistはストレージリポジトリUUIDをリストします。drtask-createコマンドは、ホワイトリストに登録されたUUIDの1つを持つストレージリポジトリのみを導入して接続します

drtask-destroy

drtask-destroy uuid=dr-task-uuid

障害回復タスクを破棄してストレージリポジトリの接続を消去します。

vm-assert-can-be-recovered

vm-assert-can-be-recovered uuid=vm-uuid database:vdi-uuid=vdi-uuid

特定の仮想マシンを回復するためにストレージを使用できるかどうかをテストします。

appliance-assert-can-be-recovered

appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid

仮想アプライアンス/vAppディスクを格納しているストレージが使用可能かどうかをチェックします。

appliance-recover

appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [force=true|false]

指定したVDIのデータベースから仮想アプライアンス/vAppを回復します。

vm-recover

vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid [force=true|false]

指定したVDIのデータベースから仮想マシンを回復します。

sr-enable-database-replication

sr-enable-database-replication uuid=sr_uuid

指定した(共有)ストレージリポジトリへのXAPIデータベースの複製を有効にします。例:

xe sr-enable-database-replication uuid=sr-uuid

sr-disable-database-replication

sr-disable-database-replication uuid=sr_uuid

指定したストレージリポジトリへのXAPIデータベースの複製を無効にします。例:

xe sr-enable-database-replication uuid=sr-uuid

使用例

ここでは、障害回復コマンドの使用例を順に挙げます。

プライマリサイトで、データベースの複製を有効にします。

xe sr-database-replication uuid=sr=uuid

障害発生後、セカンダリサイトでストレージリポジトリに接続します。device-configコマンドにはsr-probeと同じフィールドがあります。

xe drtask-create type=lvmoiscsi \
device-config:target=target ip address \
device-config:targetIQN=target-iqn \
device-config:SCSIid=scsi-id \
sr-whitelist=sr-uuid

ストレージリポジトリ上のデータベースVDIを見つけます。

xe vdi-list sr-uuid=sr-uuid type=Metadata

データベースVDIから仮想マシンを照会します。

xe vm-list database:vdi-uuid=vdi-uuid

仮想マシンを回復します。

xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid

障害回復タスクを破棄します。このタスクによりイントロデュースされ、かつ仮想マシンで使用されないすべてのストレージリポジトリを破棄します:

xe drtask-destroy uuid=drtask-uuid

イベントコマンド

イベント(eventオブジェクト)を操作します。

eventオブジェクトのクラス

eventオブジェクトには、以下のクラスがあります。

クラス名 説明
pool 物理ホストのリソースプール
vm 仮想マシン
host 物理ホスト
network 仮想ネットワーク
vif 仮想ネットワークインターフェイス
pif 物理ネットワークインターフェイス(NICに関連付けられた各VLANは個別のPIFとして表されます)
sr ストレージレポジトリ
vdi 仮想ディスクイメージ
vbd 仮想ブロックデバイス
pbd ホストがストレージリポジトリへのアクセスに使用する物理ブロックデバイス

event-wait

event-wait class=class_name [param-name=param_value] [param-name=/=param_value]

コマンドラインで指定された条件を満たすオブジェクトが存在するまで他のコマンドの実行をブロックします。x=yは「フィールドxの値がyになるまで待機する」、x=/=yは、「フィールドxの値がy以外になるまで待機する」を意味します。

例:特定の仮想マシンが実行状態になるまで待機する場合は、次のコマンドを実行します。

xe event-wait class=vm name-label=myvm power-state=running

このコマンドでは、myvmという名前の仮想マシンのpower-stateが「running」になるまで、ほかのコマンドの実行をブロックします。

例:特定の仮想マシンが再起動するまで待機する場合は、次のコマンドを実行します。

xe event-wait class=vm uuid=$VM start-time=/=$(xe vm-list uuid=$VM params=start-time --minimal)

このコマンドでは、UUIDが $VM の仮想マシンが再起動するまで、ほかのコマンドの実行をブロックします。このコマンドはstart-timeの値で仮想マシンがいつ再起動するかを決定します。

クラス名は、このセクションの冒頭に挙げられているイベントクラスから選ぶことができます。パラメーターは、CLIコマンドのclass-pram-listにリストされているパラメーターから選ぶことができます。

GPUコマンド

物理GPU(pgpu)、GPUグループ(gpu-group)、および仮想GPU(vgpu)を操作します。

GPUオブジェクトは、次の標準的なオブジェクトリストコマンドでリストできます:xe pgpu-listxe gpu-group-listxe vgpu-list。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

物理GPUのパラメーター

物理GPU(pGPU)には、以下のパラメーターがあります:

パラメーター名 説明 種類
uuid 物理GPUの一意の識別子/オブジェクト参照 読み取り専用
vendor-name 物理GPUベンダの名前 読み取り専用
device-name ベンダが物理GPUモデルに割り当てた名前 読み取り専用
gpu-group-uuid この物理GPUがにより自動的に割り当てられたGPUグループの一意の識別子/オブジェクト参照。プール内のすべてのホスト上の同一物理GPUがグループ化されます 読み取り専用
gpu-group-name-label この物理GPUが割り当てられたGPUグループの名前 読み取り専用
host-uuid この物理GPUが接続しているホストの一意の識別子/オブジェクト参照 読み取り専用
host-name-label この物理GPUが接続しているホストの名前 読み取り専用
pci-id PCI identifier 読み取り専用
dependencies 同一仮想マシンにパススルーされる依存PCIデバイスのリスト 読み取り/書き込み可のマップパラメータ
other-config 物理GPUの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
supported-VGPU-types ハードウェアでサポートされる仮想GPUの一覧 読み取り専用
enabled-VGPU-types この物理GPUで有効な仮想GPUの一覧 読み取り/書き込み
resident-VGPUs この物理GPUで実行中の仮想GPUの一覧 読み取り専用

pgpu-disable-dom0-access

pgpu-disable-dom0-access uuid=uuid

dom0へのPGPUアクセスを無効にします。

pgpu-enable-dom0-access

pgpu-enable-dom0-access uuid=uuid

dom0へのPGPUアクセスを有効にします。

gpu-groupオブジェクトのパラメーター

gpu-groupオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid GPUグループの一意の識別子/オブジェクト参照 読み取り専用
name-label GPUグループの名前 読み取り/書き込み
name-description GPUグループの説明文字列 読み取り/書き込み
VGPU-uuids GPUグループ内の仮想GPUの一意の識別子/オブジェクト参照の一覧 読み取り専用のセットパラメータ
PGPU-uuids GPUグループ内の物理GPUの一意の識別子/オブジェクト参照のリスト 読み取り専用のセットパラメータ
other-config GPUグループの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
supported-VGPU-types ハードウェアでサポートされるすべての仮想GPUの一覧 読み取り専用
enabled-VGPU-types 物理GPUで有効なすべての仮想GPUの一覧 読み取り専用
allocation-algorithm グループ内の物理GPUに割り当てられた仮想GPUの深さ優先/幅優先設定 読み取り/書き込み可のenumパラメーター

GPUグループの操作

GPUグループを操作するコマンド

gpu-group-create
gpu-group-create name-label=name_for_group [name-description=description]

物理GPUが移動できる新規(空の)GPUグループを作成します。

gpu-group-destroy
gpu-group-destroy uuid=uuid_of_group

GPUグループを破棄します。対象は空のグループのみです。

gpu-group-get-remaining-capacity
gpu-group-get-remaining-capacity uuid=uuid_of_group vgpu-type-uuid=uuid_of_vgpu_type

GPUグループでインスタンス化できる、指定した種類の仮想GPUの数を返します。

gpu-group-param-set
gpu-group-param-set uuid=uuid_of_group allocation-algorithm=breadth-first|depth-first

GPUグループが仮想GPUを物理GPUに割り当てるために使用するアルゴリズムを変更します。

gpu-group-param-get-uuid
gpu-group-param-get-uuid uuid=uuid_of_group param-name=supported-vGPU-types|enabled-vGPU-types

このGPUグループでサポートされるかまたは有効な種類を返します。

仮想GPUのパラメーター

仮想GPUには、以下のパラメーターがあります。

パラメーター名 説明 種類
uuid 仮想GPUの一意の識別子/オブジェクト参照 読み取り専用
vm-uuid この仮想GPUが割り当てられた仮想マシンの一意の識別子/オブジェクト参照 読み取り専用
vm-name-label この仮想GPUが割り当てられた仮想マシンの名前 読み取り専用
gpu-group-uuid この仮想GPUを含んでいるGPUグループの一意の識別子/オブジェクト参照 読み取り専用
gpu-group-name-label この仮想GPUを含んでいるGPUグループの名前 読み取り専用
currently-attached GPUパススルーを使用する仮想マシンが実行中の場合はtrue、そうでない場合はfalse 読み取り専用
other-config 仮想GPUの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
type-uuid この仮想GPUの仮想GPUの種類の一意の識別子/オブジェクト参照 読み取り/書き込み可のマップパラメータ
type-model-name 仮想GPUに関連付けられているモデル名 読み取り専用

仮想GPUのパラメーター

注:

GPUベンダーが提供するサポートされるソフトウェアおよびグラフィックカードがないと、GPUパススルーおよび仮想GPUは、Storage または仮想マシンの一時停止で機能しません。つまり、このサポートがなければダウンタイムを回避するために仮想マシンを移行することはできません。NVIDIA vGPUと、ストレージ、およびVM Suspendとの互換性についての詳細は、「グラフィック」を参照してください。

仮想GPUの種類には、以下のパラメーターがあります。

パラメーター名 説明 種類
uuid 仮想GPUの種類の一意の識別子/オブジェクト参照 読み取り専用
vendor-name 仮想GPUのベンダー名 読み取り専用
model-name 仮想GPUに関連付けられているモデル名 読み取り専用
freeze-frame 仮想GPUのフレームバッファーサイズ(バイト数) 読み取り専用
max-heads 仮想GPUでサポートされるディスプレイの最大数 読み取り専用
supported-on-PGPUs この仮想GPUをサポートする物理GPUの一覧 読み取り専用
enabled-on-PGPUs この仮想GPUが有効な物理GPUの一覧 読み取り専用
VGPU-uuids この種類の仮想GPUの一覧 読み取り専用

仮想GPUの操作

vgpu-create

vgpu-create vm-uuid=uuid_of_vm gpu_group_uuid=uuid_of_gpu_group [vgpu-type-uuid=uuid_of_vgpu-type]

仮想GPUを作成します。仮想マシンを指定したGPUグループに接続し、必要に応じて仮想GPUの種類を指定します。仮想GPUの種類を指定しない場合は、「パススルー」が割り当てられます。

vgpu-destroy

vgpu-destroy uuid=uuid_of_vgpu

指定した仮想GPUを破棄します。

仮想GPUを持つ仮想マシンのVNCの無効化

`xe vm-param-add uuid=uuid_of_vmparam-name=platform vgpu_vnc_enabled=true|false.`

falseを指定すると、disablevnc=1がディスプレイエミュレーターに渡され、仮想マシンのVNCが無効になります。デフォルトでは、VNCは有効になっています。

ホストコマンド

ホスト(hostオブジェクト)を操作します。

ホストとは、ソフトウェアを実行している物理サーバーを指します。これらのサーバー上では仮想マシンが実行され、コントロールドメインまたはドメイン0と呼ばれる特殊な権限を持つ仮想マシンにより制御されます。

ホストオブジェクトは、次の標準的なオブジェクトリストコマンドでリストできます:xe host-listxe host-cpu-listxe host-crashdump-list。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

hostオブジェクトセレクター

ここで説明する多くのコマンドでは、以下の標準的な方法で1つまたは複数のホストを操作対象として指定します。最も簡単なのは、引数host=uuid_or_name_labelを指定することです。また、すべてのhostオブジェクトのリストを、フィールドの値に基づいてフィルターして、を指定することもできます。たとえば、 enabled=trueと指定すると、enabledフィールドがtrueのホストがすべて操作対象として選択されます。複数のホストがフィルター条件に一致し、その複数のホストで操作を実行する場合は、--multipleを指定する必要があります。指定できるすべてのパラメーターの一覧は、次の表のとおりです。このコマンドのリストを取得するには、コマンドxe host-list params=allを実行します。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。

hostオブジェクトのパラメーター

のhostオブジェクトには、以下のパラメーターがあります。

パラメーター名 説明 種類
uuid ホストの一意の識別子/オブジェクトリファレンス 読み取り専用
name-label ホストの名前 読み取り/書き込み
name-description ホストの説明文字列 読み取り専用
enabled 無効になっている場合はfalseです。これにより、新しい仮想マシンがホスト上で起動するのを防ぎ、ホストのシャットダウンまたは再起動を準備します。ホストが有効な場合はtrueです 読み取り専用
API-version-major メジャーバージョン番号 読み取り専用
API-version-minor マイナーバージョン番号 読み取り専用
API-version-vendor APIベンダーのID 読み取り専用
API-version-vendor-implementation ベンダー実装の詳細 読み取り専用のマップパラメータ
logging ログ設定 読み取り/書き込み可のマップパラメータ
suspend-image-sr-uuid 一時停止状態のイメージが格納されるストレージリポジトリの一意の識別子/オブジェクトリファレンス 読み取り/書き込み
crash-dump-sr-uuid クラッシュダンプが格納されるストレージリポジトリの一意の識別子/オブジェクトリファレンス 読み取り/書き込み
software-version バージョン管理パラメーターとその値のリスト 読み取り専用のマップパラメータ
capabilities ホストを実行できるXenのバージョンのリスト 読み取り専用のセットパラメータ
other-config ホストの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
chipset-info チップセットの追加設定パラメータを指定するキー/値ペアのリスト 読み取り専用のマップパラメータ
hostname ホストのホスト名 読み取り専用
address ホストのIPアドレス 読み取り専用
license-server ライセンスサーバーの情報を指定するキー/値ペアのリスト。」を参照してください。 読み取り専用のマップパラメータ
supported-bootloaders ホストがサポートするブートローダーの一覧。pygrub、eliloaderなど 読み取り専用のセットパラメータ
memory-total ホスト上の物理RAMの量(バイト数) 読み取り専用
memory-free 仮想マシンに割り当てることのできる物理RAMの残量(バイト数) 読み取り専用
host-metrics-live このホストが動作可能の場合はtrue 読み取り専用
logging syslog_destinationキーでリモートのsyslogサービスのホスト名を設定。 読み取り/書き込み可のマップパラメータ
allowed-operations 現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もあります。 読み取り専用のセットパラメータ
current-operations 現在処理中の操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もあります。 読み取り専用のセットパラメータ
patches ホストに対するパッチのセット 読み取り専用のセットパラメータ
blobs バイナリデータストア 読み取り専用
memory-free-computed ホスト上の空きメモリ量(少なく見積もった量) 読み取り専用
ha-statefiles 高可用性ステートファイルのUUID 読み取り専用
ha-network-peers 障害発生時にこのホスト上の仮想マシンを実行できるホストのUUID 読み取り専用
external-auth-type 外部認証の種類(Active Directoryなど) 読み取り専用
external-auth-service-name 外部認証サービスの名前 読み取り専用
external-auth-configuration 外部認証サービスの設定情報 読み取り専用のマップパラメータ

ホストには、パラメータリストを持つ以下のオブジェクトも含まれています。

ホストのCPU(cpuオブジェクト)には、以下のパラメータがあります。

パラメーター名 説明 種類
uuid CPUの一意の識別子/オブジェクト参照 読み取り専用
number ホスト内の物理CPUコアの数 読み取り専用
vendor CPU名のベンダー文字列 読み取り専用
speed CPUのクロック速度(Hz数) 読み取り専用
modelname CPUモデルのベンダー文字列。たとえば 「Intel(R) Xeon(TM) CPU 3.00 GHz」 読み取り専用
stepping CPUのリビジョン番号 読み取り専用
flags 物理CPUのフラグ(featuresフィールドのデコード版) 読み取り専用
Utilisation 現在のCPU使用率 読み取り専用
host-uuid このCPUが動作するホストのUUID 読み取り専用
model 物理CPUのモデル番号 読み取り専用
family 物理CPUのファミリ番号 読み取り専用

ホストのクラッシュダンプ(crashdumpオブジェクト)には、以下のパラメータがあります。

パラメーター名 説明 種類
uuid クラッシュダンプの一意の識別子/オブジェクト参照 読み取り専用
host クラッシュダンプが対応するホスト 読み取り専用
timestamp クラッシュダンプの日時。形式はyyyymmdd-hhmmss-ABC(ここでABCはGMTなどのタイムゾーンインジケーター) 読み取り専用
size クラッシュダンプのサイズ(バイト数) 読み取り専用

host-all-editions

host-all-editions

利用可能なすべてのエディションのリストを取得します

host-apply-edition

host-apply-edition [host-uuid=host_uuid] [edition=xenserver_edition="free" "per-socket" "xendesktop"]

特定エディションのライセンスをホストサーバーに割り当てます。は、指定された種類のライセンスをライセンスサーバーに要求し、割り当て可能なライセンスがある場合はそれをライセンスサーバーからチェックアウトします。

初期ライセンス設定については、license-server-addressおよびlicense-server-portも参照してください。

host-backup

host-backup file-name=backup_filename host=host_name

このコマンドでは、指定したホストのコントロールドメインのバックアップを、コマンドの実行元マシンにダウンロードし、file-nameのファイル名で保存します。

重要:

xe host-backupコマンドは、ローカルホスト上(つまり特定のホスト名を指定せずに)実行しても機能しますが、そのように使用しないでください。これを行うと、コントロールドメインのパーティションに大きなバックアップファイルが作成され、空きディスク容量が足りなくなります。このコマンドは、バックアップファイルを保持できるディスク領域があるリモートコンピューターからのみ使用してください。

host-bugreport-upload

host-bugreport-upload [host-selector=host_selector_value...] [url=destination_url http-proxy=http_proxy_name]

このコマンドでは、新しいバグレポート(xen-bugtoolを使って、すべてのオプションファイルを含めて)を生成し、サポートFTPサイトなどにアップロードします。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

オプションのパラメーターは、http-proxy:使用するHTTPプロキシを指定する、およびurl:アップロード先を指定するURLです。これらのオプションパラメーターを使用しない場合、プロキシサーバーは特定されず、デフォルトのサポートFTPサイトにアップロードされます。

host-call-plugin

host-call-plugin host-uuid=host_uuid plugin=plugin fn=function [args=args]

オプションの引数を指定して、指定されたホスト上のプラグイン内の関数を呼び出します。

host-compute-free-memory

host-compute-free-memory

ホスト上の空きメモリの量を計算します。

host-compute-memory-overhead

host-compute-memory-overhead

ホストの仮想化メモリオーバーヘッドを計算します。

host-cpu-info

host-cpu-info [uuid=uuid]

ホストの物理CPUに関する情報を一覧表示します。

host-crashdump-destroy

host-crashdump-destroy uuid=crashdump_uuid

このコマンドでは、UUIDで指定したクラッシュダンプをホストから削除します。

host-crashdump-upload

host-crashdump-upload uuid=crashdump_uuid [url=destination_url] [http-proxy=http_proxy_name]

このコマンドでは、クラッシュダンプをサポートFTPサイトなどにアップロードします。これらのオプションパラメーターを使用しない場合、プロキシサーバーは特定されず、デフォルトのサポートFTPサイトにアップロードされます。オプションのパラメーターは、http-proxy:使用するHTTPプロキシを指定する、およびurl:アップロード先を指定するURLです。

host-declare-dead

host-declare-dead uuid=host_uuid

ホストが明示的に通信しておらず使用不可であることを宣言します。

警告:

この呼び出しは危険で、ホストが実際には使用可能な場合はデータを失う可能性があります。

host-disable

host-disable [host-selector=host_selector_value...]

このコマンドでは、指定したホストが無効になり、新しい仮想マシンがそのホスト上で起動しなくなります。これにより、そのホストがシャットダウンまたは再起動できる状態になります。

このコマンドの対象ホストを指定するには、「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-disable-display

host-disable-display uuid=host_uuid

ホストの表示を無効にします。

host-disable-local-storage-caching

host-disable-local-storage-caching

指定されたホスト上のローカルストレージキャッシュを無効にします。

host-dmesg

host-dmesg [host-selector=host_selector_value...]

このコマンドでは、指定したホストからXen dmesg(カーネルリングバッファの出力)を取得します。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-emergency-ha-disable

host-emergency-ha-disable  [--force]

ローカルホスト上の高可用性を無効にします。破損した高可用性セットアップでプールを回復するためにのみ使用されます。

host-emergency-management-reconfigure

host-emergency-management-reconfigure interface=uuid_of_management_interface_pif

このコマンドでは、このホストの管理インターフェイスを設定し直します。このコマンドは、ホストが緊急モードの場合のみ使用します。緊急モードとは、あるリソースプール内のメンバーであるホストが、そのプールマスターへの接続を切断され、何度再試行しても接続できないことを意味します。

host-enable

host-enable [host-selector=host_selector_value...]

このコマンドでは、指定したホストが有効になり、新しい仮想マシンがそのホスト上で起動可能になります。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-enable-display

host-enable-display uuid=host_uuid

ホストの表示を有効にします。

host-enable-local-storage-caching

host-enable-local-storage-caching  sr-uuid=sr_uuid

指定されたホスト上のローカルストレージキャッシュを有効にします。

host-evacuate

host-evacuate [host-selector=host_selector_value...]

このコマンドでは、指定したホスト上で実行されているすべての仮想マシンを、リソースプール内のほかの適切なホストに移行(ライブマイグレーション)します。まず、host-disableコマンドを使用してホストを無効にします。

プールマスタを無効にする場合は、ほかのホストがプールマスタとして選出される必要があります。高可用性機能が無効なリソースプールでプールマスターを変更するには、pool-designate-new-masterコマンドを使用します。詳しくは、「pool-designate-new-master」を参照してください。

高可用性機能が有効な場合は、そのホストをシャットダウンすれば、高可用性機能により任意のホストがプールマスターとして選出されます。詳しくは、host-shutdownを参照してください。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-forget

host-forget uuid=host_uuid

このコマンドでは、指定したホストがXAPIエージェントから削除されて、その結果リソースプールから除外されます。

--forceパラメーターを使用すると、確認のメッセージが表示されなくなります。

警告:

リソースプールの高可用性を有効にしたまま、このコマンドを使用しないでください。ホストを除外するには、事前に高可用性を無効にしておき、このコマンドを実行した後で高可用性を有効にします。

ヒント:

このコマンドは、「除外する」ホストが使用不可の場合に役立ちます。ただし、 ホストが使用可能でプールの一部である場合は、代わりにxe pool-ejectを使用します。

host-get-cpu-features

host-get-cpu-features {features=pool_master_cpu_features} [uuid=host_uuid]

ホストの物理CPUの機能を示す16進数値を出力します。

host-get-server-certificate

host-get-server-certificate

インストールされているサーバーのSSL証明書を取得します。

host-get-sm-diagnostics

host-get-sm-diagnostics uuid=uuid

ホストごとのSM診断情報を表示します。

host-get-system-status

host-get-system-status filename=name_for_status_file [entries=comma_separated_list] [output=tar.bz2|zip] [host-selector=host_selector_value...]

このコマンドでは、システム状態の情報を指定したパスにダウンロードします。オプションのパラメーターentriesは、システム情報エントリのコンマ区切りのリストです。これらのエントリは、host-get-system-status-capabilitiesコマンドで返されるXMLフラグメントから指定します。詳しくは、host-get-system-status-capabilitiesを参照してください。このパラメータを指定しない場合、すべてのシステム状態の情報がファイルに保存されます。パラメーターoutputは、tar.bz2(デフォルト)またはzipである可能性があります。このパラメーターを指定しない場合、ファイルはtar.bz2形式で保存されます。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。

host-get-system-status-capabilities

host-get-system-status-capabilities [host-selector=host_selector_value...]

このコマンドでは、指定したホストのシステム状態の情報を取得します。機能は、次の例のようなXMLフラグメントとして返されます:


各機能エンティティは、以下の属性を有することができます。

  • key:機能の一意の識別子。
  • content-type:text/plainまたはapplication/data。インターフェイスにユーザーが判読できる形式で表示されるかどうかを示します。
  • default-checked:yesまたはno。ユーザーインターフェイスでこのエントリをデフォルトで選択するかどうかを示します。
  • min-sizemax-size:このエントリのサイズのおおよその範囲をバイト数で示します。-1はサイズが重要でないことを示します。
  • min-timemax-time:このエントリの収集時間のおおよその範囲を秒数で示します。-1は時間が重要でないことを示します。
  • pii:個人を特定できる情報。このエントリに、システムの所有者やネットワークトポロジの詳細を特定できる情報があるかどうかを示します。属性の値は次のいずれかです:

    • no:エントリに機密性の高い情報がない
    • yes:エントリに機密性の高い情報がある、またはその可能性が高い
    • maybe:機密性の高い情報があるかどうかを監査すべき
    • if_customized:ファイルが変更されていない場合は、機密情報は含まれない。しかし、これらのファイルの編集が推奨されているため、このようなカスタマイズによって機密情報が導入された可能性がある。この値は特にコントロールドメインのネットワークスクリプトに使用される。

    piiの値にかかわらず、いかなるバグレポートにもパスワードは含まれません。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。

host-get-thread-diagnostics

host-get-thread-diagnostics uuid=uuid

ホストごとのスレッド診断情報を表示します。

host-get-vms-which-prevent-evacuation

host-get-vms-which-prevent-evacuation uuid=uuid

特定のホストの退避を妨げる仮想マシンのリストを返し、それぞれの理由を表示します。

host-is-in-emergency-mode

host-is-in-emergency-mode

このホストが緊急モードで動作しているかどうかを識別します。緊急モードの場合はtrueが出力され、それ以外はfalseが出力されます。このコマンドは、プールマスタが存在しなくてもメンバホストに直接実行できます。

host-license-add

host-license-add [license-file=path/license_filename] [host-uuid=host_uuid]

無償版ので、ローカルのライセンスファイルを解析して、指定したホストにそのライセンスを追加します。

host-license-remove

host-license-remove [host-uuid=host_uuid]

ホストに適用されているライセンスを削除します。

host-license-view

host-license-view [host-uuid=host_uuid]

ホストライセンスの内容を表示します。

host-logs-download

host-logs-download [file-name=logfile_name] [host-selector=host_selector_value...]

このコマンドでは、指定したホストのログのコピーをダウンロードします。ログのコピーは、デフォルトで作成日時が記録されたhostname-yyyy-mm-dd T hh:mm:ssZ.tar.gzという形式のファイル名で保存されます。オプションのパラメーターfile-nameを使用して、別のファイル名を指定できます。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

重要:

xe host-logs-downloadコマンドは、ローカルホスト上(つまり特定のホスト名を指定せずに)実行しても機能しますが、そのように使用しないでください。これを行うと、コントロールドメインのパーティションにログのコピーファイルが作成されてしまいます。このコマンドは、ログのコピーファイルを保持できるディスク領域があるリモートコンピュータからのみ使用してください。

host-management-disable

host-management-disable

このコマンドでは、外部の管理ネットワークインターフェイス上のホストエージェントを無効にして、接続しているすべてのAPIクライアント(など)を切断します。このコマンドは、CLIが接続されているホストで直接操作します。ホストのメンバーに適用された場合、コマンドはプールマスターに転送されません。

警告:

このCLIコマンドをリモートのホストに対して使用する場合は注意してください。このコマンドを実行すると、ネットワークを介してリモートでコントロールドメインに接続して、ホストエージェントを再度有効にすることができなくなります。

host-management-reconfigure

host-management-reconfigure [interface=device] [pif-uuid=uuid]

このコマンドでは、ホストがに接続するための管理インターフェイスを再指定します。これにより、/etc/xensource-inventoryのMANAGEMENT_INTERFACEキーが更新されます。

インターフェイス(IPアドレスが必要)のデバイス名を指定した場合、ホストは直ちにバインドし直します。この場合、このコマンドは通常モードと緊急モードのいずれの場合でも機能します。

PIFオブジェクトのUUIDを指定した場合、ホストは再バインドすべきIPアドレスを自動的に判断します。この場合、緊急モードではこのコマンドを使用できません。

警告:

このコマンドをリモートのホストに対して使用する場合は、xe pif-reconfigureを使用して新しいインターフェイスでのネットワーク接続を設定しておいてください。これを行わないと、そのホストに対してCLIコマンドを実行できなくなります。

host-power-on

host-power-on [host=host_uuid]

ホストの電源投入機能が有効なホストの電源を投入します。このコマンドを使用する前に、対象のホストで host-set-power-onを有効にします。

host-reboot

host-reboot [host-selector=host_selector_value...]

このコマンドでは、指定したホストを再起動します。ここで指定するホストは、既にxe host-disableコマンドで無効になっている必要があります。ホストが有効になっていると、HOST_IN_USEというエラーメッセージが表示されます。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

指定したホストがプールのメンバーである場合、シャットダウン時に接続は失われますが、ホストが元の接続状態に戻ると、プールに復帰します。他のメンバーとマスターは引き続き機能します。

マスターをシャットダウンすると、次のいずれかのアクションが発生するまでプールは機能しなくなります:

  • メンバーの1人をマスターにする
  • 元のマスターが再起動され、オンラインに戻る

    マスターがオンラインに戻ると、メンバーは再接続してマスターと同期します。

host-restore

host-restore [file-name=backup_filename] [host-selector=host_selector_value...]

このコマンドでは、file-nameで指定した、ホストコントロールソフトウェアのバックアップを復元します。このコマンドでの「復元」は通常の完全な復元ではなく、圧縮されたバックアップファイルがセカンダリパーティションに展開されるだけです。xe host-restoreを実行した後は、インストールCDから起動して、[バックアップから復元]を選択する必要があります。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-send-debug-keys

host-send-debug-keys  host-uuid=host_uuid keys=keys

指定されたハイパーバイザーデバッグキーを、指定されたホストに送信します。

host-set-hostname-live

host-set-hostname host-uuid=uuid_of_host hostname=new_hostname

このコマンドでは、host-uuidで指定したホストのホスト名を変更します。これにより、コントロールドメインのデータべース内のホスト名レコードおよびホストの実際のLinuxホスト名が永続的に設定されます。hostnameの値はname_labelフィールドの値と同じではないことに注意してください。

host-set-power-on-mode

host-set-power-on-mode {host=host_uuid {power-on-mode="" "wake-on-lan"
"iLO" "DRAC" "custom"} | [power-on-config="power_on_ip" "power_on_user" "power_on_password_secret"] }

電源管理ソリューションと互換性のあるホストのホスト電源投入機能を有効にします。host-set-power-onコマンドでは、ホストの電源管理ソリューションの種類をpower-on-modeで指定する必要があります。次に、power-on-config引数とそれに関連するキーと値のペアを使用して構成オプションを指定します。"power_on_password_secret"でキーを指定するには、事前にパスワードシークレットを作成しておく必要があります。

host-shutdown

host-shutdown [host-selector=host_selector_value...]

このコマンドでは、指定したホストをシャットダウンします。ここで指定するホストは、既にxe host-disableコマンドで無効になっている必要があります。ホストが有効になっていると、HOST_IN_USEというエラーメッセージが表示されます。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

指定したホストがプールのメンバーである場合、シャットダウン時に接続は失われますが、ホストが元の接続状態に戻ると、プールに復帰します。他のメンバーとマスターは引き続き機能します。

マスターをシャットダウンすると、次のいずれかのアクションが発生するまでプールは機能しなくなります:

  • メンバーの1人をマスターにする
  • 元のマスターが再起動され、オンラインに戻る

    マスターがオンラインに戻ると、メンバーは再接続してマスターと同期します。

高可用性が有効なプールでは、任意のメンバーホストが自動的にプールマスターとして選出されます。高可用性が無効なプールでは、マスターがpool-designate-new-masterコマンドを使用して、特定のサーバーを指定する必要があります。詳しくは、「pool-designate-new-master」を参照してください。

host-sm-dp-destroy

host-sm-dp-destroy uuid=uuid dp=dp [allow-leak=true|false]

ホスト上のストレージデータパスの破棄とクリーンアップを試みます。完全にシャットダウンできない場合でも、allow-leak=trueによってデータパスの記録をすべて削除します。

host-sync-data

host-sync-data

プールマスターに格納されている非データベースのデータを、指定されたホストと同期させます。

host-syslog-reconfigure

host-syslog-reconfigure [host-selector=host_selector_value...]

このコマンドは、指定したホスト上のsyslogデーモンを再設定します。これにより、ホストのloggingパラメーターで定義されている設定情報が適用されます。

このコマンドの対象ホストを指定するには、上記の「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。

host-data-source-list

host-data-source-list [host-selectors=host selector value...]

ホストで記録可能なデータソースのリストを出力します。

このコマンドの対象ホストを指定するには、「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。

データソースにはstandardenabledという2つのパラメーターがあります。このコマンドは、パラメーターの値を出力します:

  • データソースのenabledパラメーターがtrueの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースに記録中であることを示します。
  • データソースのstandardパラメーターがtrueの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースにデフォルトで記録されることを示します。enabledの値は、このデータソースに対してもtrueに設定されます。
  • データソースのstandardパラメーターがfalseの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースにデフォルトで記録されないことを示します。enabledの値は、このデータソースに対してもfalseに設定されます。

データソースメトリクスのパフォーマンスデータベースへの記録を開始するには、host-data-source-recordコマンドを実行します。このコマンドは、enabledtrueに設定します。停止するには、host-data-source-forgetを実行します。このコマンドは、enabledfalseに設定します。

host-data-source-record

host-data-source-record data-source=name_description_of_data_source [host-selectors=host_selector_value...]

ホストで、指定したデータソースを記録します。

これにより、ホストの永続的なパフォーマンスメトリクスデータベースにデータソースからの情報が書き込まれます。このデータベースは、パフォーマンス上の理由から、通常のエージェントデータベースとは区別されます。

このコマンドの対象ホストを指定するには、「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。

host-data-source-forget

host-data-source-forget data-source=name_description_of_data_source [host-selectors=host_selector_value...]

ホストのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。

このコマンドの対象ホストを指定するには、「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。

host-data-source-query

host-data-source-query data-source=name_description_of_data_source [host-selectors=host_selector_value...]

ホストで、指定したデータソースを表示します。

このコマンドの対象ホストを指定するには、「ホストセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「ホストパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。

ログコマンド

ログ(logオブジェクト)を操作します。

log-get

log-get

文字列ロガーに現在格納されているログを返します。

log-get-keys

log-get-keys

ロガーの既知のキーを一覧表示します。

log-reopen

log-reopen

すべてのロガーを再度開きます(ファイルのローテーションに使用します)。

log-set-output

log-set-output output=output [key=key] [level=level]

すべてのロガーを指定した出力(nil、stderr、string、file:filename、syslog:something)に設定します。

メッセージコマンド

メッセージ(messageオブジェクト)を操作します。messageオブジェクトは、重要なイベントの発生をユーザーに通知するために作成され、にアラートとして表示されます。

messageオブジェクトのリストは、標準オブジェクトリストコマンド(xe message-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

messageオブジェクトのパラメーター

パラメーター名 説明 種類
uuid メッセージの一意の識別子/オブジェクト参照 読み取り専用
name メッセージの一意の名前 読み取り専用
priority メッセージの優先度。数値が大きいほど高い優先度を示します 読み取り専用
class メッセージのクラス(VMなど) 読み取り専用
obj-uuid 影響を受けるオブジェクトのUUID 読み取り専用
timestamp メッセージの生成時刻 読み取り専用
body メッセージの内容 読み取り専用

message-create

message-create name=message_name body=message_text [[host-uuid=uuid_of_host] | [sr-uuid=uuid_of_sr} | [vm-uuid=uuid_of_vm] | [pool-uuid=uuid_of_pool]]

メッセージを作成します。

message-destroy

message-destroy [uuid=message_uuid]

既存のメッセージを破棄します。スクリプトを作成して、すべてのメッセージを破棄することもできます。例:

# Dismiss all alerts   \
IFS=","; for m in $(xe message-list params=uuid --minimal); do  \
xe message-destroy uuid=$m  \
done

ネットワークコマンド

ネットワーク(networkオブジェクト)を操作します。

networkオブジェクトのリストは、標準オブジェクトリストコマンド(xe network-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

networkオブジェクトのパラメーター

networkオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid ネットワークの一意の識別子/オブジェクト参照 読み取り専用
name-label ネットワークの名前 読み取り/書き込み
name-description ネットワークの説明文字列 読み取り/書き込み
VIF-uuids 仮想マシンからこのネットワークに接続されているVIFの一意の識別子のリスト 読み取り専用のセットパラメータ
PIF-uuids ホストからこのネットワークに接続されているPIFの一意の識別子のリスト 読み取り専用のセットパラメータ
bridge ローカルホスト上のこのネットワークに対応するブリッジの名前 読み取り専用
default-locking-mode ARPフィルタを設定するときにVIFオブジェクトと一緒に使用するネットワークオブジェクト。VIFのすべてのフィルター規則を解除する場合はunlocked、VIFのすべてのトラフィックをドロップする場合はdisabled 読み取り/書き込み
purpose ホストがこのネットワークを使用するための目的セット。ネットワークを使用してNBD接続を確立するには、nbdに設定します。 読み取り/書き込み
other-config:staticroutes subnet/netmask/gateway形式で指定する、サブネットへの通信路のコンマ区切りの一覧。たとえば、other-config:static-routesに172.16.0.0/15/192.168.0.3,172.18.0.0/16/192.168.0.4を指定すると、172.16.0.0/15へのトラフィックが192.168.0.3にルーティングされ、172.18.0.0/16へのトラフィックが192.168.0.4にルーティングされます 読み取り/書き込み
other-config:ethtoolautoneg 物理インターフェイスまたはブリッジの自動ネゴシエーションを無効にする場合はno。デフォルトはyesです。 読み取り/書き込み
other-config:ethtool-rx チェックサムの受信を有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-tx チェックサムの転送を有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-sg Scatter/Gatherを有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-tso TCPセグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
other-config:ethtool-ufo UDPフラグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
other-config:ethtool-gso 汎用セグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
blobs バイナリデータストア 読み取り専用

network-create

network-create name-label=name_for_network [name-description=descriptive_text]

ネットワークを作成します。

network-destroy

network-destroy uuid=network_uuid

既存のネットワークを破棄します。

SR-IOVコマンド

SR-IOVを操作するコマンドです。

network-sriovオブジェクトのリストは、標準オブジェクトリストコマンド(xe network-sriov-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

SR-IOVパラメーター

SR-IOVには次のパラメーターがあります。

パラメーター名 説明 種類
physical-PIF SR-IOVを有効にするPIF。 読み取り専用
logical-PIF SR-IOV論理PIF。ユーザーはこれをパラメーターとして使用して、SR-IOV VLANネットワークを作成できます。 読み取り専用
requires-reboot Trueに設定すると、ホストを再起動してSR-IOVを有効にするために使用されます。 読み取り専用
remaining-capacity 残された使用可能なVFの数。 読み取り専用

network-sriov-create

xe network-sriov-create network-uuid=network_uuid pif-uuid=physical_pif_uuid

特定の物理PIFに対してSR-IOVネットワークオブジェクトを作成し、物理PIF上でSR-IOVを有効にします。

network-sriov-destroy

xe network-sriov-destroy uuid=network_sriov_uuid

SR-IOVネットワークオブジェクトを削除し、物理PIF上でSR-IOVを無効にします。

SR-IOV VFの割り当て

xe vif-create device=device_index mac=vf_mac_address network-uuid=sriov_network vm-uuid=vm_uuid

SR-IOVネットワークから仮想マシンにVFを割り当てます。

SDNコントローラーコマンド

SDNコントローラー(sdn-controllerオブジェクト)を操作します。

sdn-controller-forget

sdn-controller-introduce [address=address] [protocol=protocol] [tcp-port=tcp_port]

SDNコントローラーを導入します。

sdn-controller-introduce

sdn-controller-forget uuid=uuid

SDNコントローラーを削除します。

トンネルコマンド

トンネル(tunnelオブジェクト)を操作します。

tunnel-create

tunnel-create pif-uuid=pif_uuid network-uuid=network_uuid

ホスト上に新しいトンネルを作成します。

tunnel-destroy

tunnel-destroy uuid=uuid

トンネルを破棄します。

パッチコマンド

パッチ(patchオブジェクト)を操作します。

patch-apply

patch-apply uuid=patch_uuid host-uuid=host_uuid

以前にアップロードしたパッチを指定されたホストに適用します。

patch-clean

patch-clean uuid=uuid

以前にアップロードしたパッチファイルを削除します。

patch-destroy

patch-destroy uuid=uuid

適用されていないパッチレコードとファイルをサーバーから削除します。

patch-pool-apply

patch-pool-apply uuid=uuid

以前にアップロードしたパッチをプール内のすべてのホストに適用します。

patch-pool-clean

patch-pool-clean uuid=uuid

プール内のすべてのホストで以前にアップロードしたパッチファイルを削除します。

patch-precheck

patch-precheck uuid=uuid host-uuid=host_uuid

以前アップロードされたパッチに含まれている事前チェックを、指定したホストに対して実行します。

patch-upload

patch-upload file-name=file_name

パッチファイルをサーバーにアップロードします。

PBD(物理ブロックデバイス)コマンド

PBD(pbdオブジェクト)を操作します。pbdオブジェクトは、ホストがストレージリポジトリへのアクセスに使用するソフトウェアオブジェクトです。

pbdオブジェクトのリストは、標準オブジェクトリストコマンド(xe pbd-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

pbdオブジェクトのパラメーター

pbdオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid PBDの一意の識別子/オブジェクト参照 読み取り専用
sr-uuid PBDの接続先ストレージリポジトリ 読み取り専用
device-config ホストのストレージリポジトリバックエンドドライバーに提供される追加構成情報 読み取り専用のマップパラメータ
currently-attached ストレージリポジトリがこのホストに接続されている場合はtrue、それ以外はfalse 読み取り専用
host-uuid PBDが使用可能になっている物理マシンのUUID 読み取り専用
host このパラメータは廃止。代わりにhost_uuidを使用 読み取り専用
other-config 追加の構成情報。 読み取り/書き込み可のマップパラメータ

pbd-create

pbd-create host-uuid=uuid_of_host sr-uuid=uuid_of_sr [device-config:key=corresponding_value]

ホスト上にPBDを作成します。読み取り専用のdevice-configパラメーターは、作成時にのみ設定できます。

‘path’から’/tmp’にマップを追加するには、コマンドでdevice-config:path=/tmpを指定します。

ストレージリポジトリの各種類でサポートされるdevice-configパラメーターのキー/値ペアについては、「ストレージ」を参照してください。

pbd-destroy

pbd-destroy uuid=uuid_of_pbd

指定したPBDを破棄します。

pbd-plug

pbd-plug uuid=uuid_of_pbd

PBDをホストにプラグします。成功すると、参照されているストレージリポジトリ(およびそれに含まれているVDI)がホストからアクセス可能になります。

pbd-unplug

pbd-unplug uuid=uuid_of_pbd

PBDをホストからアンプラグします。

PIF(物理ネットワークインターフェイス)コマンド

PIF(pifオブジェクト)を操作します。

pifオブジェクトのリストは、標準オブジェクトリストコマンド(xe pif-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

pifオブジェクトのパラメーター

pifオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid PIFの一意の識別子/オブジェクト参照 読み取り専用
device machine-readable インターフェイス名(eth0など) 読み取り専用
MAC PIFのMACアドレス 読み取り専用
other-config 追加のPIF構成name:valueペア。 読み取り/書き込み可のマップパラメータ
physical PIFが実際の物理ネットワークインターフェイスをポイントしている場合はtrue 読み取り専用
currently-attached PIFが現在このホストに接続されているかどうか。trueまたはfalse 読み取り専用
MTU PIFのMTU(Maximum Transmission Unit)バイト数。 読み取り専用
VLAN このPIFを通過するすべてのトラフィックのVLANタグ。-1はVLANタグが割り当てられていないことを示す 読み取り専用
bond-master-of このPIFがマスターになっているボンディングのUUID(該当する場合) 読み取り専用
bond-slave-of このPIFがスレーブになっているボンディングのUUID(該当する場合) 読み取り専用
management このPIFがコントロールドメインの管理インターフェイスとして指定されているかどうか 読み取り専用
network-uuid このPIFが接続されている仮想ネットワークの一意の識別子/オブジェクト参照 読み取り専用
network-name-label このPIFが接続している仮想ネットワークの名前 読み取り専用
host-uuid このPIFが接続しているホストの一意の識別子/オブジェクト参照 読み取り専用
host-name-label このPIFが接続しているホストの名前 読み取り専用
IP-configuration-mode ネットワークアドレス設定の種類、DHCPまたはstatic 読み取り専用
IP PIFのIPアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない 読み取り専用
netmask PIFのネットマスクアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない 読み取り専用
gateway PIFのゲートウェイアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない 読み取り専用
DNS PIFのDNSアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない 読み取り専用
io_read_kbs このデバイスの平均読み取り速度(kB/秒) 読み取り専用
io_write_kbs このデバイスの平均書き込み速度(kB/秒) 読み取り専用
carrier デバイスのリンク状態 読み取り専用
vendor-id NICベンダーに割り当てられたID 読み取り専用
vendor-name NICベンダーの名前 読み取り専用
device-id ベンダーがNICモデルに割り当てたID 読み取り専用
device-name ベンダーがNICモデルに割り当てた名前 読み取り専用
speed NICのデータ転送レート 読み取り専用
duplex NICの二重モード。full(全二重)またはhalf(半二重) 読み取り専用
pci-bus-path PCIバスパスのアドレス 読み取り専用
other-config:ethtoolspeed 接続速度(Mbps)の設定 読み取り/書き込み
other-config:ethtoolautoneg 物理インターフェイスまたはブリッジの自動ネゴシエーションを無効にする場合はno。デフォルトはyesです。 読み取り/書き込み
other-config:ethtoolduplex PIFのデュプレックス機能をフルまたはハーフに設定します。 読み取り/書き込み
other-config:ethtool-rx チェックサムの受信を有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-tx チェックサムの転送を有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-sg Scatter/Gatherを有効にする場合はon、無効にする場合はoff 読み取り/書き込み
other-config:ethtool-tso TCPセグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
other-config:ethtool-ufo UDPフラグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
other-config:ethtool-gso 汎用セグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff 読み取り/書き込み
other-config:domain DNS検索パスの設定(コンマ区切りの一覧) 読み取り/書き込み
other-config:bondmiimon リンクの状態チェック間隔(ミリ秒) 読み取り/書き込み
other-config:bonddowndelay リンクの切断が検出されてから切断リンクとして認識されるまでの待機時間(ミリ秒)。一時的な切断を許容するためのパラメーター 読み取り/書き込み
other-config:bondupdelay リンクの回復が検出されてから接続リンクとして認識されるまでの待機時間(ミリ秒)。一時的な回復を無視するための設定。指定された時間待機してからトラフィック転送が開始される(デフォルト値は31s)。 読み取り/書き込み
disallow-unplug このPIFがストレージ専用NICの場合にtrue、それ以外はfalse 読み取り/書き込み

注:

PIFのother-configフィールドへの変更は、再起動後に有効になります。または、xe pif-unplugコマンドとxe pif-plugコマンドを使用して、PIF設定が再書き込みされるようにすることもできます。

pif-forget

pif-forget uuid=uuid_of_pif

特定のホスト上の指定したPIFを破棄します。

pif-introduce

pif-introduce host-uuid=host_uuid mac=mac_address_for_pif device=interface_name

指定したホスト上の物理インターフェイスを表すpifオブジェクトを作成します。

pif-plug

pif-plug uuid=uuid_of_pif

指定した物理インターフェイスを起動します。

pif-reconfigure-ip

pif-reconfigure-ip uuid=uuid_of_pif [mode=dhcp|mode=static] gateway=network_gateway_address IP=static_ip_for_this_pif netmask=netmask_for_this_pif [DNS=dns_address]

PIFのIPアドレスを変更します。静的アドレスを使用する場合は、modeパラメーターにstaticを設定し、gatewayパラメーター、IPパラメーター、およびnetmaskパラメーターに適切な値を設定します。DHCPを使用する場合は、modeパラメーターをDHCPに設定します。ほかのパラメーターを定義する必要はありません。

注:

STP Fast Linkが無効な(またはサポートされていない)スイッチ上のポートにスパニングツリープロトコルで接続する物理ネットワークインターフェイスで静的IPアドレスを使用すると、無トラフィック期間が発生します。

pif-reconfigure-ipv6

pif-reconfigure-ipv6 uuid=uuid_of_pif mode=mode [gateway=network_gateway_address] [IPv6=static_ip_for_this_pif] [DNS=dns_address]

PIFのIPv6アドレス設定を再構成します。

pif-scan

pif-scan host-uuid=host_uuid

指定したホスト上の新規物理インターフェイスを検出します。

pif-set-primary-address-type

pif-set-primary-address-type  uuid=uuid primary_address_type=address_type

このPIFで使用されるプライマリアドレスの種類を変更します。

pif-unplug

pif-unplug uuid=uuid_of_pif

指定した物理インターフェイスを停止します。

プールコマンド

リソースプール(poolオブジェクト)を操作します。リソースプールは、1つ以上のホストの集合です。リソースプールでは1つ以上の共有ストレージリポジトリを使用して、プール内のあるホスト上で実行されている仮想マシンを、同じプール内の別のホストにほぼリアルタイムで移行できます。この移行は、仮想マシンをシャットダウンしたり再起動したりすることなく、仮想マシンの起動中に実行されます。各ホストは、それ自体がデフォルトでリソースプールを構成します。このプールにほかのホストを追加すると、追加したホストはメンバーホストとして動作し、元のホストがプールマスタになります。

シングルトンプールオブジェクトは、標準的なオブジェクトリストコマンド(xe pool-list)でリストできます。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

poolオブジェクトのパラメーター

poolオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid プールの一意の識別子/オブジェクト参照 読み取り専用
name-label プールの名前 読み取り/書き込み
name-description プールの説明文字列 読み取り/書き込み
master プールマスタとして動作するホストの一意の識別子/オブジェクト参照 読み取り専用
default-SR プールのデフォルトストレージリポジトリの一意の識別子/オブジェクト参照 読み取り/書き込み
crash-dump-SR メンバーホストのクラッシュダンプが格納されるストレージリポジトリの一意の識別子/オブジェクト参照 読み取り/書き込み
metadata-vdis プールの既知のメタデータVDI 読み取り専用
suspend-image-SR メンバーホスト上でサスペンド状態の仮想マシンが格納されるストレージリポジトリの一意の識別子/オブジェクト参照 読み取り/書き込み
other-config プールの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
supported-sr-types このプールで使用可能なストレージリポジトリの種類 読み取り専用
ha-enabled プールの高可用性が有効な場合にtrue、それ以外はfalse 読み取り専用
ha-configuration 将来バージョン用に予約 読み取り専用
ha-statefiles 高可用性によりストレージの状態を検出するために使用されるVDIのUUIDリスト 読み取り専用
ha-host-failures-to-tolerate システムアラートを送信せずに許容されるホスト障害数(フェイルオーバートレランス数) 読み取り/書き込み
ha-plan-exists-for 高可用性アルゴリズムにより算出される、対応可能なホスト障害数 読み取り専用
ha-allow-overcommit プールがオーバーコミットできる場合はtrue、そうでない場合はfalse 読み取り/書き込み
ha-overcommitted プールがオーバーコミットされている場合にtrue 読み取り専用
blobs バイナリデータストア 読み取り専用
live-patching-disabled ライブパッチを有効にするには、falseに設定します。ライブパッチを無効にするには、trueに設定します。 読み取り/書き込み
igmp-snooping-enabled IGMPスヌーピングを有効にするには、trueに設定します。IGMPスヌーピングを無効にするには、falseに設定します。 読み取り/書き込み

pool-apply-edition

pool-apply-edition edition=edition [uuid=uuid] [license-server-address=address] [license-server-port=port]

プール全体にエディションを適用します。

pool-certificate-install

pool-certificate-install filename=file_name

プール全体にSSL証明書をインストールします。

pool-certificate-list

pool-certificate-list

インストールされているすべてのSSL証明書をリストします。

pool-certificate-sync

pool-certificate-sync

マスターからスレーブへのSSL証明書と証明書失効一覧を同期します。

pool-certificate-uninstall

pool-certificate-uninstall name=name

SSL証明書をアンインストールします。

pool-crl-install

pool-crl-install filename=file_name

プール全体にSSL証明書失効一覧をインストールします。

pool-crl-list

pool-crl-list

インストールされているすべてのSSL証明書失効一覧をリストします。

pool-crl-uninstall

pool-crl-uninstall name=name

SSL証明書失効一覧をアンインストールします。

pool-deconfigure-wlb

pool-deconfigure-wlb

ワークロードバランスの構成を完全に削除します。

pool-designate-new-master

pool-designate-new-master host-uuid=uuid_of_new_master

指定したホスト(メンバーホスト)をプールマスタとして動作させます。このコマンドにより、プールマスタの役割をそのプール内の別のホストに正しく移譲できます。このコマンドは、現在のマスターがオンラインの場合にのみ機能します。これは以下に挙げられている緊急モードのコマンドに代わるものではありません。

pool-disable-external-auth

pool-disable-external-auth [uuid=uuid] [config=config]

プール内のすべてのホストで外部認証を無効にします。

pool-disable-local-storage-caching

pool-disable-local-storage-caching uuid=uuid

プール全体のローカルストレージキャッシュを無効にします。

pool-disable-redo-log

pool-disable-redo-log

HAが有効になっていない限り、使用中はredoログを無効にします。

pool-disable-ssl-legacy

pool-disable-ssl-legacy [uuid=uuid]

各ホストでssl-legacyをfalseに設定します。

pool-dump-database

pool-dump-database file-name=filename_to_dump_database_into_(on_client)

プールデータベース全体のコピーをダウンロードして、クライアント上のファイルにバックアップします。

pool-enable-external-auth

pool-enable-external-auth  auth-type=auth_type service-name=service_name [uuid=uuid] [config:=config]

プール内のすべてのホストで外部認証を有効にします。auth-typeの値によっては、特定のconfig:値が必要になることに注意してください。

pool-enable-local-storage-caching

pool-enable-local-storage-caching uuid=uuid

プール全体でローカルストレージキャッシュを有効にします。

pool-enable-redo-log

pool-ensable-redo-log sr-uuid=sr_uuid

HAが有効になっていない限り、使用中は指定されたストレージリポジトリのredoログを有効にします。

pool-enable-ssl-legacy

pool-enable-ssl-legacy [uuid=uuid]

各ホストでssl-legacyをtrueに設定します。

pool-eject

pool-eject host-uuid=uuid_of_host_to_eject

既存のリソースプールから指定したホストを除外します。

pool-emergency-reset-master

pool-emergency-reset-master master-address=address_of_pool_master

スレーブメンバーホストが使用しているプールマスターのアドレスをリセットして、新しいアドレスのプールマスターに接続します。マスターホストでこのコマンドを実行しないでください。

pool-emergency-transition-to-master

pool-emergency-transition-to-master

任意のホスト(メンバーホスト)をプールマスタとして動作させます。ホストは、ホストが緊急モードに移行してから、このコマンドを受け入れます。緊急モードとは、あるプール内のメンバーが、そのプールマスタへの接続を切断され、何度か再試行しても接続できないことを意味します。

ホストがプールに参加してからホストパスワードが変更された場合、このコマンドによってホストのパスワードがリセットされる可能性があります。詳しくは、(ユーザーコマンド)を参照してください。

pool-ha-enable

pool-ha-enable heartbeat-sr-uuids=uuid_of_heartbeat_sr

指定したストレージリポジトリを中央ストレージハートビートリポジトリとして使用して、リソースプールの高可用性機能を有効にします。

pool-ha-disable

pool-ha-disable

リソースプールの高可用性機能を無効にします。

pool-ha-compute-hypothetical-max-host-failures-to-tolerate

現在のプール構成で許容されるホスト障害の最大数を計算します。

pool-ha-compute-max-host-failures-to-tolerate

pool-ha-compute-hypothetical-max-host-failures-to-tolerate [vm-uuid=vm_uuid] [restart-priority=restart_priority]

提供され、提案され、保護された仮想マシンで許容される最大ホスト障害数を計算します。

pool-initialize-wlb

pool-initialize-wlb wlb_url=url wlb_username=wlb_username wlb_password=wlb_password xenserver_username=username xenserver_password=password

現在のプールのワークロードバランスをターゲットWLBサーバーで初期化します。

pool-join

pool-join master-address=address master-username=username master-password=password

ホストを既存のリソースプールに追加します。

pool-management-reconfigure

pool-management-reconfigure [network-uuid=network-uuid]

このコマンドでは、リソースプールのすべてのホストでに接続するための管理インターフェイスを再指定します。これにより、すべてのホストで/etc/xensource-inventoryのMANAGEMENT_INTERFACEキーが更新されます。

インターフェイス(IPアドレスが必要)のデバイス名を指定した場合、プールマスタは直ちにバインドし直します。この場合、このコマンドは通常モードと緊急モードのいずれの場合でも機能します。

指定されたネットワークUUIDからホストに割り当てられるPIFオブジェクトのUUIDを特定し、これによって再バインドすべきIPアドレスを自動的に判断します。この場合、緊急モードではこのコマンドを使用できません。

警告:

このコマンドをリモートのホストに対して使用する場合は、xe pif-reconfigureを使用して新しいインターフェイスでのネットワーク接続を設定しておいてください。これを行わないと、そのホストに対してCLIコマンドを実行できなくなります。

pool-recover-slaves

pool-recover-slaves

プールマスタに対して、緊急モードで動作中のすべてのメンバーホストのプールマスーアドレスをリセットさせます。通常、pool-emergency-transition-to-masterでメンバホストの1つを新しいプールマスタとして設定した後に、このコマンドを使用します。

pool-restore-database

pool-restore-database file-name=filename_to_restore_from_on_client [dry-run=true|false]

データベースバックアップ(pool-dump-databaseで作成)をリソースプールにアップロードします。プールマスタがアップロードを受信すると、新しいデータベースを使用して再起動します。

dry runオプションも用意されており、実際の処理を実行しなくてもプールデータベースが復元可能かどうかを確認できます。dry-runのデフォルト値はfalseです。

pool-retrieve-wlb-configuration

pool-retrieve-wlb-configuration

ワークロードバランスサーバーからプール最適化基準を取得します。

pool-retrieve-wlb-diagnostics

pool-retrieve-wlb-diagnostics [filename=file_name]

ワークロードバランスサーバーから診断を取得します。

pool-retrieve-wlb-recommendations

pool-retrieve-wlb-recommendations

ワークロードバランスサーバーからプールの仮想マシン移行推奨事項を取得します。

pool-retrieve-wlb-report

pool-retrieve-wlb-report report=report [filename=file_name]

ワークロードバランスサーバーからレポートを取得します。

pool-send-test-post

pool-send-test-post dest-host=destination_host dest-port=destination_port body=post_body

HTTPSを使用して、指定された本文を指定されたホストおよびポートに送信し、応答を出力します。これは、SSL層のデバッグに使用されます。

pool-send-wlb-configuration

pool-send-wlb-configuration [config:=config]

ワークロードバランスサーバーのプール最適化基準を設定します。

pool-sync-database

pool-sync-database

プールデータベースを、リソースプールのすべてのホストと強制的に同期します。データベースは定期的に自動複製されるため、このコマンドは通常の操作では不要です。しかしこのコマンドは、重要なCLI操作の実行後、変更が迅速に複製されるようにするのに役立ちます。

プールをigmp-snoopingに設定します

pool-param-set [uuid=pool-uuid] [igmp-snooping-enabled=true|false]

プールでIGMPスヌーピングを有効または無効にします。

PVSアクセラレータコマンド

PVSアクセラレータを操作するためのコマンド。

pvs-cache-storage-create

pvs-cache-storage-create sr-uuid=sr_uuid pvs-site-uuid=pvs_site_uuid size=size

指定されたホストの特定のストレージリポジトリ上にPVSキャッシュを構成します。

pvs-cache-storage-destroy

pvs-cache-storage-destroy uuid=uuid

PVSキャッシュを削除します。

pvs-proxy-create

pvs-proxy-create pvs-site-uuid=pvs_site_uuid vif-uuid=vif_uuid

PVSプロキシを使用するように仮想マシン/仮想ネットワークインターフェイスを設定します。

pvs-proxy-destroy

pvs-proxy-destroy uuid=uuid

この仮想ネットワークインターフェイス/仮想マシンのPVSプロキシを削除(またはスイッチオフ)します。

pvs-server-forget

pvs-server-forget uuid=uuid

PVSサーバーを削除します。

pvs-server-introduce

pvs-server-introduce addresses=adresses first-port=first_port last-port=last_port pvs-site-uuid=pvs_site_uuid

新しいPVSサーバーを導入します。

pvs-site-forget

pvs-site-forget uuid=uuid

PVSサイトを削除します。

pvs-site-introduce

pvs-site-introduce name-label=name_label [name-description=name_description] [pvs-uuid=pvs_uuid]

新しいPVSサイトを導入します。

ストレージマネージャコマンド

ストレージマネージャプラグイン(smオブジェクト)を制御します。

ストレージマネージャオブジェクトは、標準的なオブジェクトリストコマンド(xe sm-list)でリストできます。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

smオブジェクトのパラメーター

smオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid SMプラグインの一意の識別子/オブジェクトリファレンス 読み取り専用
name-label SMプラグインの名前 読み取り専用
name-description SMプラグインの説明文字列 読み取り専用
type このプラグインが接続するストレージリポジトリの種類 読み取り専用
vendor このプラグインを作成したベンダーの名前 読み取り専用
copyright SMプラグインの著作権声明 読み取り専用
required-api-version ホストで要求される最低SM APIバージョン 読み取り専用
configuration デバイス設定キーの名前と説明 読み取り専用
capabilities SMプラグインの機能 読み取り専用
driver-filename SRドライバーのファイル名。 読み取り専用

スナップショットコマンド

スナップショットを操作します。

snapshot-clone

snapshot-clone new-name-label=name_label [uuid=uuid] [new-name-description=description]

既存のスナップショットを複製し、ストレージレベルの高速ディスククローン処理を行うことで、新しいテンプレートを作成します(サポートされる場合)。

snapshot-copy

snapshot-copy new-name-label=name_label [uuid=uuid] [new-name-description=name_description] [sr-uuid=sr_uuid]

通常の方法で既存の仮想マシンを複製して新しいテンプレートを作成します(ストレージレベルの高速ディスククローン処理がサポートされる場合でもそれを使用しません)。複製された仮想マシンのディスクイメージは常に「フルイメージ」 であり、CoWの一部ではありません。

snapshot-destroy

snapshot-destroy  [uuid=uuid] [snapshot-uuid=snapshot_uuid]

スナップショットを破棄します。そのスナップショットに関連付けられたストレージはそのまま残ります。ストレージも削除するには、snapshot-uninstallを使用します。

snapshot-disk-list

snapshot-disk-list [uuid=uuid] [snapshot-uuid=snapshot_uuid] [vbd-params=vbd_params] [vdi-params=vdi_params]

選択した仮想マシン上のディスクを一覧表示します。

snapshot-export-to-template

snapshot-export-to-template filename=file_name snapshot-uuid=snapshot_uuid  [preserve-power-state=true|false]

スナップショットをfilenameにエクスポートします。

snapshot-reset-powerstate

snapshot-reset-powerstate [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]

管理ツールスタックデータベースでのみ、仮想マシンの電源を強制的に停止させます。このコマンドは、「一時停止」とマークされたスナップショットを回復するために使用されます。この操作は危険である可能性があります:メモリイメージが不要であることを確認する必要があります(操作を実行するとスナップショットを再開できなくなります)。

snapshot-revert

snapshot-revert [uuid=uuid] [snapshot-uuid=snapshot_uuid]

既存の仮想マシンを以前のチェックポイント状態またはスナップショット状態に戻します。

snapshot-uninstall

snapshot-uninstall [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]

スナップショットをアンインストールします。この操作により、RWとマークされた、このスナップショットにのみ接続されているVDIを破棄します。VMレコードを単に破棄するには、snapshot-destroyを使用します。

ストレージリポジトリコマンド

ストレージリポジトリ(srオブジェクト)を制御するためのコマンド

srオブジェクトのリストは、標準オブジェクトリストコマンド(xe sr-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

srオブジェクトのパラメーター

srオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid ストレージリポジトリの一意の識別子/オブジェクト参照 読み取り専用
name-label ストレージリポジトリの名前 読み取り/書き込み
name-description ストレージリポジトリの説明文字列 読み取り/書き込み
allowed-operations 現在のSRの状態で可能な操作のリスト 読み取り専用のセットパラメータ
current-operations このストレージリポジトリ上で現在処理中の操作のリスト 読み取り専用のセットパラメータ
VDIs このストレージリポジトリ内の仮想ディスクの一意の識別子/オブジェクト参照 読み取り専用のセットパラメータ
PBDs このストレージリポジトリに接続されているPBDの一意の識別子/オブジェクト参照 読み取り専用のセットパラメータ
physical-utilisation このストレージリポジトリ上で現在使用されている物理スペース(バイト数)。シンプロビジョニングの場合は、物理的な使用量が仮想割り当てより小さくなることがあります 読み取り専用
physical-size ストレージリポジトリの総物理サイズ(バイト数) 読み取り専用
type ストレージリポジトリの種類。使用するストレージリポジトリバックエンドドライバーを指定するために使用 読み取り専用
introduced-by ストレージリポジトリをイントロデュースした障害回復タスク(該当する場合) 読み取り専用
content-type SRの内容の種類。ISOライブラリをほかのSRから区別するために使用されています。ISOのライブラリを格納するストレージリポジトリのcontent-typeはisoである必要があります。そのほかのストレージリポジトリでは、このパラメーターを空白にするかuserを指定することをはお勧めします。 読み取り専用
shared このストレージリポジトリを複数のホストで共有できる場合はtrue。それ以外はfalse 読み取り/書き込み
other-config ストレージリポジトリの追加構成パラメーターを指定するキー/値ペアのリスト 読み取り/書き込み可のマップパラメータ
host SRのホスト名 読み取り専用
virtual-allocation このストレージリポジトリの全VDIのvirtual-size値の合計(バイト数) 読み取り専用
sm-config SMに依存するデータ 読み取り専用のマップパラメータ
blobs バイナリデータストア 読み取り専用

sr-create

sr-create name-label=name physical-size=size type=type content-type=content_type device-config:config_name=value [host-uuid=host_uuid] [shared=true|false]

ディスク上にストレージリポジトリを作成し、データベースにイントロデュースして、このストレージリポジトリをホストに接続するためのPBDを作成します。sharedtrueに設定されている場合、PBDはプールのホストそれぞれに作成されます。sharedが指定されていないか、falseに設定されている場合、PBDはhost-uuidで指定されたホストにのみ作成されます。

device-configパラメーターは、デバイスのtypeによって異なります。さまざまなストレージバックエンド用のパラメーターについて詳しくは、「ストレージ」を参照してください。

sr-data-source-forget

sr-data-source-forget data-source=data_source

ストレージリポジトリのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。

sr-data-source-list

sr-data-source-list"

ストレージリポジトリで、記録可能なデータソースのリストを出力します。

sr-data-source-query

sr-data-source-query data-source=data_source

ストレージリポジトリのデータソースから最後に読み取った値を照会します。

sr-data-source-record

sr-data-source-record  data-source=data_source

ストレージリポジトリで、指定したデータソースを記録します。

sr-destroy

sr-destroy uuid=sr_uuid

ホスト上の指定したストレージリポジトリを破棄します。

sr-enable-database-replication

sr-enable-database-replication uuid=sr_uuid

指定した(共有)ストレージリポジトリへのXAPIデータベースの複製を有効にします。例:

xe sr-enable-database-replication uuid=sr-uuid

sr-disable-database-replication

sr-disable-database-replication uuid=sr_uuid

指定したストレージリポジトリへのXAPIデータベースの複製を無効にします。例:

xe sr-enable-database-replication uuid=sr-uuid

sr-forget

sr-forget uuid=sr_uuid

XAPIエージェントから、ホストの指定されたストレージリポジトリを削除します。XAPIエージェントからストレージリポジトリが削除されると、ストレージリポジトリが切断され、その上のVDIにアクセスできなくなります。ただし、そのストレージリポジトリはソースメディア上に残ります(データは失われません)。

sr-introduce

sr-introduce name-label=name physical-size=physical_size type=type content-type=content_type uuid=sr_uuid

ストレージリポジトリレコードをデータベースに配置(イントロデュース)します。device-configを使用してdevice-config:parameter_key=parameter_valueの形式で追加パラメーターを指定します。例:

xe sr-introduce device-config:device=/dev/sdb1

注:

このコマンドは、通常の操作では使用しません。作成後のストレージリポジトリを共有用に再設定する必要のある場合や、さまざまな障害シナリオからの回復に使用できる、高度な操作です。

sr-probe

sr-probe type=type [host-uuid=host_uuid] [device-config:config_name=value]

指定したdevice-configキーに基づいて、特定のバックエンドのスキャンを行います。device-configで目的のストレージリポジトリバックエンドの設定パラメーターを指定すると、その値に一致するストレージリポジトリのリストが返されます。device-configで一部のパラメーターのみを指定して特定バックエンドのスキャンを行うと、目的のストレージリポジトリを検出するために指定すべきほかのdevice-configパラメーターが返されます。スキャンの結果は、バックエンド固有のXML形式で返され、CLIにより出力されます。

device-configパラメーターは、デバイスのtypeによって異なります。さまざまなストレージバックエンド用のパラメーターについて詳しくは、「ストレージ」を参照してください。

sr-probe-ext

sr-probe-ext type=type [host-uuid=host_uuid] [device-config:=config] [sm-config:-sm_config]

ストレージプローブを実行します。device-configパラメーターは、device-config:devs=/dev/sdb1などで指定できます。sr-probeとは異なり、このコマンドはすべてのストレージリポジトリの種類に対して人間が判読可能な形式で結果を返します。

sr-scan

sr-scan uuid=sr_uuid

ストレージリポジトリのスキャンを強制して、XAPIデータベースを、そのストレージサブストレートに存在するVDIと同期します。

sr-update

sr-update uuid=uuid

データベース内のsrオブジェクトのフィールドを更新します。

lvhd-enable-thin-provisioning

lvhd-enable-thin-provisioning  sr-uuid=sr_uuid initial-allocation=initial_allocation allocation-quantum=allocation_quantum

LVHDストレージリポジトリのシンプロビジョニングを有効にします。

サブジェクトコマンド

サブジェクトを操作します。

session-subject-identifier-list

session-subject-identifier-list

外部で認証された既存のすべてのセッションのすべてのユーザーサブジェクトIDのリストを返します。

session-subject-identifier-logout

session-subject-identifier-logout subject-identifier=subject_identifier

ユーザーのサブジェクトIDに関連付けられたすべての外部認証セッションをログアウトします。

session-subject-identifier-logout-all

session-subject-identifier-logout-all

すべての外部認証セッションをログアウトします。

subject-add

subject-add subject-name=subject_name

プールにアクセスできるサブジェクトのリストにサブジェクトを追加します。

subject-remove

subject-remove subject-uuid=subject_uuid

プールにアクセスできるサブジェクトのリストからサブジェクトを削除します。

subject-role-add

subject-role-add uuid=uuid [role-name=role_name] [role-uuid=role_uuid]

サブジェクトにロールを追加します。

subject-role-remove

subject-role-remove uuid=uuid [role-name=role_name] [role-uuid=role_uuid]

サブジェクトからロールを削除します。

secret-create

secret-create value=value

シークレットを作成します。

secret-destroy

secret-destroy uuid=uuid

シークレットを破棄します。

タスクコマンド

実行時間の長い非同期タスク(taskオブジェクト)を操作します。非同期タスクとは、仮想マシンの起動、停止、一時停止などのタスクを指します。通常、これらのタスクは、要求された操作をまとまって実行するほかのアトミックサブタスクの集合からなります。

taskオブジェクトのリストは、標準オブジェクトリストコマンド(xe task-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

taskオブジェクトのパラメーター

taskオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid タスクの一意の識別子/オブジェクトリファレンス 読み取り専用
name-label タスクの名前 読み取り専用
name-description タスクの説明文字列 読み取り専用
resident-on タスクを実行しているホストの一意の識別子/オブジェクトリファレンス 読み取り専用
status タスクの現在の状態 読み取り専用
progress タスクが保留中の場合はその処理の推定完了率(0-1)。成功したかどうかに関係なく、完了すると値は1。 読み取り専用
type タスクが正常に完了した場合、このパラメーターにはエンコードされた結果のタイプが含まれる。タイプは、参照が結果フィールドにあるクラスの名前。それ以外の場合、このパラメーターの値は未定義 読み取り専用
result タスクが正常に完了した場合は結果値(Voidまたはオブジェクト参照)。それ以外は未定義 読み取り専用
error_info タスクが失敗した場合はそのタスクに関するエラー文字列。それ以外の場合、このパラメーターの値は未定義 読み取り専用
allowed_operations この状態で可能な操作のリスト 読み取り専用
created タスクの作成時刻 読み取り専用
finished タスクが完了(成功または失敗)した時刻。task-statusがpendingの場合、このフィールドの値は意味を持ちません 読み取り専用
subtask_of このサブタスクが参照するタスクのUUID 読み取り専用
subtasks このタスクのすべてのサブタスクのUUID 読み取り専用

task-cancel

task-cancel [uuid=task_uuid]

指定したタスクを取り消して戻します。

テンプレートコマンド

仮想マシンテンプレート(templateオブジェクト)を操作します。

基本的に、templateオブジェクトは、is-a-templateパラメーターがtrueに設定されたvmオブジェクトです。テンプレートは、特定の仮想マシンをインスタント化するさまざまな設定を含む「ゴールドイメージ」です。にはテンプレートの基本セットが付属しており、これらを基に「未加工」の汎用仮想マシンを作成して、オペレーティングシステムベンダーのインストールCDから起動できます(RHEL、CentOS、SLES、Windowsなど)。仮想マシンを作成し、それを必要に応じて設定し、将来の展開用にそのコピーをテンプレートとして保存できます。

templateオブジェクトのリストは、標準オブジェクトリストコマンド(xe template-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

注:

is-a-templateパラメーターをfalseに設定して、テンプレートを仮想マシンに直接変換することはできません。is-a-templateパラメーターをfalseに設定することはサポートされておらず、仮想マシンを起動できなくなります。

templateオブジェクトのパラメーター

templateオブジェクトには、以下のパラメータがあります。

  • uuid(読み取り専用)テンプレートの一意の識別子/オブジェクト参照
  • name-label(読み取り/書き込み)テンプレートの名前
  • name-description(読み取り/書き込み)テンプレートの説明文字列
  • user-version(読み取り/書き込み)バージョン情報に含める、仮想マシンおよびテンプレートの作成者用の文字列
  • is-a-template(読み取り/書き込み)このVMがテンプレートの場合はtrue。 テンプレートは起動できない仮想マシンで、複製して仮想マシンを作成するためのものです。この値をtrueに設定すると、falseにリセットすることはできません。このパラメータを使用して、テンプレート仮想マシンを仮想マシンに変換することはできません。
  • is-control-domain(読み取り専用)コントロールドメイン(ドメイン0またはドライバードメイン)の場合にtrue
  • power-state(読み取り専用)現在の電源状態。テンプレートの値は常にhaltedです
  • memory-dynamic-max(読み取り専用)動的最大メモリ量(バイト数)。 現在使用されていないパラメーターですが、変更する場合は以下の制限があります:memory_static_max >= memory_dynamic_max >= memory_dynamic_min >= memory_static_min
  • memory-dynamic-min(読み取り/書き込み)動的最小メモリ量(バイト数)。 現在、使用されていないパラメーターですが、変更する場合はmemory-dynamic-maxと同じ制限が適用されます。
  • memory-static-max(読み取り/書き込み)静的設定(絶対)最大値(バイト数)。このフィールドは、仮想マシンに割り当てるメモリ量を指定するための主な値です。
  • memory-static-min(読み取り/書き込み)静的設定(絶対)最小値(バイト数)。 仮想マシンに割り当てる最少メモリ量。memory-static-minにはmemory-static-maxよりも小さい値を指定します。 通常では使用されないパラメーターですが、前述の制限が適用されます。
  • suspend-VDI-uuid(読み取り専用)一時停止イメージを格納するVDI(テンプレートの場合意味を持ちません)
  • VCPUs-params(読み取り/書き込みマップパラメーター)選択したvCPUポリシーの構成パラメーター。

    次のコマンドで、使用するvCPUを指定できます:

    xe template-param-set uuid=<template_uuid> vCPUs-params:mask=1,2,3
    

    これにより、このテンプレートから作成した仮想マシンは物理CPUの1、2、および3上でのみ動作します。

    また、capおよびweightパラメーターを使用して、vCPUの優先度(xen scheduling)を指定することもできます。例:

    xe template-param-set uuid=<template_uuid> VCPUs-params:weight=512 xe template-param-set uuid=<template_uuid> VCPUs-params:cap=100
    

    これにより、このテンプレートから作成した仮想マシン(weightは512)は、そのホスト上のほかのドメイン(weightは256)の2倍のCPUリソースを使用できます。weightに指定可能な値は1~65535で、デフォルト値は256です。

    capパラメーターを指定すると、ホストのCPUにアイドルサイクルがある場合でも、このテンプレートから作成した仮想マシンが使用するCPUサイクルに上限を設定できます。capには1つの物理CPUのパーセンテージを指定します。つまり100は1つの物理CPU、50はその半分、400は4つの物理CPUを示します。デフォルト値は0で、これは上限を設定しないことを示します。

  • VCPUs-max(読み取り/書き込み)vCPUの最大数
  • VCPUs-at-startup(読み取り/書き込み)vCPUの起動数
  • actions-after-crash(読み取り/書き込み)このテンプレートから作成した仮想マシンがクラッシュした後で実行する処理
  • console-uuids(読み取り専用の設定パラメーター)仮想コンソールデバイス
  • platform(読み取り/書き込みマップパラメーター)プラットフォーム固有の構成

    HVMゲスト(Windows仮想マシンなど)のパラレルポートのエミュレーションを無効にするには、次のコマンドを使用します。

    xe vm-param-set uuid=<vm_uuid> platform:parallel=none
    

    HVMゲストのシリアルポートのエミュレーションを無効にするには、次のコマンドを使用します。

    xe vm-param-set uuid=<vm_uuid> platform:hvm_serial=none
    

    HVMゲストのUSBコントローラおよびUSBタブレットデバイスのエミュレーションを無効にするには、次のコマンドを使用します。

    xe vm-param-set uuid=<vm_uuid> platform:usb=false
    xe vm-param-set uuid=<vm_uuid> platform:usb_tablet=false
    

    USBパススルー用にqemu-upstreamを使用するには:

    xe vm-param-set uuid=<vm_uuid> platform:device-model=qemu-upstream-compat
    
  • allowed-operations(読み取り専用の設定パラメーター)この状態で可能な操作のリスト
  • current-operations(読み取り専用の設定パラメーター)このテンプレート上で現在処理中の操作のリスト
  • allowed-VBD-devices(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVBD識別子のリスト。このリストは情報を提供するだけで、ほかのデバイスも使用できます(ただし機能しない場合があります)
  • allowed-VIF-devices(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVIF識別子のリスト。このリストは情報を提供するだけで、ほかのデバイスも使用できます(ただし機能しない場合があります)
  • HVM-boot-policy(読み取り/書き込み)HVMゲストの起動ポリシー。BIOS Orderまたは空の文字列。
  • HVM-boot-params(読み取り/書き込みマップパラメーター)orderキーがHVMゲストの起動順序を制御します:起動順序は、d(CD/DVD)、c(ルートディスク)、およびn(ネットワークPXEブート)の各文字で定義されます。デフォルトはdcです。
  • PV-kernel(読み取り/書き込み)カーネルへのパス
  • PV-ramdisk(読み取り/書き込み)initrdへのパス
  • PV-args(読み取り/書き込み)カーネルコマンドライン引数の文字列
  • PV-legacy-args(読み取り/書き込み)このテンプレートから作成した従来の仮想マシンを起動するための引数文字列
  • PV-bootloader(読み取り/書き込み)ブートローダーの名前またはパス
  • PV-bootloader-args(読み取り/書き込み)ブートローダーの各種引数の文字列
  • last-boot-CPU-flags(読み取り専用)このテンプレートから作成した仮想マシンを最後に起動したときのCPUフラグ。テンプレートに対しては指定されません
  • resident-on(読み取り専用)このテンプレートから作成した仮想マシンが常駐するホスト。テンプレートの場合は「not in database」と表示されます
  • affinity(読み取り/書き込み)このテンプレートから作成した仮想マシンが優先的に実行されるホスト。xe vm-startコマンドによって使用され、仮想マシンを実行する場所を決定します
  • other-config(読み取り/書き込みマップパラメーター)テンプレートの追加構成パラメーターを指定するキー/値ペアのリスト
  • start-time(読み取り専用)このテンプレートから作成した仮想マシンのメトリクスが読み取られた日時。形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)。テンプレートの場合は1 Jan 1970 Z(Unix/POSIXエポックの基準日時)を設定します
  • install-time(読み取り専用)このテンプレートから作成した仮想マシンのメトリクスが読み取られた日時。形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)。テンプレートの場合は1 Jan 1970 Z(Unix/POSIXエポックの基準日時)を設定します
  • memory-actual(読み取り専用)このテンプレートから作成した仮想マシンが使用する実メモリ。テンプレートの場合は0
  • VCPUs-number(読み取り専用)このテンプレートから作成した仮想マシンに割り当てられた仮想CPUの数。テンプレートの場合は0
  • VCPUs-Utilization(読み取り専用マップパラメーター)仮想CPUとその読み取り専用のweightマップパラメーターのリスト。os-versionはこのテンプレートから作成した仮想マシンのオペレーティングシステムのバージョン。テンプレートの場合は「not in database」と表示されます
  • PV-drivers-version(読み取り専用マップパラメーター)このテンプレートから作成した仮想マシンの準仮想化ドライバーのバージョン。テンプレートの場合は「not in database」と表示されます
  • PV-drivers-detected(読み取り専用)このテンプレートから作成した仮想マシンの準仮想化ドライバーの最新バージョンのフラグ。テンプレートの場合は「not in database」と表示されます
  • memory(読み取り専用マップパラメーター)このテンプレートから作成した仮想マシンのエージェントによって報告されるメモリメトリック。テンプレートの場合は「not in database」と表示されます
  • disks(読み取り専用マップパラメーター)このテンプレートから作成した仮想マシンのエージェントによって報告されるディスクメトリック。テンプレートの場合は「not in database」と表示されます
  • networks(読み取り専用マップパラメーター)このテンプレートから作成した仮想マシンのエージェントによって報告されるネットワークメトリック。テンプレートの場合は「not in database」と表示されます
  • other(読み取り専用マップパラメーター)このテンプレートから作成した仮想マシンのエージェントによって報告されるその他のメトリック。テンプレートの場合は「not in database」と表示されます
  • guest-metrics-last-updated(読み取り専用)ゲスト内のエージェントがこれらのフィールドへ最後に書き込みを実行したときの日時。形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)
  • actions-after-shutdown(読み取り/書き込み)仮想マシンがシャットダウンした後で実行する処理
  • actions-after-reboot(読み取り/書き込み)仮想マシンが再起動した後で実行する処理
  • possible-hosts(読み取り専用)この仮想マシンを実行可能なホストのリスト
  • HVM-shadow-multiplier(読み取り/書き込み)ゲストで使用できるシャドウメモリ量に適用される乗数
  • dom-id(読み取り専用)ドメインID(使用可能な場合。それ以外は-1)
  • recommendations(読み取り専用)この仮想マシンのプロパティに対する推奨値と推奨範囲のXML仕様
  • xenstore-data(読み取り/書き込みマップパラメーター)仮想マシンの作成後、xenstoreツリー(/local/domain/domid/vmdata)に挿入するデータ
  • is-a-snapshot(読み取り専用)このテンプレートが仮想マシンスナップショットの場合はtrue
  • snapshot_of(読み取り専用)このテンプレートのスナップショット元の仮想マシンのUUID
  • snapshots(読み取り専用)このテンプレートから作成されたすべてのスナップショットのUUID
  • snapshot_time(読み取り専用)最新の仮想マシンスナップショットの作成日時
  • memory-target(読み取り専用)このテンプレートに設定されているターゲットメモリ量
  • blocked-operations(読み取り/書き込みマップパラメーター)このテンプレートで実行できない操作の一覧表示
  • last-boot-record(読み取り専用)このテンプレートで最後に使用されたブートパラメーターのレコード(XML形式)
  • ha-always-run(読み取り/書き込み)このテンプレートのインスタンスがそのホストの障害時に常にほかのホストで再起動する場合はtrue。このパラメータは廃止されています。代わりとしてha-restartpriorityを使用します。
  • ha-restart-priority(読み取り専用)再起動またはベストエフォート型の読み取り/書き込みBLOBバイナリデータストア
  • live(読み取り専用)実行中の仮想マシンでのみ意味を持ちます。

template-export

template-export template-uuid=uuid_of_existing_template filename=filename_for_new_template

指定したテンプレートのコピーを新規のファイル名でエクスポートします。

template-uninstall

template-uninstall template-uuid=template_uuid [--force]

カスタムテンプレートをアンインストールします。この操作により、このテンプレートによって「所有」とマークされたVDIが破棄されます。

アップデートコマンド

次のセクションには、ホストのアップデートコマンドが含まれています。

アップデートオブジェクトのリストは、標準オブジェクトリストコマンド(xe update-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

アップデートパラメーター

ホストのアップデートには、以下のパラメーターがあります。

パラメーター名 説明 種類
uuid アップデートの一意の識別子/オブジェクト参照 読み取り専用
host このアップデートが適用されるホストの一覧 読み取り専用
host-uuid 照会するホストの一意の識別子 読み取り専用
name-label アップデートの名前 読み取り専用
name-description アップデートの説明文字列 読み取り専用
applied このアップデートが適用されているかどうか。trueまたはfalse 読み取り専用
installation-size アップデートのサイズ(バイト数) 読み取り専用
after-apply-guidance XAPIツールスタックまたはホストの再起動が必要かどうか 読み取り専用
version アップデートのバージョン 読み取り専用

update-upload

update-upload file-name=update_filename

指定したアップデートファイルをホストにアップロードします。このコマンドでアップデートを適用できる状態になります。アップロードに成功すると、アップデートファイルのUUIDが返されます。同じアップデートが既にアップロードされている場合、UPDATE_ALREADY_EXISTSエラーが返され、これはアップロードされません。

update-precheck

update-precheck uuid=update_uuid host-uuid=host_uuid

指定したアップデートに含まれている事前チェックを指定したホストに対して実行します。

update-destroy

update-destroy uuid=update_file_uuid

適用されていないアップデートファイルをプールから削除します。ホストに適用できないアップデートファイルの削除に使用できます。

update-apply

update-apply host-uuid=host_uuid uuid=update_file_uuid

指定したアップデートファイルを適用します。

update-pool-apply

update-pool-apply uuid=update_uuid

指定したアップデートをリソースプール内のすべてのホストに適用します。

update-introduce

update-introduce vdi-uuid=vdi_uuid

更新VDIを導入します。

update-pool-clean

update-pool-clean uuid=uuid

プール内のすべてのホストからアップデートファイルを削除します。

ユーザーコマンド

user-password-change

user-password-change old=old_password new=new_password

ログインしているユーザーのパスワードを変更します。このコマンドを実行するにはスーパーバイザー権限が必要なため、変更前のパスワードフィールドはチェックされません。

VBD(仮想ブロックデバイス)コマンド

VBD(vbdオブジェクト)を操作します。

vbdオブジェクトは、仮想マシンをVDIに接続するソフトウェアオブジェクトで、仮想ディスクの内容を示します。VBD(vbdオブジェクト)にはVDIを仮想マシンに関連付ける属性(起動の可否、読み取り/書き込みメトリックなど)があります。vdiオブジェクトには仮想ディスクの物理属性に関する情報(ストレージリポジトリの種類、ディスクの共有の可否、メディアが読み取り/書き込み可能か読み取り専用かなど)があります。

vbdオブジェクトのリストは、標準オブジェクトリストコマンド(xe vbd-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

vbdオブジェクトのパラメーター

vbdオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid VBDの一意の識別子/オブジェクト参照 読み取り専用
vm-uuid このVBDが接続されている仮想マシンの一意の識別子/オブジェクト参照 読み取り専用
vm-name-label このVBDが接続されている仮想マシンの名前 読み取り専用
vdi-uuid このVBDがマップされているVDIの一意の識別子/オブジェクト参照 読み取り専用
vdi-name-label このVBDがマップされているVDIの名前 読み取り専用
empty 空のドライブの場合にtrue 読み取り専用
device ゲストから見たデバイス。たとえばhda 読み取り専用
userdevice vbd-createのときにdeviceパラメーターによって指定されるデバイス番号。hdaの場合は0、hdbの場合は1のようになります 読み取り/書き込み
bootable このVBDが起動可能な場合にtrue 読み取り/書き込み
mode VBDのマウントに使用すべきモード 読み取り/書き込み
type 仮想マシンにVBDが表示される方法。ディスクやCDなどです 読み取り/書き込み
currently-attached VBDがこのホストに接続されている場合はtrue。それ以外はfalse 読み取り専用
storage-lock ストレージレベルのロックが取得された場合はtrue 読み取り専用
status-code 最後の接続操作に関連するエラー/成功コード 読み取り専用
status-detail 最後の接続操作の状態に関連するエラー/成功コード 読み取り専用
qos_algorithm_type 使用するQoSアルゴリズム 読み取り/書き込み
qos_algorithm_params 選択したQoSアルゴリズムのパラメーター 読み取り/書き込み可のマップパラメータ
qos_supported_algorithms このVBDでサポートされるQoSアルゴリズム 読み取り専用のセットパラメータ
io_read_kbs このVBDの平均読み取り速度(kB/秒) 読み取り専用
io_write_kbs このVBDの平均書き込み速度(kB/秒) 読み取り専用
allowed-operations 現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もありあます 読み取り専用のセットパラメータ
current-operations 実行中の各タスクのリンク。タスクの性質を表すcurrent_operation enumに対して、このオブジェクトを参照して使用する。 読み取り専用のセットパラメータ
unpluggable このVBDがホットアンプラグをサポートする場合はtrue 読み取り/書き込み
attachable デバイスが接続できる場合はtrue 読み取り専用
other-config 追加の構成 読み取り/書き込み可のマップパラメータ

vbd-create

vbd-create vm-uuid=uuid_of_the_vm device=device_value vdi-uuid=uuid_of_vdi_to_connect_to [bootable=true] [type=Disk|CD] [mode=RW|RO]

仮想マシン上にVBDを作成します。

deviceフィールドに指定可能な値は0~15の整数で、数値は仮想マシンごとに一意である必要があります。現在指定可能な値は、指定した仮想マシンのallowed-VBD-devicesパラメーターで確認できます。これはvbdパラメーターにuserdeviceとして表示されます。

typeDiskの場合、vdi-uuidは必須です。DiskのmodeパラメーターにはROまたはRWを指定できます。

typeCDの場合、vdi-uuidは任意です。VDIを指定しない場合は、空のVBDがCD用に作成されます。CDのmodeパラメーターはROである必要があります。

vbd-destroy

vbd-destroy uuid=uuid_of_vbd

指定したVBDを破棄します。

そのVBDのother-config:ownerパラメーターがtrueの場合、関連付けられているVDIも破棄されます。

vbd-eject

vbd-eject uuid=uuid_of_vbd

指定したVBDのドライブからメディアを取り除きます。このコマンドが機能するのは、メディアの種類が取り外し可能(物理CDまたはISO)な場合のみです。それ以外の場合は、エラーメッセージVBD_NOT_REMOVABLE_MEDIAが返されます。

vbd-insert

vbd-insert uuid=uuid_of_vbd vdi-uuid=uuid_of_vdi_containing_media

指定したVBDのドライブに新しいメディアを挿入します。このコマンドが機能するのは、メディアの種類が取り外し可能(物理CDまたはISO)な場合のみです。それ以外の場合は、エラーメッセージVBD_NOT_REMOVABLE_MEDIAが返されます。

vbd-plug

vbd-plug uuid=uuid_of_vbd

仮想マシンが実行状態のときにVBDの接続を試みます。

vbd-unplug

vbd-unplug uuid=uuid_of_vbd

仮想マシンが実行状態のときにVBDの接続解除を試みます。

VDI(仮想ディスクイメージ)コマンド

VDI(vdiオブジェクト)を操作します。

vdiオブジェクトはソフトウェアオブジェクトで、仮想マシンに表示される仮想ディスクの内容を示します。これは、仮想マシンをVDIに結び付けるオブジェクトであるvbdオブジェクトとは異なります。vdiオブジェクトには仮想ディスクの物理属性に関する情報(ストレージリポジトリの種類、ディスクの共有の可否、メディアが読み取り/書き込み可能か読み取り専用かなど)があります。VBD(vbdオブジェクト)にはVDIを仮想マシンに関連付ける属性(起動の可否、読み取り/書き込みメトリックなど)があります。

vdiオブジェクトのリストは、標準オブジェクトリストコマンド(xe vdi-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

vdiオブジェクトのパラメーター

vdiオブジェクトには、以下のパラメータがあります。

パラメーター名 説明 種類
uuid VDIの一意の識別子/オブジェクト参照 読み取り専用
name-label VDIの名前 読み取り/書き込み
name-description VDIの説明文字列 読み取り/書き込み
allowed-operations この状態で可能な操作のリスト 読み取り専用のセットパラメータ
current-operations このVDIで現在処理中の操作のリスト 読み取り専用のセットパラメータ
sr-uuid VDIを格納するストレージリポジトリ 読み取り専用
vbd-uuids このVDIを参照するVBDのリスト 読み取り専用のセットパラメータ
crashdump-uuids このVDIを参照するクラッシュダンプのリスト 読み取り専用のセットパラメータ
virtual-size 仮想マシンで表示されるディスクのサイズ(バイト数)。ストレージバックエンドの種類によっては、正確に表示されない場合があります 読み取り専用
physical-utilisation ストレージリポジトリ上でのVDIの物理スペース(バイト数) 読み取り専用
type VDIの種類。たとえばSystemまたはUser 読み取り専用
sharable VDIが共有可能な場合はtrue 読み取り専用
read-only VDIを読み取り専用のみでマウントする場合はtrue 読み取り専用
storage-lock VDIがストレージレベルでロックされている場合はtrue 読み取り専用
parent VDIがチェーンの一部である場合は、親VDIへの参照 読み取り専用
missing ストレージリポジトリのスキャン操作によりこのVDIがディスク上に存在しないと認識された場合はtrue 読み取り専用
other-config VDIの追加構成情報 読み取り/書き込み可のマップパラメータ
sr-name-label ストレージリポジトリの名前 読み取り専用
location 場所情報 読み取り専用
managed VDIが管理されている場合はtrue 読み取り専用
xenstore-data VDIの接続後、xenstoreツリー(/local/domain/0/backend/ vbd/domid/device-id/smdata)に挿入するデータ。SMバックエンドは通常このフィールドをvdi_attachに設定します。 読み取り専用のマップパラメータ
sm-config SMに依存するデータ 読み取り専用のマップパラメータ
is-a-snapshot このVDIが仮想マシンストレージスナップショットの場合はtrue 読み取り専用
snapshot_of このVDIのスナップショット元のストレージのUUID 読み取り専用
snapshots このVDIのすべてのスナップショットのUUID 読み取り専用
snapshot_time このVDIを作成したスナップショット操作の日時 読み取り専用
metadata-of-pool このVDIを作成したプールのUUID 読み取り専用
metadata-latest VDIがプールの最新のメタデータを含んでいることを示すフラグ 読み取り専用
cbt-enabled 変更ブロック追跡がVDIで有効になっていことを示すフラグ 読み取り/書き込み

vdi-clone

vdi-clone uuid=uuid_of_the_vdi [driver-params:key=value]

直接使用できる、書き込み可能なVDIのコピーを新規に作成します。このコマンドがサポートされる場合、vdi-copyよりも高速にイメージを複製できます。

オプションのdriver-paramsマップパラメーターを使用して、ベンダー固有の追加構成情報を、そのVDIのバックエンドストレージドライバーに渡すことができます。詳しくは、ストレージベンダードライバーのドキュメントを参照してください。

vdi-copy

vdi-copy uuid=uuid_of_the_vdi sr-uuid=uuid_of_the_destination_sr

VDIを指定したストレージリポジトリにコピーします。

vdi-create

vdi-create sr-uuid=uuid_of_sr_to_create_vdi_on name-label=name_for_the_vdi type=system|user|suspend|crashdump virtual-size=size_of_virtual_disk sm-config-\*=storage_specific_configuration_data

VDIを作成します。

virtual-sizeパラメーターは、バイト単位またはIEC標準のKiB、MiB、GiB、およびTiBを使用して指定できます。

注:

ディスクのシンプロビジョニングをサポートする種類のストレージリポジトリ(ローカルVHDやNFS)では、ディスクの仮想割り当てが強制されません。このため、ストレージリポジトリ上で仮想ディスクを過剰に割り当てる場合には注意が必要です。過剰に割り当てたストレージリポジトリに空き領域がなくなった場合、そのターゲットサブストレートを使うか、またはそのストレージリポジトリ上の不要なVDIを削除して、ディスク領域を確保する必要があります。

注:

ストレージリポジトリの種類によっては、設定したブロックサイズで分割できるようにvirtual-sizeの値が切り上げられる可能性があります。

vdi-data-destroy

vdi-data-destroy uuid=uuid_of_vdi

指定されたVDIに関連付けられたデータを破棄しますが、変更ブロック追跡のメタデータは保持します。

注:

VDIの増分バックアップを作成するために変更ブロック追跡を使用する場合、スナップショットを削除しながらメタデータを保持するには、vdi-data-destroyコマンドを使用するようにしてください。変更ブロック追跡が有効になったVDIのスナップショットでvdi-destroyを使用しないでください。

vdi-destroy

vdi-destroy uuid=uuid_of_vdi

指定したVDIを破棄します。

注:

VDIの増分バックアップを作成するために変更ブロック追跡を使用する場合、スナップショットを削除しながら メタデータを保持するには、vdi-data-destroyコマンドを使用するようにしてください。変更ブロック追跡が有効になったVDIのスナップショットでvdi-destroyを使用しないでください。

注:

ローカルVHDおよびNFSのストレージリポジトリでは、vdi-destroyにより即時にディスク領域が解放されるのではなく、ストレージリポジトリのスキャン時に定期的に解放されます。VDIの破棄後のディスク領域を強制的に解放するには、手動で[sr-scan](#sr-scan)を実行します。

vdi-disable-cbt

vdi-disable-cbt uuid=uuid_of_vdi

VDIの変更ブロック追跡を無効にします。

vdi-enable-cbt

vdi-enable-cbt uuid=uuid_of_vdi

VDIの変更ブロック追跡を有効にします。

注:

変更ブロック追跡は、ライセンスが適用された インスタンスでのみ有効にできます。

vdi-export

vdi-export uuid=uuid_of_vdi filename=filename_to_export_to [format=format] [base=uuid_of_base_vdi] [--progress]

指定したファイル名にVDIをエクスポートします。VDIは、次のいずれかの形式でエクスポートできます:

  • raw
  • vhd

VHD形式はスパースである可能性があります。VDI内に割り当てられていないブロックがある場合、これらのブロックはVHDファイルから省略され、VHDファイルが小さくなる可能性があります。サポートされているすべてのVHDベースのストレージタイプ(EXT、NFS)からVHD形式にエクスポートできます。

baseパラメーターを指定する場合、このコマンドにより、エクスポートされたVDIとベースVDIの間で変更されたブロックのみがエクスポートされます。

vdi-forget

vdi-forget uuid=uuid_of_vdi

ストレージからVDIを削除せずに、データベースからVDIレコードだけを削除します。通常は、[vdi-destroy](#vdi-destroy)を使用します。

vdi-import

vdi-import uuid=uuid_of_vdi filename=filename_to_import_from [format=format] [--progress]

VDIをインポートします。VDIは、次のいずれかの形式からインポートできます:

  • raw
  • vhd

vdi-introduce

vdi-introduce uuid=uuid_of_vdi sr-uuid=uuid_of_sr name-label=name_of_new_vdi type=system|user|suspend|crashdump location=device_location_(varies_by_storage_type) [name-description=description_of_vdi] [sharable=yes|no] [read-only=yes|no] [other-config=map_to_store_misc_user_specific_data] [xenstore-data=map_to_of_additional_xenstore_keys] [sm-config=storage_specific_configuration_data]

ストレージを実際に変更したり作成したりせずに、既存のストレージデバイスのvdiオブジェクトを作成します。このコマンドは、ホットプラグされたストレージデバイスを自動的にイントロデュースするために、主に内部で使用されます。

vdi-list-changed-blocks

vdi-list-changed-blocks vdi-from-uuid=first-vdi-uuid vdi-to-uuid=second-vdi-uuid

2つのVDIを比較し、変更されたブロックの一覧をBASE64でエンコードされた文字列として返します。このコマンドは、変更ブロック追跡を有効にしたVDIに対してのみ機能します。

詳しくは、「変更ブロック追跡」を参照してください。

vdi-pool-migrate

vdi-pool-migrate uuid=VDI_uuid sr-uuid=destination-sr-uuid

VDIを指定したストレージリポジトリに移行し、VDIを実行中のゲストに接続します。(ストレージ)

詳しくは、「仮想マシンの移行」参照してください。

vdi-resize

vdi-resize uuid=vdi_uuid disk-size=new_size_for_disk

UUIDで指定したVDIのサイズを変更します。

vdi-snapshot

vdi-snapshot uuid=uuid_of_the_vdi [driver-params=params]

バックアップまたはテンプレートの作成時、またはその両方の作成時に参照できる、読み書き可能なVDIを作成します。バックアップを行う場合、仮想マシン内でバックアップソフトウェアをインストールして実行する代わりに、スナップショットを使ってバックアップを作成できます。仮想マシンの外部でバックアップソフトウェアがスナップショットの内容をバックアップメディアに保存している間も、仮想マシンを停止する必要はありません。同様に、スナップショットはテンプレートの基になる「ゴールドイメージ」として使用することもできます。テンプレートは、いずれのVDIからも作成できます。

オプションのdriver-paramsマップパラメーターを使用して、VDIの基盤となるバックエンドストレージドライバーに追加のベンダー固有の構成情報を渡します。詳しくは、ストレージベンダードライバーのドキュメントを参照してください。

スナップショットの複製は、常に書き込み可能なVDIを作成します。

vdi-unlock

vdi-unlock uuid=uuid_of_vdi_to_unlock [force=true]

指定したVDIのロック解除を試みます。force=trueを指定すると、強制的にロックを解除します。

vdi-update

vdi-update uuid=uuid

データベース内のvdiオブジェクトのフィールドを更新します。

VIF(仮想ネットワークインターフェイス)コマンド

VIF(vifオブジェクト)を操作します。

vifオブジェクトのリストは、標準オブジェクトリストコマンド(xe vif-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

vifオブジェクトのパラメーター

vifオブジェクトには、以下のパラメータがあります。

  • uuid(読み取り専用)VIFの一意の識別子/オブジェクト参照
  • vm-uuid(読み取り専用)このVIFが存在する仮想マシンの一意の識別子/オブジェクト参照
  • vm-name-label(読み取り専用)VIFが存在する仮想マシンの名前
  • allowed-operations(読み取り専用の設定パラメーター)この状態で可能な操作のリスト
  • current-operations(読み取り専用の設定パラメーター)このVIFで現在処理中の操作のリスト
  • device(読み取り専用)VIFバックエンドの作成順を示す、VIFの整数ラベル
  • MAC(読み取り専用)仮想マシンに提供される、VIFのMACアドレス
  • MTU(読み取り専用)VIFのMTU(Maximum Transmission Unit)バイト数。

    このパラメーターは読み取り専用ですが、other-configマップパラメーターのmtuキーでこのMTU設定よりも優先される値を指定できます。たとえば、次のコマンドで、仮想NICのMTU設定をジャンボフレーム用に変更できます。

    xe vif-param-set \
    uuid=<vif_uuid> \
    other-config:mtu=9000
    
  • currently-attached(読み取り専用)デバイスが接続されている場合はtrue
  • qos_algorithm_type(読み取り/書き込み)使用するQoSアルゴリズム
  • qos_algorithm_params(読み取り/書き込みマップパラメーター)選択したQoSアルゴリズムのパラメーター
  • qos_supported_algorithms(読み取り専用の設定パラメーター)このVIFでサポートされるQoSアルゴリズム
  • MAC-autogenerated(読み取り専用)VIFのMACアドレスが自動生成の場合にtrue
  • other-config(読み取り/書き込みマップパラメーター)追加構成のkey:valueペア
  • other-config:ethtoolrx(読み取り/書き込み)チェックサムの受信を有効にする場合はon、無効にする場合はoff
  • other-config:ethtooltx(読み取り/書き込み)チェックサムの転送を有効にする場合はon、無効にする場合はoff
  • other-config:ethtoolsg(読み取り/書き込み)Scatter/Gatherを有効にする場合はon、無効にする場合はoff
  • other-config:ethtooltso(読み取り/書き込み)TCPセグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff
  • other-config:ethtoolufo(読み取り/書き込み)UDPフラグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff
  • other-config:ethtoolgso(読み取り/書き込み)汎用セグメンテーションオフロードを有効にする場合はon、 無効にする場合はoff
  • other-config:promiscuous(読み取り/書き込み)VIFがブリッジ上で無作為検出(ブリッジ上のすべてのトラフィックを検出)を行う場合にtrue。仮想マシンで侵入検知システム(IDS:Intrusion Detection System)を実行する場合に使用
  • network-uuid(読み取り専用)このVIFが接続されている仮想ネットワークの一意の識別子/オブジェクト参照
  • network-name-label(読み取り専用)このVIFが接続されている仮想ネットワークの名前
  • io_read_kbs(読み取り専用)このVIFの平均読み取り速度(kB/秒)
  • io_write_kbs(読み取り専用)このVIFの平均書き込み速度(kB/秒)
  • locking_mode(読み取り専用)VIFで送受信されるトラフィックをMACアドレスやIPアドレスでフィルターするためのロックモード。追加のパラメーターが必要です。
  • locking_mode:default(読み取り専用)ネットワークのロックモードがVIFに適用されます。

    ネットワークのdefault-locking-modeがdisabledの場合、によってそのネットワークが接続するVIFですべての送受信トラフィックがドロップされます。default-lockingmodeがunlockedの場合、によってそのネットワークが接続するVIFですべての送受信トラフィックが許可されます。詳しくは、「ネットワークコマンド」を参照してください。

  • locking_mode:locked(読み取り/書き込み)VIFで特定のMACアドレスおよびIPアドレスで送受信されるトラフィックのみが許可されます。IPアドレスを指定しない場合、すべてのトラフィックがドロップされます。
  • locking_mode:unlocked(読み取り/書き込み)VIFで送受信されるトラフィックにいかなるフィルターも適用されません。
  • locking_mode:disabled(読み取り/書き込み)によりVIFですべての送受信トラフィックがドロップされます。

vif-create

vif-create vm-uuid=uuid_of_the_vm device=see below network-uuid=uuid_of_network_to_connect_to [mac=mac_address]

仮想マシンにVIFを作成します。

deviceフィールドに指定可能な値は、指定した仮想マシンのパラメーターallowed-VIF-devicesにリストされます。VIFが存在しない仮想マシンで指定可能な値は0~15の整数です。

macパラメーターは、aa:bb:cc:dd:ee:ff形式の標準MACアドレスです。指定しない場合、ランダムなMACアドレスが作成されます。mac=randomを指定することで、ランダムなMACアドレス作成を明示的に設定することもできます。

vif-destroy

vif-destroy uuid=uuid_of_vif

VIFを破棄します。

vif-move

vif-move uuid=uuid network-uuid=network_uuid

VIFを別のネットワークに移動します。

vif-plug

vif-plug uuid=uuid_of_vif

仮想マシンが実行状態のときにVIFの接続を試みます。

vif-unplug

vif-unplug uuid = uuid_of_vif

仮想マシンが実行状態のときにVIFの接続解除を試みます。

vif-configure-ipv4

この仮想インターフェイスでIPv4設定を構成します。以下のように、IPv4設定を設定します。

vif-configure-ipv4 uuid=uuid_of_vif mode=static address=CIDR_address gateway=gateway_address

例:

VIF.configure_ipv4(vifObject,"static", " 192.168.1.10/24", " 192.168.1.1")

以下のように、IPv4設定を削除します。

vif-configure-ipv4 uuid=uuid_of_vif mode=none

vif-configure-ipv6

この仮想インターフェイスでIPv6設定を構成します。以下のように、IPv6設定を設定します。

vif-configure-ipv6 uuid=uuid_of_vif mode=static address=IP_address gateway=gateway_address

例:

VIF.configure_ipv6(vifObject,"static", "fd06:7768:b9e5:8b00::5001/64", "fd06:7768:b9e5:8b00::1")

以下のように、IPv6設定を削除します。

vif-configure-ipv6 uuid=uuid_of_vif mode=none

VLAN(仮想ネットワーク)コマンド

VLAN(vlanオブジェクト)を操作します。仮想インターフェイスの一覧を出力して編集するには、PIFコマンドを使用します。このコマンドには、関連付けられた仮想ネットワークがあることを示すVLANパラメーターがあります。詳しくは、「PIFコマンド」を参照してください。たとえば、VLANを一覧表示するにはxe pif-listを使用します。

vlan-create

vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network

ホスト上にVLANを作成します。

pool-vlan-create

pool-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network

リソースプール内のすべてのホストについて、指定されたネットワークが接続されているインターフェイス(eth0など)を識別し、新しいPIFオブジェクトを作成およびプラグして、VLANを作成します。

vlan-destroy

vlan-destroy uuid=uuid_of_pif_mapped_to_vlan

VLANを破棄します。VLANにマップされたPIFのUUIDを指定する必要があります。

仮想マシンコマンド

仮想マシン(vmオブジェクト)とその属性を操作します。

vmオブジェクトセレクター

ここで説明する多くのコマンドでは、1つまたは複数の仮想マシンを操作対象として選択するための共通のメカニズムがあります。最も簡単な方法は、引数vm=name_or_uuidを指定することです。実際の仮想マシンのuuidは、xe vm-list power-state=runningなどを実行して簡単に取得できます(指定できるフィールドの一覧を取得するには、コマンドxe vm-list params=allを使用します)。たとえば、power-state=haltedを指定することで仮想マシンを選択します。その仮想マシンのpower-stateパラメーターはhaltedと同等です。複数の仮想マシンがフィルター条件に一致し、そのすべてのオブジェクトに対してコマンドを実行する場合は、オプション--multipleを指定します。指定できるすべてのパラメーターの一覧は、次の表のとおりです。

vmオブジェクトのリストは、標準オブジェクトリストコマンド(xe vm-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

vmオブジェクトのパラメーター

vmオブジェクトには、以下のパラメータがあります。

注:

書き込み可能なvmパラメーターの値は、対象の仮想マシンが実行中であっても変更できます。ただし、その変更は動的には適用されず、仮想マシンを再起動するまで反映されません。

  • appliance(読み取り/書き込み)仮想マシンを含んでいる仮想アプライアンス/vApp
  • uuid(読み取り専用)仮想マシンの一意の識別子/オブジェクト参照
  • name-label(読み取り/書き込み)仮想マシンの名前
  • name-description(読み取り/書き込み)仮想マシンの説明文字列
  • order start order(読み取り/書き込み)vAppの起動/シャットダウン時や高可用性での仮想マシンの起動順序
  • version(読み取り専用)この仮想マシンが復元された回数。新しい仮想マシンを古いバージョンで上書きする場合は、vm-recoverを呼び出します
  • user-version(読み取り/書き込み)バージョン情報に含める、仮想マシンおよびテンプレートの作成者用の文字列
  • is-a-template(読み取り/書き込み)この仮想マシンがテンプレートでない場合はfalse。テンプレート仮想マシンは起動できないものであり、複製して仮想マシンを作成するためのものです。この値をtrueに設定すると、その後falseにリセットすることはできません。このパラメータを使用して、テンプレート仮想マシンを仮想マシンに変換することはできません。
  • is-control-domain(読み取り専用)コントロールドメイン(ドメイン0またはドライバードメイン)の場合にtrue
  • power-state(読み取り専用)現在の電源状態
  • start-delay(読み取り/書き込み)仮想マシンの起動コールが返るまでの待機時間
  • shutdown-delay(読み取り/書き込み)仮想マシンのシャットダウンコールが返るまでの待機時間
  • memory-dynamic-max(読み取り/書き込み)動的最大メモリ量(バイト数)
  • memory-dynamic-min(読み取り/書き込み)動的最小メモリ量(バイト数)
  • memory-static-max(読み取り/書き込み)静的設定(絶対)最大値(バイト数)。この値を変更するには、仮想マシンがシャットダウン状態である必要があります。
  • memory-static-min(読み取り/書き込み)静的設定(絶対)最小値(バイト数)。この値を変更するには、仮想マシンがシャットダウン状態である必要があります。
  • suspend-VDI-uuid(読み取り専用)一時停止イメージを格納するVDI
  • VCPUs-params(読み取り/書き込みマップパラメーター)選択したvCPUポリシーの構成パラメーター。

    次のコマンドで、使用するvCPUを指定できます

    xe vm-param-set uuid=<vm_uuid> VCPUs-params:mask=1,2,3
    

    これにより、この仮想マシンは物理CPUの1、2、および3上でのみ動作します。 また、capおよびweightパラメーターを使用して、vCPUの優先度(xen scheduling)を指定することもできます。例:

    xe vm-param-set uuid=<vm_uuid> VCPUs-params:weight=512 xe vm-param-set uuid=<vm_uuid> VCPUs-params:cap=100
    

    これにより、この仮想マシン(weightは512)は、そのホスト上のほかのドメイン(weightは256)の2倍のCPUリソースを使用できます。weightに指定可能な値は1~65535で、デフォルト値は256です。capパラメータを指定すると、ホストのCPUにアイドルサイクルがある場合でも、この仮想マシンが使用するCPUサイクルに上限を設定できます。capには1つの物理CPUのパーセンテージを指定します。つまり100は1つの物理CPU、50はその半分、400は4つの物理CPUを示します。デフォルト値は0で、これは上限を設定しないことを示します。

  • VCPUs-max(読み取り/書き込み)vCPUの最大数。
  • VCPUs-at-startup(読み取り/書き込み)vCPUの起動数
  • actions-after-crash(読み取り/書き込み)仮想マシンがクラッシュしたときに実行する処理。PVゲストの場合、有効なパラメーターは次のとおりです:
    • preserve(分析用のみ)
    • coredump_and_restart(コアダンプを記録して、仮想マシンを再起動する)
    • coredump_and_destroy(コアダンプを記録して、仮想マシンを停止状態のままにする)
    • restart(コアダンプを記録せずに、仮想マシンを再起動する)
    • destroy(コアダンプを記録せずに、仮想マシンを停止状態のままにする)
  • console-uuids(読み取り専用の設定パラメーター)仮想コンソールデバイス
  • platform(読み取り/書き込みマップパラメーター)プラットフォーム固有の構成

    Virtual Desktop Agent(VDA)を無効にしてWindows 10をタブレットモードに切り替えるには:

    xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=0
    

    VDAを有効にしてWindows 10をタブレットモードに切り替えるには:

    xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=1
    

    現在の状態を確認するには:

    xe vm-param-get uuid=<vm_uuid> param-name=platform param-key=acpi_laptop_slate
    
  • allowed-operations(読み取り専用の設定パラメーター)この状態で可能な操作のリスト
  • current-operations(読み取り専用の設定パラメーター)仮想マシン上で現在処理中の操作のリスト
  • allowed-VBD-devices(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVBD識別子のリスト。このリストは情報を提供するだけで、ほかのデバイスも使用できます(ただし機能しない場合があります)。
  • allowed-VIF-devices(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVIF識別子のリスト。このリストは情報を提供するだけで、ほかのデバイスも使用できます(ただし機能しない場合があります)。
  • HVM-boot-policy(読み取り/書き込み)HVMゲストの起動ポリシー。BIOS Orderまたは空の文字列。
  • HVM-boot-params(読み取り/書き込みマップパラメーター)orderキーがHVMゲストの起動順序を制御します:起動順序は、d(CD/DVD)、c(ルートディスク)、およびn(ネットワークPXEブート)の各文字で定義されます。デフォルトはdcです。
  • HVM-shadow-multiplier(読み取り/書き込み)仮想マシンに許可するシャドウメモリオーバーヘッドの量を制御する浮動小数点値。デフォルトは1.0(最小値)で、この設定は上級ユーザーのみが変更するようにしてください。
  • PV-kernel(読み取り/書き込み)カーネルへのパス
  • PV-ramdisk(読み取り/書き込み)initrdへのパス
  • PV-args(読み取り/書き込み)カーネルコマンドライン引数の文字列
  • PV-legacy-args(読み取り/書き込み)従来の仮想マシンを起動するための引数文字列
  • PV-bootloader(読み取り/書き込み)ブートローダーの名前またはパス
  • PV-bootloader-args(読み取り/書き込み)ブートローダーの各種引数の文字列
  • last-boot-CPU-flags(読み取り専用)仮想マシンが最後に起動したCPUフラグの説明
  • resident-on(読み取り専用)仮想マシンが常駐するホスト
  • affinity(読み取り/書き込み)仮想マシンが優先的に実行されるホスト。xe vm-startコマンドによって使用され、仮想マシンを実行する場所を決定します
  • other-config(読み取り/書き込みマップパラメーター)仮想マシンの追加構成パラメーターを指定するキー/値ペアのリストother-configパラメーターがキーと値のペアauto_poweron: trueを含む場合、その仮想マシンはホストの起動時に自動的に開始されます。
  • start-time(読み取り専用)仮想マシンのメトリックが読み取られた日時のタイムスタンプ。このタイムスタンプの形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)
  • install-time (読み取り専用)仮想マシンのメトリックが読み取られた日時のタイムスタンプ。このタイムスタンプの形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)
  • memory-actual(読み取り専用)仮想マシンが使用する実メモリ
  • VCPUs-number(読み取り専用)PV(準仮想化)またはHVM(ハードウェア仮想マシン)のLinux仮想マシンの場合、仮想マシンに割り当てられているvCPUの数。この値がVCPUS-maxと異なっていても構いません。また、vm-vcpu-hotplugコマンドを使用すると、仮想マシンを再起動せずに値を変更できます。詳しくは、「[vm-vcpu-hotplug](#vm-vcpu-hotplug)」を参照してください。Windows仮想マシンの場合、常にVCPUsmaxに設定された数のVCPUが使用されます。この値を変更した場合、仮想マシンの再起動が必要になります。ホスト上の物理CPUの数より大きい値をVCPUs-numberに設定すると、パフォーマンスが著しく低下します。
  • VCPUs-Utilization(読み取り専用マップパラメーター)仮想CPUとその優先度(weight)のリスト
  • os-version(読み取り専用マップパラメーター)仮想マシンのオペレーティングシステムのバージョン
  • PV-drivers-version(読み取り専用マップパラメーター)仮想マシンの準仮想化ドライバーのバージョン
  • PV-drivers-detected(読み取り専用)仮想マシンの準仮想化ドライバーの最新バージョンのフラグ
  • memory(読み取り専用マップパラメーター)仮想マシンのエージェントによって報告されるメモリメトリック
  • disks(読み取り専用マップパラメーター)仮想マシンのエージェントによって報告されるディスクメトリック。
  • networks(読み取り専用マップパラメーター)仮想マシンのエージェントによって報告されるネットワークメトリック。
  • other(読み取り専用マップパラメーター)仮想マシンのエージェントによって報告されるその他のメトリック
  • guest-metrics-lastupdated(読み取り専用)ゲスト内のエージェントがこれらのフィールドへ最後に書き込みを実行したときの日時。このタイムスタンプの形式はyyyymmddThh:mm:ss z。ここでzは、1文字の軍用タイムゾーンインジケーターで、たとえばZはUTC(GMT)
  • actions-after-shutdown(読み取り/書き込み)仮想マシンがシャットダウンした後で実行する処理
  • actions-after-reboot(読み取り/書き込み)仮想マシンが再起動した後で実行する処理
  • possible-hostsこの読み取り専用仮想マシンを実行可能なホスト
  • dom-id(読み取り専用)ドメインID(使用可能な場合。それ以外は-1)
  • recommendations(読み取り専用)この仮想マシンのプロパティに対する推奨値と推奨範囲のXML仕様
  • xenstore-data(読み取り/書き込みマップパラメーター)仮想マシンの作成後、xenstoreツリー(/local/domain/domid/vm-data)に挿入するデータ
  • is-a-snapshot(読み取り専用)この仮想マシンがスナップショットの場合はtrue
  • snapshot_of(読み取り専用)このスナップショット元の仮想マシンのUUID
  • snapshots(読み取り専用)この仮想マシンのすべてのスナップショットのUUID
  • snapshot_time(読み取り専用)この仮想マシンスナップショットの作成日時
  • memory-target(読み取り専用)この仮想マシンに設定されているターゲットメモリ量
  • blocked-operations(読み取り/書き込みマップパラメーター)この仮想マシンで実行できない操作の一覧表示
  • last-boot-record(読み取り専用)このテンプレートで最後に使用されたブートパラメーターのレコード(XML形式)
  • ha-always-run(読み取り/書き込み)この仮想マシンがそのホストの障害時に常にほかのホストで再起動する場合はtrue。このパラメータは廃止されています。代わりとしてha-restart-priorityを使用します。
  • ha-restart-priority(読み取り/書き込み)再起動またはベストエフォート
  • blobs(読み取り専用)バイナリデータストア
  • live(読み取り専用)仮想マシンが実行中の場合はtrue。高可用性機能により仮想マシンが実行されていないと認識される場合はfalse。

vm-assert-can-be-recovered

vm-assert-can-be-recovered uuid [database] vdi-uuid

特定の仮想マシンを回復するためにストレージを使用できるかどうかをテストします。

vm-call-plugin

vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]

オプションの引数(args:key=value)を指定して、指定された仮想マシン上のプラグイン内の関数を呼び出します。特殊文字(たとえば改行)を含む「value」文字列を渡すには、構文args:key:file=local_fileを代わりに使用して、local_fileの内容を取得し、全体として「key」に割り当てます。

vm-cd-add

vm-cd-add cd-name=name_of_new_cd device=integer_value_of_an_available_vbd [vm-selector=vm_selector_value...]

指定した仮想マシンに新しい仮想CDを追加します。deviceパラメーターは、仮想マシンのallowed-VBD-devicesパラメーターの値から選択する必要があります。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、本セクションに記載されている「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-cd-eject

vm-cd-eject [vm-selector=vm_selector_value...]

仮想CDドライブからCDをイジェクトします。このコマンドは、仮想マシンに設定されているCDが1つのみの場合に機能します。複数のCDがある場合は、xe vbd-ejectコマンドを使用し、VBDのUUIDを指定します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-cd-insert

vm-cd-insert cd-name=name_of_cd [vm-selector=vm_selector_value...]

仮想CDドライブにCDを挿入します。このコマンドは、仮想マシンに設定されているCDが1つのみで、そのデバイスが空である場合に機能します。空のCDデバイスが複数ある場合は、xe vbd-insertコマンドを使用し、VBDと挿入するVDIのUUIDを指定します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-cd-list

vm-cd-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]

指定した仮想マシンに接続されているCDのリストを出力します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

対象のVBDパラメータとVDIパラメータも指定できます。

vm-cd-remove

vm-cd-remove cd-name=name_of_cd [vm-selector=vm_selector_value...]

指定した仮想マシンから仮想CDを削除します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-checkpoint

vm-checkpoint new-name-label=name_label [new-name-description=description]

ストレージレベルの高速ディスクスナップショット処理により、既存の仮想マシンをチェックポイントします(サポートされる場合)。

vm-clone

vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]

ストレージレベルの高速ディスククローン処理により、既存の仮想マシンを複製します(サポートされる場合)。new-name-label引数とnew-name-description引数を使用して、複製後の仮想マシンの名前と説明(オプション)を指定します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-compute-maximum-memory

vm-compute-maximum-memory total=amount_of_available_physical_ram_in_bytes [approximate=add overhead memory for additional vCPUS? true|false] [vm_selector=vm_selector_value...]

物理RAMの合計量を上限値として、既存の仮想マシンに割り当てることが可能な静的メモリの最大量を計算します。オプションのパラメーターapproximateを使用すると、仮想マシンに仮想CPUを後から追加する場合を考慮して、十分な量の余分なメモリを予約できます。

例:

xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`

このコマンドでは、xe host-listが返したmemory-freeパラメーターの値を使用して、仮想マシンtestvmの最大メモリ量を設定します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-compute-memory-overhead

vm-compute-memory-overhead

仮想マシンの仮想化メモリオーバーヘッドを計算します。

vm-copy

vm-copy new-name-label=name_for_copy [new-name-description=description_for_copy] [sr-uuid=uuid_of_sr] [vm-selector=vm_selector_value...]

通常の方法で既存の仮想マシンを複製します(ストレージレベルの高速ディスククローン処理がサポートされる場合でもそれを使用しません)。複製された仮想マシンのディスクイメージは常にフルイメージであり、コピーオンライト(CoW)の一部ではありません。

new-name-label引数とnew-name-description引数を使用して、複製後の仮想マシンの名前と説明(オプション)を指定します。

sr-uuidでは、複製後の仮想マシンを格納するストレージリポジトリを指定します。このパラメータを指定しない場合、元の仮想マシンと同じストレージリポジトリに格納されます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-copy-bios-strings

vm-copy-bios-strings host-uuid=host_uuid

指定されたホストのBIOS文字列を仮想マシンにコピーします。

vm-crashdump-list

vm-crashdump-list [vm-selector=vm selector value...]

指定した仮想マシンに関するクラッシュダンプのリストを出力します。

オプションの引数paramsを使用して特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルターする)場合は、そのオブジェクトのパラメーターのリストを含む文字列を値として指定します。または、キーワードallを指定してすべてのパラメーターのリストを出力することもできます。paramsを使用しない場合、使用可能なすべてのパラメーターのうち、デフォルトのサブセットが出力されます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-data-source-list

vm-data-source-list [vm-selector=vm selector value...]

仮想マシンで、記録可能なデータソースのリストを出力します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

データソースには、パラメーターとしてstandardおよびenabledがあり、このコマンドの出力で確認できます。データソースのenabledパラメーターがtrueの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースに記録中であることを示します。standardパラメーターがtrueのデータソースでは、デフォルトでメトリクス情報がパフォーマンスデータベースに記録されます(enabledパラメーターにtrueが設定されます)。データソースのstandardパラメーターがfalseの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースにデフォルトで記録されないことを示します(enabledパラメーターにfalseが設定されます)。

データソースメトリクスのパフォーマンスデータベースへの記録を開始するには、vm-data-source-recordコマンドを実行します。このコマンドは、enabledtrueに設定します。停止するには、vm-data-source-forgetを実行します。このコマンドは、enabledfalseに設定します。

vm-data-source-record

vm-data-source-record data-source=name_description_of_data-source [vm-selector=vm selector value...]

仮想マシンで、指定したデータソースを記録します。

これにより、仮想マシンの永続的なパフォーマンスメトリクスデータベースにデータソースからの情報が書き込まれます。このデータベースは、パフォーマンス上の理由から、通常のエージェントデータベースとは区別されます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-data-source-forget

vm-data-source-forget data-source=name_description_of_data-source [vm-selector=vm selector value...]

仮想マシンのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-data-source-query

vm-data-source-query data-source=name_description_of_data-source [vm-selector=vm_selector_value...]

仮想マシンで、指定したデータソースを表示します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-destroy

vm-destroy uuid=uuid_of_vm

指定した仮想マシンを破棄します。その仮想マシンに関連付けられたストレージはそのまま残ります。ストレージも削除するには、xe vm-uninstallを使用します。

vm-disk-add

vm-disk-add disk-size=size_of_disk_to_add device=uuid_of_device [vm-selector=vm_selector_value...]

指定した仮想マシンにディスクを追加します。deviceパラメーターは、仮想マシンのallowed-VBD-devicesパラメーターの値から選択します。

disk-sizeパラメーターは、バイト単位またはIEC標準のKiB、MiB、GiB、およびTiBを使用して指定できます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-disk-list

vm-disk-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]

指定した仮想マシンに接続されているディスクのリストを出力します。vbd-paramsおよびvdi-paramsパラメーターは、それぞれのオブジェクトのフィールドを制御して出力します。この2つのパラメーターをコンマ区切りリストとして指定するか、完全なリストの場合は特殊キーallを指定します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-disk-remove

vm-disk-remove device=integer_label_of_disk [vm-selector=vm_selector_value...]

指定した仮想マシンからディスクを削除して、そのディスクを破棄します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-export

vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]

指定した仮想マシンをローカルコンピュータ上のファイルに(ディスクイメージを含めて)エクスポートします。仮想マシンのエクスポート先のファイル名を、filenameパラメーターで指定します。ファイル名の拡張子として、.xvaを指定する必要があります。

metadataパラメーターがtrueの場合、ディスクはエクスポートされません。仮想マシンメタデータのみが出力ファイルに書き込まれます。このパラメーターを使用することで、仮想マシンのストレージをほかの方法で移動して、仮想マシン情報を再作成できるようになります。詳しくは、「vm-import」を参照してください。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-import

vm-import filename=export_filename [metadata=true|false] [preserve=true|false][sr-uuid=destination_sr_uuid]

以前にエクスポートしたファイルから仮想マシンをインポートします。preservetrueに設定すると、元の仮想マシンのMACアドレスが保持されます。sr-uuidによって、仮想マシンのインポート先のストレージリポジトリを決定します。このパラメーターを指定しない場合、 デフォルトのストレージリポジトリが使用されます。

filenameパラメーターは、 3.2からの従来のエクスポート形式であるXVA形式の仮想マシンを提示することもできます。この形式は、サードパーティのベンダーが仮想アプライアンスを提供するために使用します。XVA形式では仮想マシンデータの格納にディレクトリが使用されるため、filenameにファイル自体ではなく、XVAエクスポートのルートディレクトリを設定します。インポートしたレガシーゲストを後でエクスポートするときは、自動的に新しいファイル名ベースの形式にアップグレードされます。新しいエクスポート形式では、より多くの仮想マシン設定データが格納されます。

注:

古いディレクトリベースのXVA形式では、仮想マシンのすべての属性が完全にエクスポートされるわけではありません。特に、インポートされた仮想マシンにはデフォルトで仮想ネットワークインターフェイスが接続されていません。ネットワークが必要な場合は、vif-createvif-plugを使用して作成します。

metadatatrueに設定すると、エクスポート済みのメタデータを、それに関連付けられているディスクブロックを除外してインポートできます。このメタデータのみのインポートは、VDIが見つからない場合(ストレージリポジトリとVDI.locationにより指定)に失敗します。この場合、--forceオプションを指定して強制的にインポートできます。ディスクのミラーまたは移動が可能な場合、メタデータのインポート/エクスポートは、異なるリソースプール間で仮想マシンをすばやく移動するための手段になります(障害復旧時など)。

注:

複数の仮想マシンをインポートする場合は、同時に実行するよりも順番に実行した方が早く完了します。

vm-install

vm-install new-name-label=name [template-uuid=uuid_of_desired_template] [template=template_uuid_or_name] [sr-uuid=sr_uuid | sr-name-label=name_of_sr][copy-bios-strings-from=host_uuid]

指定したテンプレートから仮想マシンをインストールまたは複製します。template-uuid引数またはtemplate引数のいずれかを使用して、テンプレート名を指定します。sr-uuid引数またはsr-name-label引数のいずれかを使用して、ストレージリポジトリを指定 します。BIOSで特定ホスト用にロックされたメディアからインストールする場合は、copy-bios-strings-from引数を指定します。

注:

既存のディスクを持つテンプレートからインストールする場合は、デフォルトでそのディスクと同じストレージリポジトリ上に新しいディスクが作成されます。ストレージリポジトリがサポートする場合は、これらのディスクの高速複製が実行されます。ほかのストレージリポジトリをコマンドで指定した場合は、新しいディスクがそのストレージリポジトリ上に作成されます。この場合、高速複製は不可能であり、完全コピーが実行されます。

既存のディスクを持たないテンプレートからのインストールでは、指定したストレージリポジトリ、またはプールのデフォルトストレージリポジトリ(ストレージリポジトリを指定しない場合)上に新しいディスクが作成されます。

vm-is-bios-customized

vm-is-bios-customized

仮想マシンのBIOS文字列がカスタマイズされているかどうかを示します。

vm-memory-balloon

vm-memory-balloon target=target

実行中の仮想マシンのメモリターゲットを設定します。指定された値は、仮想マシンのmemory_dynamic_minの値およびmemory_dynamic_maxの値で定義された範囲内でなければなりません。

vm-memory-dynamic-range-set

vm-memory-dynamic-range-set min=min max=max

仮想マシンのダイナミックメモリ範囲を設定します。ダイナミックメモリ範囲は、仮想マシンのメモリのソフト下限と上限を定義します。仮想マシンが実行中または停止中にこれらのフィールドを変更することは可能です。ダイナミックレンジは静的範囲内に収まる必要があります。

vm-memory-limits-set

vm-memory-limits-set static-min=static_min static-max=static_max dynamic-min=dynamic_min dynamic-max=dynamic_max

仮想マシンのメモリ制限を構成します。

vm-memory-set

vm-memory-set memory=memory

仮想マシンのメモリ割り当てを設定します。

vm-memory-shadow-multiplier-set

vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]

指定した仮想マシンのシャドウメモリ乗数を設定します。

これは、ハードウェア支援型仮想マシンに割り当てられるシャドウメモリの量を変更するための高度なオプションです。

このメモリは、オーバーヘッドとして考えることができます。シャドウメモリは、仮想マシン用の通常のメモリとは別に計算されます。このコマンドを実行すると、その乗数に応じてホスト上の空きメモリ量が減り、HVM_shadow_multiplierフィールドが仮想マシンに割り当てられた値でアップデートされます。ホストの空きメモリ量が足りない場合は、エラーが返されます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。

vm-memory-static-range-set

vm-memory-static-range-set min=min max=max

仮想マシンの静的メモリ範囲を設定します。静的メモリ範囲は、仮想マシンのメモリのハード下限と上限を定義します。仮想マシンの停止中にのみ、これらのフィールドを変更できます。ダイナミックレンジは静的範囲内に収まる必要があります。

vm-memory-target-set

vm-memory-target-set target=target

停止中または実行中の仮想マシンのメモリターゲットを設定します。指定された値は、仮想マシンのmemory_static_minの値およびmemory_static_maxの値で定義された範囲内でなければなりません。

vm-memory-target-wait

vm-memory-target-wait

実行中の仮想マシンが現在のメモリターゲットに達するまで待機します。

vm-migrate

vm-migrate [copy=true|false] [host-uuid=destination_host_uuid] [host=name_or_ uuid_of_destination_host] [force=true|false] [live=true|false] [vm-selector=vm_selector_value...] [remote-master=destination_pool_master_uuid] [remote-username=destination_pool_username] [remote-password=destination_pool_password] [remote-network=destination_pool_network_uuid ][vif:=vif_uuid] [vdi=vdi_uuid]

このコマンドにより、指定した仮想マシンが物理ホスト間で移行されます。hostパラメーターには、ホストの名前かUUIDを指定できます。たとえば、2つのホストが共有しているストレージに仮想マシンのディスクがあるプール内でその別のホストに仮想マシンを移行するには、次のコマンドを実行します:

xe vm-migrate uuid=vm_uuid host-uuid=host_uuid

ストレージを共有していない(ストレージ)、同一プール内のホスト間で仮想マシンを移動するには、次のコマンドを実行します:

xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78 \
remote-username=username remote-password=password \
host-uuid=desination_host_uuid vdi=vdi_uuid

各VDIが格納されているストレージリポジトリは、次のようにして選択できます。

xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \
vdi1:vdi_1_uuid=destination_sr_uuid \
vdi2:vdi_2_uuid=destination_sr2_uuid \
vdi3:vdi_3_uuid=destination_sr3_uuid

また、移行後に仮想マシンに接続するネットワークは、次のようにして選択できます。

xe vm-migrate uuid=vm_uuid \
vdi1:vdi_1_uuid=destination_sr_uuid \
vdi2:vdi_2_uuid=destination_sr2_uuid \
vdi3:vdi_3_uuid=destination_sr3_uuid \
vif:vif_uuid=network_uuid

プール間の移行の場合は、次のコマンドを実行します。

xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78
remote-username=username remote-password=password \
host-uuid=desination_host_uuid vdi=vdi_uuid

Storage 、、およびLive VDIの移行について詳しくは、「およびStorageを含む仮想マシンの移行」を参照してください。

デフォルトでは、仮想マシンが一時停止し、移行後に別のホスト上で再開します。liveパラメーターはを選択します。は仮想マシンを実行したまま移行でき、このときの仮想マシンのダウンタイムは1秒未満です。仮想マシンでメモリ負荷の高い処理を実行中など、状況によっては機能が無効になります。この場合、仮想マシンを一時停止してからメモリ転送が行われます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-pause

vm-pause

実行中のVMを一時停止します。この操作では、関連するメモリは解放されません(vm-suspendを参照)。

vm-query-services

vm-query-services

特定のVMによって提供されるシステムサービスを照会します。

vm-reboot

vm-reboot [vm-selector=vm_selector_value...] [force=true]

指定した仮想マシンを再起動します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

強制的な再起動を引き起こすには、force引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。

vm-recover

vm-recover vm-uuid [database] [vdi-uuid] [force]

指定したVDIのデータベースから仮想マシンを回復します。

vm-reset-powerstate

vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

これは、プール内のメンバホストがダウンしたときのみに使用する、高度なコマンドです。このコマンドを使用して、プールマスターに強制的にVMの電源の状態をhaltedにリセットさせることができます。基本的に、このコマンドにより仮想マシンとそのディスクが強制的にロックされるため、その仮想マシンをプール内の別のホスト上で起動できます。このコマンドではforce引数の指定が必須で、これを指定しないと失敗します。

vm-resume

vm-resume [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid]

指定した仮想マシンを再開します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、起動するプールメンバーをon引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。

vm-retrieve-wlb-recommendations

vm-retrieve-wlb-recommendations

選択された仮想マシンのワークロードバランス推奨事項を取得します。

vm-shutdown

vm-shutdown [vm-selector=vm_selector_value...] [force=true|false]

指定した仮想マシンをシャットダウンします。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

仮想マシンを強制的にシャットダウンするには、force引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。

vm-snapshot

vm-snapshot new-name-label=name_label [new-name-description+name_description]

ストレージレベルの高速ディスクスナップショット処理により、既存の仮想マシンをスナップショットします(サポートされる場合)。

vm-snapshot-with-quiesce

vm-snapshot-with-quiesce new-name-label=name_label [new-name-description+name_description]

ストレージレベルの高速ディスクスナップショット処理により、既存の休止している仮想マシンをスナップショットします(サポートされる場合)。

vm-start

vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]

指定した仮想マシンを起動します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、その仮想マシンを起動するプールメンバーをon引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。

vm-suspend

vm-suspend [vm-selector=vm_selector_value...]

指定した仮想マシンをサスペンドします。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-uninstall

vm-uninstall [vm-selector=vm_selector_value...] [force=true|false]

仮想マシンをアンインストールし、そのディスク(RWのマークが付けられ、この仮想マシンのみに接続されているVDI)とメタデータレコードを破棄します。仮想マシンのメタデータだけを破棄するには、xe vm-destroyを使用します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

vm-unpause

vm-unpause

一時停止した仮想マシンの一時停止を解除します。

vm-vcpu-hotplug

vm-vcpu-hotplug new-vcpus=new_vcpu_count [vm-selector=vm_selector_value...]

実行中のPVまたはHVM Linux仮想マシンで使用可能なvCPUの数を動的に変更します。vCPUの数は、パラメーターVCPUs-maxによって制限されます。Windows仮想マシンの場合、常にVCPUs-maxに設定された数のVCPUが使用されます。この値を変更した場合、仮想マシンの再起動が必要になります。

このコマンドの対象PVまたはHVM Linux仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

注:

をインストールせずにLinux仮想マシンを実行する場合、仮想マシンで以下のコマンドをrootとして実行し、新しくホットプラグされたvCPUが確実に使用されるようにする必要があります:# for i in /sys/devices/system/cpu/cpu[1-9]*/online; do if [ "$(cat $i)" = 0 ]; then echo 1 > $i; fi; done

vm-vif-list

vm-vif-list [vm-selector=vm_selector_value...]

指定した仮想マシンのVIFのリストを出力します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。VIFではなく仮想マシンがフィルターの対象になることに注意してください。オプションの引数には、「vmオブジェクトのパラメーター」から任意の数を指定できます。

スケジュールされたスナップショット

仮想マシンのスケジュールされたスナップショットとその属性を操作します。

vmssオブジェクトのリストは、標準オブジェクトリストコマンド(xe vmss-list)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド」を参照してください。

vmss-create

vmss-create enabled=True/False name-label=name type=type frequency=frequency retained-snapshots=value name-description=description schedule:schedule

プールのスナップショットスケジュールを作成。

例:

xe vmss-create retained-snapshots=9 enabled=true frequency=daily \
name-description=sample name-label=samplepolicy type=snapshot \
schedule:hour=10 schedule:min=30

スナップショットスケジュールには次のパラメータがあります。

パラメーター名 説明 種類
name-label スナップショットスケジュールの名前。 読み取り/書き込み
name-description スナップショットスケジュールの説明。 読み取り/書き込み
type ディスクスナップショット、メモリスナップショット、休止スナップショット 読み取り/書き込み
frequency 毎時、毎日、毎週 読み取り/書き込み
retained-snapshots 保持するスナップショット範囲:1~10。 読み取り/書き込み
schedule schedule:days(月曜日〜日曜日)、schedule:hours(0〜23)、schedule:minutes(0、15、30、45) 読み取り/書き込み

vmss-destroy

vmss-destroy uuid=uuid

プールのスナップショットスケジュールを破棄。

USBパススルー

USBパススルーの有効化/無効化

pusb-param-set uuid=pusb_uuid passthrough-enabled=true/false

USBパススルーを有効/無効にします。

pusb-scan

pusb-scan host-uuid=host_uuid

PUSBをスキャンして更新します。

vusb-create

vusb-create usb-group-uuid=usb_group_uuid vm-uuid=vm_uuid

プールに仮想USBを作成します。仮想マシンを起動して、USBを仮想マシンにパススルーします。

vusb-unplug

vusb-unplug uuid=vusb_uuid

仮想マシンからUSBを接続解除します。

vusb-destroy

vusb-destroy uuid=vusb_uuid

仮想マシンから仮想USB一覧を削除します。