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

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

xe CLIの使用を開始する

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

Citrix Hypervisorサーバー上

xeコマンドラインインターフェイスは、デフォルトでサーバーにインストールされます。dom0コンソールでxe CLIコマンドを実行できます。次のいずれかの方法でdom0コンソールにアクセスします：

• XenCenterで、コマンドを実行するサーバーの［コンソール］タブに移動します。
• コマンドを実行するサーバーにSSHで接続します。

Windowsの場合

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

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

Linuxの場合

RPMベースのディストリビューション（Red Hatなど）では、メインのCitrix HypervisorインストールISOイメージの「client_install/xapi-xe-BUILD.x86_64.rpm」という名前のRPMからスタンドアロンxeコマンドをインストールできます。

RPMからインストールするには、次のコマンドを使用します：

rpm -ivh xapi-xe-BUILD.x86_64.rpm
<!--NeedCopy-->

コマンドラインでパラメーターを使用すると、xeコマンドの実行時に使用するCitrix Hypervisorサーバー、ユーザー名、およびパスワードを定義できます。または、パラメーターではなく環境変数として設定することもできます。例：

export XE_EXTRA_ARGS="server=<host name>,username=<user name>,password=<password>"
<!--NeedCopy-->

注：

セキュリティで保護された接続を介してファイル転送を行うコマンドを実行しようとすると、Linux上のリモートxe CLIが動作を停止することがあります。この場合は、--no-sslパラメーターを使用することで、セキュリティで保護されない接続を介してCitrix Hypervisorサーバーにコマンドを実行できます。

xeコマンドのヘルプの表示

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

xe help command
<!--NeedCopy-->

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

xe help
<!--NeedCopy-->

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

xe help --all
<!--NeedCopy-->

基本構文

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

xe command-name argument=value argument=value
<!--NeedCopy-->

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

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

server引数では、コマンドの実行先のホスト名またはIPアドレスを指定します。username引数とpassword引数では、認証情報（ユーザー名とパスワード）を指定します。

password-file引数は、パスワードを直接入力する代わりに指定できます。この場合、xeコマンドは指定されたファイルからパスワードの読み取りを試み、そのパスワードを使用して接続します（ファイルの最後にある行末のCRおよびLFはすべて削除されます）。この方法は、コマンドラインでパスワードを直接指定するよりも安全です。

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

例： ローカルのCitrix Hypervisorサーバーの場合：

xe vm-list
<!--NeedCopy-->

例： リモートのCitrix Hypervisorサーバーの場合：

xe vm-list username=username password=password server=hostname
<!--NeedCopy-->

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

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

例： リモートのCitrix Hypervisorサーバーの場合：

xe vm-list -u myuser -pw mypassword -s hostname
<!--NeedCopy-->

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

export XE_EXTRA_ARGS="server=jeffbeck,port=443,username=root,password=pass"
<!--NeedCopy-->

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

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

特殊文字と構文

xeコマンドで引数/値ペアを指定するには、次の形式を使用します：argument=value

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

スペースを含む値の場合、次のように記述します：argument="value with spaces"

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

注：

リモートのCitrix Hypervisorサーバーに対してコマンドを実行する場合、通常この自動補完機能は無効です。ただし、コマンドを入力するマシンで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
<!--NeedCopy-->

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

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

• xe class-param-list uuid=uuid

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

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

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

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

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

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

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

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

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

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

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

低レベルリストコマンド

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

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

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

xe vm-list params=name-label,other-config
<!--NeedCopy-->

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

xe vm-list params=all
<!--NeedCopy-->

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

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

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

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

xe vm-list HVM-boot-policy="BIOS order" power-state=halted
<!--NeedCopy-->

この例では、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
<!--NeedCopy-->

シークレット

Citrix Hypervisorでは、シークレット機能によって、パスワードがコマンドライン履歴またはAPIオブジェクトにプレーンテキストで保存されないようにします。XenCenterでは、この機能が自動的に使用されます。また、パスワードが必要なコマンドのxe CLIでも、この機能を使用できます。

注：

パスワードのシークレットを使って、xe CLIのリモートインスタンスからCitrix Hypervisorホストで認証することはできません。

シークレットオブジェクトを作成するには、Citrix Hypervisorホストで以下のコマンドを実行します。

xe secret-create value=my-password
<!--NeedCopy-->

シークレットが作成され、Citrix Hypervisorホストに格納されます。このコマンドを使用すると、シークレットオブジェクトのUUIDが出力されます。例：99945d96-5890-de2a-3899-8c04ef2521db。_secretをpassword引数の名前に追加し、このUUIDがパスワードが必要なコマンドに渡されるようにします。

例： シークレットを作成したCitrix Hypervisorホストで、以下のコマンドを実行できます：

    xe sr-create device-config:location=sr_address device-config:type=cifs device-config:username=cifs_username  \
    device-config:cifspassword_secret=secret_uuid name-label="CIFS ISO SR" type="iso" content-type="iso" shared="true"
<!--NeedCopy-->

コマンド履歴

xe vm-migrateやxe pool-enable-external-authといった一部のxeコマンドは、パスワードなどのシークレットをパラメーターとして受け取ります。これらはシェル履歴に保存されて、コマンドの実行中にプロセステーブルに表示されます。そのため、これらのコマンドは信頼できる環境でのみ実行することが重要です。

bashシェルの場合は、HISTCONTROL変数を使用して、どのコマンドがシェル履歴に保存されるかを制御できます。

xeコマンドリファレンス

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

アプライアンスコマンド

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

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

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

appliance-assert-can-be-recovered

xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

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

appliance-create

xe appliance-create name-label=name-label [name-description=name-description]
<!--NeedCopy-->

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

xe appliance-create name-label=my_appliance
<!--NeedCopy-->

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

xe vm-param-set uuid=VM-UUID appliance=appliance-uuid
<!--NeedCopy-->

appliance-destroy

xe appliance-destroy uuid=appliance-uuid
<!--NeedCopy-->

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

xe appliance-destroy uuid=appliance-uuid
<!--NeedCopy-->

appliance-recover

xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [paused=true|false]
<!--NeedCopy-->

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

appliance-shutdown

xe appliance-shutdown uuid=appliance-uuid [force=true|false]
<!--NeedCopy-->

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

xe appliance-shutdown uuid=appliance-uuid
<!--NeedCopy-->

appliance-start

xe appliance-start uuid=appliance-uuid [paused=true|false]
<!--NeedCopy-->

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

xe appliance-start uuid=appliance-uuid
<!--NeedCopy-->

監査コマンド

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

audit-log-getパラメーター

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

audit-log-get

xe audit-log-get [since=timestamp] filename=filename
<!--NeedCopy-->

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

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

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

ボンディングコマンド

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

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

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

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

bond-create

xe bond-create network-uuid=network_uuid pif-uuids=pif_uuid_1,pif_uuid_2,...
<!--NeedCopy-->

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

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

bond-destroy

xe bond-destroy uuid=bond_uuid
<!--NeedCopy-->

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

bond-set-mode

xe bond-set-mode uuid=bond_uuid mode=bond_mode
<!--NeedCopy-->

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

CD（仮想ネットワーク）コマンド

Citrix Hypervisorサーバー上の物理CD/DVDドライブ（cdオブジェクト）を操作します。

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

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

cd-list

xe cd-list [params=param1,param2,...] [parameter=parameter_value]
<!--NeedCopy-->

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

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

オプションの引数には、このセクションの冒頭に挙げられている、cdオブジェクトのパラメーターをいくつでも指定できます。

クラスターコマンド

クラスター化されたプールを操作するためのコマンドです。

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

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

クラスターパラメーター

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

cluster-host-destroy

xe cluster-host-destroy uuid=host_uuid
<!--NeedCopy-->

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

cluster-host-disable

xe cluster-host-disable uuid=cluster_uuid
<!--NeedCopy-->

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

cluster-host-enable

xe cluster-host-enable uuid=cluster_uuid
<!--NeedCopy-->

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

cluster-host-force-destroy

xe cluster-host-force-destroy uuid=cluster_host
<!--NeedCopy-->

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

cluster-pool-create

xe cluster-pool-create network-uuid=network_uuid [cluster-stack=cluster_stack] [token-timeout=token_timeout] [token-timeout-coefficient=token_timeout_coefficient]
<!--NeedCopy-->

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

cluster-pool-destroy

xe cluster-pool-destroy cluster-uuid=cluster_uuid
<!--NeedCopy-->

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

cluster-pool-force-destroy

xe cluster-pool-force-destroy cluster-uuid=cluster_uuid
<!--NeedCopy-->

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

cluster-pool-resync

xe cluster-pool-resync cluster-uuid=cluster_uuid
<!--NeedCopy-->

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

コンソールコマンド

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

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

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

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

console

xe console
<!--NeedCopy-->

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

診断コマンド

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

diagnostic-compact

xe diagnostic-compact
<!--NeedCopy-->

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

廃止済み：diagnostic-db-log

xe diagnostic-db-log
<!--NeedCopy-->

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

diagnostic-db-stats

xe diagnostic-db-stats
<!--NeedCopy-->

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

diagnostic-gc-stats

xe diagnostic-gc-stats
<!--NeedCopy-->

GC統計を出力します。

diagnostic-license-status

xe diagnostic-license-status
<!--NeedCopy-->

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

diagnostic-net-stats

xe diagnostic-net-stats [uri=uri] [method=method] [params=param1,param2...]
<!--NeedCopy-->

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

diagnostic-timing-stats

xe diagnostic-timing-stats
<!--NeedCopy-->

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

diagnostic-vdi-status

xe diagnostic-vdi-status uuid=vdi_uuid
<!--NeedCopy-->

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

diagnostic-vm-status

xe diagnostic-vm-status uuid=vm_uuid
<!--NeedCopy-->

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

障害回復コマンド

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

drtask-create

xe drtask-create type=type sr-whitelist=sr-white-list device-config=device-config
<!--NeedCopy-->

障害回復タスクを作成します。たとえば、障害回復の準備タスクとして特定の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
<!--NeedCopy-->

注：

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

drtask-destroy

xe drtask-destroy uuid=dr-task-uuid
<!--NeedCopy-->

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

vm-assert-can-be-recovered

xe vm-assert-can-be-recovered uuid=vm-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

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

appliance-assert-can-be-recovered

xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

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

appliance-recover

xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [force=true|false]
<!--NeedCopy-->

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

vm-recover

xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid [force=true|false]
<!--NeedCopy-->

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

sr-enable-database-replication

xe sr-enable-database-replication uuid=sr_uuid
<!--NeedCopy-->

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

sr-disable-database-replication

xe sr-disable-database-replication uuid=sr_uuid
<!--NeedCopy-->

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

使用例

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

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

xe sr-database-replication uuid=sr=uuid
<!--NeedCopy-->

障害発生後、セカンダリサイトでストレージリポジトリに接続します。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
<!--NeedCopy-->

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

xe vdi-list sr-uuid=sr-uuid type=Metadata
<!--NeedCopy-->

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

xe vm-list database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

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

xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid
<!--NeedCopy-->

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

xe drtask-destroy uuid=drtask-uuid
<!--NeedCopy-->

イベントコマンド

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

eventオブジェクトのクラス

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

event-wait

xe event-wait class=class_name [param-name=param_value] [param-name=/=param_value]
<!--NeedCopy-->

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

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

xe event-wait class=vm name-label=myvm power-state=running
<!--NeedCopy-->

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

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

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

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

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

GPUコマンド

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

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

物理GPUのパラメーター

物理GPU（pGPU）には、以下のパラメーターがあります：

pgpu-disable-dom0-access

xe pgpu-disable-dom0-access uuid=uuid
<!--NeedCopy-->

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

pgpu-enable-dom0-access

xe pgpu-enable-dom0-access uuid=uuid
<!--NeedCopy-->

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

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

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

GPUグループの操作

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

gpu-group-create

xe gpu-group-create name-label=name_for_group [name-description=description]
<!--NeedCopy-->

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

gpu-group-destroy

xe gpu-group-destroy uuid=uuid_of_group
<!--NeedCopy-->

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

gpu-group-get-remaining-capacity

xe gpu-group-get-remaining-capacity uuid=uuid_of_group vgpu-type-uuid=uuid_of_vgpu_type
<!--NeedCopy-->

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

gpu-group-param-set

xe gpu-group-param-set uuid=uuid_of_group allocation-algorithm=breadth-first|depth-first
<!--NeedCopy-->

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

gpu-group-param-get-uuid

xe gpu-group-param-get-uuid uuid=uuid_of_group param-name=supported-vGPU-types|enabled-vGPU-types
<!--NeedCopy-->

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

仮想GPUのパラメーター

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

仮想GPUのパラメーター

注：

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

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

仮想GPUの操作

vgpu-create

xe vgpu-create vm-uuid=uuid_of_vm gpu_group_uuid=uuid_of_gpu_group [vgpu-type-uuid=uuid_of_vgpu-type]
<!--NeedCopy-->

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

vgpu-destroy

xe vgpu-destroy uuid=uuid_of_vgpu
<!--NeedCopy-->

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

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

xe vm-param-add uuid=uuid_of_vmparam-name=platform vgpu_vnc_enabled=true|false
<!--NeedCopy-->

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

ホストコマンド

Citrix Hypervisorサーバー（hostオブジェクト）を操作します。

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

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

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

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

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

Citrix Hypervisorサーバーには次のパラメーターがあります：

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

Citrix HypervisorサーバーのCPU（中央処理装置）には、次のパラメーターがあります：

Citrix Hypervisorサーバーのクラッシュダンプ（crashdumpオブジェクト）には、以下のパラメーターがあります：

host-all-editions

xe host-all-editions
<!--NeedCopy-->

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

host-apply-edition

xe host-apply-edition [host-uuid=host_uuid] [edition=xenserver_edition="free" "per-socket" "xendesktop"]
<!--NeedCopy-->

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

Citrix Virtual DesktopsおよびCitrix DaaS用のCitrix Hypervisorの場合、"xendesktop"を使用します。

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

host-backup

xe host-backup file-name=backup_filename host=host_name
<!--NeedCopy-->

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

重要：

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

host-bugreport-upload

xe host-bugreport-upload [host-selector=host_selector_value...] [url=destination_url http-proxy=http_proxy_name]
<!--NeedCopy-->

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

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

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

host-call-plugin

xe host-call-plugin host-uuid=host_uuid plugin=plugin fn=function [args=args]
<!--NeedCopy-->

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

host-compute-free-memory

xe host-compute-free-memory
<!--NeedCopy-->

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

host-compute-memory-overhead

xe host-compute-memory-overhead
<!--NeedCopy-->

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

host-cpu-info

xe host-cpu-info [uuid=uuid]
<!--NeedCopy-->

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

host-crashdump-destroy

xe host-crashdump-destroy uuid=crashdump_uuid
<!--NeedCopy-->

このコマンドでは、UUIDで指定したクラッシュダンプをCitrix Hypervisorサーバーから削除します。

host-crashdump-upload

xe host-crashdump-upload uuid=crashdump_uuid [url=destination_url] [http-proxy=http_proxy_name]
<!--NeedCopy-->

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

host-declare-dead

xe host-declare-dead uuid=host_uuid
<!--NeedCopy-->

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

警告：

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

host-disable

xe host-disable [host-selector=host_selector_value...]
<!--NeedCopy-->

このコマンドでは、指定したCitrix Hypervisorサーバーが無効になり、新しい仮想マシンがそのサーバー上で起動しなくなります。これにより、そのCitrix Hypervisorサーバーがシャットダウンまたは再起動できる状態になります。ホストが再起動した後、有効にするためのすべての条件が満たされると（たとえば、ストレージが使用可能であるなど）、ホストは自動的に再び有効になります。

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

host-disable-display

xe host-disable-display uuid=host_uuid
<!--NeedCopy-->

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

host-disable-local-storage-caching

xe host-disable-local-storage-caching
<!--NeedCopy-->

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

host-dmesg

xe host-dmesg [host-selector=host_selector_value...]
<!--NeedCopy-->

このコマンドでは、指定したCitrix HypervisorサーバーからXen dmesg（カーネルリングバッファーの出力）を取得します。

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

host-emergency-ha-disable

xe host-emergency-ha-disable  [--force]
<!--NeedCopy-->

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

host-emergency-management-reconfigure

xe host-emergency-management-reconfigure interface=uuid_of_management_interface_pif
<!--NeedCopy-->

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

host-emergency-reset-server-certificate

xe host-emergency-reset-server-certificate
<!--NeedCopy-->

コマンドを実行するCitrix Hypervisorサーバーに、自己署名証明書をインストールします。

host-enable

xe host-enable [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

host-enable-display

xe host-enable-display uuid=host_uuid
<!--NeedCopy-->

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

host-enable-local-storage-caching

xe host-enable-local-storage-caching  sr-uuid=sr_uuid
<!--NeedCopy-->

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

host-evacuate

xe host-evacuate [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

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

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

host-forget

xe host-forget uuid=host_uuid
<!--NeedCopy-->

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

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

警告：

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

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

host-get-server-certificate

xe host-get-server-certificate
<!--NeedCopy-->

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

host-get-sm-diagnostics

xe host-get-sm-diagnostics uuid=uuid
<!--NeedCopy-->

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

host-get-system-status

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

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

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

host-get-system-status-capabilities

xe host-get-system-status-capabilities [host-selector=host_selector_value...]
<!--NeedCopy-->

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

<?xml version="1.0" ?>
<system-status-capabilities>
    <capability content-type="text/plain" default-checked="yes" key="xenserver-logs"  \
        max-size="150425200" max-time="-1" min-size="150425200" min-time="-1" \
        pii="maybe"/>
    <capability content-type="text/plain" default-checked="yes" \
        key="xenserver-install" max-size="51200" max-time="-1" min-size="10240" \
        min-time="-1" pii="maybe"/>
    ...
</system-status-capabilities>
<!--NeedCopy-->

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

• key：機能の一意の識別子。
• content-type：text/plainまたはapplication/data。人間が消費するエントリをUIがレンダリングできるかどうかを示します。
• default-checked：yesまたはno。ユーザーインターフェイスでこのエントリをデフォルトで選択するかどうかを示します。
• min-size、max-size：このエントリのサイズのおおよその範囲をバイト数で示します。-1はサイズが重要でないことを示します。
• min-time、max-time：このエントリの収集時間のおおよその範囲を秒数で示します。-1は時間が重要でないことを示します。

• pii：個人を特定できる情報（PII）。このエントリに、システムの所有者やネットワークトポロジの詳細を特定できる情報があるかどうかを示します。この属性には、次の値のいずれかを指定できます：

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

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

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

host-get-thread-diagnostics

xe host-get-thread-diagnostics uuid=uuid
<!--NeedCopy-->

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

host-get-vms-which-prevent-evacuation

xe host-get-vms-which-prevent-evacuation uuid=uuid
<!--NeedCopy-->

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

host-is-in-emergency-mode

xe host-is-in-emergency-mode
<!--NeedCopy-->

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

host-license-add

xe host-license-add [license-file=path/license_filename] [host-uuid=host_uuid]
<!--NeedCopy-->

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

host-license-remove

xe host-license-remove [host-uuid=host_uuid]
<!--NeedCopy-->

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

host-license-view

xe host-license-view [host-uuid=host_uuid]
<!--NeedCopy-->

Citrix Hypervisorサーバーのライセンスの内容を表示します。

host-logs-download

xe host-logs-download [file-name=logfile_name] [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

重要：

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

host-management-disable

xe host-management-disable
<!--NeedCopy-->

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

警告：

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

host-management-reconfigure

xe host-management-reconfigure [interface=device] [pif-uuid=uuid]
<!--NeedCopy-->

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

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

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

警告：

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

host-power-on

xe host-power-on [host=host_uuid]
<!--NeedCopy-->

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

host-reboot

xe host-reboot [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

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

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

• メンバーの1人をマスターにする

• 元のマスターが再起動され、オンラインに戻る

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

host-restore

xe host-restore [file-name=backup_filename] [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

host-send-debug-keys

xe host-send-debug-keys  host-uuid=host_uuid keys=keys
<!--NeedCopy-->

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

host-server-certificate-install

xe host-server-certificate-install certificate=path_to_certificate_file private-key=path_to_private_key [certificate-chain=path_to_chain_file] [host=host_name | uuid=host_uuid]
<!--NeedCopy-->

Citrix HypervisorサーバーにTLS証明書をインストールします。

host-set-hostname-live

xe host-set-hostname-live host-uuid=uuid_of_host host-name=new_hostname
<!--NeedCopy-->

host-uuidによって指定されたCitrix Hypervisorサーバーのホスト名を変更します。これにより、コントロールドメインのデータべース内のホスト名レコードおよびCitrix Hypervisorサーバーの実際のLinuxホスト名が永続的に設定されます。host-nameの値はname_labelフィールドの値と同じではありません。

host-set-power-on-mode

xe host-set-power-on-mode host=host_uuid power-on-mode={"" | "wake-on-lan" | "DRAC" | "custom"} \
    [ power-on-config:power_on_ip=ip-address power-on-config:power_on_user=user power-on-config:power_on_password_secret=secret-uuid ]
<!--NeedCopy-->

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

"power_on_password_secret"でキーを指定するには、事前にパスワードシークレットを作成しておく必要があります。詳しくは、「シークレット」を参照してください。

host-shutdown

xe host-shutdown [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

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

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

• メンバーの1人をマスターにする

• 元のマスターが再起動され、オンラインに戻る

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

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

host-sm-dp-destroy

xe host-sm-dp-destroy uuid=uuid dp=dp [allow-leak=true|false]
<!--NeedCopy-->

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

host-sync-data

xe host-sync-data
<!--NeedCopy-->

プールマスターに格納されているデータを、指定されたホストと同期させます（これには、データベースデータは含まれません）。

host-syslog-reconfigure

xe host-syslog-reconfigure [host-selector=host_selector_value...]
<!--NeedCopy-->

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

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

host-data-source-list

xe host-data-source-list [host-selectors=host selector value...]
<!--NeedCopy-->

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

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

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

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

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

host-data-source-record

xe host-data-source-record data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

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

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

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

host-data-source-forget

xe host-data-source-forget data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

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

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

host-data-source-query

xe host-data-source-query data-source=name_description_of_data_source [host-selectors=host_selector_value...]
<!--NeedCopy-->

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

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

廃止済み：ログコマンド

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

廃止済み：log-get

xe log-get
<!--NeedCopy-->

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

廃止済み：log-get-keys

xe log-get-keys
<!--NeedCopy-->

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

廃止済み：log-reopen

xe log-reopen
<!--NeedCopy-->

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

廃止済み：log-set-output

xe log-set-output output=output [key=key] [level=level]
<!--NeedCopy-->

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

メッセージコマンド

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

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

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

message-create

xe 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]]
<!--NeedCopy-->

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

message-destroy

xe message-destroy [uuid=message_uuid]
<!--NeedCopy-->

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

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

ネットワークコマンド

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

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

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

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

network-create

xe network-create name-label=name_for_network [name-description=descriptive_text]
<!--NeedCopy-->

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

network-destroy

xe network-destroy uuid=network_uuid
<!--NeedCopy-->

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

SR-IOVコマンド

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

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

SR-IOVパラメーター

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

network-sriov-create

xe network-sriov-create network-uuid=network_uuid pif-uuid=physical_pif_uuid
<!--NeedCopy-->

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

network-sriov-destroy

xe network-sriov-destroy uuid=network_sriov_uuid
<!--NeedCopy-->

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
<!--NeedCopy-->

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

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

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

sdn-controller-forget

xe sdn-controller-introduce [address=address] [protocol=protocol] [tcp-port=tcp_port]
<!--NeedCopy-->

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

sdn-controller-introduce

xe sdn-controller-forget uuid=uuid
<!--NeedCopy-->

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

トンネルコマンド

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

tunnel-create

xe tunnel-create pif-uuid=pif_uuid network-uuid=network_uuid
<!--NeedCopy-->

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

tunnel-destroy

xe tunnel-destroy uuid=uuid
<!--NeedCopy-->

トンネルを破棄します。

パッチコマンド

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

patch-apply

xe patch-apply uuid=patch_uuid host-uuid=host_uuid
<!--NeedCopy-->

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

patch-clean

xe patch-clean uuid=uuid
<!--NeedCopy-->

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

patch-destroy

xe patch-destroy uuid=uuid
<!--NeedCopy-->

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

patch-pool-apply

xe patch-pool-apply uuid=uuid
<!--NeedCopy-->

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

patch-pool-clean

xe patch-pool-clean uuid=uuid
<!--NeedCopy-->

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

patch-precheck

xe patch-precheck uuid=uuid host-uuid=host_uuid
<!--NeedCopy-->

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

patch-upload

xe patch-upload file-name=file_name
<!--NeedCopy-->

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

PBD（物理ブロックデバイス）コマンド

PBD（pbdオブジェクト）を操作します。pbdオブジェクトは、Citrix Hypervisorサーバーがストレージリポジトリへのアクセスに使用するソフトウェアオブジェクトです。

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

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

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

pbd-create

xe pbd-create host-uuid=uuid_of_host sr-uuid=uuid_of_sr [device-config:key=corresponding_value]
<!--NeedCopy-->

このコマンドでは、Citrix Hypervisorサーバー上にPBDを作成します。読み取り専用のdevice-configパラメーターは、作成時にのみ設定できます。

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

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

pbd-destroy

xe pbd-destroy uuid=uuid_of_pbd
<!--NeedCopy-->

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

pbd-plug

xe pbd-plug uuid=uuid_of_pbd
<!--NeedCopy-->

このコマンドでは、PBDをCitrix Hypervisorサーバーに接続します。成功すると、参照されているストレージリポジトリ（およびそれに含まれているVDI）がCitrix Hypervisorサーバーからアクセス可能になります。

pbd-unplug

xe pbd-unplug uuid=uuid_of_pbd
<!--NeedCopy-->

このコマンドでは、PBDとCitrix Hypervisorサーバーとの接続を解除します。

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

PIF（pifオブジェクト）を操作します。

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

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

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

注：

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

pif-forget

xe pif-forget uuid=uuid_of_pif
<!--NeedCopy-->

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

pif-introduce

xe pif-introduce host-uuid=host_uuid mac=mac_address_for_pif device=interface_name
<!--NeedCopy-->

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

pif-plug

xe pif-plug uuid=uuid_of_pif
<!--NeedCopy-->

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

pif-reconfigure-ip

xe 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]
<!--NeedCopy-->

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

注：

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

pif-reconfigure-ipv6

xe pif-reconfigure-ipv6 uuid=uuid_of_pif mode=mode [gateway=network_gateway_address] [IPv6=static_ip_for_this_pif] [DNS=dns_address]
<!--NeedCopy-->

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

pif-scan

xe pif-scan host-uuid=host_uuid
<!--NeedCopy-->

指定したCitrix Hypervisorサーバー上の新規物理インターフェイスを検出します。

pif-set-primary-address-type

xe pif-set-primary-address-type  uuid=uuid primary_address_type=address_type
<!--NeedCopy-->

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

pif-unplug

xe pif-unplug uuid=uuid_of_pif
<!--NeedCopy-->

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

プールコマンド

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

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

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

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

pool-apply-edition

xe pool-apply-edition edition=edition [uuid=uuid] [license-server-address=address] [license-server-port=port]
<!--NeedCopy-->

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

pool-certificate-install

xe pool-certificate-install filename=file_name
<!--NeedCopy-->

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

pool-certificate-list

xe pool-certificate-list
<!--NeedCopy-->

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

pool-certificate-sync

xe pool-certificate-sync
<!--NeedCopy-->

TLS証明書と証明書失効リストをプールマスターから他のプールメンバーに同期します。

pool-certificate-uninstall

xe pool-certificate-uninstall name=name
<!--NeedCopy-->

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

pool-crl-install

xe pool-crl-install filename=file_name
<!--NeedCopy-->

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

pool-crl-list

xe pool-crl-list
<!--NeedCopy-->

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

pool-crl-uninstall

xe pool-crl-uninstall name=name
<!--NeedCopy-->

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

pool-deconfigure-wlb

xe pool-deconfigure-wlb
<!--NeedCopy-->

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

pool-designate-new-master

xe pool-designate-new-master host-uuid=uuid_of_new_master
<!--NeedCopy-->

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

pool-disable-external-auth

xe pool-disable-external-auth [uuid=uuid] [config=config]
<!--NeedCopy-->

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

pool-disable-local-storage-caching

xe pool-disable-local-storage-caching uuid=uuid
<!--NeedCopy-->

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

pool-disable-redo-log

xe pool-disable-redo-log
<!--NeedCopy-->

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

pool-dump-database

xe pool-dump-database file-name=filename_to_dump_database_into_(on_client)
<!--NeedCopy-->

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

pool-enable-external-auth

xe pool-enable-external-auth  auth-type=auth_type service-name=service_name [uuid=uuid] [config:=config]
<!--NeedCopy-->

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

pool-enable-local-storage-caching

xe pool-enable-local-storage-caching uuid=uuid
<!--NeedCopy-->

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

pool-enable-redo-log

xe pool-enable-redo-log sr-uuid=sr_uuid
<!--NeedCopy-->

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

pool-eject

xe pool-eject host-uuid=uuid_of_host_to_eject
<!--NeedCopy-->

指定したCitrix Hypervisorサーバーを既存のプールから除外します。

pool-emergency-reset-master

xe pool-emergency-reset-master master-address=address_of_pool_master
<!--NeedCopy-->

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

pool-emergency-transition-to-master

xe pool-emergency-transition-to-master
<!--NeedCopy-->

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

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

pool-ha-enable

xe pool-ha-enable heartbeat-sr-uuids=uuid_of_heartbeat_sr
<!--NeedCopy-->

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

pool-ha-disable

xe pool-ha-disable
<!--NeedCopy-->

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

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

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

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

xe pool-ha-compute-hypothetical-max-host-failures-to-tolerate [vm-uuid=vm_uuid] [restart-priority=restart_priority]
<!--NeedCopy-->

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

pool-initialize-wlb

xe pool-initialize-wlb wlb_url=url wlb_username=wlb_username wlb_password=wlb_password xenserver_username=username xenserver_password=password
<!--NeedCopy-->

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

pool-join

xe pool-join master-address=address master-username=username master-password=password
<!--NeedCopy-->

Citrix Hypervisorサーバーを既存のプールに追加します。

pool-management-reconfigure

xe pool-management-reconfigure [network-uuid=network-uuid]
<!--NeedCopy-->

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

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

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

警告：

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

pool-recover-slaves

xe pool-recover-slaves
<!--NeedCopy-->

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

pool-restore-database

xe pool-restore-database file-name=filename_to_restore_from_on_client [dry-run=true|false]
<!--NeedCopy-->

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

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

pool-retrieve-wlb-configuration

xe pool-retrieve-wlb-configuration
<!--NeedCopy-->

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

pool-retrieve-wlb-diagnostics

xe pool-retrieve-wlb-diagnostics [filename=file_name]
<!--NeedCopy-->

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

pool-retrieve-wlb-recommendations

xe pool-retrieve-wlb-recommendations
<!--NeedCopy-->

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

pool-retrieve-wlb-report

xe pool-retrieve-wlb-report report=report [filename=file_name]
<!--NeedCopy-->

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

pool-secret-rotate

xe pool-secret-rotate
<!--NeedCopy-->

プールシークレットを入れ替えます。

プールシークレットは、プール内のサーバー間で共有されるシークレットです。これにより、サーバーはプールに対するメンバーシップを証明できます。プール管理者の役割を持つユーザーは、SSH経由でサーバーに接続するときにこのシークレットを表示できます。こうしたユーザーが組織を離れるか、プール管理者の役割を失った場合は、プールシークレットを入れ替えます。

pool-send-test-post

xe pool-send-test-post dest-host=destination_host dest-port=destination_port body=post_body
<!--NeedCopy-->

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

pool-send-wlb-configuration

xe pool-send-wlb-configuration [config:=config]
<!--NeedCopy-->

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

pool-sync-database

xe pool-sync-database
<!--NeedCopy-->

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

igmp-snooping-enabled

xe pool-param-set [uuid=pool-uuid] [igmp-snooping-enabled=true|false]
<!--NeedCopy-->

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

https-only

xe pool-param-set [uuid=pool-uuid] [https-only=true|false]
<!--NeedCopy-->

Citrix Hypervisorホストの管理インターフェイスでポート80のブロックを有効または無効にします。

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

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

pvs-cache-storage-create

xe pvs-cache-storage-create sr-uuid=sr_uuid pvs-site-uuid=pvs_site_uuid size=size
<!--NeedCopy-->

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

pvs-cache-storage-destroy

xe pvs-cache-storage-destroy uuid=uuid
<!--NeedCopy-->

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

pvs-proxy-create

xe pvs-proxy-create pvs-site-uuid=pvs_site_uuid vif-uuid=vif_uuid
<!--NeedCopy-->

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

pvs-proxy-destroy

xe pvs-proxy-destroy uuid=uuid
<!--NeedCopy-->

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

pvs-server-forget

xe pvs-server-forget uuid=uuid
<!--NeedCopy-->

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

pvs-server-introduce

xe pvs-server-introduce addresses=adresses first-port=first_port last-port=last_port pvs-site-uuid=pvs_site_uuid
<!--NeedCopy-->

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

pvs-site-forget

xe pvs-site-forget uuid=uuid
<!--NeedCopy-->

PVSサイトを削除します。

pvs-site-introduce

xe pvs-site-introduce name-label=name_label [name-description=name_description] [pvs-uuid=pvs_uuid]
<!--NeedCopy-->

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

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

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

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

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

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

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

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

snapshot-clone

xe snapshot-clone new-name-label=name_label [uuid=uuid] [new-name-description=description]
<!--NeedCopy-->

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

snapshot-copy

xe snapshot-copy new-name-label=name_label [uuid=uuid] [new-name-description=name_description] [sr-uuid=sr_uuid]
<!--NeedCopy-->

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

snapshot-destroy

xe snapshot-destroy  [uuid=uuid] [snapshot-uuid=snapshot_uuid]
<!--NeedCopy-->

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

snapshot-disk-list

xe snapshot-disk-list [uuid=uuid] [snapshot-uuid=snapshot_uuid] [vbd-params=vbd_params] [vdi-params=vdi_params]
<!--NeedCopy-->

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

snapshot-export-to-template

xe snapshot-export-to-template filename=file_name snapshot-uuid=snapshot_uuid  [preserve-power-state=true|false]
<!--NeedCopy-->

スナップショットをファイル名にエクスポートします。

snapshot-reset-powerstate

xe snapshot-reset-powerstate [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
<!--NeedCopy-->

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

snapshot-revert

xe snapshot-revert [uuid=uuid] [snapshot-uuid=snapshot_uuid]
<!--NeedCopy-->

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

snapshot-uninstall

xe snapshot-uninstall [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
<!--NeedCopy-->

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

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

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

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

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

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

sr-create

xe 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]
<!--NeedCopy-->

ディスク上にストレージリポジトリを作成し、データベースに導入して、このストレージリポジトリをCitrix Hypervisorサーバーに接続するためのPBDを作成します。sharedがtrueに設定されている場合、PBDはプール内のCitrix Hypervisorサーバーそれぞれに作成されます。sharedが指定されていないか、falseに設定されている場合、PBDはhost-uuidで指定されたCitrix Hypervisorサーバーにのみ作成されます。

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

sr-data-source-forget

xe sr-data-source-forget data-source=data_source
<!--NeedCopy-->

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

sr-data-source-list

xe sr-data-source-list
<!--NeedCopy-->

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

sr-data-source-query

xe sr-data-source-query data-source=data_source
<!--NeedCopy-->

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

sr-data-source-record

xe sr-data-source-record  data-source=data_source
<!--NeedCopy-->

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

sr-destroy

xe sr-destroy uuid=sr_uuid
<!--NeedCopy-->

Citrix Hypervisorサーバー上の指定されたストレージリポジトリを破棄します。

sr-enable-database-replication

xe sr-enable-database-replication uuid=sr_uuid
<!--NeedCopy-->

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

sr-disable-database-replication

xe sr-disable-database-replication uuid=sr_uuid
<!--NeedCopy-->

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

sr-forget

xe sr-forget uuid=sr_uuid
<!--NeedCopy-->

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

sr-introduce

xe sr-introduce name-label=name physical-size=physical_size type=type content-type=content_type uuid=sr_uuid
<!--NeedCopy-->

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

xe sr-introduce device-config:device=/dev/sdb1
<!--NeedCopy-->

注：

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

sr-probe

xe sr-probe type=type [host-uuid=host_uuid] [device-config:config_name=value]
<!--NeedCopy-->

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

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

sr-probe-ext

xe sr-probe-ext type=type [host-uuid=host_uuid] [device-config:=config] [sm-config:-sm_config]
<!--NeedCopy-->

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

sr-scan

xe sr-scan uuid=sr_uuid
<!--NeedCopy-->

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

sr-update

xe sr-update uuid=uuid
<!--NeedCopy-->

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

lvhd-enable-thin-provisioning

xe lvhd-enable-thin-provisioning  sr-uuid=sr_uuid initial-allocation=initial_allocation allocation-quantum=allocation_quantum
<!--NeedCopy-->

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

サブジェクトコマンド

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

session-subject-identifier-list

xe session-subject-identifier-list
<!--NeedCopy-->

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

session-subject-identifier-logout

xe session-subject-identifier-logout subject-identifier=subject_identifier
<!--NeedCopy-->

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

session-subject-identifier-logout-all

xe session-subject-identifier-logout-all
<!--NeedCopy-->

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

subject-add

xe subject-add subject-name=subject_name
<!--NeedCopy-->

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

subject-remove

xe subject-remove subject-uuid=subject_uuid
<!--NeedCopy-->

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

subject-role-add

xe subject-role-add uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
<!--NeedCopy-->

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

subject-role-remove

xe subject-role-remove uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
<!--NeedCopy-->

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

secret-create

xe secret-create value=value
<!--NeedCopy-->

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

secret-destroy

xe secret-destroy uuid=uuid
<!--NeedCopy-->

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

タスクコマンド

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

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

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

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

task-cancel

xe task-cancel [uuid=task_uuid]
<!--NeedCopy-->

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

テンプレートコマンド

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

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

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

注：

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

VMテンプレートパラメーター

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

• uuid（読み取り専用）テンプレートの一意の識別子/オブジェクト参照
• name-label（読み取り/書き込み）テンプレートの名前
• name-description（読み取り/書き込み）テンプレートの説明文字列
• user-version（読み取り/書き込み）バージョン情報に含める、仮想マシンおよびテンプレートの作成者用の文字列

• is-a-template（読み取り/書き込み）このVMがテンプレートの場合はtrue。 テンプレートは起動できない仮想マシンで、複製して仮想マシンを作成するためのものです。この値をtrueに設定すると、falseにリセットすることはできません。テンプレート仮想マシンは、このパラメーターを使用して仮想マシンに変換することはできません。

  次のコマンドで仮想マシンをテンプレートに変換できます。

   xe vm-param-set uuid=<vm uuid> is-a-template=true
   <!--NeedCopy-->
  

• 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
   <!--NeedCopy-->
  

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

  また、capおよびweightパラメーターを使用して、仮想CPUの優先度（xen scheduling）を指定できます。例：

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

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

  capパラメーターを指定すると、Citrix Hypervisorサーバーの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
   <!--NeedCopy-->
  

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

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

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

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

• allowed-operations（読み取り専用の設定パラメーター）この状態で可能な操作のリスト
• current-operations（読み取り専用の設定パラメーター）このテンプレート上で現在処理中の操作のリスト
• allowed-VBD-devices（読み取り専用の設定パラメーター）0～15の整数で表した使用可能なVBD識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます（ただし機能しない場合があります）。
• allowed-VIF-devices（読み取り専用の設定パラメーター）0～15の整数で表した使用可能なVIF識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます（ただし機能しない場合があります）。
• HVM-boot-policy（読み取り/書き込み）HVMゲストの起動ポリシー。BIOSの順序または空の文字列のいずれかです。
• 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（読み取り専用）このテンプレートから作成した仮想マシンが常駐するCitrix Hypervisorサーバー。テンプレートの場合は「not in database」と表示されます
• affinity（読み取り/書き込み）このテンプレートから作成した仮想マシンが優先的に実行されるCitrix Hypervisorサーバー。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文字の24時間制タイムゾーンインジケーターであり、たとえばUTC（GMT）の場合はZです。
• 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

xe template-export template-uuid=uuid_of_existing_template filename=filename_for_new_template
<!--NeedCopy-->

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

template-uninstall

xe template-uninstall template-uuid=template_uuid [--force]
<!--NeedCopy-->

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

アップデートコマンド

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

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

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

Citrix Hypervisorサーバーのアップデートには次のパラメーターがあります：

update-upload

xe update-upload file-name=update_filename
<!--NeedCopy-->

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

update-precheck

xe update-precheck uuid=update_uuid host-uuid=host_uuid
<!--NeedCopy-->

指定されたアップデートに含まれている事前チェックを、指定されたCitrix Hypervisorサーバーに対して実行します。

update-destroy

xe update-destroy uuid=update_file_uuid
<!--NeedCopy-->

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

update-apply

xe update-apply host-uuid=host_uuid uuid=update_file_uuid
<!--NeedCopy-->

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

update-pool-apply

xe update-pool-apply uuid=update_uuid
<!--NeedCopy-->

指定されたアップデートをプール内のすべてのCitrix Hypervisorサーバーに適用します。

update-introduce

xe update-introduce vdi-uuid=vdi_uuid
<!--NeedCopy-->

更新VDIを導入します。

update-pool-clean

xe update-pool-clean uuid=uuid
<!--NeedCopy-->

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

ユーザーコマンド

user-password-change

xe user-password-change old=old_password new=new_password
<!--NeedCopy-->

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

VBD（仮想ブロックデバイス）コマンド

VBD（vbdオブジェクト）を操作します。

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

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

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

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

vbd-create

xe 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]
<!--NeedCopy-->

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

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

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

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

vbd-destroy

xe vbd-destroy uuid=uuid_of_vbd
<!--NeedCopy-->

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

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

vbd-eject

xe vbd-eject uuid=uuid_of_vbd
<!--NeedCopy-->

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

vbd-insert

xe vbd-insert uuid=uuid_of_vbd vdi-uuid=uuid_of_vdi_containing_media
<!--NeedCopy-->

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

vbd-plug

xe vbd-plug uuid=uuid_of_vbd
<!--NeedCopy-->

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

vbd-unplug

xe vbd-unplug uuid=uuid_of_vbd
<!--NeedCopy-->

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

VDI（仮想ディスクイメージ）コマンド

VDI（vdiオブジェクト）を操作します。

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

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

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

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

vdi-clone

xe vdi-clone uuid=uuid_of_the_vdi [driver-params:key=value]
<!--NeedCopy-->

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

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

vdi-copy

xe vdi-copy uuid=uuid_of_the_vdi sr-uuid=uuid_of_the_destination_sr
<!--NeedCopy-->

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

vdi-create

xe 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
<!--NeedCopy-->

VDIを作成します。

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

注：

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

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

vdi-data-destroy

xe vdi-data-destroy uuid=uuid_of_vdi
<!--NeedCopy-->

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

注：

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

vdi-destroy

xe vdi-destroy uuid=uuid_of_vdi
<!--NeedCopy-->

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

注：

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

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

vdi-disable-cbt

xe vdi-disable-cbt uuid=uuid_of_vdi
<!--NeedCopy-->

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

vdi-enable-cbt

xe vdi-enable-cbt uuid=uuid_of_vdi
<!--NeedCopy-->

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

注：

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

vdi-export

xe vdi-export uuid=uuid_of_vdi filename=filename_to_export_to [format=format] [base=uuid_of_base_vdi] [--progress]
<!--NeedCopy-->

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

• raw
• vhd

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

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

vdi-forget

xe vdi-forget uuid=uuid_of_vdi
<!--NeedCopy-->

ストレージからVDIを削除せずに、データベースからVDIレコードだけを削除します。通常の操作では、代わりにvdi-destroyを使用します。

vdi-import

xe vdi-import uuid=uuid_of_vdi filename=filename_to_import_from [format=format] [--progress]
<!--NeedCopy-->

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

• raw
• vhd

vdi-introduce

xe 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]
<!--NeedCopy-->

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

vdi-list-changed-blocks

xe vdi-list-changed-blocks vdi-from-uuid=first-vdi-uuid vdi-to-uuid=second-vdi-uuid
<!--NeedCopy-->

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

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

vdi-pool-migrate

xe vdi-pool-migrate uuid=VDI_uuid sr-uuid=destination-sr-uuid
<!--NeedCopy-->

VDIを指定したストレージリポジトリに移行し、VDIを実行中のゲストに接続します。（ストレージライブマイグレーション）

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

vdi-resize

xe vdi-resize uuid=vdi_uuid disk-size=new_size_for_disk
<!--NeedCopy-->

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

vdi-snapshot

xe vdi-snapshot uuid=uuid_of_the_vdi [driver-params=params]
<!--NeedCopy-->

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

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

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

vdi-unlock

xe vdi-unlock uuid=uuid_of_vdi_to_unlock [force=true]
<!--NeedCopy-->

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

vdi-update

xe vdi-update uuid=uuid
<!--NeedCopy-->

データベース内の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
   <!--NeedCopy-->
  

• 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）などを実行するのに便利です。
• 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の場合、Citrix Hypervisorによって、そのネットワークが接続するVIFですべての送受信トラフィックがドロップされます。default-lockingmodeがunlockedの場合、Citrix Hypervisorによって、そのネットワークが接続するVIFですべての送受信トラフィックが許可されます。詳しくは、「ネットワークコマンド」を参照してください。

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

vif-create

xe vif-create vm-uuid=uuid_of_the_vm device=see below network-uuid=uuid_of_network_to_connect_to [mac=mac_address]
<!--NeedCopy-->

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

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

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

vif-destroy

xe vif-destroy uuid=uuid_of_vif
<!--NeedCopy-->

VIFを破棄します。

vif-move

xe vif-move uuid=uuid network-uuid=network_uuid
<!--NeedCopy-->

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

vif-plug

xe vif-plug uuid=uuid_of_vif
<!--NeedCopy-->

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

vif-unplug

xe vif-unplug uuid=uuid_of_vif
<!--NeedCopy-->

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

vif-configure-ipv4

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

xe vif-configure-ipv4 uuid=uuid_of_vif mode=static address=CIDR_address gateway=gateway_address
<!--NeedCopy-->

例：

VIF.configure_ipv4(vifObject,"static", " 192.168.1.10/24", " 192.168.1.1")
<!--NeedCopy-->

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

xe vif-configure-ipv4 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

vif-configure-ipv6

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

xe vif-configure-ipv6 uuid=uuid_of_vif mode=static address=IP_address gateway=gateway_address
<!--NeedCopy-->

例：

VIF.configure_ipv6(vifObject,"static", "fd06:7768:b9e5:8b00::5001/64", "fd06:7768:b9e5:8b00::1")
<!--NeedCopy-->

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

xe vif-configure-ipv6 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

VLAN（仮想ネットワーク）コマンド

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

vlan-create

xe vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
<!--NeedCopy-->

Citrix Hypervisorサーバー上にVLANを作成します。

pool-vlan-create

xe pool-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
<!--NeedCopy-->

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

vlan-destroy

xe vlan-destroy uuid=uuid_of_pif_mapped_to_vlan
<!--NeedCopy-->

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（読み取り/書き込み）vAppの起動/シャットダウン時や高可用性での仮想マシンの起動順序。順序として0を指定すると、その仮想マシンが最初に起動します。次に1を指定した仮想マシンが起動し、2、3と続きます。
• version（読み取り専用）この仮想マシンが復元された回数。新しい仮想マシンを古いバージョンで上書きする場合は、vm-recoverを呼び出します
• user-version（読み取り/書き込み）バージョン情報に含める、仮想マシンおよびテンプレートの作成者用の文字列

• is-a-template（読み取り/書き込み）この仮想マシンがテンプレートでない場合はfalse。テンプレート仮想マシンは起動できないものであり、複製して仮想マシンを作成するためのものです。この値をtrueに設定すると、その後falseにリセットすることはできません。テンプレート仮想マシンは、このパラメーターを使用して仮想マシンに変換することはできません。

  次のコマンドで仮想マシンをテンプレートに変換できます。

   xe vm-param-set uuid=<vm uuid> is-a-template=true
   <!--NeedCopy-->
  

• 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
   <!--NeedCopy-->
  

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

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

  これにより、この仮想マシン（weightは512）は、そのCitrix Hypervisorサーバー上のほかのドメイン（weightは256）の2倍のCPUリソースを使用できます。weightに指定可能な値は1～65535で、デフォルト値は256です。capパラメーターを指定すると、Citrix Hypervisorサーバーの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（読み取り/書き込みマップパラメーター）プラットフォーム固有の構成

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

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

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

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

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

   xe vm-param-get uuid=<vm_uuid> param-name=platform param-key=acpi_laptop_slate
   <!--NeedCopy-->
  

• allowed-operations（読み取り専用の設定パラメーター）この状態で可能な操作のリスト
• current-operations（読み取り専用の設定パラメーター）仮想マシン上で現在処理中の操作のリスト
• allowed-VBD-devices（読み取り専用の設定パラメーター）0～15の整数で表した使用可能なVBD識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます（ただし機能しない場合があります）。
• allowed-VIF-devices（読み取り専用の設定パラメーター）0～15の整数で表した使用可能なVIF識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます（ただし機能しない場合があります）。
• HVM-boot-policy（読み取り/書き込み）HVMゲストの起動ポリシー。BIOSの順序または空の文字列のいずれかです。
• 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（読み取り専用）仮想マシンが常駐するCitrix Hypervisorサーバー
• affinity（読み取り/書き込み）仮想マシンが優先的に実行されるCitrix Hypervisorサーバー。xe vm-startコマンドによって使用され、仮想マシンを実行する場所を決定します

• other-config（読み取り/書き込みマップパラメーター）仮想マシンの追加構成パラメーターを指定するキー/値ペアのリスト。

  たとえば、other-configキー/値ペアauto_poweron: trueは、プール内のホストが起動した後にVMを自動的に起動するように要求します。このパラメータをプールの other-configにも設定する必要があります。これらのパラメータは現廃止されています。代わりとしてha-restart-priorityを使用します。

• start-time （読み取り専用）仮想マシンのメトリックが読み取られた日時のタイムスタンプ。このタイムスタンプの書式はyyyymmddThh:mm:ss zです。ここでのzは1文字の24時間制タイムゾーンインジケータです。たとえば、UTC（GMT）の場合はZです。
• install-time （読み取り専用）仮想マシンのメトリックが読み取られた日時のタイムスタンプ。このタイムスタンプの書式はyyyymmddThh:mm:ss zです。ここでのzは1文字の24時間制タイムゾーンインジケータです。たとえば、UTC（GMT）の場合はZです。
• memory-actual（読み取り専用）仮想マシンが使用する実メモリ
• VCPUs-number（読み取り専用）Linux仮想マシンの場合、仮想マシンに割り当てられている仮想CPUの数。この値がVCPUS-maxと異なっていても構いません。また、vm-vcpu-hotplugコマンドを使用すると、仮想マシンを再起動せずに値を変更できます。詳しくは、vm-vcpu-hotplugを参照してください。Windows仮想マシンの場合、常にVCPUsmaxに設定された数の仮想CPUを使用します。この値を変更した場合、仮想マシンの再起動が必要です。Citrix Hypervisorサーバー上の物理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文字の24時間制タイムゾーンインジケータです。たとえば、UTC（GMT）の場合はZです。
• 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

xe vm-assert-can-be-recovered uuid [database] vdi-uuid
<!--NeedCopy-->

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

vm-call-plugin

xe vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]
<!--NeedCopy-->

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

vm-cd-add

xe vm-cd-add cd-name=name_of_new_cd device=integer_value_of_an_available_vbd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

vm-cd-eject

xe vm-cd-eject [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

vm-cd-insert

xe vm-cd-insert cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

vm-cd-list

xe vm-cd-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

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

vm-cd-remove

xe vm-cd-remove cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

vm-checkpoint

xe vm-checkpoint new-name-label=name_label [new-name-description=description]
<!--NeedCopy-->

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

vm-clone

xe vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

vm-compute-maximum-memory

xe 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...]
<!--NeedCopy-->

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

例：

xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`
<!--NeedCopy-->

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

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

vm-compute-memory-overhead

xe vm-compute-memory-overhead
<!--NeedCopy-->

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

vm-copy

xe vm-copy new-name-label=name_for_copy [new-name-description=description_for_copy] [sr-uuid=uuid_of_sr] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

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

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

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

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

vm-copy-bios-strings

xe vm-copy-bios-strings host-uuid=host_uuid
<!--NeedCopy-->

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

注：

仮想マシンを初めて起動するとき、起動したあとにそのBIOS文字列を変更することはできません。初めての場合は仮想マシンを起動する前に、BIOS文字列が正しいことを確認してください。

vm-crashdump-list

xe vm-crashdump-list [vm-selector=vm selector value...]
<!--NeedCopy-->

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

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

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

vm-data-source-list

xe vm-data-source-list [vm-selector=vm selector value...]
<!--NeedCopy-->

仮想マシンで、記録可能なデータソースのリストを出力します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

データソースには、パラメーターとしてstandardおよびenabledがあり、このコマンドの出力で確認できます。データソースのenabledパラメーターがtrueの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースに記録中であることを示します。standardパラメーターがtrueのデータソースでは、デフォルトでメトリクス情報がパフォーマンスデータベースに記録されます（enabledパラメーターにtrueが設定されます）。データソースのstandardパラメーターがfalseの場合、そのデータソースのメトリクス情報がパフォーマンスデータベースにデフォルトで記録されないことを示します（enabledパラメーターにfalseが設定されます）。

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

vm-data-source-record

xe vm-data-source-record data-source=name_description_of_data-source [vm-selector=vm selector value...]
<!--NeedCopy-->

仮想マシンで、指定したデータソースを記録します。

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

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-data-source-forget

xe vm-data-source-forget data-source=name_description_of_data-source [vm-selector=vm selector value...]
<!--NeedCopy-->

仮想マシンのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-data-source-query

xe vm-data-source-query data-source=name_description_of_data-source [vm-selector=vm_selector_value...]
<!--NeedCopy-->

仮想マシンで、指定したデータソースを表示します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。

vm-destroy

xe vm-destroy uuid=uuid_of_vm
<!--NeedCopy-->

指定した仮想マシンを破棄します。その仮想マシンに関連付けられたストレージはそのまま残ります。ストレージも削除するには、xe vm-uninstallを使用します。

vm-disk-add

xe vm-disk-add disk-size=size_of_disk_to_add device=uuid_of_device [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定した仮想マシンにディスクを追加します。deviceパラメーターは、仮想マシンのallowed-VBD-devicesパラメーターの値から選択します。

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

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

vm-disk-list

xe vm-disk-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定した仮想マシンに接続されているディスクのリストを出力します。vbd-paramsおよびvdi-paramsパラメーターは、それぞれのオブジェクトのフィールドを制御して出力します。この2つのパラメーターをコンマ区切りリストとして指定するか、完全なリストの場合は特殊キーallを指定します。

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

vm-disk-remove

xe vm-disk-remove device=integer_label_of_disk [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定した仮想マシンからディスクを削除して、そのディスクを破棄します。

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

vm-export

xe vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定された仮想マシン（ディスクイメージを含む）を、ローカルマシン上のファイルにエクスポートします。仮想マシンのエクスポート先のファイル名を、filenameパラメーターで指定します。ファイル名の拡張子として、.xvaが付きます。

metadataパラメーターがtrueの場合、ディスクはエクスポートされません。仮想マシンメタデータのみが出力ファイルに書き込まれます。このパラメーターを使用することで、仮想マシンのストレージをほかの方法で移動して、仮想マシン情報を再作成できるようになります。詳しくは、vm-importを参照してください。

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

vm-import

xe vm-import filename=export_filename [metadata=true|false] [preserve=true|false][sr-uuid=destination_sr_uuid]
<!--NeedCopy-->

以前にエクスポートしたファイルから仮想マシンをインポートします。preserveをtrueに設定すると、元の仮想マシンのMACアドレスが保持されます。sr-uuidによって、仮想マシンのインポート先のストレージリポジトリを決定します。このパラメーターが指定されていない場合、デフォルトのストレージリポジトリが使用されます。

metadataをtrueに設定すると、エクスポート済みのメタデータを、それに関連付けられているディスクブロックを除外してインポートできます。このメタデータのみのインポートは、VDIが見つからない場合（ストレージリポジトリとVDI.locationにより指定）に失敗します。この場合、--forceオプションを指定して強制的にインポートできます。ディスクのミラーまたは移動が可能な場合、メタデータのインポート/エクスポートは、異なるリソースプール間で仮想マシンをすばやく移動するための手段になります（障害復旧時など）。

注：

複数の仮想マシンをインポートする場合は、同時に実行するよりも順番に実行した方が早く完了します。

vm-install

xe 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]
<!--NeedCopy-->

テンプレートから仮想マシンをインストールまたは複製します。template-uuid引数またはtemplate引数のいずれかを使用して、テンプレート名を指定します。sr-uuid引数またはsr-name-label引数のいずれかを使用して、ストレージリポジトリを指定 します。BIOSで特定ホスト用にロックされたメディアからインストールする場合は、copy-bios-strings-from引数を指定します。

注：

既存のディスクを持つテンプレートからインストールする場合は、デフォルトでそのディスクと同じストレージリポジトリ上に新しいディスクが作成されます。ストレージリポジトリがサポートする場合は、これらのディスクの高速複製が実行されます。ほかのストレージリポジトリをコマンドで指定した場合は、新しいディスクがそのストレージリポジトリ上に作成されます。この場合、高速複製は不可能であり、完全コピーが実行されます。

既存のディスクを持たないテンプレートからのインストールでは、指定したストレージリポジトリ、またはプールのデフォルトストレージリポジトリ（ストレージリポジトリを指定しない場合）上に新しいディスクが作成されます。

vm-is-bios-customized

xe vm-is-bios-customized
<!--NeedCopy-->

仮想マシンのBIOS文字列がカスタマイズされているかどうかを示します。

vm-memory-dynamic-range-set

xe vm-memory-dynamic-range-set min=min max=max
<!--NeedCopy-->

仮想マシンのダイナミックメモリ範囲を設定します。ダイナミックメモリ範囲は、仮想マシンのメモリのソフト下限と上限を定義します。仮想マシンが実行中または停止中にこれらのフィールドを変更することは可能です。ダイナミックレンジは静的範囲内に収まる必要があります。

vm-memory-limits-set

xe vm-memory-limits-set static-min=static_min static-max=static_max dynamic-min=dynamic_min dynamic-max=dynamic_max
<!--NeedCopy-->

仮想マシンのメモリ制限を構成します。

vm-memory-set

xe vm-memory-set memory=memory
<!--NeedCopy-->

仮想マシンのメモリ割り当てを設定します。

vm-memory-shadow-multiplier-set

xe vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]
<!--NeedCopy-->

指定した仮想マシンのシャドウメモリ乗数を設定します。

これは、ハードウェア支援型仮想マシンに割り当てられるシャドウメモリの量を変更するための高度なオプションです。

Citrix Virtual Appsなどの特化したアプリケーションの処理負荷で最高のパフォーマンスを得るには、追加のシャドウメモリが必要です。

このメモリは、オーバーヘッドとして考えることができます。シャドウメモリは、仮想マシン用の通常のメモリとは別に計算されます。このコマンドを実行すると、その乗数に応じてホスト上の空きメモリ量が減り、HVM_shadow_multiplierフィールドが、Xenが仮想マシンに割り当てた値で更新されます。Citrix Hypervisorサーバーの空きメモリ量が足りない場合は、エラーが返されます。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。

vm-memory-static-range-set

xe vm-memory-static-range-set min=min max=max
<!--NeedCopy-->

仮想マシンの静的メモリ範囲を設定します。静的メモリ範囲は、仮想マシンのメモリのハード下限と上限を定義します。仮想マシンの停止中にのみ、これらのフィールドを変更できます。ダイナミックレンジは静的範囲内に収まる必要があります。

vm-memory-target-set

xe vm-memory-target-set target=target
<!--NeedCopy-->

停止中または実行中の仮想マシンのメモリターゲットを設定します。指定された値は、仮想マシンのmemory_static_minの値およびmemory_static_maxの値で定義された範囲内でなければなりません。

vm-migrate

xe 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:source_vif_uuid=destination_network_uuid] [vdi:vdi_uuid=destination_sr_uuid]
<!--NeedCopy-->

このコマンドでは、指定した仮想マシンを物理ホスト間で移行します。hostパラメーターには、Citrix Hypervisorサーバーの名前かUUIDを指定できます。たとえば、2つのホストが共有しているストレージに仮想マシンのディスクがあるプール内でその別のホストに仮想マシンを移行するには、次のコマンドを実行します：

xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid
<!--NeedCopy-->

ストレージを共有していない同一プール内のホスト間で仮想マシンを移動する（ストレージライブマイグレーション）には、次のコマンドを実行します：

xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \
    remote-master=192.0.2.35 remote-username=username remote-password=password
<!--NeedCopy-->

ストレージのライブマイグレーションでは、同じプール内で移行する場合でも、プールマスターのホスト名またはIPアドレス、ユーザー名、およびパスワードを指定する必要があります。

各VDIが格納されているストレージリポジトリは、次のようにして選択できます：

xe vm-migrate uuid=vm_uuid remote-master=192.0.2.35 remote-username=username remote-password=password host-uuid=destination_host_uuid \
    vdi:vdi_1=destination_sr1_uuid \
    vdi:vdi_2=destination_sr2_uuid \
    vdi:vdi_3=destination_sr3_uuid
<!--NeedCopy-->

また、移行後に仮想マシンに接続するネットワークは、次のようにして選択できます。

xe vm-migrate uuid=vm_uuid \
    vdi1:vdi_1_uuid=destination_sr1_uuid \
    vdi2:vdi_2_uuid=destination_sr2_uuid \
    vdi3:vdi_3_uuid=destination_sr3_uuid \
    vif:vif_uuid=network_uuid
<!--NeedCopy-->

プール間の移行の場合は、次のコマンドを実行します：

xe vm-migrate uuid=vm_uuid remote-master=192.0.2.35 \
    remote-username=username remote-password=password \
    host-uuid=destination_host_uuid  \
    vif:source_vif_uuid=destination_network_uuid \
    vdi:vdi_uuid=destination_sr_uuid
<!--NeedCopy-->

ストレージライブマイグレーション、ライブマイグレーション、ライブVDIマイグレーションについて詳しくは、「仮想マシンの移行」を参照してください。

デフォルトでは、仮想マシンが一時停止し、移行後に別のホスト上で再開します。liveパラメーターは、ライブマイグレーションを選択します。ライブマイグレーションは仮想マシンを実行したまま移行できます。したがって、このときの仮想マシンのダウンタイムが最小化されます。仮想マシンでメモリ負荷の高い処理を実行中など、状況によってはライブマイグレーション機能が無効になります。この場合、仮想マシンを一時停止してからメモリ転送が行われます。

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

vm-pause

xe vm-pause
<!--NeedCopy-->

実行中のVMを一時停止します。この操作では、関連するメモリは解放されません（vm-suspendを参照）。

vm-reboot

xe vm-reboot [vm-selector=vm_selector_value...] [force=true]
<!--NeedCopy-->

指定した仮想マシンを再起動します。

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

強制的な再起動を引き起こすには、force引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。

vm-recover

xe vm-recover vm-uuid [database] [vdi-uuid] [force]
<!--NeedCopy-->

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

vm-reset-powerstate

xe vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}
<!--NeedCopy-->

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

これは、プール内のメンバーホストがダウンしたときのみに使用する、高度なコマンドです。このコマンドを使用して、仮想マシンの電源状態を強制的にhaltedとしてプールマスターに認識させます。基本的に、このコマンドにより仮想マシンとそのディスクが強制的にロックされるため、その仮想マシンをプール内の別のホスト上で起動できます。このコマンドではforce引数の指定が必須で、これを指定しないと失敗します。

vm-resume

xe vm-resume [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid]
<!--NeedCopy-->

指定した仮想マシンを再開します。

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

仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、起動するプールメンバーをon引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。

vm-retrieve-wlb-recommendations

xe vm-retrieve-wlb-recommendations
<!--NeedCopy-->

選択された仮想マシンのワークロードバランス推奨事項を取得します。

vm-shutdown

xe vm-shutdown [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

指定した仮想マシンをシャットダウンします。

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

仮想マシンを強制的にシャットダウンするには、force引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。

vm-snapshot

xe vm-snapshot new-name-label=name_label [new-name-description+name_description]
<!--NeedCopy-->

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

vm-start

xe vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]
<!--NeedCopy-->

指定した仮想マシンを起動します。

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

仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、その仮想マシンを起動するプールメンバーをon引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。

vm-suspend

xe vm-suspend [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定した仮想マシンを一時停止します。

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

vm-uninstall

xe vm-uninstall [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

仮想マシンをアンインストールし、そのディスク（RWとマークされ、この仮想マシンにのみ接続されているVDI）とそのメタデータレコードを破棄します。仮想マシンのメタデータだけを破棄するには、xe vm-destroyを使用します。

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

vm-unpause

xe vm-unpause
<!--NeedCopy-->

一時停止した仮想マシンの一時停止を解除します。

vm-vcpu-hotplug

xe vm-vcpu-hotplug new-vcpus=new_total_vcpu_count [vm-selector=vm_selector_value...]
<!--NeedCopy-->

実行中のLinux仮想マシンで使用可能なvCPUの数を動的に調整します。vCPUの数は、パラメーターVCPUs-maxによって制限されます。Windows仮想マシンの場合、常にVCPUs-maxに設定された数の仮想CPUを使用します。この値を変更した場合、仮想マシンの再起動が必要です。

new-vcpusパラメーターを使用して、このコマンドの実行後に必要な仮想CPUの新しい合計数を定義します。追加する仮想CPUの数を指定するために、このパラメーターを使用しないでください。たとえば、仮想マシンに既存の仮想CPUが2つあり、さらに2つの仮想CPUを追加する場合は、new-vcpus=4を指定します。

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

注：

Citrix VM Toolsをインストールせずに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

xe vm-vif-list [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定した仮想マシンのVIFのリストを出力します。

このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター」を参照してください。VIFではなく仮想マシンがフィルターの対象になることに注意してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。

スケジュールされたスナップショット

仮想マシンのスケジュールされたスナップショットとその属性を操作します。

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

vmss-create

xe vmss-create enabled=True/False name-label=name type=type frequency=frequency retained-snapshots=value name-description=description schedule:schedule
<!--NeedCopy-->

プールのスナップショットスケジュールを作成。

例：

xe vmss-create retained-snapshots=9 enabled=true frequency=daily \
    name-description=sample name-label=samplepolicy type=snapshot \
    schedule:hour=10 schedule:min=30
<!--NeedCopy-->

スナップショットスケジュールには次のパラメーターがあります。

vmss-destroy

xe vmss-destroy uuid=uuid
<!--NeedCopy-->

プールのスナップショットスケジュールを破棄。

USBパススルー

USBパススルーは、USBバージョン1.1、2.0、および3.0でサポートされています。

USBパススルーの有効化/無効化

xe pusb-param-set uuid=pusb_uuid passthrough-enabled=true/false
<!--NeedCopy-->

USBパススルーを有効/無効にします。

pusb-scan

xe pusb-scan host-uuid=host_uuid
<!--NeedCopy-->

PUSBをスキャンして更新します。

vusb-create

xe vusb-create usb-group-uuid=usb_group_uuid vm-uuid=vm_uuid
<!--NeedCopy-->

プールに仮想USBを作成します。仮想マシンを起動して、USBを仮想マシンにパススルーします。

vusb-unplug

xe vusb-unplug uuid=vusb_uuid
<!--NeedCopy-->

仮想マシンからUSBを接続解除します。

vusb-destroy

xe vusb-destroy uuid=vusb_uuid
<!--NeedCopy-->

仮想マシンから仮想USB一覧を削除します。