コマンドラインインターフェイス
xeCLIを使用すると,システム管理タスクをスクリプト化して自動化できます。CLIを使用することで,Citrix Hypervisorを既存のITインフラストラクチャに統合できます。
xe CLIのインストール
xeコマンドラインインターフェイスは、すべてのCitrix Hypervisorサーバーにデフォルトでインストールされ、XenCenterにも含まれています。Linuxの場合、スタンドアロンのリモートCLIも使用できます。
Windowsの場合
Windowsでは、xe.exe
コマンドがXenCenterと一緒にインストールされています。
xe.exe
コマンドを使用するには、Windowsのコマンドプロンプトを開き、ディレクトリをxe.exe
ファイルが保存されているディレクトリに変更します(通常はC:\Program Files\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
コマンドラインでパラメーターを使用すると、xeコマンドの実行時に使用するCitrix Hypervisorサーバー、ユーザー名、およびパスワードを定義できます。または、パラメーターではなく環境変数として設定することもできます。たとえば、次のようになります:
export XE_EXTRA_ARGS="server=,username=,password="
注:
セキュリティで保護された接続を介してファイル転送を行うコマンドを実行しようとすると、Linux上のリモートxe CLIが動作を停止することがあります。この場合は、
--no-ssl
パラメーターを使用することで、セキュリティで保護されない接続を介してCitrix Hypervisorサーバーにコマンドを実行できます。
xeコマンドのヘルプの表示
ホスト上のCLIの基本ヘルプを表示するには、次のコマンドを実行します:
xe help command
使用頻度の高いxeコマンドの一覧を表示するには、次のコマンドを実行します:
xe help
また、すべてのxeコマンドの一覧を表示するには、次のコマンドを実行します:
xe help --all
基本構文
Citrix Hypervisorのすべてのxe CLIコマンドの基本構文は、次のとおりです:
xe command-name argument=value argument=value
各コマンドには、argument=value
という形式で指定する引数のセットがあります。一部のコマンドには必須の引数があり、多くのコマンドにはオプションの引数があります。通常、オプションの引数を指定せずにコマンドを実行すると、各引数のデフォルト値が適用されます。
xeコマンドがリモートで実行されると、接続と認証に追加の引数が使用されます。これらの引数も、argument=argument_value
形式で指定します。
server
引数では、コマンドの実行先のホスト名またはIPアドレスを指定します。username
引数とpassword
引数では、認証情報(ユーザー名とパスワード)を指定します。
password-file
引数は、パスワードを直接入力する代わりに指定できます。この場合、xeコマンドは指定されたファイルからパスワードの読み取りを試み、そのパスワードを使用して接続します(ファイルの最後にある行末のCRおよびLFはすべて削除されます)。この方法は、コマンドラインでパスワードを直接指定するよりも安全です。
オプションのport
引数を使用して、リモートのCitrix Hypervisorサーバーのエージェントポート(デフォルトで443)を指定できます。
例:ローカルのCitrix Hypervisorサーバーの場合:
xe vm-list
例:リモートのCitrix Hypervisorサーバーの場合:
xe vm-list username=username password=password server=hostname
リモート接続用の引数では、以下の省略構文も使用できます:
-u
:ユーザー名-pw
:パスワード-pwf
:パスワードファイル-p
:ポート-s
:サーバー
例:リモートのCitrix Hypervisorサーバーの場合:
xe vm-list -u myuser -pw mypassword -s hostname
また、引数は、環境変数XE_EXTRA_ARGSからコンマ区切りのキー/値ペアの形式でも取得されます。たとえば、リモートのCitrix Hypervisorサーバーで実行されるコマンドを入力するには、まず次のコマンドを実行します:
export XE_EXTRA_ARGS="server=jeffbeck,port=443,username=root,password=pass"
このコマンドを実行した後は、実行する各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
低レベルパラメーターコマンド
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 =参数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
すべてのパラメーターのリストを出力するには、次の構文を使用します。
xe vm-list params=all
計算のために多くのリソースを消費するパラメーターは、listコマンドで表示されない場合があります。この場合、そのパラメーターは次のように示されます:
allowed-VBD-devices (SRO):
これらのフィールドを取得するには、class-param-listコマンドまたはclass-param-getコマンドを使用します。
特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルターする)には、そのパラメーターおよび値をコマンドラインで指定します。たとえば、次のようになります:
xe vm-list HVM-boot-policy="BIOS order" power-state=halted
この例では、power-state
フィールドに値haltedを持ち、さらにHVM-boot-policy
フィールドに値BIOS orderを持つ仮想マシンだけが出力されます。
マップのキーの値、またはセットに値が存在するかどうかを指定してリストをフィルターすることもできます。マップ内のキーに基づいてフィルタリングするための構文は、map-name:key=value
です。セット内に存在する値に基づいてフィルタリングするための構文は、set-name:contains=value
です。
スクリプトを作成する場合は、コマンドラインに--minimal
を渡すことで、xe
で最初のフィールドだけをコンマ区切りで出力できます。たとえば、3つの仮想マシンがインストールされたホスト上でxe vm-list --minimal
を実行すると、次のように3つの仮想マシンのUUIDがコンマ区切りで出力されます:
a85d6717-7264-d00e-069b-3b1d19d56ad9,aaa3eec5-9499-bcf3-4c03-af10baea96b7, \ 42c044de-df69-4b30-89d9-2c199564581d
シークレット
Citrix Hypervisorでは、シークレット機能によって、パスワードがコマンドライン履歴またはAPIオブジェクトにプレーンテキストで保存されないようにします。XenCenterでは、この機能が自動的に使用されます。また、パスワードが必要なコマンドのxe CLIでも、この機能を使用できます。
注
パスワードのシークレットを使って、xe CLIのリモートインスタンスからCitrix Hypervisorホストで認証することはできません。
シークレットオブジェクトを作成するには、Citrix Hypervisorホストで以下のコマンドを実行します。
xe secret-create value=my-password
シークレットが作成され、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"
コマンド履歴
xe vm-migrate
やxe池-enable-external-auth
といった一部のxeコマンドは、パスワードなどのシークレットをパラメーターとして受け取ります。これらはシェル履歴に保存されて、コマンドの実行中にプロセステーブルに表示されます。そのため、これらのコマンドは信頼できる環境でのみ実行することが重要です。
bashシェルの場合は、HISTCONTROL
変数を使用して、どのコマンドがシェル履歴に保存されるかを制御できます。
xeコマンドリファレンス
このセクションでは、コマンドが扱うオブジェクトによってコマンドをグループ化します。これらのオブジェクトはアルファベット順に表示されます。
アプライアンスコマンド
vAppとも呼ばれる仮想アプライアンス(applianceオブジェクト)を作成または変更します。詳しくは、「vApps“を参照してください。
applianceオブジェクトのパラメーター
applianceオブジェクトには、以下のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
アプライアンスのUUID | 必須 |
name-description |
アプライアンスの説明文字列 | オプション |
paused |
オプション | |
force |
強制シャットダウン | オプション |
appliance-assert-can-be-recovered
xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
この仮想アプライアンス/vAppを回復するためのストレージが使用可能かどうかをテストします。
appliance-create
xe appliance-create name-label=name-label [name-description=name-description]
仮想アプライアンス/vAppを作成します。たとえば、次のようになります:
xe appliance-create name-label=my_appliance
アプライアンスに仮想マシンを追加します。
xe vm-param-set uuid=VM-UUID appliance=appliance-uuid
appliance-destroy
xe appliance-destroy uuid=appliance-uuid
仮想アプライアンス/vAppを破棄します。たとえば、次のようになります:
xe appliance-destroy uuid=appliance-uuid
appliance-recover
xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [paused=true|false]
指定したVDIのデータベースから仮想アプライアンス/vAppを回復します。
appliance-shutdown
xe appliance-shutdown uuid=appliance-uuid [force=true|false]
仮想アプライアンス/vAppのすべての仮想マシンをシャットダウンします。たとえば、次のようになります:
xe appliance-shutdown uuid=appliance-uuid
appliance-start
xe appliance-start uuid=appliance-uuid [paused=true|false]
仮想アプライアンス/vAppを起動します。たとえば、次のようになります:
xe appliance-start uuid=appliance-uuid
監査コマンド
リソースプールのRBAC監査ファイルのすべての記録をファイルとしてダウンロードします。オプションのsince
パラメーターを指定すると、その日時以降の記録のみがダウンロードされます。
audit-log-get
パラメーター
audit-log-get
には次のパラメーターがあります
パラメーター名 | 説明 | 種類 |
---|---|---|
filename |
プールの監査ログをfilenameで指定するファイルに書き込みます | 必須 |
since |
特定の日時以降の記録のみをダウンロードします | オプション |
audit-log-get
xe audit-log-get [since=timestamp] filename=filename
指定した日時(ミリ秒単位)以降の監査ログをダウンロードします。
次のコマンドを実行します:
xe audit-log-get since=2009-09-24T17:56:20.530Z filename=/tmp/auditlog-pool-actions.out
ボンディングコマンド
物理インターフェイスのフェイルオーバーによる障害許容力のために、ネットワークボンドを操作します。詳しくは、「ネットワーク“を参照してください。
bondオブジェクトは、masterとmemberのPIFを結合する参照オブジェクトです。master PIFは、bondオブジェクトを参照するために総体的なPIFとして使用されるボンディングインターフェイスです。member PIFは、2つ以上の物理インターフェイスのセットであり、高レベルのボンディングインターフェイスとして結束されています。
bondオブジェクトのパラメーター
bondオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
ボンディングの一意の識別子/オブジェクト参照 | 読み取り専用 |
master |
ボンドマスタPIFのUUID | 読み取り専用 |
members |
ボンディングを構成するPIFのUUIDのセット | 読み取り専用 |
bond-create
xe bond-create network-uuid=network_uuid pif-uuids=pif_uuid_1,pif_uuid_2,...
既存のPIFオブジェクトをリストで指定して、指定したネットワーク上にボンディングネットワークインターフェイスを作成します。コマンドは、次のいずれかの場合に失敗します:
- PIFが既に別のボンドにある場合
- いずれかのメンバーにVLANタグが設定されている場合
- 参照されるPIFが同じCitrix Hypervisorサーバーにない場合
- PIFが2個未満の場合
bond-destroy
xe bond-destroy uuid=bond_uuid
UUIDで指定したボンディングインターフェイスをホストから削除します。
bond-set-mode
xe bond-set-mode uuid=bond_uuid mode=bond_mode
ボンディングモードを変更します。
CD(仮想ネットワーク)コマンド
Citrix Hypervisorサーバー上の物理CD/DVDドライブ(cdオブジェクト)を操作します。
cdオブジェクトのパラメーター
cdオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
CDの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
CDの名前 | 読み取り/書き込み |
name-description |
CDの説明文字列 | 読み取り/書き込み |
allowed-operations |
このCD上で実行できる操作のリスト | 読み取り専用のセットパラメーター |
current-operations |
このCD上で現在処理中の操作のリスト | 読み取り専用のセットパラメーター |
sr-uuid |
このCDが属しているストレージリポジトリの一意の識別子/オブジェクト参照 | 読み取り専用 |
sr-name-label |
このCDが属しているストレージリポジトリの名前 | 読み取り専用 |
vbd-uuids |
このCDに接続している仮想マシン上のVBDの一意の識別子のリスト | 読み取り専用のセットパラメーター |
crashdump-uuids |
CDでは使用されません。クラッシュダンプはCDに書き込むことができないため | 読み取り専用のセットパラメーター |
virtual-size |
仮想マシンに表示されたCDのサイズ(バイト数) | 読み取り専用 |
physical-utilisation |
ストレージリポジトリ上でのCDイメージの物理スペース(バイト数) | 読み取り専用 |
type |
CDのユーザーに設定 | 読み取り専用 |
可分享的 |
CDドライブが共有可能かどうか。デフォルトはfalse です。 |
読み取り専用 |
read-only |
CDが読み取り専用かどうか。false の場合は書き込み可能。CDは常にtrueです。 |
読み取り専用 |
storage-lock |
このディスクがストレージレベルでロックされている場合はtrue 。 |
読み取り専用 |
parent |
このCDがチェーンの一部である場合は、親ディスクへの参照 | 読み取り専用 |
missing |
ストレージリポジトリのスキャン操作によりこのCDがディスク上に存在しないと認識された場合値はtrue |
読み取り専用 |
other-config |
CDの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
location |
このデバイスがマウントされているパス | 読み取り専用 |
managed |
デバイスが管理されている場合はtrue |
読み取り専用 |
xenstore-data |
xenstore ツリーに挿入されるべきデータ |
読み取り専用のマップパラメーター |
sm-config |
ストレージマネージャーデバイス設定キーの名前と説明 | 読み取り専用のマップパラメーター |
is-a-snapshot |
このテンプレートがCDスナップショットの場合はtrue |
読み取り専用 |
snapshot_of |
このテンプレートのスナップショット元のCDのUUID | 読み取り専用 |
snapshots |
このCDから作成されたすべてのスナップショットのUUID | 読み取り専用 |
snapshot_time |
スナップショット作成日時 | 読み取り専用 |
cd-list
xe cd-list [params=param1,param2,...] [parameter=parameter_value]
Citrix Hypervisorサーバーまたはプール上のCDとISO(CDイメージファイル)のリストを、オプションの引数params
に基づいてフィルターして出力します。
オプションの引数params
を使用して特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルターする)場合は、そのオブジェクトのパラメーターのリストを含む文字列を値として指定します。または、キーワードall
を指定してすべてのパラメーターのリストを出力することもできます。params
を使用しない場合、使用可能なすべてのパラメーターのうち、デフォルトのサブセットが出力されます。
オプションの引数には,このセクションの冒頭に挙げられている,cdオブジェクトのパラメーターをいくつでも指定できます。
クラスターコマンド
クラスター化されたプールを操作するためのコマンドです。
クラスター化されたプールは、クラスタリング機能が有効になっているリソースプールです。GFS2ストレージリポジトリと共にこれらのプールを使用します。詳しくは、「クラスター化プール“を参照してください。
クラスターオブジェクトとクラスターホストオブジェクトのリストは、標準オブジェクトリストコマンド(xe cluster-list
とxe cluster-host-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。 クラスター化されたプールを操作するためのコマンドです。
クラスターパラメーター
クラスターには次のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
クラスターの一意の識別子/オブジェクト参照 | 読み取り専用 |
cluster-hosts |
クラスター内のホストの一意の識別子/オブジェクト参照のリスト | 読み取り専用のセットパラメーター |
cluster-token |
xapi-clusterd が他のホスト上で自身と通信するときに使用する秘密キー |
読み取り専用 |
cluster-stack |
クラスタリング機能を提供するテクノロジスタック。使用できる値はcorosync です。 |
読み取り専用 |
allowed-operations |
現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でクラスターの状態が変更されている可能性もあります。 | 読み取り専用のセットパラメーター |
current-operations |
現在処理中の操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でクラスターの状態が変更されている可能性もあります。 | 読み取り専用のセットパラメーター |
token-timeout |
corosync トークンのタイムアウト(秒単位) |
読み取り専用 |
token-timeout-coefficient |
corosync トークンのタイムアウト係数(秒単位) |
読み取り専用 |
pool-auto-join |
新しいプールメンバーをクラスターに自動的に参加させる場合はtrue。これはtrue に設定されます。 |
読み取り専用 |
cluster-config |
クラスターの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り専用のマップパラメーター |
other-config |
クラスターの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
cluster-host-create
xe cluster-host-create cluster-uuid=cluster_uuid host-uuid=host_uuid pif-uuid=pif_uuid
既存のクラスターにホストを追加します。
cluster-host-destroy
xe cluster-host-destroy uuid=host_uuid
クラスターホストを破棄して、クラスターを効果的に残します。
cluster-host-disable
xe cluster-host-disable uuid=cluster_uuid
有効なクラスターホストのクラスターメンバーシップを無効にします。
cluster-host-enable
xe cluster-host-enable uuid=cluster_uuid
無効になっているクラスターホストのクラスターメンバーシップを有効にします。
cluster-host-force-destroy
xe cluster-host-force-destroy uuid=cluster_host
クラスターホストオブジェクトを強制的に破棄して、クラスターを効果的に残します。
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]
プール全体のクラスターを作成します。
cluster-pool-destroy
xe cluster-pool-destroy cluster-uuid=cluster_uuid
プール全体のクラスターを破棄します。プールは引き続き存在しますが、クラスター化されなくなり、GFS2ストレージリポジトリを使用できなくなります。
cluster-pool-force-destroy
xe cluster-pool-force-destroy cluster-uuid=cluster_uuid
プール全体のクラスターを強制的に破棄します。
cluster-pool-resync
xe cluster-pool-resync cluster-uuid=cluster_uuid
プール全体でクラスターを再同期します。
コンソールコマンド
コンソール(consoleオブジェクト)を操作します。
コンソールオブジェクトのリストは、標準オブジェクトリストコマンド(xe console-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
consoleオブジェクトのパラメーター
consoleオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
コンソールの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
このコンソールを開いているVMの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
このコンソールを開いているVMの名前 | 読み取り専用 |
protocol |
このコンソールが使用するプロトコル。使用できる値:vt100 :VT100端末、rfb :Remote Framebufferプロトコル(VNCで使用)、またはrdp :リモートデスクトッププロトコル |
読み取り専用 |
location |
このコンソールのサービスのURI | 読み取り専用 |
other-config |
コンソールの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
console
xe console
特定のコンソールに接続します。
診断コマンド
Citrix Hypervisorから診断情報を収集するためのコマンド。
diagnostic-compact
xe diagnostic-compact
主要なGC収集とヒープの圧縮を実行します。
廃止済み:diagnostic-db-log
xe diagnostic-db-log
データベース操作のロギングを開始します。警告:一度起動すると停止できません。
diagnostic-db-stats
xe diagnostic-db-stats
データベース統計を出力します。
diagnostic-gc-stats
xe diagnostic-gc-stats
GC統計を出力します。
diagnostic-license-status
xe diagnostic-license-status
プール全体のライセンス問題を診断するのに役立ちます。
diagnostic-net-stats
xe diagnostic-net-stats [uri=uri] [method=method] [params=param1,param2...]
ネットワーク統計を出力します。
diagnostic-timing-stats
xe diagnostic-timing-stats
タイミング統計を出力する。
diagnostic-vdi-status
xe diagnostic-vdi-status uuid=vdi_uuid
VDIのロックおよび共有状態を照会します。
diagnostic-vm-status
xe diagnostic-vm-status uuid=vm_uuid
VMが起動できるホストを照会し、すべてのVBDの共有/ロック状態を確認します。
障害回復コマンド
障害発生後に仮想マシンを回復するコマンドです。
drtask-create
xe drtask-create type=type sr-whitelist=sr-white-list device-config=device-config
障害回復タスクを作成します。たとえば、障害回復の準備タスクとして特定のiSCSIストレージリポジトリに接続するには、次のコマンドを実行します。
xe drtask-create type=lvmoiscsi device-config:target=target-ip-address \ device-config:targetIQN=targetIQN device-config:SCSIid=SCSIid \ sr-whitelist=sr-uuid-list
注:
コマンド
sr-whitelist
は、許可されるストレージリポジトリUUIDをリストします。drtask-create
コマンドは、許可されたUUIDの1つを持つストレージリポジトリのみを導入して接続します。
drtask-destroy
xe drtask-destroy uuid=dr-task-uuid
障害回復タスクを破棄してストレージリポジトリの接続を消去します。
vm-assert-can-be-recovered
xe vm-assert-can-be-recovered uuid=vm-uuid database:vdi-uuid=vdi-uuid
特定の仮想マシンを回復するためにストレージを使用できるかどうかをテストします。
appliance-assert-can-be-recovered
xe appliance-assert-can-be-recovered uuid=appliance-uuid database:vdi-uuid=vdi-uuid
仮想アプライアンス/vAppディスクを格納しているストレージが使用可能かどうかをチェックします。
appliance-recover
xe appliance-recover uuid=appliance-uuid database:vdi-uuid=vdi-uuid [force=true|false]
指定したVDIのデータベースから仮想アプライアンス/vAppを回復します。
vm-recover
xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid [force=true|false]
指定したVDIのデータベースから仮想マシンを回復します。
sr-enable-database-replication
xe sr-enable-database-replication uuid=sr_uuid
指定した(共有)ストレージリポジトリへのXAPIデータベースの複製を有効にします。
sr-disable-database-replication
xe sr-disable-database-replication uuid=sr_uuid
指定したストレージリポジトリへのXAPIデータベースの複製を無効にします。
使用例
ここでは、障害回復コマンドの使用例を順に挙げます。
プライマリサイトで、データベースの複製を有効にします。
xe sr-database-replication uuid=sr=uuid
障害発生後、セカンダリサイトでストレージリポジトリに接続します。device-config
コマンドにはsr-probe
と同じフィールドがあります。
xe drtask-create type=lvmoiscsi \ device-config:target=target ip address \ device-config:targetIQN=target-iqn \ device-config:SCSIid=scsi-id \ sr-whitelist=sr-uuid
ストレージリポジトリ上のデータベースVDIを見つけます。
xe vdi-list sr-uuid=sr-uuid type=Metadata
データベースVDIから仮想マシンを照会します。
xe vm-list database:vdi-uuid=vdi-uuid
仮想マシンを回復します。
xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid
障害回復タスクを破棄します。このタスクによりイントロデュースされ、かつ仮想マシンで使用されないすべてのストレージリポジトリを破棄します:
xe drtask-destroy uuid=drtask-uuid
イベントコマンド
イベント(eventオブジェクト)を操作します。
eventオブジェクトのクラス
eventオブジェクトには、以下のクラスがあります。
クラス名 | 説明 |
---|---|
pool |
物理ホストのリソースプール |
vm |
仮想マシン |
host |
物理ホスト |
network |
仮想ネットワーク |
vif |
仮想ネットワークインターフェイス |
pif |
物理ネットワークインターフェイス(NICに関連付けられた各VLANは個別のPIFとして表されます) |
sr |
ストレージレポジトリ |
vdi |
仮想ディスクイメージ |
vbd |
仮想ブロックデバイス |
pbd |
ホストがストレージリポジトリへのアクセスに使用する物理ブロックデバイス |
event-wait
xe event-wait class=class_name [param-name=param_value] [param-name=/=param_value]
このコマンドでは、コマンドラインで指定した条件を満たすオブジェクトが存在するようになるまで、ほかのコマンドの実行をブロックします。x=y
は「フィールドxの値がyになるまで待機する」、x=/=y
は、「フィールドxの値がy以外になるまで待機する」を意味します。
例:特定の仮想マシンが実行状態になるまで待機する場合は、次のコマンドを実行します。
xe event-wait class=vm name-label=myvm power-state=running
このコマンドでは、myvm
という名前の仮想マシンのpower-state
が「running」になるまで、ほかのコマンドの実行をブロックします。
例:特定の仮想マシンが再起動するまで待機する場合は、次のコマンドを実行します。
xe event-wait class=vm uuid=$VM start-time=/=$(xe vm-list uuid=$VM params=start-time --minimal)
このコマンドでは、UUIDが$VMの仮想マシンが再起動するまで、ほかのコマンドの実行をブロックします。このコマンドはstart-time
の値で仮想マシンがいつ再起動するかを決定します。
クラス名は、このセクションの冒頭に挙げられている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)には、以下のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
物理GPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
vendor-name |
物理GPUベンダの名前 | 読み取り専用 |
device-name |
ベンダが物理GPUモデルに割り当てた名前 | 読み取り専用 |
gpu-group-uuid |
この物理GPUがCitrix Hypervisorにより自動的に割り当てられたGPUグループの一意の識別子/オブジェクト参照。プール内のすべてのホスト上の同一物理GPUがグループ化されます | 読み取り専用 |
gpu-group-name-label |
この物理GPUが割り当てられたGPUグループの名前 | 読み取り専用 |
host-uuid |
この物理GPUが接続されているCitrix Hypervisorサーバーの一意の識別子/オブジェクト参照 | 読み取り専用 |
host-name-label |
この物理GPUが接続されているCitrix Hypervisorサーバーの名前 | 読み取り専用 |
pci-id |
PCI identifier | 読み取り専用 |
dependencies |
同一仮想マシンにパススルーされる依存PCIデバイスのリスト | 読み取り/書き込み可のマップパラメーター |
other-config |
物理GPUの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
supported-VGPU-types |
ハードウェアでサポートされる仮想GPUの一覧 | 読み取り専用 |
enabled-VGPU-types |
この物理GPUで有効な仮想GPUの一覧 | 読み取り/書き込み |
resident-VGPUs |
この物理GPUで実行中の仮想GPUの一覧 | 読み取り専用 |
pgpu-disable-dom0-access
xe pgpu-disable-dom0-access uuid=uuid
dom0へのPGPUアクセスを無効にします。
pgpu-enable-dom0-access
xe pgpu-enable-dom0-access uuid=uuid
dom0へのPGPUアクセスを有効にします。
gpu-groupオブジェクトのパラメーター
gpu-groupオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
GPUグループの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
GPUグループの名前 | 読み取り/書き込み |
name-description |
GPUグループの説明文字列 | 読み取り/書き込み |
VGPU-uuids |
GPUグループ内の仮想GPUの一意の識別子/オブジェクト参照の一覧 | 読み取り専用のセットパラメーター |
PGPU-uuids |
GPUグループ内の物理GPUの一意の識別子/オブジェクト参照のリスト | 読み取り専用のセットパラメーター |
other-config |
GPUグループの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
supported-VGPU-types |
ハードウェアでサポートされるすべての仮想GPUの一覧 | 読み取り専用 |
enabled-VGPU-types |
物理GPUで有効なすべての仮想GPUの一覧 | 読み取り専用 |
allocation-algorithm |
グループ内の物理GPUに割り当てられた仮想GPUの深さ優先/幅優先設定 | 読み取り/書き込み可の列挙型パラメーター |
GPUグループの操作
GPUグループを操作するコマンド
gpu-group-create
xe gpu-group-create name-label=name_for_group [name-description=description]
物理GPUが移動できる新規(空の)GPUグループを作成します。
gpu-group-destroy
xe gpu-group-destroy uuid=uuid_of_group
GPUグループを破棄します。対象は空のグループのみです。
gpu-group-get-remaining-capacity
xe gpu-group-get-remaining-capacity uuid=uuid_of_group vgpu-type-uuid=uuid_of_vgpu_type
GPUグループでインスタンス化できる、指定した種類の仮想GPUの数を返します。
gpu-group-param-set
xe gpu-group-param-set uuid=uuid_of_group allocation-algorithm=breadth-first|depth-first
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
このGPUグループでサポートされるかまたは有効な種類を返します。
仮想GPUのパラメーター
仮想GPUには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
仮想GPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
この仮想GPUが割り当てられた仮想マシンの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
この仮想GPUが割り当てられた仮想マシンの名前 | 読み取り専用 |
gpu-group-uuid |
この仮想GPUを含んでいるGPUグループの一意の識別子/オブジェクト参照 | 読み取り専用 |
gpu-group-name-label |
この仮想GPUを含んでいるGPUグループの名前 | 読み取り専用 |
currently-attached |
GPUパススルーを使用する仮想マシンが実行中の場合はtrue、そうでない場合はfalse | 読み取り専用 |
other-config |
仮想GPUの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
type-uuid |
この仮想GPUの仮想GPUの種類の一意の識別子/オブジェクト参照 | 読み取り/書き込み可のマップパラメーター |
type-model-name |
仮想GPUに関連付けられているモデル名 | 読み取り専用 |
仮想GPUのパラメーター
注:
GPUベンダーが提供するサポートされるソフトウェアおよびグラフィックカードがないと、GPUパススルーおよび仮想GPUは、ライブマイグレーション、ストレージライブマイグレーションおよび仮想マシンの一時停止で機能しません。つまり、このサポートがなければダウンタイムを回避するために仮想マシンを移行することはできません。NVIDIA vGPUとライブマイグレーション、ストレージライブマイグレーション、および仮想マシンの一時停止との互換性については、「グラフィック“を参照してください。
仮想GPUの種類には、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
仮想GPUの種類の一意の識別子/オブジェクト参照 | 読み取り専用 |
vendor-name |
仮想GPUのベンダー名 | 読み取り専用 |
model-name |
仮想GPUに関連付けられているモデル名 | 読み取り専用 |
freeze-frame |
仮想GPUのフレームバッファーサイズ(バイト数) | 読み取り専用 |
max-heads |
仮想GPUでサポートされるディスプレイの最大数 | 読み取り専用 |
supported-on-PGPUs |
この仮想GPUをサポートする物理GPUの一覧 | 読み取り専用 |
enabled-on-PGPUs |
この仮想GPUが有効な物理GPUの一覧 | 読み取り専用 |
VGPU-uuids |
この種類の仮想GPUの一覧 | 読み取り専用 |
仮想GPUの操作
vgpu-create
xe vgpu-create vm-uuid=uuid_of_vm gpu_group_uuid=uuid_of_gpu_group [vgpu-type-uuid=uuid_of_vgpu-type]
仮想GPUを作成します。仮想マシンを指定したGPUグループに接続し、必要に応じて仮想GPUの種類を指定します。仮想GPUの種類を指定しない場合は、「パススルー」が割り当てられます。
vgpu-destroy
xe vgpu-destroy uuid=uuid_of_vgpu
指定した仮想GPUを破棄します。
仮想GPUを持つ仮想マシンのVNCの無効化
xe vm-param-add uuid=uuid_of_vmparam-name=platform vgpu_vnc_enabled=true|false
false
を指定すると、disablevnc=1
がディスプレイエミュレーターに渡され、仮想マシンのVNCが無効になります。デフォルトでは、VNCは有効になっています。
ホストコマンド
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サーバーには次のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
Citrix Hypervisorサーバーの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
Citrix Hypervisorサーバーの名前 | 読み取り/書き込み |
name-description |
Citrix Hypervisorサーバーの説明文字列 | 読み取り専用 |
enabled |
無効になっている場合はfalse です。これにより、新しい仮想マシンがホスト上で起動するのを防ぎ、ホストのシャットダウンまたは再起動を準備します。ホストが有効な場合はtrue です |
読み取り専用 |
API-version-major |
メジャーバージョン番号 | 読み取り専用 |
API-version-minor |
マイナーバージョン番号 | 読み取り専用 |
API-version-vendor |
APIベンダーのID | 読み取り専用 |
API-version-vendor-implementation |
ベンダー実装の詳細 | 読み取り専用のマップパラメーター |
logging |
ログ設定 | 読み取り/書き込み可のマップパラメーター |
suspend-image-sr-uuid |
一時停止状態のイメージが格納されるストレージリポジトリの一意の識別子/オブジェクトリファレンス | 読み取り/書き込み |
crash-dump-sr-uuid |
クラッシュダンプが格納されるストレージリポジトリの一意の識別子/オブジェクトリファレンス | 読み取り/書き込み |
software-version |
バージョン管理パラメーターとその値のリスト | 読み取り専用のマップパラメーター |
capabilities |
Citrix Hypervisorサーバーを実行できるXenのバージョンのリスト | 読み取り専用のセットパラメーター |
other-config |
Citrix Hypervisorサーバーの構成パラメーターを追加で指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
chipset-info |
チップセットの追加設定パラメーターを指定するキー/値ペアのリスト | 読み取り専用のマップパラメーター |
hostname |
Citrix Hypervisorサーバーのホスト名 | 読み取り専用 |
address |
Citrix HypervisorサーバーのIPアドレス | 読み取り専用 |
license-server |
ライセンスサーバーの情報を指定するキー/値ペアのリスト。Citrix製品との通信では、デフォルトでポート27000が使用されます。競合が原因でポート番号を変更する場合の手順について詳しくは、「ポート番号の変更“を参照してください。 | 読み取り専用のマップパラメーター |
supported-bootloaders |
Citrix Hypervisorサーバーがサポートするブートローダーの一覧。pygrub 、eliloader など |
読み取り専用のセットパラメーター |
memory-total |
Citrix Hypervisorサーバー上の物理RAMの量(バイト数) | 読み取り専用 |
memory-free |
仮想マシンに割り当てることのできる物理RAMの残量(バイト数) | 読み取り専用 |
host-metrics-live |
このホストが動作可能の場合はtrue | 読み取り専用 |
logging |
syslog_destination キーでリモートのsyslogサービスのホスト名を設定。 |
読み取り/書き込み可のマップパラメーター |
allowed-operations |
現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もあります。 | 読み取り専用のセットパラメーター |
current-operations |
現在処理中の操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もあります。 | 読み取り専用のセットパラメーター |
patches |
ホストに対するパッチのセット | 読み取り専用のセットパラメーター |
blobs |
バイナリデータストア | 読み取り専用 |
memory-free-computed |
ホスト上の空きメモリ量(少なく見積もった量) | 読み取り専用 |
ha-statefiles |
高可用性ステートファイルのUUID | 読み取り専用 |
ha-network-peers |
障害発生時にこのホスト上の仮想マシンを実行できるホストのUUID | 読み取り専用 |
external-auth-type |
外部認証の種類(Active Directoryなど) | 読み取り専用 |
external-auth-service-name |
外部認証サービスの名前 | 読み取り専用 |
external-auth-configuration |
外部認証サービスの構成情報 | 読み取り専用のマップパラメーター |
Citrix Hypervisorサーバーには、パラメーターリストを持つ以下のオブジェクトも含まれています。
Citrix HypervisorサーバーのCPU(中央処理装置)には、次のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
CPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
number |
Citrix Hypervisorサーバー内の物理CPUコアの数 | 読み取り専用 |
vendor |
CPU名のベンダー文字列 | 読み取り専用 |
speed |
CPUのクロック速度(Hz数) | 読み取り専用 |
modelname |
CPUモデルのベンダー文字列。たとえば 「Intel(R) Xeon(TM) CPU 3.00 GHz」 | 読み取り専用 |
stepping |
CPUのリビジョン番号 | 読み取り専用 |
flags |
物理CPUのフラグ(featuresフィールドのデコード版) | 読み取り専用 |
Utilisation |
現在のCPU使用率 | 読み取り専用 |
host-uuid |
このCPUが動作するホストのUUID | 読み取り専用 |
model |
物理CPUのモデル番号 | 読み取り専用 |
family |
物理CPUのファミリ番号 | 読み取り専用 |
Citrix Hypervisorサーバーのクラッシュダンプ(crashdumpオブジェクト)には、以下のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
クラッシュダンプの一意の識別子/オブジェクト参照 | 読み取り専用 |
host |
クラッシュダンプが対応するCitrix Hypervisorサーバー | 読み取り専用 |
timestamp |
クラッシュダンプの日時。形式はyyyymmdd-hhmmss-ABC (ここでABCはGMTなどのタイムゾーンインジケーター) |
読み取り専用 |
size |
クラッシュダンプのサイズ(バイト数) | 読み取り専用 |
host-all-editions
xe host-all-editions
利用可能なすべてのエディションのリストを取得します
host-apply-edition
xe host-apply-edition [host-uuid=host_uuid] [edition=xenserver_edition="free" "per-socket" "xendesktop"]
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
このコマンドでは、指定したCitrix Hypervisorサーバーのコントロールドメインのバックアップを、コマンドの実行元マシンにダウンロードし、文件名称
のファイル名で保存します。
重要:
xe host-backup
コマンドは、ローカルホスト上(つまり特定のホスト名を指定せずに)実行しても機能しますが、そのように使用しないでください。これを行うと、コントロールドメインのパーティションに大きなバックアップファイルが作成され、空きディスク容量が足りなくなります。このコマンドは、バックアップファイルを保持できるディスク領域があるリモートコンピューターからのみ使用してください。
host-bugreport-upload
xe host-bugreport-upload [host-selector=host_selector_value...] [url=destination_url http-proxy=http_proxy_name]
このコマンドでは、新しいバグレポート(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]
オプションの引数を指定して、指定されたホスト上のプラグイン内の関数を呼び出します。
host-compute-free-memory
xe host-compute-free-memory
ホスト上の空きメモリの量を計算します。
host-compute-memory-overhead
xe host-compute-memory-overhead
ホストの仮想化メモリオーバーヘッドを計算します。
host-cpu-info
xe host-cpu-info [uuid=uuid]
ホストの物理CPUに関する情報を一覧表示します。
host-crashdump-destroy
xe host-crashdump-destroy uuid=crashdump_uuid
このコマンドでは、UUIDで指定したクラッシュダンプをCitrix Hypervisorサーバーから削除します。
host-crashdump-upload
xe host-crashdump-upload uuid=crashdump_uuid [url=destination_url] [http-proxy=http_proxy_name]
このコマンドでは、クラッシュダンプをサポートFTPサイトなどにアップロードします。これらのオプションパラメーターを使用しない場合、プロキシサーバーは特定されず、デフォルトのサポートFTPサイトにアップロードされます。オプションのパラメーターは、http-proxy
:使用するHTTPプロキシを指定する、およびurl
:アップロード先を指定するURLです。
host-declare-dead
xe host-declare-dead uuid=host_uuid
ホストが明示的に通信しておらず使用不可であることを宣言します。
警告:
この呼び出しは危険で、ホストが実際には使用可能な場合はデータを失う可能性があります。
host-disable
xe host-disable [host-selector=host_selector_value...]
このコマンドでは、指定したCitrix Hypervisorサーバーが無効になり、新しい仮想マシンがそのサーバー上で起動しなくなります。これにより、そのCitrix Hypervisorサーバーがシャットダウンまたは再起動できる状態になります。
このコマンドの対象ホストを指定するには、「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-disable-display
xe host-disable-display uuid=host_uuid
ホストの表示を無効にします。
host-disable-local-storage-caching
xe host-disable-local-storage-caching
指定されたホスト上のローカルストレージキャッシュを無効にします。
host-dmesg
xe host-dmesg [host-selector=host_selector_value...]
このコマンドでは、指定したCitrix HypervisorサーバーからXendmesg
(カーネルリングバッファーの出力)を取得します。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-emergency-ha-disable
xe host-emergency-ha-disable [--force]
ローカルホスト上の高可用性を無効にします。破損した高可用性セットアップでプールを回復するためにのみ使用されます。
host-emergency-management-reconfigure
xe host-emergency-management-reconfigure interface=uuid_of_management_interface_pif
このコマンドでは、このCitrix Hypervisorサーバーの管理インターフェイスを設定し直します。このコマンドは、Citrix Hypervisorサーバーが緊急モードの場合のみ使用します。緊急モードとは、あるリソースプール内のメンバーであるホストが、そのプールマスターへの接続を切断され、何度再試行しても接続できないことを意味します。
host-emergency-reset-server-certificate
xe host-emergency-reset-server-certificate
コマンドを実行するCitrix Hypervisorサーバーに、自己署名証明書をインストールします。
host-enable
xe host-enable [host-selector=host_selector_value...]
このコマンドでは、指定したCitrix Hypervisorサーバーが有効になり、新しい仮想マシンがそのサーバー上で起動可能になります。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-enable-display
xe host-enable-display uuid=host_uuid
ホストの表示を有効にします。
host-enable-local-storage-caching
xe host-enable-local-storage-caching sr-uuid=sr_uuid
指定されたホスト上のローカルストレージキャッシュを有効にします。
host-evacuate
xe host-evacuate [host-selector=host_selector_value...]
このコマンドでは、指定したホスト上で実行されているすべての仮想マシンを、リソースプール内のほかの適切なホストに移行(ライブマイグレーション)します。最初に、host-disable
コマンドを使用してホストを無効にします。
退避されたホストがプールマスターの場合、別のホストをプールマスターとして選択する必要があります。高可用性機能が無効なリソースプールでプールマスターを変更するには、pool-designate-new-master
コマンドを使用します。詳しくは、pool-designate-new-masterを参照してください。
高可用性機能が有効な場合は、そのホストをシャットダウンすれば、高可用性機能により任意のホストがプールマスターとして選出されます。詳しくは、host-shutdownを参照してください。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-forget
xe host-forget uuid=host_uuid
このコマンドでは、指定したCitrix HypervisorサーバーがXAPIエージェントから削除されて、その結果リソースプールから除外されます。
--force
パラメーターを使用すると、確認のメッセージが表示されなくなります。
警告:
リソースプールの高可用性を有効にしたまま、このコマンドを使用しないでください。ホストを除外するには、事前に高可用性を無効にしておき、このコマンドを実行した後で高可用性を有効にします。
このコマンドは、「除外する」Citrix Hypervisorサーバーが使用不可の場合に役立ちます。ただし、Citrix Hypervisorサーバーが使用可能でプールの一部である場合は、代わりにxe池-eject
を使用します。
host-get-cpu-features
xe host-get-cpu-features {features=pool_master_cpu_features} [uuid=host_uuid]
ホストの物理CPUの機能を示す16進数値を出力します。
host-get-server-certificate
xe host-get-server-certificate
インストールされているサーバーのTLS証明書を取得します。
host-get-sm-diagnostics
xe host-get-sm-diagnostics uuid=uuid
ホストごとの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...]
指定したファイルにシステム状態の情報をダウンロードします。オプションのパラメーター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...]
このコマンドでは、指定したホストのシステム状態の情報を取得します。機能は、次の例のようなXMLフラグメントとして返されます:
content-type="text/plain"default-checked="yes"key="xenserver-logs"\max-size="150425200"max-time="-1"min-size="150425200"min-time="-1"\pii="maybe"/>content-type="text/plain"default-checked="yes"\key="xenserver-install"max-size="51200"max-time="-1"min-size="10240"\min-time="-1"pii="maybe"/>...
各機能エンティティは、以下の属性を有することができます。
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
ホストごとのスレッド診断情報を表示します。
host-get-vms-which-prevent-evacuation
xe host-get-vms-which-prevent-evacuation uuid=uuid
特定のホストの退避を妨げる仮想マシンのリストを返し、それぞれの理由を表示します。
host-is-in-emergency-mode
xe host-is-in-emergency-mode
このホストが緊急モードで動作しているかどうかを識別します。緊急モードの場合はtrue
が出力され、それ以外はfalse
が出力されます。このCLIコマンドは、マスターサーバーが存在しない場合でも、プールメンバーサーバーで直接機能します。
host-license-add
xe host-license-add [license-file=path/license_filename] [host-uuid=host_uuid]
無償版のCitrix Hypervisorで、ローカルのライセンスファイルを解析して、指定したCitrix Hypervisorサーバーにそのライセンスを追加します。
host-license-remove
xe host-license-remove [host-uuid=host_uuid]
ホストに適用されているライセンスを削除します。
host-license-view
xe host-license-view [host-uuid=host_uuid]
Citrix Hypervisorサーバーのライセンスの内容を表示します。
host-logs-download
xe host-logs-download [file-name=logfile_name] [host-selector=host_selector_value...]
このコマンドでは、指定したCitrix Hypervisorサーバーのログのコピーをダウンロードします。ログのコピーは、デフォルトで作成日時が記録されたhostname-yyyy-mm-dd T hh:mm:ssZ.tar.gz
という形式のファイル名で保存されます。オプションのパラメーター文件名称を使用して、別のファイル名を指定できます。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
重要:
xe host-logs-download
コマンドは、ローカルホスト上(つまり特定のホスト名を指定せずに)実行しても機能しますが、そのように使用しないでください。これを行うと、コントロールドメインのパーティションにログのコピーファイルが作成されてしまいます。このコマンドは、ログのコピーファイルを保持できるディスク領域があるリモートコンピューターからのみ使用してください。
host-management-disable
xe host-management-disable
このコマンドでは、外部の管理ネットワークインターフェイス上のホストエージェントを無効にして、接続しているすべてのAPIクライアント(XenCenterなど)を切断します。このコマンドは、CLIが接続されているCitrix Hypervisorサーバーで直接操作します。Citrix Hypervisorサーバーのメンバーに適用された場合、コマンドはプールマスターに転送されません。
警告:
このCLIコマンドをリモートのホストに対して使用する場合は注意してください。このコマンドを実行すると、ネットワークを介してリモートでコントロールドメインに接続して、ホストエージェントを再度有効にすることができなくなります。
host-management-reconfigure
xe host-management-reconfigure [interface=device] [pif-uuid=uuid]
このコマンドでは、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]
このコマンドでは、ホストの電源投入機能が有効なCitrix Hypervisorサーバーの電源を投入します。このコマンドを使用する前に、対象のホストでhost-set-power-on
を有効にします。
host-reboot
xe host-reboot [host-selector=host_selector_value...]
指定された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...]
このコマンドでは、文件名称
で指定した、Citrix Hypervisorサーバーコントロールソフトウェアのバックアップを復元します。このコマンドでの「復元」は通常の完全な復元ではなく、圧縮されたバックアップファイルがセカンダリパーティションに展開されるだけです。xe host-restore
を実行した後は、インストールCDから起動して、[バックアップから復元]を選択する必要があります。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-send-debug-keys
xe host-send-debug-keys host-uuid=host_uuid keys=keys
指定されたハイパーバイザーデバッグキーを、指定されたホストに送信します。
host-server-certificate-install
xe host-server-certificate-install证书=帕特h_to_certificate_file private-key=path_to_private_key [certificate-chain=path_to_chain_file] [host=host_name | uuid=host_uuid]
Citrix HypervisorサーバーにTLS証明書をインストールします。
host-set-hostname-live
xe host-set-hostname-live host-uuid=uuid_of_host host-name=new_hostname
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 ]
電源管理ソリューションと互換性のある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...]
このコマンドでは、指定した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]
このコマンドは、ホスト上のストレージデータパスの破棄およびクリーンアップを試みます。完全にシャットダウンできない場合でも、allow-leak=true
によってデータパスの記録をすべて削除します。
host-sync-data
xe host-sync-data
プールマスターに格納されているデータを、指定されたホストと同期させます(これには、データベースデータは含まれません)。
host-syslog-reconfigure
xe host-syslog-reconfigure [host-selector=host_selector_value...]
このコマンドは、指定したCitrix Hypervisorサーバー上のsyslog
デーモンを再設定します。これにより、ホストのlogging
パラメーターで定義されている設定情報が適用されます。
このコマンドの対象ホストを指定するには、上記の「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。
host-data-source-list
xe host-data-source-list [host-selectors=host selector value...]
ホストで記録可能なデータソースのリストを出力します。
このコマンドの対象ホストを指定するには、「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...]
ホストで、指定したデータソースを記録します。
これにより、ホストの永続的なパフォーマンスメトリクスデータベースにデータソースからの情報が書き込まれます。このデータベースは、パフォーマンス上の理由から、通常のエージェントデータベースとは区別されます。
このコマンドの対象ホストを指定するには、「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。
host-data-source-forget
xe host-data-source-forget data-source=name_description_of_data_source [host-selectors=host_selector_value...]
ホストのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。
このコマンドの対象ホストを指定するには、「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。
host-data-source-query
xe host-data-source-query data-source=name_description_of_data_source [host-selectors=host_selector_value...]
ホストで、指定したデータソースを表示します。
このコマンドの対象ホストを指定するには、「hostオブジェクトセレクター」で説明されている標準的な方法を使用します。オプションの引数には、「hostオブジェクトのパラメーター」から任意の数を指定できます。ホストを選択するパラメーターを指定しない場合、すべてのホストに対してその操作が実行されます。
廃止済み:ログコマンド
ログ(logオブジェクト)を操作します。
廃止済み:log-get
xe log-get
文字列ロガーに現在格納されているログを返します。
廃止済み:log-get-keys
xe log-get-keys
ロガーの既知のキーを一覧表示します。
廃止済み:log-reopen
xe log-reopen
すべてのロガーを再度開きます(ファイルのローテーションに使用します)。
廃止済み:log-set-output
xe log-set-output output=output [key=key] [level=level]
すべてのロガーを指定した出力(nil
、stderr
、string
、file:
filename、syslog:
something)に設定します。
メッセージコマンド
メッセージ(messageオブジェクト)を操作します。messageオブジェクトは、重要なイベントの発生をユーザーに通知するために作成され、XenCenterにアラートとして表示されます。
messageオブジェクトのリストは、標準オブジェクトリストコマンド(xe message-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
messageオブジェクトのパラメーター
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
メッセージの一意の識別子/オブジェクト参照 | 読み取り専用 |
name |
メッセージの一意の名前 | 読み取り専用 |
priority |
メッセージの優先度。数値が大きいほど高い優先度を示します | 読み取り専用 |
class |
メッセージのクラス(VMなど) | 読み取り専用 |
obj-uuid |
影響を受けるオブジェクトのUUID | 読み取り専用 |
timestamp |
メッセージの生成時刻 | 読み取り専用 |
body |
メッセージの内容 | 読み取り専用 |
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]]
メッセージを作成します。
message-destroy
xe message-destroy [uuid=message_uuid]
既存のメッセージを破棄します。スクリプトを作成して、すべてのメッセージを破棄することもできます。たとえば、次のようになります:
# Dismiss all alerts \ IFS=","; for m in $(xe message-list params=uuid --minimal); do \ xe message-destroy uuid=$m \ done
ネットワークコマンド
ネットワーク(networkオブジェクト)を操作します。
networkオブジェクトのリストは、標準オブジェクトリストコマンド(xe network-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
networkオブジェクトのパラメーター
networkオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
ネットワークの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
ネットワークの名前 | 読み取り/書き込み |
name-description |
ネットワークの説明文字列 | 読み取り/書き込み |
VIF-uuids |
仮想マシンからこのネットワークに接続されているVIFの一意の識別子のリスト | 読み取り専用のセットパラメーター |
PIF-uuids |
Citrix Hypervisorサーバーからこのネットワークに接続されているPIF(物理ネットワークインターフェイス)の一意の識別子のリスト | 読み取り専用のセットパラメーター |
bridge |
ローカルCitrix Hypervisorサーバー上のこのネットワークに対応するブリッジの名前 | 読み取り専用 |
default-locking-mode |
ARPフィルターを設定するときにVIFオブジェクトと一緒に使用するネットワークオブジェクト。VIFのすべてのフィルター規則を解除する場合はunlocked 、VIFのすべてのトラフィックをドロップする場合はdisabled 。 |
読み取り/書き込み |
purpose |
Citrix Hypervisorサーバーがこのネットワークを使用する目的のセット。ネットワークを使用してNBD接続を確立するには、nbd に設定します。 |
読み取り/書き込み |
other-config:staticroutes |
subnet/netmask/gateway形式で指定する、サブネットへの通信路のコンマ区切りの一覧。たとえば、other-config:static-routes に172.16.0.0/15/192.168.0.3,172.18.0.0/16/192.168.0.4を指定すると、172.16.0.0/15へのトラフィックが192.168.0.3にルーティングされ、172.18.0.0/16へのトラフィックが192.168.0.4にルーティングされます |
読み取り/書き込み |
other-config:ethtoolautoneg |
物理インターフェイスまたはブリッジの自動ネゴシエーションを無効にする場合はno。デフォルトはyesです。 | 読み取り/書き込み |
other-config:ethtool-rx |
チェックサムの受信を有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-tx |
チェックサムの転送を有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-sg |
Scatter/Gatherを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-tso |
TCPセグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-ufo |
UDPフラグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-gso |
汎用セグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
blobs |
バイナリデータストア | 読み取り専用 |
network-create
xe network-create name-label=name_for_network [name-description=descriptive_text]
ネットワークを作成します。
network-destroy
xe network-destroy uuid=network_uuid
既存のネットワークを破棄します。
SR-IOVコマンド
SR-IOVを操作するコマンドです。
network-sriov
オブジェクトのリストは、標準オブジェクトリストコマンド(xe network-sriov-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
SR-IOVパラメーター
SR-IOVには次のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
physical-PIF |
SR-IOVを有効にするPIF。 | 読み取り専用 |
logical-PIF |
SR-IOV論理PIF。ユーザーはこれをパラメーターとして使用して、SR-IOV VLANネットワークを作成できます。 | 読み取り専用 |
requires-reboot |
Trueに設定すると、ホストを再起動してSR-IOVを有効にするために使用されます。 | 読み取り専用 |
remaining-capacity |
残された使用可能なVFの数。 | 読み取り専用 |
network-sriov-create
xe network-sriov-create network-uuid=network_uuid pif-uuid=physical_pif_uuid
特定の物理PIFに対してSR-IOVネットワークオブジェクトを作成し、物理PIF上でSR-IOVを有効にします。
network-sriov-destroy
xe network-sriov-destroy uuid=network_sriov_uuid
SR-IOVネットワークオブジェクトを削除し、物理PIF上でSR-IOVを無効にします。
SR-IOV VFの割り当て
xe vif-create device=device_index mac=vf_mac_address network-uuid=sriov_network vm-uuid=vm_uuid
SR-IOVネットワークから仮想マシンにVFを割り当てます。
SDNコントローラーコマンド
SDNコントローラー(sdn-controllerオブジェクト)を操作します。
sdn-controller-forget
xe sdn-controller-introduce [address=address] [protocol=protocol] [tcp-port=tcp_port]
SDNコントローラーを導入します。
sdn-controller-introduce
xe sdn-controller-forget uuid=uuid
SDNコントローラーを削除します。
トンネルコマンド
トンネル(tunnelオブジェクト)を操作します。
tunnel-create
xe tunnel-create pif-uuid=pif_uuid network-uuid=network_uuid
ホスト上に新しいトンネルを作成します。
tunnel-destroy
xe tunnel-destroy uuid=uuid
トンネルを破棄します。
パッチコマンド
パッチ(patchオブジェクト)を操作します。
patch-apply
xe patch-apply uuid=patch_uuid host-uuid=host_uuid
以前にアップロードしたパッチを指定されたホストに適用します。
patch-clean
xe patch-clean uuid=uuid
以前にアップロードしたパッチファイルを削除します。
patch-destroy
xe patch-destroy uuid=uuid
適用されていないパッチレコードとファイルをサーバーから削除します。
patch-pool-apply
xe patch-pool-apply uuid=uuid
以前にアップロードしたパッチをプール内のすべてのホストに適用します。
patch-pool-clean
xe patch-pool-clean uuid=uuid
プール内のすべてのホストで以前にアップロードしたパッチファイルを削除します。
patch-precheck
xe patch-precheck uuid=uuid host-uuid=host_uuid
以前アップロードされたパッチに含まれている事前チェックを、指定したホストに対して実行します。
patch-upload
xe patch-upload file-name=file_name
パッチファイルをサーバーにアップロードします。
PBD(物理ブロックデバイス)コマンド
PBD(pbdオブジェクト)を操作します。pbdオブジェクトは、Citrix Hypervisorサーバーがストレージリポジトリへのアクセスに使用するソフトウェアオブジェクトです。
pbdオブジェクトのリストは、標準オブジェクトリストコマンド(xe pbd-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
pbdオブジェクトのパラメーター
pbdオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
PBDの一意の識別子/オブジェクト参照 | 読み取り専用 |
sr-uuid |
PBDの接続先ストレージリポジトリ | 読み取り専用 |
device-config |
ホストのストレージリポジトリバックエンドドライバーに提供される追加構成情報 | 読み取り専用のマップパラメーター |
currently-attached |
ストレージリポジトリがこのホストに接続されている場合はtrue、それ以外はfalse | 読み取り専用 |
host-uuid |
PBDが使用可能になっている物理マシンのUUID | 読み取り専用 |
host |
このパラメーターは廃止。代わりにhost_uuidを使用 | 読み取り専用 |
other-config |
追加の構成情報。 | 読み取り/書き込み可のマップパラメーター |
pbd-create
xe pbd-create host-uuid=uuid_of_host sr-uuid=uuid_of_sr [device-config:key=corresponding_value]
このコマンドでは、Citrix Hypervisorサーバー上にPBDを作成します。読み取り専用のdevice-config
パラメーターは、作成時にのみ設定できます。
‘path’から’/tmp’にマップを追加するには、コマンドでdevice-config:path=/tmp
を指定します。
ストレージリポジトリの各種類でサポートされるdevice-configパラメーターのキー/値ペアについては、「ストレージ“を参照してください。
pbd-destroy
xe pbd-destroy uuid=uuid_of_pbd
指定したPBDを破棄します。
pbd-plug
xe pbd-plug uuid=uuid_of_pbd
このコマンドでは,PBDをCitrix Hypervisorサーバーに接続します。成功すると,参照されているストレージリポジトリ(およびそれに含まれているVDI)がCitrix Hypervisorサーバーからアクセス可能になります。
pbd-unplug
xe pbd-unplug uuid=uuid_of_pbd
このコマンドでは、PBDとCitrix Hypervisorサーバーとの接続を解除します。
PIF(物理ネットワークインターフェイス)コマンド
PIF(pifオブジェクト)を操作します。
pifオブジェクトのリストは、標準オブジェクトリストコマンド(xe pif-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
pifオブジェクトのパラメーター
pifオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
PIFの一意の識別子/オブジェクト参照 | 読み取り専用 |
device machine-readable |
インターフェイス名(eth0など) | 読み取り専用 |
MAC |
PIFのMACアドレス | 読み取り専用 |
other-config |
追加のPIF構成name:value ペア。 |
読み取り/書き込み可のマップパラメーター |
physical |
PIFが実際の物理ネットワークインターフェイスをポイントしている場合はtrue | 読み取り専用 |
currently-attached |
PIFが現在このホストに接続されているかどうか。true またはfalse |
読み取り専用 |
MTU |
PIFのMTU(Maximum Transmission Unit)バイト数。 | 読み取り専用 |
VLAN |
このPIFを通過するすべてのトラフィックのVLANタグ。-1はVLANタグが割り当てられていないことを示す | 読み取り専用 |
bond-master-of |
このPIFがマスターになっているボンディングのUUID(該当する場合) | 読み取り専用 |
bond-slave-of |
このPIFが含まれているボンドのUUID(存在する場合) | 読み取り専用 |
management |
このPIFがコントロールドメインの管理インターフェイスとして指定されているかどうか | 読み取り専用 |
network-uuid |
このPIFが接続されている仮想ネットワークの一意の識別子/オブジェクト参照 | 読み取り専用 |
network-name-label |
このPIFが接続している仮想ネットワークの名前 | 読み取り専用 |
host-uuid |
このPIFが接続しているCitrix Hypervisorサーバーの一意の識別子/オブジェクト参照 | 読み取り専用 |
host-name-label |
このPIFが接続しているCitrix Hypervisorサーバーの名前 | 読み取り専用 |
IP-configuration-mode |
ネットワークアドレス設定の種類、DHCPまたはstatic | 読み取り専用 |
IP |
PIFのIPアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない | 読み取り専用 |
netmask |
PIFのネットマスクアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない | 読み取り専用 |
gateway |
PIFのゲートウェイアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない | 読み取り専用 |
DNS |
PIFのDNSアドレス。IP-configuration-modeがstaticの場合はここで定義し、DHCPの場合は定義しない | 読み取り専用 |
io_read_kbs |
このデバイスの平均読み取り速度(kB/秒) | 読み取り専用 |
io_write_kbs |
このデバイスの平均書き込み速度(kB /秒) | 読み取り専用 |
carrier |
デバイスのリンク状態 | 読み取り専用 |
vendor-id |
NICベンダーに割り当てられたID | 読み取り専用 |
vendor-name |
NICベンダーの名前 | 読み取り専用 |
device-id |
ベンダーがNICモデルに割り当てたID | 読み取り専用 |
device-name |
ベンダーがNICモデルに割り当てた名前 | 読み取り専用 |
speed |
NICのデータ転送レート | 読み取り専用 |
duplex |
NICの二重モード。full(全二重)またはhalf(半二重) | 読み取り専用 |
pci-bus-path |
PCIバスパスのアドレス | 読み取り専用 |
other-config:ethtoolspeed |
接続速度(Mbps)の設定 | 読み取り/書き込み |
other-config:ethtoolautoneg |
物理インターフェイスまたはブリッジの自動ネゴシエーションを無効にする場合はno。デフォルトはyesです。 | 読み取り/書き込み |
other-config:ethtoolduplex |
PIFのデュプレックス機能をフルまたはハーフに設定します。 | 読み取り/書き込み |
other-config:ethtool-rx |
チェックサムの受信を有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-tx |
チェックサムの転送を有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-sg |
Scatter/Gatherを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-tso |
TCPセグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-ufo |
UDPフラグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:ethtool-gso |
汎用セグメンテーションオフロードを有効にする場合はon、無効にする場合はoff | 読み取り/書き込み |
other-config:domain |
DNS検索パスの設定(コンマ区切りの一覧) | 読み取り/書き込み |
other-config:bondmiimon |
リンクの状態チェック間隔(ミリ秒) | 読み取り/書き込み |
other-config:bonddowndelay |
リンクの切断が検出されてから切断リンクとして認識されるまでの待機時間(ミリ秒)。一時的な切断を許容するためのパラメーター | 読み取り/書き込み |
other-config:bondupdelay |
リンクの回復が検出されてから接続リンクとして認識されるまでの待機時間(ミリ秒)。一時的な回復を無視するための設定。指定された時間待機してからトラフィック転送が開始される(デフォルト値は31s )。 |
読み取り/書き込み |
disallow-unplug |
このPIFがストレージ専用NICの場合にtrue、それ以外はfalse | 読み取り/書き込み |
注:
PIFの
other-config
フィールドへの変更は、再起動後に有効になります。または、xe pif-unplug
コマンドとxe pif-plug
コマンドを使用して、PIF設定が再書き込みされるようにすることもできます。
pif-forget
xe pif-forget uuid=uuid_of_pif
特定のホスト上の指定したPIFを破棄します。
pif-introduce
xe pif-introduce host-uuid=host_uuid mac=mac_address_for_pif device=interface_name
指定したCitrix Hypervisorサーバー上の物理インターフェイスを表すpifオブジェクトを作成します。
pif-plug
xe pif-plug uuid=uuid_of_pif
指定した物理インターフェイスを起動します。
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]
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]
PIFのIPv6アドレス設定を再構成します。
pif-scan
xe pif-scan host-uuid=host_uuid
指定したCitrix Hypervisorサーバー上の新規物理インターフェイスを検出します。
pif-set-primary-address-type
xe pif-set-primary-address-type uuid=uuid primary_address_type=address_type
このPIFで使用されるプライマリアドレスの種類を変更します。
pif-unplug
xe pif-unplug uuid=uuid_of_pif
指定した物理インターフェイスを停止します。
プールコマンド
リソースプール(poolオブジェクト)を操作します。プールは、1つまたは複数のCitrix Hypervisorサーバーの集合です。リソースプールでは1つ以上の共有ストレージリポジトリを使用して、プール内のあるホスト上で実行されている仮想マシンを、同じプール内の別のホストにほぼリアルタイムで移行できます。この移行は、仮想マシンをシャットダウンしたり再起動したりすることなく、仮想マシンの起動中に実行されます。デフォルトでは、各Citrix Hypervisorサーバーが、単一メンバーで構成された1つのプールとなります。このプールにほかのCitrix Hypervisorサーバーを追加すると、追加したホストはメンバーホストとして動作し、元のホストがプールマスターになります。
シングルトンプールオブジェクトは、標準的なオブジェクトリストコマンド(xe池-list
)でリストできます。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
poolオブジェクトのパラメーター
poolオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
プールの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
プールの名前 | 読み取り/書き込み |
name-description |
プールの説明文字列 | 読み取り/書き込み |
master |
プールマスターとして動作するCitrix Hypervisorサーバーの一意の識別子/オブジェクト参照 | 読み取り専用 |
default-SR |
プールのデフォルトストレージリポジトリの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
crash-dump-SR |
メンバーホストのクラッシュダンプが格納されるストレージリポジトリの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
metadata-vdis |
プールの既知のメタデータVDI | 読み取り専用 |
suspend-image-SR |
メンバーホスト上でサスペンド状態の仮想マシンが格納されるストレージリポジトリの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
other-config |
プールの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
supported-sr-types |
このプールで使用可能なストレージリポジトリの種類 | 読み取り専用 |
ha-enabled |
プールの高可用性が有効な場合にtrue、それ以外はfalse | 読み取り専用 |
ha-configuration |
将来バージョン用に予約 | 読み取り専用 |
ha-statefiles |
高可用性によりストレージの状態を検出するために使用されるVDIのUUIDリスト | 読み取り専用 |
ha-host-failures-to-tolerate |
システムアラートを送信せずに許容されるホスト障害数(フェイルオーバートレランス数) | 読み取り/書き込み |
ha-plan-exists-for |
高可用性アルゴリズムにより算出される、対応可能なホスト障害数 | 読み取り専用 |
ha-allow-overcommit |
プールがオーバーコミットできる場合はtrue、そうでない場合はfalse | 読み取り/書き込み |
ha-overcommitted |
プールがオーバーコミットされている場合にtrue | 読み取り専用 |
blobs |
バイナリデータストア | 読み取り専用 |
live-patching-disabled |
ライブパッチを有効にするには、falseに設定します。ライブパッチを無効にするには、trueに設定します。 | 読み取り/書き込み |
igmp-snooping-enabled |
IGMPスヌーピングを有効にするには、trueに設定します。IGMPスヌーピングを無効にするには、falseに設定します。 | 読み取り/書き込み |
pool-apply-edition
xe池-apply-edition edition=edition [uuid=uuid] [license-server-address=address] [license-server-port=port]
プール全体にエディションを適用します。
pool-certificate-install
xe池-certificate-install filename=file_name
プール全体にTLS証明書をインストールします。
pool-certificate-list
xe池-certificate-list
プールにインストールされているすべてのTLS証明書をリストします。
pool-certificate-sync
xe池-certificate-sync
TLS証明書と証明書失効リストをプールマスターから他のプールメンバーに同期します。
pool-certificate-uninstall
xe池-certificate-uninstall name=name
TLS証明書をアンインストールします。
pool-crl-install
xe池-crl-install filename=file_name
プール全体にTLS証明書失効一覧をインストールします。
pool-crl-list
xe池-crl-list
インストールされているすべてのTLS証明書失効一覧をリストします。
pool-crl-uninstall
xe池-crl-uninstall name=name
TLS証明書失効一覧をアンインストールします。
pool-deconfigure-wlb
xe池-deconfigure-wlb
ワークロードバランスの設定を完全に削除します。
pool-designate-new-master
xe池-designate-new-master host-uuid=uuid_of_new_master
指定したCitrix Hypervisorサーバー(メンバーホスト)をプールマスターとして動作させます。このコマンドにより、プールマスターの役割をそのプール内の別のホストに正しく移譲できます。このコマンドは、現在のマスターがオンラインの場合にのみ機能します。これは以下に挙げられている緊急モードのコマンドに代わるものではありません。
pool-disable-external-auth
xe池-disable-external-auth [uuid=uuid] [config=config]
プール内のすべてのホストで外部認証を無効にします。
pool-disable-local-storage-caching
xe池-disable-local-storage-caching uuid=uuid
プール全体のローカルストレージキャッシュを無効にします。
pool-disable-redo-log
xe池-disable-redo-log
HAが有効になっていない限り、使用中はredoログを無効にします。
pool-dump-database
xe池-dump-database file-name=filename_to_dump_database_into_(on_client)
プールデータベース全体のコピーをダウンロードして、クライアント上のファイルにバックアップします。
pool-enable-external-auth
xe池-enable-external-auth auth-type=auth_type service-name=service_name [uuid=uuid] [config:=config]
プール内のすべてのホストで外部認証を有効にします。auth-type
の値によっては、特定のconfig:
値が必要になることに注意してください。
pool-enable-local-storage-caching
xe池-enable-local-storage-caching uuid=uuid
プール全体でローカルストレージキャッシュを有効にします。
pool-enable-redo-log
xe池-ensable-redo-log sr-uuid=sr_uuid
HAが有効になっていない限り、使用中は指定されたストレージリポジトリのredoログを有効にします。
pool-eject
xe池-eject host-uuid=uuid_of_host_to_eject
指定したCitrix Hypervisorサーバーを既存のプールから除外します。
pool-emergency-reset-master
xe池-emergency-reset-master master-address=address_of_pool_master
プールメンバーサーバーが使用しているプールマスターサーバーアドレスをリセットして、新しいアドレスのプールマスターに接続します。このコマンドはマスターサーバーでは実行しないでください。
pool-emergency-transition-to-master
xe池-emergency-transition-to-master
任意のCitrix Hypervisorサーバー(メンバーホスト)をプールマスターとして動作させます。Citrix Hypervisorサーバーは、ホストが緊急モードに移行した後にのみ、このコマンドを受け入れます。緊急モードとは、あるプール内のメンバーが、そのプールマスターへの接続を切断され、何度か再試行しても接続できないことを意味します。
ホストがプールに参加してからホストパスワードが変更された場合、このコマンドによってホストのパスワードがリセットされる可能性があります。詳しくは、「ユーザーコマンド“を参照してください。
pool-ha-enable
xe池-ha-enable heartbeat-sr-uuids=uuid_of_heartbeat_sr
指定したストレージリポジトリを中央ストレージハートビートリポジトリとして使用して、リソースプールの高可用性機能を有効にします。
pool-ha-disable
xe池-ha-disable
リソースプールの高可用性機能を無効にします。
pool-ha-compute-hypothetical-max-host-failures-to-tolerate
現在のプール構成で許容されるホスト障害の最大数を計算します。
pool-ha-compute-max-host-failures-to-tolerate
xe池-ha-compute-hypothetical-max-host-failures-to-tolerate [vm-uuid=vm_uuid] [restart-priority=restart_priority]
提供され、提案され、保護された仮想マシンで許容される最大ホスト障害数を計算します。
pool-initialize-wlb
xe池-initialize-wlb wlb_url=url wlb_username=wlb_username wlb_password=wlb_password xenserver_username=username xenserver_password=password
現在のプールのワークロードバランスをターゲットのワークロードバランスサーバーで初期化します。
pool-join
xe池-join master-address=address master-username=username master-password=password
Citrix Hypervisorサーバーを既存のプールに追加します。
pool-management-reconfigure
xe池-management-reconfigure [network-uuid=network-uuid]
このコマンドでは、プール内のすべてのホストで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池-recover-slaves
プールマスターに対して、緊急モードで動作中のすべてのメンバーホストのプールマスーアドレスをリセットさせます。通常、pool-emergency-transition-to-master
でメンバーホストの1つを新しいプールマスターとして設定した後に、このコマンドを使用します。
pool-restore-database
xe池-restore-database file-name=filename_to_restore_from_on_client [dry-run=true|false]
データベースバックアップ(pool-dump-database
で作成)をリソースプールにアップロードします。プールマスターがアップロードを受信すると、新しいデータベースを使用して再起動します。
dry runオプションも用意されており、実際の処理を実行しなくてもプールデータベースが復元可能かどうかを確認できます。dry-run
のデフォルト値はfalseです。
pool-retrieve-wlb-configuration
xe池-retrieve-wlb-configuration
ワークロードバランスサーバーからプール最適化基準を取得します。
pool-retrieve-wlb-diagnostics
xe池-retrieve-wlb-diagnostics [filename=file_name]
ワークロードバランスサーバーから診断を取得します。
pool-retrieve-wlb-recommendations
xe池-retrieve-wlb-recommendations
ワークロードバランスサーバーからプールの仮想マシン移行推奨事項を取得します。
pool-retrieve-wlb-report
xe池-retrieve-wlb-report report=report [filename=file_name]
ワークロードバランスサーバーからレポートを取得します。
pool-rotate-secret
xe池-rotate-secret
プールシークレットを入れ替えます。
プールシークレットは,プール内のサーバー間で共有されるシークレットです。これにより,サーバーはプールに対するメンバーシップを証明できます。プール管理者の役割を持つユーザーは、SSH経由でサーバーに接続するときにこのシークレットを表示できます。こうしたユーザーが組織を離れるか、プール管理者の役割を失った場合は、プールシークレットを入れ替えます。
pool-send-test-post
xe池-send-test-post dest-host=destination_host dest-port=destination_port body=post_body
HTTPSを使用して、指定された本文を指定されたホストおよびポートに送信し、応答を出力します。 これは、TLSレイヤーのデバッグに使用されます。
pool-send-wlb-configuration
xe池-send-wlb-configuration [config:=config]
ワークロードバランスサーバーのプール最適化基準を設定します。
pool-sync-database
xe池-sync-database
プールデータベースを、リソースプールのすべてのホストと強制的に同期します。データベースは定期的に自動複製されるため、このコマンドは通常の操作では不要です。しかしこのコマンドは、重要なCLI操作の実行後、変更が迅速に複製されるようにするのに役立ちます。
プールをigmp-snooping
に設定します
xe池-param-set [uuid=pool-uuid] [igmp-snooping-enabled=true|false]
Citrix HypervisorプールでIGMPスヌーピングを有効または無効にします。
PVSアクセラレータコマンド
PVSアクセラレータを操作するためのコマンド。
pvs-cache-storage-create
xe pvs-cache-storage-create sr-uuid=sr_uuid pvs-site-uuid=pvs_site_uuid size=size
指定されたホストの特定のストレージリポジトリ上にPVSキャッシュを構成します。
pvs-cache-storage-destroy
xe pvs-cache-storage-destroy uuid=uuid
PVSキャッシュを削除します。
pvs-proxy-create
xe pvs-proxy-create pvs-site-uuid=pvs_site_uuid vif-uuid=vif_uuid
PVSプロキシを使用するように仮想マシン/仮想ネットワークインターフェイスを設定します。
pvs-proxy-destroy
xe pvs-proxy-destroy uuid=uuid
この仮想ネットワークインターフェイス/仮想マシンのPVSプロキシを削除(またはスイッチオフ)します。
pvs-server-forget
xe pvs-server-forget uuid=uuid
PVSサーバーを削除します。
pvs-server-introduce
xe pvs-server-introduce addresses=adresses first-port=first_port last-port=last_port pvs-site-uuid=pvs_site_uuid
新しいPVSサーバーを導入します。
pvs-site-forget
xe pvs-site-forget uuid=uuid
PVSサイトを削除します。
pvs-site-introduce
xe pvs-site-introduce name-label=name_label [name-description=name_description] [pvs-uuid=pvs_uuid]
新しいPVSサイトを導入します。
ストレージマネージャコマンド
ストレージマネージャプラグイン(smオブジェクト)を制御します。
ストレージマネージャオブジェクトは、標準的なオブジェクトリストコマンド(xe sm-list
)でリストできます。パラメーターは標準パラメーターコマンドで操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
smオブジェクトのパラメーター
smオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
SMプラグインの一意の識別子/オブジェクトリファレンス | 読み取り専用 |
name-label |
SMプラグインの名前 | 読み取り専用 |
name-description |
SMプラグインの説明文字列 | 読み取り専用 |
type |
このプラグインが接続するストレージリポジトリの種類 | 読み取り専用 |
vendor |
このプラグインを作成したベンダーの名前 | 読み取り専用 |
copyright |
SMプラグインの著作権声明 | 読み取り専用 |
required-api-version |
Citrix Hypervisorサーバーで要求される最低SM APIバージョン | 読み取り専用 |
configuration |
デバイス設定キーの名前と説明 | 読み取り専用 |
capabilities |
SMプラグインの機能 | 読み取り専用 |
driver-filename |
SRドライバーのファイル名。 | 読み取り専用 |
スナップショットコマンド
スナップショットを操作します。
snapshot-clone
xe snapshot-clone new-name-label=name_label [uuid=uuid] [new-name-description=description]
既存のスナップショットを複製し、ストレージレベルの高速ディスククローン処理を行うことで、新しいテンプレートを作成します(サポートされる場合)。
snapshot-copy
xe snapshot-copy new-name-label=name_label [uuid=uuid] [new-name-description=name_description] [sr-uuid=sr_uuid]
通常の方法で既存の仮想マシンを複製して新しいテンプレートを作成します(ストレージレベルの高速ディスククローン処理がサポートされる場合でもそれを使用しません)。複製された仮想マシンのディスクイメージは常に「フルイメージ」 であり、CoWの一部ではありません。
snapshot-destroy
xe snapshot-destroy [uuid=uuid] [snapshot-uuid=snapshot_uuid]
スナップショットを破棄します。そのスナップショットに関連付けられたストレージはそのまま残ります。ストレージも削除するには、snapshot-uninstallを使用します。
snapshot-disk-list
xe snapshot-disk-list [uuid=uuid] [snapshot-uuid=snapshot_uuid] [vbd-params=vbd_params] [vdi-params=vdi_params]
選択した仮想マシン上のディスクを一覧表示します。
snapshot-export-to-template
xe snapshot-export-to-template filename=file_name snapshot-uuid=snapshot_uuid [preserve-power-state=true|false]
スナップショットをファイル名にエクスポートします。
snapshot-reset-powerstate
xe snapshot-reset-powerstate [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
管理ツールスタックデータベースでのみ、仮想マシンの電源を強制的に停止させます。このコマンドは、「一時停止」とマークされたスナップショットを回復するために使用されます。この操作は危険である可能性があります:メモリイメージが不要であることを確認する必要があります。スナップショットを再開できなくなります。
snapshot-revert
xe snapshot-revert [uuid=uuid] [snapshot-uuid=snapshot_uuid]
既存の仮想マシンを以前のチェックポイント状態またはスナップショット状態に戻します。
snapshot-uninstall
xe snapshot-uninstall [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
スナップショットをアンインストールします。この操作により、RWとマークされた、このスナップショットにのみ接続されているVDIを破棄します。VMレコードを単に破棄するには、snapshot-destroyを使用します。
ストレージリポジトリコマンド
ストレージリポジトリ(srオブジェクト)を制御するためのコマンド
srオブジェクトのリストは、標準オブジェクトリストコマンド(xe sr-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
srオブジェクトのパラメーター
srオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
ストレージリポジトリの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
ストレージリポジトリの名前 | 読み取り/書き込み |
name-description |
ストレージリポジトリの説明文字列 | 読み取り/書き込み |
allowed-operations |
現在のSRの状態で可能な操作のリスト | 読み取り専用のセットパラメーター |
current-operations |
このストレージリポジトリ上で現在処理中の操作のリスト | 読み取り専用のセットパラメーター |
VDIs |
このストレージリポジトリ内の仮想ディスクの一意の識別子/オブジェクト参照 | 読み取り専用のセットパラメーター |
PBDs |
このストレージリポジトリに接続されているPBDの一意の識別子/オブジェクト参照 | 読み取り専用のセットパラメーター |
physical-utilisation |
このストレージリポジトリ上で現在使用されている物理スペース(バイト数)。シンプロビジョニングの場合は、物理的な使用量が仮想割り当てより小さくなることがあります | 読み取り専用 |
physical-size |
ストレージリポジトリの総物理サイズ(バイト数) | 読み取り専用 |
type |
ストレージリポジトリの種類。使用するストレージリポジトリバックエンドドライバーを指定するために使用 | 読み取り専用 |
introduced-by |
ストレージリポジトリをイントロデュースしたdrtask (該当する場合) |
読み取り専用 |
content-type |
SRの内容の種類。ISOライブラリをほかのSRから区別するために使用されています。ISOのライブラリを格納するストレージリポジトリのcontent-typeはisoである必要があります。そのほかのストレージリポジトリでは、このパラメーターを空白にするかuserを指定することをお勧めします。 | 読み取り専用 |
shared |
このストレージリポジトリを複数のCitrix Hypervisorサーバーで共有できる場合はtrue。それ以外はfalse | 読み取り/書き込み |
other-config |
ストレージリポジトリの追加構成パラメーターを指定するキー/値ペアのリスト | 読み取り/書き込み可のマップパラメーター |
host |
SRのホスト名 | 読み取り専用 |
virtual-allocation |
このストレージリポジトリの全VDIのvirtual-size値の合計(バイト数) | 読み取り専用 |
sm-config |
SMに依存するデータ | 読み取り専用のマップパラメーター |
blobs |
バイナリデータストア | 読み取り専用 |
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]
ディスク上にストレージリポジトリを作成し、データベースに導入して、このストレージリポジトリを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
ストレージリポジトリのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。
sr-data-source-list
xe sr-data-source-list
ストレージリポジトリで、記録可能なデータソースのリストを出力します。
sr-data-source-query
xe sr-data-source-query data-source=data_source
ストレージリポジトリのデータソースから最後に読み取った値を照会します。
sr-data-source-record
xe sr-data-source-record data-source=data_source
ストレージリポジトリで、指定したデータソースを記録します。
sr-destroy
xe sr-destroy uuid=sr_uuid
Citrix Hypervisorサーバー上の指定されたストレージリポジトリを破棄します。
sr-enable-database-replication
xe sr-enable-database-replication uuid=sr_uuid
指定した(共有)ストレージリポジトリへのXAPIデータベースの複製を有効にします。
sr-disable-database-replication
xe sr-disable-database-replication uuid=sr_uuid
指定したストレージリポジトリへのXAPIデータベースの複製を無効にします。
sr-forget
xe sr-forget uuid=sr_uuid
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
ストレージリポジトリレコードをデータベースに配置するだけです。device-config
を使用してdevice-config:parameter_key=parameter_value
の形式で追加パラメーターを指定します。例:
xe sr-introduce device-config:device=/dev/sdb1
注:
このコマンドは、通常の操作では使用しません。作成後のストレージリポジトリを共有用に再設定する必要のある場合や、さまざまな障害シナリオからの回復に使用できる、高度な操作です。
sr-probe
xe sr-probe type=type [host-uuid=host_uuid] [device-config:config_name=value]
指定したdevice-config
キーに基づいて、バックエンドのスキャンを行います。device-config
で目的のストレージリポジトリバックエンドの設定パラメーターを指定すると、その値に一致するストレージリポジトリのリストが返されます。device-config
で一部のパラメーターのみを指定して特定バックエンドのスキャンを行うと、目的のストレージリポジトリを検出するために指定すべきほかのdevice-config
パラメーターが返されます。スキャン結果は、バックエンドに固有のXMLとして返され、CLIに出力されます。
device-config
パラメーターは、デバイスのtype
によって異なります。さまざまなストレージバックエンド用のパラメーターについて詳しくは、「ストレージ“を参照してください。
sr-probe-ext
xe sr-probe-ext type=type [host-uuid=host_uuid] [device-config:=config] [sm-config:-sm_config]
ストレージプローブを実行します。device-configパラメーターは、device-config:devs=/dev/sdb1などで指定できます。sr-probeとは異なり、このコマンドはすべてのストレージリポジトリの種類に対して人間が判読可能な形式で結果を返します。
sr-scan
xe sr-scan uuid=sr_uuid
ストレージリポジトリのスキャンを強制して、XAPIデータベースを、そのストレージサブストレートに存在するVDIと同期します。
sr-update
xe sr-update uuid=uuid
データベース内のsrオブジェクトのフィールドを更新します。
lvhd-enable-thin-provisioning
xe lvhd-enable-thin-provisioning sr-uuid=sr_uuid initial-allocation=initial_allocation allocation-quantum=allocation_quantum
LVHDストレージリポジトリのシンプロビジョニングを有効にします。
サブジェクトコマンド
サブジェクトを操作します。
session-subject-identifier-list
xe session-subject-identifier-list
外部で認証された既存のすべてのセッションのすべてのユーザーサブジェクトIDのリストを返します。
session-subject-identifier-logout
xe session-subject-identifier-logout subject-identifier=subject_identifier
ユーザーのサブジェクトIDに関連付けられたすべての外部認証セッションをログアウトします。
session-subject-identifier-logout-all
xe session-subject-identifier-logout-all
すべての外部認証セッションをログアウトします。
subject-add
xe subject-add subject-name=subject_name
プールにアクセスできるサブジェクトのリストにサブジェクトを追加します。
subject-remove
xe subject-remove subject-uuid=subject_uuid
プールにアクセスできるサブジェクトのリストからサブジェクトを削除します。
subject-role-add
xe subject-role-add uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
サブジェクトにロールを追加します。
subject-role-remove
xe subject-role-remove uuid=uuid [role-name=role_name] [role-uuid=role_uuid]
サブジェクトからロールを削除します。
secret-create
xe secret-create value=value
シークレットを作成します。
secret-destroy
xe secret-destroy uuid=uuid
シークレットを破棄します。
タスクコマンド
実行時間の長い非同期タスク(taskオブジェクト)を操作します。非同期タスクとは、仮想マシンの起動、停止、一時停止などのタスクを指します。通常、これらのタスクは、要求された操作をまとまって実行するほかのアトミックサブタスクの集合からなります。
taskオブジェクトのリストは、標準オブジェクトリストコマンド(xe task-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
taskオブジェクトのパラメーター
taskオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
タスクの一意の識別子/オブジェクトリファレンス | 読み取り専用 |
name-label |
タスクの名前 | 読み取り専用 |
name-description |
タスクの説明文字列 | 読み取り専用 |
resident-on |
タスクを実行しているホストの一意の識別子/オブジェクトリファレンス | 読み取り専用 |
status |
タスクの現在の状態 | 読み取り専用 |
progress |
タスクが保留中の場合はその処理の推定完了率(0-1)。成功したかどうかに関係なく、完了すると値は1。 | 読み取り専用 |
type |
タスクが正常に完了した場合、このパラメーターにはエンコードされた結果のタイプが含まれる。タイプは、参照が結果フィールドにあるクラスの名前。それ以外の場合、このパラメーターの値は未定義 | 読み取り専用 |
result |
タスクが正常に完了した場合は結果値(Voidまたはオブジェクト参照)。それ以外は未定義 | 読み取り専用 |
error_info |
タスクが失敗した場合はそのタスクに関するエラー文字列。それ以外の場合、このパラメーターの値は未定義 | 読み取り専用 |
allowed_operations |
この状態で可能な操作のリスト | 読み取り専用 |
created |
タスクの作成時刻 | 読み取り専用 |
finished |
タスクが完了(成功または失敗)した時刻。task-statusがpendingの場合、このフィールドの値は意味を持ちません | 読み取り専用 |
subtask_of |
このサブタスクが参照するタスクのUUID | 読み取り専用 |
subtasks |
このタスクのすべてのサブタスクのUUID | 読み取り専用 |
task-cancel
xe task-cancel [uuid=task_uuid]
指定したタスクを取り消して戻します。
テンプレートコマンド
仮想マシンテンプレート(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=
is-a-template=true is-control-domain
(読み取り専用)コントロールドメイン(ドメイン0またはドライバードメイン)の場合にtruepower-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=
vCPUs-params:mask=1,2,3 これにより、このテンプレートから作成した仮想マシンは物理CPUの1、2、および3上でのみ動作します。
また、capおよびweightパラメーターを使用して、仮想CPUの優先度(xen scheduling)を指定できます。たとえば、次のようになります:
xe template-param-set uuid=
VCPUs-params:weight=512 xe template-param-set uuid= VCPUs-params:cap=100 これにより、このテンプレートから作成した仮想マシン(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=
platform:parallel=none HVMゲストのシリアルポートのエミュレーションを無効にするには、次のコマンドを使用します。
xe vm-param-set uuid=
platform:hvm_serial=none HVMゲストのUSBコントローラおよびUSBタブレットデバイスのエミュレーションを無効にするには、次のコマンドを使用します。
xe vm-param-set uuid=
platform:usb=false xe vm-param-set uuid= platform:usb_tablet=false 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
(読み取り専用)このテンプレートから作成した仮想マシンが使用する実メモリ。テンプレートの場合は0VCPUs-number
(読み取り専用)このテンプレートから作成した仮想マシンに割り当てられた仮想CPUの数。テンプレートの場合は0VCPUs-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
(読み取り専用)このテンプレートが仮想マシンスナップショットの場合はtruesnapshot_of
(読み取り専用)このテンプレートのスナップショット元の仮想マシンのUUIDsnapshots
(読み取り専用)このテンプレートから作成されたすべてのスナップショットのUUIDsnapshot_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
指定したテンプレートのコピーを新規のファイル名でエクスポートします。
template-uninstall
xe template-uninstall template-uuid=template_uuid [--force]
カスタムテンプレートをアンインストールします。この操作により、このテンプレートによって「所有」とマークされたVDIが破棄されます。
アップデートコマンド
次のセクションには、Citrix Hypervisorサーバーのアップデートコマンドが含まれています。
アップデートオブジェクトのリストは、標準オブジェクトリストコマンド(xe update-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
アップデートパラメーター
Citrix Hypervisorサーバーのアップデートには次のパラメーターがあります:
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
アップデートの一意の識別子/オブジェクト参照 | 読み取り専用 |
host |
このアップデートが適用されるホストの一覧 | 読み取り専用 |
host-uuid |
照会するCitrix Hypervisorサーバーの一意の識別子 | 読み取り専用 |
name-label |
アップデートの名前 | 読み取り専用 |
name-description |
アップデートの説明文字列 | 読み取り専用 |
applied |
このアップデートが適用されているかどうか。trueまたはfalse | 読み取り専用 |
installation-size |
アップデートのサイズ(バイト数) | 読み取り専用 |
after-apply-guidance |
XAPIツールスタックまたはホストの再起動が必要かどうか | 読み取り専用 |
version |
アップデートのバージョン | 読み取り専用 |
update-upload
xe update-upload file-name=update_filename
指定されたアップデートファイルをCitrix Hypervisorサーバーにアップロードします。このコマンドでアップデートを適用できる状態になります。アップロードに成功すると、アップデートファイルのUUIDが返されます。同じアップデートが既にアップロードされている場合、UPDATE_ALREADY_EXISTS
エラーが返され、これはアップロードされません。
update-precheck
xe update-precheck uuid=update_uuid host-uuid=host_uuid
指定されたアップデートに含まれている事前チェックを、指定されたCitrix Hypervisorサーバーに対して実行します。
update-destroy
xe update-destroy uuid=update_file_uuid
適用されていないアップデートファイルをプールから削除します。ホストに適用できないアップデートファイルの削除に使用できます。
update-apply
xe update-apply host-uuid=host_uuid uuid=update_file_uuid
指定したアップデートファイルを適用します。
update-pool-apply
xe update-pool-apply uuid=update_uuid
指定されたアップデートをプール内のすべてのCitrix Hypervisorサーバーに適用します。
update-introduce
xe update-introduce vdi-uuid=vdi_uuid
更新VDIを導入します。
update-pool-clean
xe update-pool-clean uuid=uuid
プール内のすべてのホストからアップデートファイルを削除します。
ユーザーコマンド
user-password-change
xe user-password-change old=old_password new=new_password
ログインしているユーザーのパスワードを変更します。このコマンドを実行するにはスーパーバイザー権限が必要なため、変更前のパスワードフィールドはチェックされません。
VBD(仮想ブロックデバイス)コマンド
VBD(vbdオブジェクト)を操作します。
vbdオブジェクトは、仮想マシンをVDIに接続するソフトウェアオブジェクトで、仮想ディスクの内容を示します。VBD(vbdオブジェクト)にはVDIを仮想マシンに関連付ける属性(起動の可否、読み取り/書き込みメトリックなど)があります。vdiオブジェクトには仮想ディスクの物理属性に関する情報(ストレージリポジトリの種類、ディスクの共有の可否、メディアが読み取り/書き込み可能か読み取り専用かなど)があります。
vbdオブジェクトのリストは、標準オブジェクトリストコマンド(xe vbd-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
vbdオブジェクトのパラメーター
vbdオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
VBDの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
このVBDが接続されている仮想マシンの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
このVBDが接続されている仮想マシンの名前 | 読み取り専用 |
vdi-uuid |
このVBDがマップされているVDIの一意の識別子/オブジェクト参照 | 読み取り専用 |
vdi-name-label |
このVBDがマップされているVDIの名前 | 読み取り専用 |
empty |
このVBDが空のドライブの場合にtrue |
読み取り専用 |
device |
ゲストから見たデバイス。たとえばhda |
読み取り専用 |
userdevice |
vbd-create のときにdeviceパラメーターによって指定されるデバイス番号。hda の場合は0、hdb の場合は1のようになります |
読み取り/書き込み |
bootable |
このVBDが起動可能な場合にtrue | 読み取り/書き込み |
mode |
VBDのマウントに使用すべきモード | 読み取り/書き込み |
type |
仮想マシンにVBDが表示される方法。ディスクやCDなどです | 読み取り/書き込み |
currently-attached |
VBDがこのホストに接続されている場合はtrue。それ以外はfalse | 読み取り専用 |
storage-lock |
ストレージレベルのロックが取得された場合はtrue | 読み取り専用 |
status-code |
最後の接続操作に関連するエラー/成功コード | 読み取り専用 |
status-detail |
最後の接続操作の状態に関連するエラー/成功コード | 読み取り専用 |
qos_algorithm_type |
使用するQoSアルゴリズム | 読み取り/書き込み |
qos_algorithm_params |
選択したQoSアルゴリズムのパラメーター | 読み取り/書き込み可のマップパラメーター |
qos_supported_algorithms |
このVBDでサポートされるQoSアルゴリズム | 読み取り専用のセットパラメーター |
io_read_kbs |
このVBDの平均読み取り速度(kB/秒) | 読み取り専用 |
io_write_kbs |
このVBDの平均書き込み速度(kB/秒) | 読み取り専用 |
allowed-operations |
現在の状態で可能な操作のリスト。このリストは参考用で、クライアントがこのフィールドを読み取る時点でサーバーの状態が変更されている可能性もありあます | 読み取り専用のセットパラメーター |
current-operations |
実行中の各タスクのリンク。タスクの性質を表すcurrent_operation enumに対して、このオブジェクトを参照して使用する。 | 読み取り専用のセットパラメーター |
unpluggable |
このVBDがホットアンプラグをサポートする場合はtrue | 読み取り/書き込み |
attachable |
デバイスが接続できる場合はtrue | 読み取り専用 |
other-config |
追加の構成 | 読み取り/書き込み可のマップパラメーター |
vbd-create
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]
仮想マシン上に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
指定したVBDを破棄します。
そのVBDのother-config:owner
パラメーターがtrue
の場合、関連付けられているVDIも破棄されます。
vbd-eject
xe vbd-eject uuid=uuid_of_vbd
指定したVBDのドライブからメディアを取り除きます。このコマンドが機能するのは、メディアの種類が取り外し可能(物理CDまたはISO)な場合のみです。それ以外の場合は、エラーメッセージVBD_NOT_REMOVABLE_MEDIA
が返されます。
vbd-insert
xe vbd-insert uuid=uuid_of_vbd vdi-uuid=uuid_of_vdi_containing_media
指定したVBDのドライブに新しいメディアを挿入します。このコマンドが機能するのは、メディアの種類が取り外し可能(物理CDまたはISO)な場合のみです。それ以外の場合は、エラーメッセージVBD_NOT_REMOVABLE_MEDIA
が返されます。
vbd-plug
xe vbd-plug uuid=uuid_of_vbd
仮想マシンが実行状態のときにVBDの接続を試みます。
vbd-unplug
xe vbd-unplug uuid=uuid_of_vbd
仮想マシンが実行状態のときにVBDの接続解除を試みます。
VDI(仮想ディスクイメージ)コマンド
VDI(vdiオブジェクト)を操作します。
vdiオブジェクトはソフトウェアオブジェクトで、仮想マシンに表示される仮想ディスクの内容を示します。これは、仮想マシンをVDIに結び付けるオブジェクトであるvbdオブジェクトとは異なります。vdiオブジェクトには仮想ディスクの物理属性に関する情報(ストレージリポジトリの種類、ディスクの共有の可否、メディアが読み取り/書き込み可能か読み取り専用かなど)があります。VBD(vbdオブジェクト)にはVDIを仮想マシンに関連付ける属性(起動の可否、読み取り/書き込みメトリックなど)があります。
vdiオブジェクトのリストは、標準オブジェクトリストコマンド(xe vdi-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
vdiオブジェクトのパラメーター
vdiオブジェクトには、以下のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
uuid |
VDIの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
VDIの名前 | 読み取り/書き込み |
name-description |
VDIの説明文字列 | 読み取り/書き込み |
allowed-operations |
この状態で可能な操作のリスト | 読み取り専用のセットパラメーター |
current-operations |
このVDIで現在処理中の操作のリスト | 読み取り専用のセットパラメーター |
sr-uuid |
VDIを格納するストレージリポジトリ | 読み取り専用 |
vbd-uuids |
このVDIを参照するVBDのリスト | 読み取り専用のセットパラメーター |
crashdump-uuids |
このVDIを参照するクラッシュダンプのリスト | 読み取り専用のセットパラメーター |
virtual-size |
仮想マシンで表示されるディスクのサイズ(バイト数)。ストレージバックエンドの種類によっては、正確に表示されない場合があります | 読み取り専用 |
physical-utilisation |
ストレージリポジトリ上でのVDIの物理スペース(バイト数) | 読み取り専用 |
type |
VDIの種類。たとえばSystemまたはUser | 読み取り専用 |
可分享的 |
VDIが共有可能な場合はtrue | 読み取り専用 |
read-only |
VDIを読み取り専用のみでマウントする場合はtrue | 読み取り専用 |
storage-lock |
VDIがストレージレベルでロックされている場合は真的 | 読み取り専用 |
parent |
VDIがチェーンの一部である場合は、親VDIへの参照 | 読み取り専用 |
missing |
ストレージリポジトリのスキャン操作によりこのVDIがディスク上に存在しないと認識された場合はtrue | 読み取り専用 |
other-config |
VDIの追加構成情報 | 読み取り/書き込み可のマップパラメーター |
sr-name-label |
ストレージリポジトリの名前 | 読み取り専用 |
location |
場所情報 | 読み取り専用 |
managed |
VDIが管理されている場合はtrue | 読み取り専用 |
xenstore-data |
VDIの接続後、xenstore ツリー(/local/domain/0/backend/ vbd/domid/device-id/smdata)に挿入するデータ。SMのバックエンドは通常、このフィールドをvdi_attach に設定します。 |
読み取り専用のマップパラメーター |
sm-config |
SMに依存するデータ | 読み取り専用のマップパラメーター |
is-a-snapshot |
このVDIが仮想マシンストレージスナップショットの場合はtrue | 読み取り専用 |
snapshot_of |
このVDIのスナップショット元のストレージのUUID | 読み取り専用 |
snapshots |
このVDIのすべてのスナップショットのUUID | 読み取り専用 |
snapshot_time |
このVDIを作成したスナップショット操作の日時 | 読み取り専用 |
metadata-of-pool |
このVDIを作成したプールのUUID | 読み取り専用 |
metadata-latest |
VDIがプールの最新のメタデータを含んでいることを示すフラグ | 読み取り専用 |
cbt-enabled |
変更ブロック追跡がVDIで有効になっていことを示すフラグ | 読み取り/書き込み |
vdi-clone
xe vdi-clone uuid=uuid_of_the_vdi [driver-params:key=value]
直接使用できる、指定されたVDIの書き込み可能なコピーを新規作成します。このコマンドがサポートされる場合、vdi-copy
よりも高速にイメージを複製できます。
オプションのdriver-params
マップパラメーターを使用して、VDIの基盤となるバックエンドストレージドライバーに追加のベンダー固有の構成情報を渡します。詳しくは、ストレージベンダードライバーのドキュメントを参照してください。
vdi-copy
xe vdi-copy uuid=uuid_of_the_vdi sr-uuid=uuid_of_the_destination_sr
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
VDIを作成します。
virtual-size
パラメーターは、バイト単位またはIEC標準のKiB、MiB、GiB、およびTiBを使用して指定できます。
注:
ディスクのシンプロビジョニングをサポートする種類のストレージリポジトリ(ローカルVHDやNFS)では、ディスクの仮想割り当てが強制されません。このため、ストレージリポジトリ上で仮想ディスクを過剰に割り当てる場合には注意が必要です。過剰に割り当てたストレージリポジトリに空き領域がなくなった場合、そのターゲットサブストレートを使うか、またはそのストレージリポジトリ上の不要なVDIを削除して、ディスク領域を確保する必要があります。
ストレージリポジトリの種類によっては、設定したブロックサイズで分割できるように
virtual-size
の値が切り上げられる可能性があります。
vdi-data-destroy
xe vdi-data-destroy uuid=uuid_of_vdi
指定されたVDIに関連付けられたデータを破棄しますが、変更ブロック追跡のメタデータは保持します。
注:
VDIの増分バックアップを作成するために変更ブロック追跡を使用する場合、スナップショットを削除しながらメタデータを保持するには、
vdi-data-destroy
コマンドを使用するようにしてください。変更ブロック追跡が有効になったVDIのスナップショットでvdi-destroy
を使用しないでください。
vdi-destroy
xe vdi-destroy uuid=uuid_of_vdi
指定した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
VDIの変更ブロック追跡を無効にします。
vdi-enable-cbt
xe vdi-enable-cbt uuid=uuid_of_vdi
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]
指定したファイル名に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
ストレージからVDIを削除せずに、データベースからVDIレコードだけを削除します。通常は、vdi-destroy
を使用します。
vdi-import
xe vdi-import uuid=uuid_of_vdi filename=filename_to_import_from [format=format] [--progress]
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]
ストレージを実際に変更したり作成したりせずに、既存のストレージデバイスのvdiオブジェクトを作成します。このコマンドは、ホットプラグされたストレージデバイスを自動的にイントロデュースするために、主に内部で使用されます。
vdi-list-changed-blocks
xe vdi-list-changed-blocks vdi-from-uuid=first-vdi-uuid vdi-to-uuid=second-vdi-uuid
2つのVDIを比較し、変更されたブロックの一覧をBASE64でエンコードされた文字列として返します。このコマンドは、変更ブロック追跡を有効にしたVDIに対してのみ機能します。
詳しくは、「変更ブロック追跡“を参照してください。
vdi-pool-migrate
xe vdi-pool-migrate uuid=VDI_uuid sr-uuid=destination-sr-uuid
VDIを指定したストレージリポジトリに移行し、VDIを実行中のゲストに接続します。(ストレージライブマイグレーション)
詳しくは、「仮想マシンの移行」参照してください。
vdi-resize
xe vdi-resize uuid=vdi_uuid disk-size=new_size_for_disk
UUIDで指定したVDIのサイズを変更します。
vdi-snapshot
xe vdi-snapshot uuid=uuid_of_the_vdi [driver-params=params]
バックアップまたはテンプレートの作成時、またはその両方の作成時に参照できる、読み書き可能なVDIを作成します。バックアップを行う場合、仮想マシン内でバックアップソフトウェアをインストールして実行する代わりに、スナップショットを使ってバックアップを作成できます。仮想マシンの外部でバックアップソフトウェアがスナップショットの内容をバックアップメディアに保存している間も、仮想マシンを停止する必要はありません。同様に、スナップショットはテンプレートの基になる「ゴールドイメージ」として使用することもできます。テンプレートは、いずれのVDIからも作成できます。
オプションのdriver-params
マップパラメーターを使用して、VDIの基盤となるバックエンドストレージドライバーに追加のベンダー固有の構成情報を渡します。詳しくは、ストレージベンダードライバーのドキュメントを参照してください。
スナップショットの複製は、常に書き込み可能なVDIを作成します。
vdi-unlock
xe vdi-unlock uuid=uuid_of_vdi_to_unlock [force=true]
指定したVDIのロック解除を試みます。force=true
を指定すると、強制的にロックを解除します。
vdi-update
xe vdi-update uuid=uuid
データベース内のvdiオブジェクトのフィールドを更新します。
VIF(仮想ネットワークインターフェイス)コマンド
VIF(vifオブジェクト)を操作します。
vifオブジェクトのリストは、標準オブジェクトリストコマンド(xe vif-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
vifオブジェクトのパラメーター
vifオブジェクトには、以下のパラメーターがあります。
uuid
(読み取り専用)VIFの一意の識別子/オブジェクト参照vm-uuid
(読み取り専用)このVIFが存在する仮想マシンの一意の識別子/オブジェクト参照vm-name-label
(読み取り専用)VIFが存在する仮想マシンの名前allowed-operations
(読み取り専用の設定パラメーター)この状態で可能な操作のリストcurrent-operations
(読み取り専用の設定パラメーター)このVIFで現在処理中の操作のリストdevice
(読み取り専用)VIFバックエンドの作成順を示す、VIFの整数ラベルMAC
(読み取り専用)仮想マシンに提供される、VIFのMACアドレスMTU
(読み取り専用)VIFのMTU(Maximum Transmission Unit)バイト数。このパラメーターは読み取り専用ですが、
other-config
マップパラメーターのmtu
キーでこのMTU設定よりも優先される値を指定できます。たとえば、ジャンボフレームを使用するように仮想NICのMTUをリセットするには、次のようにします:xe vif-param-set \ uuid=
\ other-config:mtu=9000 currently-attached
(読み取り専用)デバイスが接続されている場合はtrueqos_algorithm_type
(読み取り/書き込み)使用するQoSアルゴリズムqos_algorithm_params
(読み取り/書き込みマップパラメーター)選択したQoSアルゴリズムのパラメーターqos_supported_algorithms
(読み取り専用の設定パラメーター)このVIFでサポートされるQoSアルゴリズムMAC-autogenerated
(読み取り専用)VIFのMACアドレスが自動生成の場合にtrueother-config
(読み取り/書き込みマップパラメーター)追加構成のkey:value
ペアother-config:ethtoolrx
(読み取り/書き込み)チェックサムの受信を有効にする場合はon、無効にする場合はoffother-config:ethtooltx
(読み取り/書き込み)チェックサムの転送を有効にする場合はon、無効にする場合はoffother-config:ethtoolsg
(読み取り/書き込み)Scatter/Gatherを有効にする場合はon、無効にする場合はoffother-config:ethtooltso
(読み取り/書き込み)TCPセグメンテーションオフロードを有効にする場合はon、無効にする場合はoffother-config:ethtoolufo
(読み取り/書き込み)UDPフラグメンテーションオフロードを有効にする場合はon、無効にする場合はoffother-config:ethtoolgso
(読み取り/書き込み)汎用セグメンテーションオフロードを有効にする場合はon、無効にする場合はoffother-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]
仮想マシンに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
VIFを破棄します。
vif-move
xe vif-move uuid=uuid network-uuid=network_uuid
VIFを別のネットワークに移動します。
vif-plug
xe vif-plug uuid=uuid_of_vif
仮想マシンが実行状態のときにVIFの接続を試みます。
vif-unplug
xe vif-unplug uuid=uuid_of_vif
仮想マシンが実行状態のときにVIFの接続解除を試みます。
vif-configure-ipv4
この仮想インターフェイスでIPv4設定を構成します。以下のように、IPv4設定を設定します。
xe vif-configure-ipv4 uuid=uuid_of_vif mode=static address=CIDR_address gateway=gateway_address
たとえば、次のようになります:
VIF.configure_ipv4(vifObject,"static", " 192.168.1.10/24", " 192.168.1.1")
以下のように、IPv4設定を削除します。
xe vif-configure-ipv4 uuid=uuid_of_vif mode=none
vif-configure-ipv6
この仮想インターフェイスでIPv6設定を構成します。以下のように、IPv6設定を設定します。
xe vif-configure-ipv6 uuid=uuid_of_vif mode=static address=IP_address gateway=gateway_address
たとえば、次のようになります:
VIF.configure_ipv6(vifObject,"static", "fd06:7768:b9e5:8b00::5001/64", "fd06:7768:b9e5:8b00::1")
以下のように、IPv6設定を削除します。
xe vif-configure-ipv6 uuid=uuid_of_vif mode=none
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
Citrix Hypervisorサーバー上にVLANを作成します。
pool-vlan-create
xe池-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
リソースプール内のすべてのホストについて、指定されたネットワークが接続されているインターフェイス(eth0
など)を識別し、新しいPIFオブジェクトを作成およびプラグして、VLANを作成します。
vlan-destroy
xe vlan-destroy uuid=uuid_of_pif_mapped_to_vlan
VLANを破棄します。VLANにマップされたPIFのUUIDを指定する必要があります。
仮想マシンコマンド
仮想マシン(vmオブジェクト)とその属性を操作します。
vmオブジェクトセレクタ
ここで説明する多くのコマンドでは、以下の標準的な方法で1つまたは複数の仮想マシンを操作対象として指定します。最も簡単な方法は、引数vm=name_or_uuid
の指定です。実際の仮想マシンのUUIDを取得する簡単な方法は、たとえば、xe vm-list power-state=running
の実行です。(指定できるフィールドの一覧を取得するには、コマンドxe vm-list params=all
を使用します)。たとえば、power-state=halted
を指定することで仮想マシンを選択します。その仮想マシンのpower-state
パラメーターはhalted
と同等です。複数の仮想マシンがフィルター条件に一致し、そのすべてのオブジェクトに対してコマンドを実行する場合は、オプション--multiple
を指定します。指定できるすべてのパラメーターの一覧は、次の表のとおりです。
vmオブジェクトのリストは、標準オブジェクトリストコマンド(xe vm-list
)を使用して出力でき、パラメーターは標準パラメーターコマンドを使用して操作できます。詳しくは、「低レベルパラメーターコマンド“を参照してください。
vmオブジェクトのパラメーター
vmオブジェクトには、以下のパラメーターがあります。
注:
書き込み可能なvmパラメーターの値は、対象の仮想マシンが実行中であっても変更できます。ただし、その変更は動的には適用されず、仮想マシンを再起動するまで反映されません。
appliance
(読み取り/書き込み)仮想マシンを含んでいる仮想アプライアンス/vAppuuid
(読み取り専用)仮想マシンの一意の識別子/オブジェクト参照name-label
(読み取り/書き込み)仮想マシンの名前name-description
(読み取り/書き込み)仮想マシンの説明文字列order start order
(読み取り/書き込み)vAppの起動/シャットダウン時や高可用性での仮想マシンの起動順序version
(読み取り専用)この仮想マシンが復元された回数。新しい仮想マシンを古いバージョンで上書きする場合は、vm-recover
を呼び出しますuser-version
(読み取り/書き込み)バージョン情報に含める、仮想マシンおよびテンプレートの作成者用の文字列is-a-template
(読み取り/書き込み)この仮想マシンがテンプレートでない場合はfalse。テンプレート仮想マシンは起動できないものであり、複製して仮想マシンを作成するためのものです。この値をtrueに設定すると、その後falseにリセットすることはできません。テンプレート仮想マシンは、このパラメーターを使用して仮想マシンに変換することはできません。次のコマンドで仮想マシンをテンプレートに変換できます。
xe vm-param-set uuid=
is-a-template=true is-control-domain
(読み取り専用)コントロールドメイン(ドメイン0またはドライバードメイン)の場合にtruepower-state
(読み取り専用)現在の電源状態start-delay
(読み取り/書き込み)仮想マシンの起動コールが返るまでの待機時間shutdown-delay
(読み取り/書き込み)仮想マシンのシャットダウンコールが返るまでの待機時間memory-dynamic-max
(読み取り/書き込み)動的最大メモリ量(バイト数)memory-dynamic-min
(読み取り/書き込み)動的最小メモリ量(バイト数)memory-static-max
(読み取り/書き込み)静的設定(絶対)最大値(バイト数)。この値を変更する場合は、仮想マシンをシャットダウンする必要があります。memory-static-min
(読み取り/書き込み)静的設定(絶対)最小値(バイト数)。この値を変更する場合は、仮想マシンをシャットダウンする必要があります。suspend-VDI-uuid
(読み取り専用)一時停止イメージを格納するVDIVCPUs-params
(読み取り/書き込みマップパラメーター)選択したvCPUポリシーの構成パラメーター。次のコマンドで、使用するvCPUを指定できます
xe vm-param-set uuid=
VCPUs-params:mask=1,2,3 これにより、この仮想マシンは物理CPUの1、2、および3上でのみ動作します。 また、capおよびweightパラメーターを使用して、仮想CPUの優先度(xen scheduling)を指定できます。たとえば、次のようになります:
xe vm-param-set uuid=
VCPUs-params:weight=512 xe vm-param-set uuid= VCPUs-params:cap=100 これにより、この仮想マシン(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=
platform:acpi_laptop_slate=0 VDAを有効にしてWindows 10をタブレットモードに切り替えるには:
xe vm-param-set uuid=
platform:acpi_laptop_slate=1 現在の状態を確認するには:
xe vm-param-get uuid=
param-name=platform param-key=acpi_laptop_slate allowed-operations
(読み取り専用の設定パラメーター)この状態で可能な操作のリストcurrent-operations
(読み取り専用の設定パラメーター)仮想マシン上で現在処理中の操作のリストallowed-VBD-devices
(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVBD識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます(ただし機能しない場合があります)。allowed-VIF-devices
(読み取り専用の設定パラメーター)0~15の整数で表した使用可能なVIF識別子のリスト。このリストは参考情報であり、他のデバイスを使用することもできます(ただし機能しない場合があります)。HVM-boot-policy
(読み取り/書き込み)HVMゲストの起動ポリシー。BIOSの順序または空の文字列のいずれかです。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
を含む場合、その仮想マシンはホストの起動時に自動的に開始されます。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
(読み取り専用)この仮想マシンがスナップショットの場合はtruesnapshot_of
(読み取り専用)このスナップショット元の仮想マシンのUUIDsnapshots
(読み取り専用)この仮想マシンのすべてのスナップショットのUUIDsnapshot_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
特定の仮想マシンを回復するためにストレージを使用できるかどうかをテストします。
vm-call-plugin
xe vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]
オプションの引数(args:key=value)を指定して、指定された仮想マシン上のプラグイン内の関数を呼び出します。特殊文字(たとえば改行)を含む「value」文字列を渡すには、構文args:key:file=local_fileを代わりに使用して、local_fileの内容を取得し、全体として「key」に割り当てます。
vm-cd-add
xe vm-cd-add cd-name=name_of_new_cd device=integer_value_of_an_available_vbd [vm-selector=vm_selector_value...]
選択した仮想マシンに新しい仮想CDを追加します。device
パラメーターは、仮想マシンのallowed-VBD-devices
パラメーターの値から選択する必要があります。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-cd-eject
xe vm-cd-eject [vm-selector=vm_selector_value...]
仮想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...]
仮想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...]
指定した仮想マシンに接続されているCDのリストを出力します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
対象のVBDパラメーターとVDIパラメーターも指定できます。
vm-cd-remove
xe vm-cd-remove cd-name=name_of_cd [vm-selector=vm_selector_value...]
指定した仮想マシンから仮想CDを削除します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-checkpoint
xe vm-checkpoint new-name-label=name_label [new-name-description=description]
ストレージレベルの高速ディスクスナップショット処理により、既存の仮想マシンをチェックポイントします(サポートされる場合)。
vm-clone
xe vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]
既存の仮想マシンを複製し、ストレージレベルの高速ディスククローン処理を行います(サポートされる場合)。new-name-label
引数とnew-name-description
引数を使用して、複製後の仮想マシンの名前と説明(オプション)を指定します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-compute-maximum-memory
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...]
物理RAMの合計量を上限値として、既存の仮想マシンに割り当てることが可能な静的メモリの最大量を計算します。オプションのパラメーターapproximate
を使用すると、仮想マシンに仮想CPUを後から追加する場合を考慮して、十分な量の余分なメモリを予約できます。
たとえば、次のようになります:
xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`
このコマンドでは、xe host-list
が返したmemory-free
パラメーターの値を使用して、仮想マシンtestvm
の最大メモリ量を設定します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-compute-memory-overhead
xe vm-compute-memory-overhead
仮想マシンの仮想化メモリオーバーヘッドを計算します。
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...]
通常の方法で既存の仮想マシンを複製します(ストレージレベルの高速ディスククローン処理がサポートされる場合でもそれを使用しません)。複製された仮想マシンのディスクイメージは常にフルイメージであり、コピーオンライト(CoW)の一部ではありません。
new-name-label
引数とnew-name-description
引数を使用して、複製後の仮想マシンの名前と説明(オプション)を指定します。
sr-uuid
では、複製後の仮想マシンを格納するストレージリポジトリを指定します。このパラメーターを指定しない場合、元の仮想マシンと同じストレージリポジトリに格納されます。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-copy-bios-strings
xe vm-copy-bios-strings host-uuid=host_uuid
指定されたホストのBIOS文字列を仮想マシンにコピーします。
注:
仮想マシンを初めて起動するとき、起動したあとにそのBIOS文字列を変更することはできません。初めての場合は仮想マシンを起動する前に、BIOS文字列が正しいことを確認してください。
vm-crashdump-list
xe vm-crashdump-list [vm-selector=vm selector value...]
指定した仮想マシンに関するクラッシュダンプのリストを出力します。
オプションの引数params
を使用して特定のパラメーター値を持つオブジェクトだけを出力する(つまりリストをフィルターする)場合は、そのオブジェクトのパラメーターのリストを含む文字列を値として指定します。または、キーワードall
を指定してすべてのパラメーターのリストを出力することもできます。params
を使用しない場合、使用可能なすべてのパラメーターのうち、デフォルトのサブセットが出力されます。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-data-source-list
xe vm-data-source-list [vm-selector=vm selector value...]
仮想マシンで、記録可能なデータソースのリストを出力します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。
データソースには、パラメーターとしてstandard
およびenabled
があり、このコマンドの出力で確認できます。データソースのenabled
パラメーターがtrue
の場合、そのデータソースのメトリクス情報がパフォーマンスデータベースに記録中であることを示します。standard
パラメーターがtrue
のデータソースでは、デフォルトでメトリクス情報がパフォーマンスデータベースに記録されます(enabled
パラメーターにtrue
が設定されます)。データソースのstandard
パラメーターがfalse
の場合、そのデータソースのメトリクス情報がパフォーマンスデータベースにデフォルトで記録されないことを示します(enabled
パラメーターにfalse
が設定されます)。
データソースメトリクスのパフォーマンスデータベースへの記録を開始するには、vm-data-source-record
コマンドを実行します。このコマンドは、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...]
仮想マシンで、指定したデータソースを記録します。
これにより、仮想マシンの永続的なパフォーマンスメトリクスデータベースにデータソースからの情報が書き込まれます。このデータベースは、パフォーマンス上の理由から、通常のエージェントデータベースとは区別されます。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。
vm-data-source-forget
xe vm-data-source-forget data-source=name_description_of_data-source [vm-selector=vm selector value...]
仮想マシンのデータソースを指定して記録を停止して、記録済みのすべてのデータを消去します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。
vm-data-source-query
xe vm-data-source-query data-source=name_description_of_data-source [vm-selector=vm_selector_value...]
仮想マシンで、指定したデータソースを表示します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。ホストを選択するパラメーターを指定しない場合、すべての仮想マシンに対してその操作が実行されます。
vm-destroy
xe vm-destroy uuid=uuid_of_vm
指定した仮想マシンを破棄します。その仮想マシンに関連付けられたストレージはそのまま残ります。ストレージも削除するには、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...]
指定した仮想マシンにディスクを追加します。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...]
指定した仮想マシンに接続されているディスクのリストを出力します。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...]
指定した仮想マシンからディスクを削除して、そのディスクを破棄します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-export
xe vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]
指定された仮想マシン(ディスクイメージを含む)を、ローカルマシン上のファイルにエクスポートします。仮想マシンのエクスポート先のファイル名を、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]
以前にエクスポートしたファイルから仮想マシンをインポートします。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]
テンプレートから仮想マシンをインストールまたは複製します。template-uuid
引数またはtemplate
引数のいずれかを使用して、テンプレート名を指定します。sr-uuid
引数またはsr-name-label
引数のいずれかを使用して、ストレージリポジトリを指定 します。BIOSで特定ホスト用にロックされたメディアからインストールする場合は、copy-bios-strings-from
引数を指定します。
注:
既存のディスクを持つテンプレートからインストールする場合は、デフォルトでそのディスクと同じストレージリポジトリ上に新しいディスクが作成されます。ストレージリポジトリがサポートする場合は、これらのディスクの高速複製が実行されます。ほかのストレージリポジトリをコマンドで指定した場合は、新しいディスクがそのストレージリポジトリ上に作成されます。この場合、高速複製は不可能であり、完全コピーが実行されます。
既存のディスクを持たないテンプレートからのインストールでは、指定したストレージリポジトリ、またはプールのデフォルトストレージリポジトリ(ストレージリポジトリを指定しない場合)上に新しいディスクが作成されます。
vm-is-bios-customized
xe vm-is-bios-customized
仮想マシンのBIOS文字列がカスタマイズされているかどうかを示します。
vm-memory-balloon
xe vm-memory-balloon target=target
実行中の仮想マシンのメモリターゲットを設定します。指定された値は、仮想マシンのmemory_dynamic_minの値およびmemory_dynamic_maxの値で定義された範囲内でなければなりません。
vm-memory-dynamic-range-set
xe vm-memory-dynamic-range-set min=min max=max
仮想マシンのダイナミックメモリ範囲を設定します。ダイナミックメモリ範囲は、仮想マシンのメモリのソフト下限と上限を定義します。仮想マシンが実行中または停止中にこれらのフィールドを変更することは可能です。ダイナミックレンジは静的範囲内に収まる必要があります。
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
仮想マシンのメモリ制限を構成します。
vm-memory-set
xe vm-memory-set memory=memory
仮想マシンのメモリ割り当てを設定します。
vm-memory-shadow-multiplier-set
xe vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]
指定した仮想マシンのシャドウメモリ乗数を設定します。
これは、ハードウェア支援型仮想マシンに割り当てられるシャドウメモリの量を変更するための高度なオプションです。
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
仮想マシンの静的メモリ範囲を設定します。静的メモリ範囲は、仮想マシンのメモリのハード下限と上限を定義します。仮想マシンの停止中にのみ、これらのフィールドを変更できます。ダイナミックレンジは静的範囲内に収まる必要があります。
vm-memory-target-set
xe vm-memory-target-set target=target
停止中または実行中の仮想マシンのメモリターゲットを設定します。指定された値は、仮想マシンのmemory_static_minの値およびmemory_static_maxの値で定義された範囲内でなければなりません。
vm-memory-target-wait
xe vm-memory-target-wait
実行中の仮想マシンが現在のメモリターゲットに達するまで待機します。
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:=vif_uuid] [vdi=vdi_uuid]
このコマンドでは、指定した仮想マシンを物理ホスト間で移行します。host
パラメーターには、Citrix Hypervisorサーバーの名前かUUIDを指定できます。たとえば、2つのホストが共有しているストレージに仮想マシンのディスクがあるプール内でその別のホストに仮想マシンを移行するには、次のコマンドを実行します:
xe vm-migrate uuid=vm_uuid host-uuid=host_uuid
ストレージを共有していない同一プール内のホスト間で仮想マシンを移動する(ストレージライブマイグレーション)には、次のコマンドを実行します:
xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78 \ remote-username=username remote-password=password \ host-uuid=desination_host_uuid vdi=vdi_uuid
各VDIが格納されているストレージリポジトリは、次のようにして選択できます。
xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \ vdi1:vdi_1_uuid=destination_sr_uuid \ vdi2:vdi_2_uuid=destination_sr2_uuid \ vdi3:vdi_3_uuid=destination_sr3_uuid
また、移行後に仮想マシンに接続するネットワークは、次のようにして選択できます。
xe vm-migrate uuid=vm_uuid \ vdi1:vdi_1_uuid=destination_sr_uuid \ vdi2:vdi_2_uuid=destination_sr2_uuid \ vdi3:vdi_3_uuid=destination_sr3_uuid \ vif:vif_uuid=network_uuid
プール間の移行の場合は、次のコマンドを実行します。
xe vm-migrate uuid=vm_uuid remote-master=12.34.56.78 remote-username=username remote-password=password \ host-uuid=desination_host_uuid vdi=vdi_uuid
ストレージライブマイグレーション、ライブマイグレーション、ライブVDIマイグレーションの詳細については、「[仮想マシンの移行]」を参照してください(/en-us/citrix-hypervisor/vms/migrate.html)。
注:
7.1 CU2から8.2 CU1にアップグレードする場合は、仮想マシンの移行後にすべての仮想マシンをシャットダウンして起動し、新しい仮想化機能が確実に反映されるようにする必要があります。
デフォルトでは、仮想マシンが一時停止し、移行後に別のホスト上で再開します。live
パラメーターは、ライブマイグレーションを選択します。ライブマイグレーションは仮想マシンを実行したまま移行できます。したがって、このときの仮想マシンのダウンタイムは1秒未満です。仮想マシンでメモリ負荷の高い処理を実行中など、状況によってはライブマイグレーション機能が無効になります。この場合、仮想マシンを一時停止してからメモリ転送が行われます。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-pause
xe vm-pause
実行中のVMを一時停止します。この操作では、関連するメモリは解放されません(vm-suspend
を参照)。
vm-query-services
xe vm-query-services
特定のVMによって提供されるシステムサービスを照会します。
vm-reboot
xe vm-reboot [vm-selector=vm_selector_value...] [force=true]
指定した仮想マシンを再起動します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
強制的な再起動を引き起こすには、force
引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。
vm-recover
xe vm-recover vm-uuid [database] [vdi-uuid] [force]
指定したVDIのデータベースから仮想マシンを回復します。
vm-reset-powerstate
xe vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
これは、プール内のメンバーホストがダウンしたときのみに使用する、高度なコマンドです。このコマンドを使用して、仮想マシンの電源状態を強制的にhalted
としてプールマスターに認識させます。基本的に、このコマンドにより仮想マシンとそのディスクが強制的にロックされるため、その仮想マシンをプール内の別のホスト上で起動できます。このコマンドではforce引数の指定が必須で、これを指定しないと失敗します。
vm-resume
xe vm-resume [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid]
指定した仮想マシンを再開します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、起動するプールメンバーをon
引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。
vm-retrieve-wlb-recommendations
xe vm-retrieve-wlb-recommendations
選択された仮想マシンのワークロードバランス推奨事項を取得します。
vm-shutdown
xe vm-shutdown [vm-selector=vm_selector_value...] [force=true|false]
指定した仮想マシンをシャットダウンします。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
仮想マシンを強制的にシャットダウンするには、force
引数を使用します。これは、物理サーバーの電源ケーブルをコンセントから抜くことに相当する操作です。
vm-snapshot
xe vm-snapshot new-name-label=name_label [new-name-description+name_description]
ストレージレベルの高速ディスクスナップショット処理により、既存の仮想マシンをスナップショットします(サポートされる場合)。
vm-start
xe vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]
指定した仮想マシンを起動します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
仮想マシンがリソースプールの共有ストレージリポジトリ上にある場合は、その仮想マシンを起動するプールメンバーをon
引数で指定します。デフォルトでは、システムにより適切な任意のホストが決定されます。
vm-suspend
xe vm-suspend [vm-selector=vm_selector_value...]
指定した仮想マシンをサスペンドします。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-uninstall
xe vm-uninstall [vm-selector=vm_selector_value...] [force=true|false]
仮想マシンをアンインストールし、そのディスク(RWとマークされ、この仮想マシンにのみ接続されているVDI)とそのメタデータレコードを破棄します。仮想マシンのメタデータだけを破棄するには、xe vm-destroy
を使用します。
このコマンドの対象仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「vmオブジェクトセレクター“を参照してください。オプションの引数には、このセクションの冒頭に挙げられている、vmオブジェクトのパラメーターをいくつでも指定できます。
vm-unpause
xe vm-unpause
一時停止した仮想マシンの一時停止を解除します。
vm-vcpu-hotplug
xe vm-vcpu-hotplug new-vcpus=new_vcpu_count [vm-selector=vm_selector_value...]
実行中のLinux仮想マシンで使用可能なvCPUの数を動的に調整します。vCPUの数は、パラメーターVCPUs-max
によって制限されます。Windows仮想マシンの場合、常にVCPUs-max
に設定された数の仮想CPUを使用します。この値を変更した場合、仮想マシンの再起動が必要です。
このコマンドの対象Linux仮想マシンを指定するには、標準的な方法を使用します。詳しくは、「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...]
指定した仮想マシンの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
プールのスナップショットスケジュールを作成。
たとえば、次のようになります:
xe vmss-create retained-snapshots=9 enabled=true frequency=daily \ name-description=sample name-label=samplepolicy type=snapshot \ schedule:hour=10 schedule:min=30
スナップショットスケジュールには次のパラメーターがあります。
パラメーター名 | 説明 | 種類 |
---|---|---|
name-label |
スナップショットスケジュールの名前。 | 読み取り/書き込み |
name-description |
スナップショットスケジュールの説明。 | 読み取り/書き込み |
type |
ディスクスナップショットまたはメモリスナップショット。 | 読み取り/書き込み |
frequency |
毎時、毎日、毎週 | 読み取り/書き込み |
retained-snapshots |
保持するスナップショット範囲:1~10。 | 読み取り/書き込み |
schedule |
schedule:days (月曜日〜日曜日)、schedule:hours (0〜23)、schedule:minutes (0、15、30、45) |
読み取り/書き込み |
vmss-destroy
xe vmss-destroy uuid=uuid
プールのスナップショットスケジュールを破棄。
USBパススルー
USBパススルーは、USBバージョン1.1、2.0、および3.0でサポートされています。
USBパススルーの有効化/無効化
xe pusb-param-set uuid=pusb_uuid passthrough-enabled=true/false
USBパススルーを有効/無効にします。
pusb-scan
xe pusb-scan host-uuid=host_uuid
PUSBをスキャンして更新します。
vusb-create
xe vusb-create usb-group-uuid=usb_group_uuid vm-uuid=vm_uuid
プールに仮想USBを作成します。仮想マシンを起動して、USBを仮想マシンにパススルーします。
vusb-unplug
xe vusb-unplug uuid=vusb_uuid
仮想マシンからUSBを接続解除します。
vusb-destroy
xe vusb-destroy uuid=vusb_uuid
仮想マシンから仮想USB一覧を削除します。
この記事の概要
- xe CLIのインストール
- xeコマンドのヘルプの表示
- 基本構文
- 特殊文字と構文
- コマンドの種類
- シークレット
- コマンド履歴
- xeコマンドリファレンス
- アプライアンスコマンド
- 監査コマンド
- ボンディングコマンド
- CD(仮想ネットワーク)コマンド
- クラスターコマンド
- コンソールコマンド
- 診断コマンド
- 障害回復コマンド
- イベントコマンド
- GPUコマンド
- ホストコマンド
- 廃止済み:ログコマンド
- メッセージコマンド
- ネットワークコマンド
- SDNコントローラーコマンド
- トンネルコマンド
- パッチコマンド
- PBD(物理ブロックデバイス)コマンド
- PIF(物理ネットワークインターフェイス)コマンド
- プールコマンド
- PVSアクセラレータコマンド
- ストレージマネージャコマンド
- スナップショットコマンド
- ストレージリポジトリコマンド
- サブジェクトコマンド
- タスクコマンド
- テンプレートコマンド
- アップデートコマンド
- ユーザーコマンド
- VBD(仮想ブロックデバイス)コマンド
- VDI(仮想ディスクイメージ)コマンド
- VIF(仮想ネットワークインターフェイス)コマンド
- VLAN(仮想ネットワーク)コマンド
- 仮想マシンコマンド