xeコマンドで引数およびその値を指定するには、以下の形式を使⽤します。
A.4. xeコマンドリファレンス
ここでは、各xeコマンドの機能と、指定可能なパラメータ、構⽂などについて説明します。コマンド の対象オブジェクトごとに、アルファベット順に説明します。
A.4.1. アプライアンスコマンド
vAppとも呼ばれる仮想アプライアンス(applianceオブジェクト)を作成または変更します。vApp について詳しくは、『XenServer仮想マシンユーザーガイド』を参照してください。
A.4.1.1. applianceオブジェクトのパラメータ
applianceオブジェクトには、以下のパラメータがあります。パラメーター名 説明 種類
uuid アプライアンスのUUID 必須
name-description アプライアンスの説明⽂字列 オプショ ン
paused オプショ
ン
force 強制シャットダウン オプショ
ン
A.4.1.2. appliance-assert-can-be-recovered
appliance-assert-can-be-recovered
uuid=<appliance-uuid> database:vdi-uuid=<vdi-uuid>この仮想アプライアンス/vAppを回復するためのストレージが使⽤可能かどうかをテストします。
A.4.1.3. appliance-create
appliance-create
name-label=<name-label> [name-description=<name-description>]仮想アプライアンス/vAppを作成します。次に例を⽰します。
xe appliance-create name-label=my_appliance アプライアンスに仮想マシンを追加します。
xe vm-param-set uuid=<VM-UUID> appliance=<appliance-uuid> \ xe vm-param-set uuid=<VM-UUID> appliance=<appliance-uuid>
A.4.1.4. appliance-destroy
appliance-destroy
uuid=<appliance-uuid>仮想アプライアンス/vAppを破棄します。次に例を⽰します。
xe appliance-destroy uuid=<appliance-uuid>
A.4.1.5. appliance-recover
appliance-recover
uuid=<appliance-uuid> database:vdi-uuid=<vdi-uuid>[paused=<true|false>]
指定したVDIのデータベースから仮想アプライアンス/vAppを回復します。
A.4.1.6. appliance-shutdown
appliance-shutdown
uuid=<appliance-uuid> [force=<true|false>]仮想アプライアンス/vAppのすべての仮想マシンをシャットダウンします。次に例を⽰します。
xe appliance-shutdown uuid=<appliance-uuid>
A.4.1.7. appliance-start
appliance-start
uuid=<appliance-uuid> [paused=<true|false>]仮想アプライアンス/vAppを起動します。次に例を⽰します。
xe appliance-start uuid=<appliance-uuid>
A.4.2. 監査コマンド
リソースプールのRBAC監査ファイルのすべての記録をファイルとしてダウンロードします。オプ
ションの
since
パラメータを指定すると、その⽇時以降の記録のみがダウンロードされます。A.4.2.1. audit-log-getコマンドのパラメータ
audit-log-getコマンドには、以下のパラメータがあります。パラメーター名 説明 種類
filename プールの監査ログを<filename>で指定するファイルに書き
込みます 必須
since 特定の⽇時以降の記録のみをダウンロードします オプショ ン
A.4.2.2. audit-log-get
audit-log-get
[since=<timestamp>] filename=<filename>指定した⽇時(ミリ秒単位)以降の監査ログをダウンロードします。
次のコマンドを実⾏します。
xe audit-log-get since=2009-09-24T17:56:20.530Z \ filename=/tmp/auditlog-pool-actions.out
A.4.3. ボンディングコマンド
物理インターフェイスのフェールオーバーを提供するネットワークボンディング(bondオブジェク ト)を管理します。詳しくは、項4.4.5. 「スタンドアロンホストでNICボンディングを作成する」を 参照してください。
bondオブジェクトは、masterとmemberのPIFを結合する参照オブジェクトです。master PIF は、bondオブジェクトを参照するために総体的なPIFとして使⽤されるボンディングインターフェイ スです。member PIFは、2つ以上の物理インターフェイスのセットであり、⾼レベルのボンディン グインターフェイスとして結束されています。
A.4.3.1. bondオブジェクトのパラメータ
bondオブジェクトには、以下のパラメータがあります。
パラメーター名 説明 種類
uuid ボンディングの⼀意の識別⼦/オブジェ
クト参照 読み取り専⽤
master ボンドマスタPIFのUUID 読み取り専⽤
members ボンディングを構成するPIFのUUIDの
セット 読み取り専⽤のセットパラ
メータ
A.4.3.2. bond-create
bond-create
network-uuid=<network_uuid> pif-uuids=<pif_uuid_1,pif_uuid_2,...>既存のPIFオブジェクトをリストで指定して、指定したネットワーク上にボンディングネットワーク インターフェイスを作成します。ただし、指定したPIFが別のボンディングで使⽤されていた り、VLANタグが設定されていたり、同じXenServerホスト上に存在しなかったり、または2つ以上 のPIFが指定されていなかったりする場合、このコマンドは失敗します。
A.4.3.3. bond-destroy
bond-destroy
uuid=<bond_uuid>UUIDで指定したボンディングインターフェイスをホストから削除します。
A.4.4. CD(仮想ネットワーク)コマンド
XenServerホスト上の物理CD/DVDドライブ(cdオブジェクト)を操作します。
A.4.4.1. 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に書き込むこと
はできないため使⽤されない 読み取り専⽤のセットパラ メータ
virtual-size 仮想マシンに表⽰されたCDのサイズ
(バイト数) 読み取り専⽤
physical-utilisation ストレージリポジトリ上でのCDイメー
ジの物理スペース(バイト数) 読み取り専⽤
type CDの種類は
User
に設定される 読み取り専⽤sharable CDドライブが共有可能かどうか。デ
フォルトはfalse。 読み取り専⽤
read-only CDが読み取り専⽤かどうか。falseの場
合は書き込み可能。CDでは常にtrue 読み取り専⽤
パラメーター名 説明 種類 storage-lock ディスクがストレージレベルでロック
されている場合にtrue 読み取り専⽤
parent このCDがチェーンの⼀部である場合
は、親ディスクへの参照 読み取り専⽤
missing ストレージリポジトリのスキャン操作 によりこのCDがディスク上に存在しな いと認識された場合にtrue
読み取り専⽤
other-config CDの追加設定パラメータを指定する
キー/値ペアのリスト 読み取り/書き込み可のマップ パラメータ
location このデバイスがマウントされているパ
ス 読み取り専⽤
managed このデバイスが管理されている場合に
true 読み取り専⽤
xenstore-data xenstoreツリーに挿⼊されるべきデー
タ 読み取り専⽤のマップパラ
メータ sm-config ストレージマネージャデバイス設定
キーの名前と説明 読み取り専⽤のマップパラ
メータ is-a-snapshot このテンプレートがCDスナップショッ
トの場合にtrue 読み取り専⽤
snapshot_of このテンプレートのスナップショット
元のCDのUUID 読み取り専⽤
snapshots このCDから作成されたすべてのスナッ
プショットのUUID 読み取り専⽤
snapshot_time スナップショット作成⽇時 読み取り専⽤
A.4.4.2. cd-list
cd-list
[params=<param1,param2,...>] [parameter=<parameter_value>...]XenServerホストまたはリソースプール上のCDとISO(CDイメージファイル)のリストを、オプ ションの引数paramsに基づいてフィルタして出⼒します。
オプションの引数paramsを使⽤して特定のパラメータ値を持つオブジェクトだけを出⼒する(つま りリストをフィルタする)場合は、そのオブジェクトのパラメータのリストを含む⽂字列を値として 指定します。または、キーワード allを指定してすべてのパラメータのリストを出⼒することもでき ます。paramsを使⽤しない場合、使⽤可能なすべてのパラメータのうち、デフォルトのサブセット が出⼒されます。
オプションの引数には、CD parametersから任意の数を指定できます。
A.4.5. コンソールコマンド
コンソール(consoleオブジェクト)を操作します。
consoleオブジェクトのリストは、標準オブジェクトリストコマンド(xe console-list)を使⽤し て出⼒でき、パラメータは標準パラメータコマンドを使⽤して操作できます。詳しくは、項A.3.2.
「低レベルパラメータコマンド」を参照してください。
A.4.5.1. consoleオブジェクトのパラメータ
consoleオブジェクトには、以下のパラメータがあります。パラメーター名 説明 種類
uuid コンソールの⼀意の識別⼦/オブジェク
ト参照 読み取り専⽤
vm-uuid このコンソールを開いているVMの⼀意
の識別⼦/オブジェクト参照 読み取り専⽤
vm-name-label このコンソールを開いているVMの名前 読み取り専⽤
protocol このコンソールが使⽤するプロトコ ル。vt100︓VT100ターミナ
ル、rfb︓Remote FrameBufferプロ トコル(VNCで使⽤)、またはrdp︓ Remote Desktop Protocol(RDP)の いずれか
読み取り専⽤
location このコンソールのサービスのURI 読み取り専⽤
other-config このコンソールの追加設定パラメータ
を指定するキー/値ペアのリスト 読み取り/書き込み可のマップ パラメータ
A.4.6. 障害回復(DR)コマンド
障害発⽣時に仮想マシンを回復します。
A.4.6.1. drtask-create
drtask-create
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>