コマンドラインインターフェース
xe CLIを使用すると、システム管理タスクをスクリプト化および自動化できます。CLIを使用して、XenServer®を既存のITインフラストラクチャに統合します。
xe CLIの使用を開始する
xeコマンドラインインターフェースは、すべてのXenServerホストにデフォルトでインストールされています。リモートWindows版はXenCenterに同梱されています。スタンドアロンのリモートCLIはLinuxでも利用できます。
XenServerホスト上
xeコマンドラインインターフェースは、ホストにデフォルトでインストールされています。dom0コンソールでxe CLIコマンドを実行できます。以下のいずれかの方法でdom0コンソールにアクセスします。
-
XenCenterで、コマンドを実行したいホストのコンソールタブに移動します。
-
コマンドを実行したいホストにSSH接続します。
Windowsの場合
Windowsでは、
xe.exeコマンドはXenCenterとともにインストールされます。
xe.exeコマンドを使用するには、Windowsのコマンドプロンプトを開き、xe.exeファイルが置かれているディレクトリ (通常はC:\Program Files (x86)\XenServer\XenCenter) に移動します。xe.exeのインストール場所をシステムパスに追加すると、ディレクトリを変更せずにコマンドを使用できます。
Linux上
RPMベースのディストリビューション (Red Hatなど) では、メインのXenServerインストールISOにある
client_install/xapi-xe-BUILD.x86_64.rpmという名前のRPMからスタンドアロンのxeコマンドをインストールできます。
RPMからインストールするには、次のコマンドを使用します。
rpm -ivh xapi-xe-BUILD.x86_64.rpm
コマンドラインでパラメーターを使用して、xeコマンドの実行時に使用するXenServerホスト、ユーザー名、パスワードを定義できます。ただし、この情報を環境変数として設定するオプションもあります。例:
export XE_EXTRA_ARGS="server=<host name>,username=<user name>,password=<password>"
注:
Linux上のリモートxe CLIは、セキュアな接続を介してコマンドを実行しようとし、これらのコマンドがファイル転送を伴う場合、ハングする可能性があります。その場合、
--no-ssl パラメーターを使用して、XenServerホストへの安全でない接続を介してコマンドを実行できます。
xe コマンドのヘルプ
ホスト上でCLIコマンドの基本的なヘルプは、次のように入力することで利用できます:
xe help command
次のように入力すると、最もよく使用されるxeコマンドのリストが表示されます:
xe help
または、次のように入力すると、すべてのxeコマンドのリストが表示されます:
xe help --all
基本的な xe 構文
すべてのXenServer 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 引数は、リモートXenServerホスト上のエージェントポートを指定するために使用できます (デフォルトは443です)。
例: ローカルXenServerホスト上:
xe vm-list
例: リモートXenServerホスト上:
xe vm-list username=username password=password server=hostname
リモート接続引数には、省略形構文も使用できます。
-
-uユーザー名 -
-pwパスワード -
-pwfパスワードファイル -
-pポート -
-sサーバー
例: リモートのXenServerホストの場合:
xe vm-list -u myuser -pw mypassword -s hostname
引数は、環境変数XE_EXTRA_ARGSからも、コンマ区切りのキーと値のペアの形式で取得されます。たとえば、リモートのXenServerホストで実行されるコマンドを入力するには、まず次のコマンドを実行します。
export XE_EXTRA_ARGS="server=jeffbeck,port=443,username=root,password=pass"
このコマンドを実行すると、実行する各xeコマンドでリモートのXenServerホストパラメーターを指定する必要がなくなります。
XE_EXTRA_ARGS環境変数を使用すると、リモートのXenServerホストに対して発行されたxeコマンドのタブ補完も有効になります。これはデフォルトでは無効になっています。
特殊文字と構文
xe コマンドラインで引数と値のペアを指定するには、次のように記述します: argument=value
値にスペースが含まれていない限り、引用符は使用しないでください。引数名、等号 (=)、および値の間に空白を含めないでください。この形式に準拠しない引数はすべて無視されます。
スペースを含む値の場合は、次のように記述します:
argument="value with spaces"
XenServerホストでCLIを使用する場合、コマンドには標準のLinux bashシェルにある機能と同様のタブ補完機能があります。たとえば、
xe vm-l と入力してTABキーを押すと、コマンドの残りの部分が表示されます。複数のコマンドが vm-l で始まる場合、TABをもう一度押すと、可能性のあるコマンドが一覧表示されます。この機能は、コマンドでオブジェクトUUIDを指定する場合に役立ちます。
注記:
リモートのXenServerホストでコマンドを実行する場合、通常、タブ補完は機能しません。ただし、コマンドを入力するマシンでXE_EXTRA_ARGS変数を設定すると、タブ補完が有効になります。詳細については、「基本的なxe構文」を参照してください。
コマンドの種類
CLIコマンドは2つの種類に分けられます。低レベルコマンドは、APIオブジェクトのリスト表示とパラメーター操作に関係します。高レベルコマンドは、より抽象的なレベルでVMまたはホストと対話するために使用されます。
低レベルコマンドは次のとおりです:
-
class-リスト
-
class-param-ゲット
-
class-param-セット
-
class-param-リスト
-
class-param-アド
-
class-param-リムーブ
-
class-param-クリア
ここで、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 コマンドでアドレス指定されるオブジェクトは、それらを識別し、その状態を定義するパラメーターのセットを持っています。
ほとんどのパラメーターは単一の値を取ります。たとえば、VM の
name-label パラメーターには単一の文字列値が含まれます。xe vm-param-list のようなパラメーターリストコマンドの出力では、括弧内の値がパラメーターが読み書き可能 (RW) か読み取り専用 (RO) かを示します。 指定された VM での xe vm-param-list の出力には、次の行が含まれる場合があります。
user-version ( RW): 1
is-control-domain ( RO): false
最初のパラメーター
user-version は書き込み可能で、値は 1 です。2 番目の is-control-domain は読み取り専用で、値は false です。
他の 2 種類のパラメーターは多値です。set パラメーターには値のリストが含まれます。map パラメーターはキーと値のペアのセットです。例として、指定された VM での
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 パラメーターには、キーと値のペアを表す項目のリストがあります。キー名の後にはコロン (:) が続きます。各キーと値のペアは、セミコロン (;) で区切られています。RW の前の M は、このパラメーターがマップパラメーターであり、読み書き可能であることを示します。allowed-operations パラメーターには、項目のセットを構成するリストがあります。RO の前の S は、これがセットパラメーターであり、読み取り可能ですが書き込み不可であることを示します。
マップパラメーターをフィルター処理したり、マップパラメーターを設定したりするには、コロン (:) を使用してマップパラメーター名とキーと値のペアを区切ります。たとえば、VM の
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 パラメーターを取ります。これらのコマンドは低レベルコマンドと見なされるため、VM 名ラベルではなく UUID を使用する必要があります。
-
xe class-param-list uuid=uuidすべてのパラメーターとその関連値をリストします。class-list コマンドとは異なり、このコマンドは「高価な」フィールドの値をリストします。 -
xe class-param-get uuid=uuid param-name=parameter param-key=key特定のパラメータの値を返します。マップパラメータの場合、param-key を指定すると、マップ内のそのキーに関連付けられた値が取得されます。param-key が指定されていない場合、またはパラメータがセットである場合、コマンドはセットまたはマップの文字列表現を返します。 -
xe class-param-set uuid=uuid param=value1つ以上のパラメータの値を設定します。 -
xe class-param-add uuid=uuid param-name=parameter key=value param-key=keyマップまたはセットパラメータのいずれかに追加します。マップパラメータの場合、key=value 構文を使用してキーと値のペアを追加します。パラメータがセットである場合、param-key=key 構文を使用してキーを追加します。 -
xe class-param-remove uuid=uuid param-name=parameter param-key=keyマップからキーと値のペアを削除するか、セットからキーを削除します。 -
xe class-param-clear uuid=uuid param-name=parameterセットまたはマップを完全にクリアします。
低レベルリストコマンド
class-list コマンドは、class 型のオブジェクトを一覧表示します。デフォルトでは、この種類のコマンドはすべてのオブジェクトを一覧表示し、パラメータのサブセットを出力します。この動作は、次の方法で変更できます。
-
オブジェクトをフィルタリングして、サブセットのみを出力できます。
-
出力されるパラメータは変更できます。
出力されるパラメータを変更するには、引数 params を必要なパラメータのコンマ区切りリストとして指定します。例:
xe vm-list params=name-label,other-config
または、すべてのパラメータを一覧表示するには、次の構文を使用します。
xe vm-list params=all
listコマンドは、計算コストが高い一部のパラメータを表示しません。これらのパラメータは、例えば次のように表示されます。
allowed-VBD-devices (SRO): <expensive field>
これらのフィールドを取得するには、class-param-listコマンドまたはclass-param-getコマンドを使用します。
リストをフィルタリングするために、CLIはパラメータ値をコマンドラインで指定された値と照合し、指定されたすべての制約に一致するオブジェクトのみを出力します。例：
xe vm-list HVM-boot-policy="BIOS order" power-state=halted
このコマンドは、
power-stateフィールドの値がhaltedであり、HVM-boot-policyフィールドの値がBIOS orderである、両方の条件を満たすVMのみをリスト表示します。
マップ内のキーの値、またはセット内の値の存在によってリストをフィルタリングすることもできます。マップ内のキーに基づくフィルタリングの構文は
map-name:key=valueです。セット内に存在する値に基づくフィルタリングの構文はset-name:contains=valueです。
スクリプトを作成する際、便利なテクニックとして、コマンドラインで
--minimalを渡すことで、xeがカンマ区切りのリストの最初のフィールドのみを出力するようにする方法があります。例えば、3つのVMがインストールされているホストでコマンドxe vm-list --minimalを実行すると、3つのVMのUUIDが得られます。
a85d6717-7264-d00e-069b-3b1d19d56ad9,aaa3eec5-9499-bcf3-4c03-af10baea96b7, \
42c044de-df69-4b30-89d9-2c199564581d
シークレット
XenServerは、パスワードがコマンドライン履歴やAPIオブジェクトに平文で保存されるのを避けるためのシークレットメカニズムを提供します。XenCenterはこの機能を自動的に使用し、パスワードを必要とするあらゆるコマンドに対してxe CLIからも使用できます。
注記：
リモートのxe CLIインスタンスからXenServerホストを認証するために、パスワードシークレットを使用することはできません。
シークレットオブジェクトを作成するには、XenServerホストで次のコマンドを実行します。
xe secret-create value=my-password
シークレットが作成され、XenServerホストに保存されます。コマンドはシークレットオブジェクトのUUIDを出力します。例えば、
99945d96-5890-de2a-3899-8c04ef2521db。パスワードを必要とするコマンドにこのUUIDを渡すには、パスワード引数の名前に_secretを追加します。
例： シークレットを作成したXenServerホストで、次のコマンドを実行できます。
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コマンド（例：
xe vm-migrateまたはxe pool-enable-external-auth）は、パスワードなどのシークレットをパラメータとして受け取ります。これらはシェル履歴に残ったり、コマンドの実行中にプロセスリストで表示されたりする可能性があります。したがって、これらのコマンドは信頼できる環境でのみ実行することが重要です。
bashシェルでは、
HISTCONTROL変数を使用して、シェル履歴にどのコマンドを保存するかを制御できます。
xeコマンドリファレンス
このセクションでは、コマンドが対象とするオブジェクトごとにコマンドをグループ化しています。これらのオブジェクトはアルファベット順にリストされています。
アプライアンスコマンド
VMアプライアンス（vAppとも呼ばれます）を作成および変更するためのコマンド。詳細については、vAppsを参照してください。
アプライアンスパラメータ
アプライアンスコマンドには、次のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
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
このVMアプライアンス/vAppをリカバリするためにストレージが利用可能かどうかをテストします。
appliance-create
xe appliance-create name-label=name-label [name-description=name-description]
アプライアンス/vAppを作成します。例:
xe appliance-create name-label=my_appliance
VMをアプライアンスに追加します:
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に含まれるデータベースからVMアプライアンス/vAppをリカバリします。
appliance-shutdown
xe appliance-shutdown uuid=appliance-uuid [force=true|false]
アプライアンス/vApp内のすべてのVMをシャットダウンします。例:
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 |
プールの監査ログを ファイル名 に書き込みます | 必須 |
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
ボンディングコマンド
物理インターフェースのフェイルオーバーによる回復性のための、ネットワークボンディングを操作するコマンド。詳細については、「ネットワーキング」を参照してください。
ボンドオブジェクトは、マスター PIF と メンバー PIF を結合する参照オブジェクトです。マスター PIF は、ボンドを参照するための全体的な PIF として使用する必要があるボンディングインターフェースです。メンバー PIF は、高レベルのボンディングインターフェースに結合された 2 つ以上の物理インターフェースのセットです。
ボンドパラメーター
ボンドには次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
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が同じXenServerホスト上にない場合
-
2つ未満のPIFが提供された場合
bond-destroy
xe bond-destroy uuid=bond_uuid
ホストからUUIDで指定されたボンディングされたインターフェースを削除します。
bond-set-mode
xe bond-set-mode uuid=bond_uuid mode=bond_mode
ボンドモードを変更します。
CD コマンド
XenServer ホスト上の物理 CD/DVD ドライブを操作するためのコマンド。
CD パラメータ
CD には以下のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
CD の一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
CD の名前 | 読み取り/書き込み |
name-description |
CDの説明テキスト | 読み取り/書き込み |
allowed-operations |
このCDで実行できる操作のリスト | 読み取り専用設定パラメータ |
current-operations |
このCDで現在進行中の操作のリスト | 読み取り専用設定パラメータ |
sr-uuid |
このCDが属するSRの一意の識別子/オブジェクト参照 | 読み取り専用 |
sr-name-label |
このCDが属するSRの名前 | 読み取り専用 |
vbd-uuids |
このCDに接続する仮想マシン上のVBDの一意の識別子のリスト | 読み取り専用設定パラメータ |
crashdump-uuids |
CDでは使用されません。クラッシュダンプはCDに書き込めないため | 読み取り専用設定パラメータ |
virtual-size |
仮想マシンに表示されるCDのサイズ (バイト単位) | 読み取り専用 |
physical-utilisation |
SR上でCDイメージが占める物理領域の量 (バイト単位) | 読み取り専用 |
type |
CDの場合、Userに設定 | 読み取り専用 |
sharable |
CDドライブが共有可能かどうか。デフォルトはfalseです。 |
読み取り専用 |
read-only |
CDが読み取り専用かどうか。falseの場合、デバイスは書き込み可能です。CDの場合は常にtrueです。 |
読み取り専用 |
storage-lock |
このディスクがストレージレベルでロックされている場合、値はtrueです。 |
読み取り専用 |
parent |
このCDがチェーンの一部である場合、親ディスクへの参照。 | 読み取り専用 |
missing |
SRスキャン操作によってこの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]
XenServerホストまたはプール上のCDとISO (CDイメージファイル) を、オプション引数
params でフィルタリングして一覧表示します。
オプション引数
params が使用されている場合、params の値は、表示したいこのオブジェクトのパラメータのリストを含む文字列です。または、キーワード all を使用してすべてのパラメータを表示できます。params が使用されていない場合、返されるリストには、利用可能なすべてのパラメータのデフォルトのサブセットが表示されます。
オプション引数は、このセクションの冒頭に記載されている(/ja-jp/xenserver/8/command-line-interface.html#cd-parameters)のいずれかです。
GFS2 クラスターコマンド
GFS2 クラスタープールを操作するためのコマンド。
GFS2 クラスタープールは、クラスタリング機能が有効になっているリソースプールです。これらのプールは GFS2 SR とともに使用します。詳細については、(/ja-jp/xenserver/8/hosts-pools/clustered-pools.html)を参照してください。
クラスターオブジェクトとクラスターホストオブジェクトは、標準のオブジェクトリストコマンド (
xe cluster-list および xe cluster-host-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、(/ja-jp/xenserver/8/command-line-interface.html#low-level-parameter-commands)を参照してください。 GFS2 クラスタープールを操作するためのコマンド。
GFS2 クラスターパラメーター
GFS2 クラスターには、次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
GFS2 クラスターの一意の識別子/オブジェクト参照。 | 読み取り専用 |
cluster-hosts |
GFS2 クラスター内のホストの一意の識別子/オブジェクト参照のリスト。 | 読み取り専用設定パラメータ |
cluster-token |
他のホスト上の自身と通信する際にxapi-clusterdが使用する秘密鍵。 |
読み取り専用 |
cluster-stack |
クラスタリング機能を提供するテクノロジースタック。指定可能な値はcorosyncです。 |
読み取り専用 |
cluster-stack-version |
クラスタリング機能を提供するテクノロジースタックのバージョン。 | 読み取り専用 |
allowed-operations |
この状態で許可されている操作を一覧表示します。このリストは参考情報にすぎず、クライアントがこのフィールドを読み取るまでにGFS2クラスターの状態が変更されている可能性があります。 | 読み取り専用設定パラメータ |
current-operations |
現在処理中の操作を一覧表示します。このリストは参考情報にすぎず、クライアントがこのフィールドを読み取るまでにGFS2クラスターの状態が変更されている可能性があります。 | 読み取り専用設定パラメータ |
token-timeout |
corosyncトークンのタイムアウト（秒単位）。 |
読み取り専用 |
token-timeout-coefficient |
corosyncトークンのタイムアウト係数（秒単位）。 |
読み取り専用 |
pool-auto-join |
新しいプールメンバーがGFS2クラスターに自動的に参加する場合、値はtrueになります。これはtrueに設定されています。 |
読み取り専用 |
is-quorate |
GFS2クラスターがクォーラムを持っているかどうか。 | 読み取り専用 |
quorum |
GFS2クラスターがクォーラムを維持するために必要なライブホストの数。 | 読み取り専用 |
live-hosts |
現在稼働中のGFS2クラスター内のホスト数。 | 読み取り専用 |
cluster-config |
GFS2クラスターの追加設定パラメーターを指定するキー/値ペアのリスト。 | 読み取り専用マップパラメーター |
other-config |
GFS2クラスターの追加設定パラメーターを指定するキー/値ペアのリスト。 | 読み書きマップパラメーター |
GFS2クラスター内のホスト (
cluster-host) には、以下のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
GFS2クラスターホストの一意の識別子/オブジェクト参照。これはホストUUIDとは異なります。 | 読み取り専用 |
cluster |
このホストがメンバーであるGFS2クラスターの一意の識別子/オブジェクト参照。 | 読み取り専用 |
PIF |
PIFオブジェクトの一意の識別子/オブジェクト参照。 | 読み取り専用 |
host |
ホストの一意の識別子/オブジェクト参照。 | 読み取り専用 |
enabled |
GFS2クラスターホストが、このホストでGFS2クラスタリングを有効にするべきだと考えているかどうか。このフィールドは、GFS2クラスターホストで有効化/無効化メッセージを呼び出すことで変更できます。有効化されたメンバーのみが基盤となるクラスター・スタックを実行します。無効化されたメンバーは、引き続きGFS2クラスターのメンバーと見なされ（joinedを参照）、ユーザーによって再度有効化できます。 | 読み取り専用 |
joined |
GFS2クラスターホストがGFS2クラスターに参加しているかどうか。有効化とは異なり、参加していないホストはGFS2クラスターのメンバーとは見なされず、したがって、このホストに対して有効化および無効化操作を実行することはできません。 | 読み取り専用 |
live |
クラスタースタックがこのホストをライブと認識しているかどうか。 | 読み取り専用 |
last-update-live |
クラスタースタックからの情報に基づいて、ライブフィールドが最後に更新された時刻。 | 読み取り専用 |
allowed-operations |
この状態で許可されている操作を一覧表示します。このリストは参考情報であり、クライアントがこのフィールドを読み取るまでにGFS2クラスターホストの状態が変更されている可能性があります。 | 読み取り専用設定パラメーター |
current-operations |
現在処理中の操作を一覧表示します。このリストは参考情報であり、クライアントがこのフィールドを読み取るまでにGFS2クラスターホストの状態が変更されている可能性があります。 | 読み取り専用設定パラメーター |
other-config |
GFS2クラスターホストの追加設定パラメーターを指定するキー/値ペアのリスト。 | 読み取り専用マップパラメーター |
cluster-host-destroy
xe cluster-host-destroy uuid=host_uuid
GFS2クラスターホストを破棄し、実質的にGFS2クラスターから離脱します。
cluster-host-disable
xe cluster-host-disable uuid=cluster_uuid
有効なGFS2クラスターホストのGFS2クラスターメンバーシップを無効にします。
cluster-host-enable
xe cluster-host-enable uuid=cluster_uuid
無効なGFS2クラスターホストのGFS2クラスターメンバーシップを有効にします。
cluster-host-force-destroy
xe cluster-host-force-destroy uuid=cluster_host
GFS2クラスターホストオブジェクトを強制的に破棄し、実質的にGFS2クラスターから離脱します。
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]
プール全体のGFS2クラスターを作成します。
cluster-pool-destroy
xe cluster-pool-destroy cluster-uuid=cluster_uuid
プール全体のGFS2クラスターを破棄します。プールは引き続き存在しますが、GFS2クラスター化されなくなり、GFS2 SRを使用できなくなります。
cluster-pool-force-destroy
xe cluster-pool-force-destroy cluster-uuid=cluster_uuid
プール全体のGFS2クラスターを強制的に破棄します。
cluster-pool-resync
xe cluster-pool-resync cluster-uuid=cluster_uuid
プール全体でGFS2クラスターを再同期します。
コンソールコマンド
コンソールを操作するためのコマンド。
コンソールオブジェクトは、標準のオブジェクトリストコマンド (
xe console-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
コンソールパラメーター
コンソールには次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
コンソールの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
このコンソールが開いているVMの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
このコンソールが開いているVMの名前 | 読み取り専用 |
protocol |
このコンソールが使用するプロトコル。指定可能な値は、vt100: VT100ターミナル、rfb: リモートフレームバッファプロトコル（VNCで使用）、またはrdp: リモートデスクトッププロトコルです。 |
読み取り専用 |
location |
コンソールサービスのURI | 読み取り専用 |
other-config |
コンソールの追加設定パラメーターを指定するキーと値のペアのリスト。 | 読み取り/書き込みマップパラメーター |
console
xe console
特定のコンソールにアタッチします。
診断コマンド
XenServerから診断情報を収集するためのコマンド。
diagnostic-compact
xe diagnostic-compact
メジャーGCコレクションとヒープ圧縮を実行します。
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の共有/ロックステータスを確認します。
災害復旧コマンド
災害後にVMを復旧するためのコマンド
drtask-create
xe drtask-create type=type sr-whitelist=sr-white-list device-config=device-config
災害復旧タスクを作成します。例えば、災害復旧に備えてiSCSI SRに接続するには：
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 は、許可されているSR UUIDを一覧表示します。drtask-create コマンドは、許可されているUUIDのいずれかを持つSRのみを導入し、接続します。
drtask-destroy
xe drtask-destroy uuid=dr-task-uuid
災害復旧タスクを破棄し、導入されたSRを忘却します。
vm-assert-can-be-recovered
xe vm-assert-can-be-recovered uuid=vm-uuid database:vdi-uuid=vdi-uuid
このVMを復旧するためにストレージが利用可能かどうかをテストします。
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に含まれるデータベースからVMを復元します。
sr-enable-database-replication
xe sr-enable-database-replication uuid=sr_uuid
指定された（共有）SRへのXAPIデータベースレプリケーションを有効にします。
sr-disable-database-replication
xe sr-disable-database-replication uuid=sr_uuid
指定されたSRへのXAPIデータベースレプリケーションを無効にします。
使用例
以下の例は、DR CLIコマンドのコンテキストを示しています。
プライマリサイトで、データベースレプリケーションを有効にします。
xe sr-database-replication uuid=sr=uuid
災害後、セカンダリサイトでSRに接続します。
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
SR上のデータベースVDIを探します。
xe vdi-list sr-uuid=sr-uuid type=Metadata
存在するVMについてデータベースVDIをクエリします。
xe vm-list database:vdi-uuid=vdi-uuid
VMを復元する:
xe vm-recover uuid=vm-uuid database:vdi-uuid=vdi-uuid
DRタスクを破棄します。DRタスクによって導入され、VMに不要なSRはすべて破棄されます:
xe drtask-destroy uuid=drtask-uuid
イベントコマンド
イベントを操作するためのコマンド。
イベントクラス
イベントクラスは次の表に示されています:
| クラス名 | 説明 |
|---|---|
pool |
物理ホストのプール |
vm |
仮想マシン |
host |
物理ホスト |
network |
仮想ネットワーク |
vif |
仮想ネットワークインターフェース |
pif |
物理ネットワークインターフェース（個別のVLANは複数のPIFとして表されます） |
sr |
ストレージリポジトリ |
vdi |
仮想ディスクイメージ |
vbd |
仮想ブロックデバイス |
pbd |
ホストがSRにアクセスするための物理ブロックデバイス |
event-wait
xe event-wait class=class_name [param-name=param_value] [param-name=/=param_value]
コマンドラインで指定された条件を満たすオブジェクトが存在するまで、他のコマンドの実行をブロックします。引数
x=y は「フィールドxが値yになるまで待機する」を意味し、x=/=y は「フィールドxがy以外の値になるまで待機する」を意味します。
例: 特定のVMが実行中になるまで待機します。
xe event-wait class=vm name-label=myvm power-state=running
myvmという名前のVMがpower-state「実行中」になるまで、他のコマンドをブロックします。
例: 特定のVMが再起動するまで待機します。
xe event-wait class=vm uuid=$VM start-time=/=$(xe vm-list uuid=$VM params=start-time --minimal)
UUID \$VM を持つVMが再起動するまで、他のコマンドをブロックします。このコマンドは、VMが再起動するタイミングを決定するために
start-timeの値を使用します。
クラス名は、このセクションの冒頭に記載されているイベントクラスのいずれかになります。パラメータは、CLIコマンド class-param-list に記載されているパラメータのいずれかになります。
GPUコマンド
物理GPU、GPUグループ、および仮想GPUを操作するためのコマンド。
GPUオブジェクトは、標準のオブジェクトリストコマンド（
xe pgpu-list、xe gpu-group-list、およびxe vgpu-list）でリストできます。パラメータは、標準のパラメータコマンドで操作できます。詳細については、「低レベルパラメータコマンド」を参照してください。
物理GPUパラメータ
物理GPU (pGPU) には、以下のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
pGPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
vendor-name |
pGPUのベンダー名 | 読み取り専用 |
device-name |
このpGPUモデルにベンダーによって割り当てられた名前 | 読み取り専用 |
gpu-group-uuid |
このpGPUがXenServerによって自動的に割り当てられたGPUグループの一意の識別子/オブジェクト参照。プール内のホスト間で同一のpGPUはグループ化されます。 | 読み取り専用 |
gpu-group-name-label |
pGPUが割り当てられているGPUグループの名前 | 読み取り専用 |
host-uuid |
pGPUが接続されているXenServerホストの一意の識別子/オブジェクト参照 | 読み取り専用 |
host-name-label |
pGPUが接続されているXenServerホストの名前 | 読み取り専用 |
pci-id |
PCI識別子 | 読み取り専用 |
dependencies |
同じVMにパススルーされる依存PCIデバイスをリスト表示します | 読み取り/書き込みマップパラメーター |
other-config |
pGPUの追加構成パラメーターを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメーター |
supported-VGPU-types |
基盤となるハードウェアでサポートされている仮想GPUタイプのリスト | 読み取り専用 |
enabled-VGPU-types |
このpGPUで有効になっている仮想GPUタイプのリスト | 読み取り/書き込み |
resident-VGPUs |
このpGPUで実行されているvGPUのリスト | 読み取り専用 |
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グループのパラメータ
GPUグループには次のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
GPUグループの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
GPUグループの名前 | 読み取り/書き込み |
name-description |
GPUグループの説明テキスト | 読み取り/書き込み |
VGPU-uuids |
GPUグループ内の仮想GPUの一意の識別子/オブジェクト参照をリストします | 読み取り専用セットパラメータ |
PGPU-uuids |
GPUグループ内のpGPUの一意の識別子/オブジェクト参照をリストします | 読み取り専用セットパラメータ |
other-config |
GPUグループの追加設定パラメータを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメータ |
supported-VGPU-types |
基盤となるハードウェアでサポートされているすべての仮想GPUタイプのユニオン | 読み取り専用 |
enabled-VGPU-types |
基盤となるpGPUで有効になっているすべての仮想GPUタイプのユニオン | 読み取り専用 |
allocation-algorithm |
グループ内のpGPUに仮想GPUを割り当てるための深さ優先/幅優先設定 | 読み取り/書き込み列挙型パラメータ |
GPUグループ操作
GPUグループを操作するためのコマンド
gpu-group-create
xe gpu-group-create name-label=name_for_group [name-description=description]
pGPUを移動できる新しい（空の）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をpGPUに割り当てるために使用するアルゴリズムを変更します。
仮想GPUパラメーター
仮想GPUには以下のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
仮想GPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
仮想GPUが割り当てられているVMの一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
仮想GPUが割り当てられているVMの名前 | 読み取り専用 |
gpu-group-uuid |
仮想GPUが含まれるGPUグループの一意の識別子/オブジェクト参照 | 読み取り専用 |
gpu-group-name-label |
仮想GPUが含まれるGPUグループの名前 | 読み取り専用 |
currently-attached |
GPUパススルーが有効なVMが実行中の場合はtrue、それ以外の場合はfalse | 読み取り専用 |
other-config |
仮想GPUの追加設定パラメータを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメータ |
type-uuid |
この仮想GPUの仮想GPUタイプのユニークな識別子/オブジェクト参照 | 読み取り/書き込みマップパラメータ |
type-model-name |
仮想GPUタイプに関連付けられたモデル名 | 読み取り専用 |
仮想GPUタイプパラメータ
注:
GPUパススルーおよび仮想GPUは、GPUベンダーが提供するサポート対象のソフトウェアとグラフィックカードが存在しない限り、ライブマイグレーション、ストレージライブマイグレーション、またはVMサスペンドと互換性がありません。このサポートがないVMは、ダウンタイムを回避するために移行できません。ライブマイグレーション、ストレージライブマイグレーション、およびVMサスペンドとのNVIDIA vGPUの互換性については、グラフィックスを参照してください。
仮想GPUタイプには、次のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
仮想GPUタイプの固有の識別子/オブジェクト参照 | 読み取り専用 |
vendor-name |
仮想GPUベンダーの名前 | 読み取り専用 |
model-name |
仮想GPUタイプに関連付けられたモデル名 | 読み取り専用 |
freeze-frame |
仮想GPUタイプのフレームバッファサイズ（バイト単位） | 読み取り専用 |
max-heads |
仮想GPUタイプでサポートされるディスプレイの最大数 | 読み取り専用 |
supported-on-PGPUs |
この仮想GPUタイプをサポートするpGPUのリスト | 読み取り専用 |
enabled-on-PGPUs |
この仮想GPUタイプが有効になっているpGPUのリスト | 読み取り専用 |
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を作成します。このコマンドは、VMを指定されたGPUグループにアタッチし、オプションで仮想GPUタイプを指定します。仮想GPUタイプが指定されていない場合、「パススルー」タイプが想定されます。
vgpu-destroy
xe vgpu-destroy uuid=uuid_of_vgpu
指定された仮想GPUを破棄します。
仮想GPUを持つVMのVNCを無効にする
xe vm-param-add uuid=uuid_of_vmparam-name=platform vgpu_vnc_enabled=true|false
false を使用すると、disablevnc=1 がディスプレイエミュレーターに渡されるため、VMのVNCコンソールが無効になります。デフォルトでは、VNCは有効になっています。
ホストコマンド
XenServerホストと対話するためのコマンド。
XenServerホストは、XenServerソフトウェアを実行する物理サーバーです。これらのサーバー上では、制御ドメインまたはドメイン0として知られる特別な特権仮想マシンの制御下でVMが実行されています。
XenServerホストオブジェクトは、標準のオブジェクトリストコマンド (
xe host-list, xe host-cpu-list, および xe host-crashdump-list) でリストできます。パラメーターは、標準のパラメーターコマンドで操作できます。詳細については、低レベルパラメーターコマンド を参照してください。
ホストセレクター
ここにリストされているいくつかのコマンドには、操作を実行する1つ以上のXenServerホストを選択するための共通のメカニズムがあります。最も簡単な方法は、引数
host=uuid_or_name_label を指定することです。フィールドの値に基づいてホストの完全なリストをフィルタリングすることで、XenServerを指定することもできます。たとえば、enabled=true を指定すると、enabled フィールドが true と等しいすべてのXenServerホストが選択されます。複数のXenServerホストが一致し、操作を複数のXenServerホストで実行できる場合は、操作を実行するために --multiple を指定する必要があります。一致させることができるパラメーターの完全なリストは、このセクションの冒頭で説明されています。このコマンドリストは、コマンド xe host-list params=all を実行することで取得できます。XenServerホストを選択するためのパラメーターが指定されていない場合、操作はすべてのXenServerホストで実行されます。
ホストパラメーター
XenServerホストには、次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
XenServerホストの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
XenServerホストの名前 | 読み取り/書き込み |
name-description |
XenServerホストの説明文字列 | 読み取り専用 |
enabled |
無効になっている場合、値はfalseです。これにより、新しいVMがホストで起動するのを防ぎ、ホストをシャットダウンまたは再起動する準備をします。ホストが有効になっている場合、値はtrueです。 |
読み取り専用 |
API-version-major |
メジャーバージョン番号 | 読み取り専用 |
API-version-minor |
マイナーバージョン番号 | 読み取り専用 |
API-version-vendor |
APIベンダーの識別 | 読み取り専用 |
API-version-vendor-implementation |
ベンダー実装の詳細 | 読み取り専用マップパラメータ |
logging |
ロギング設定 | 読み書きマップパラメータ |
suspend-image-sr-uuid |
サスペンドされたイメージが配置されるSRの一意の識別子/オブジェクト参照 | 読み書き |
crash-dump-sr-uuid |
クラッシュダンプが置かれるSRの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
software-version |
バージョン管理パラメータとその値のリスト | 読み取り専用マップパラメータ |
capabilities |
XenServerホストが実行できるXenバージョンのリスト | 読み取り専用セットパラメータ |
other-config |
XenServerホスト用の追加構成パラメータを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメータ |
chipset-info |
チップセットに関する情報を指定するキーと値のペアのリスト | 読み取り専用マップパラメータ |
hostname |
XenServer ホストのホスト名 | 読み取り専用 |
address |
XenServer ホストの IP アドレス | 読み取り専用 |
license-server |
ライセンスサーバーに関する情報を指定するキーと値のペアのリストです。Citrix License Server および License Activation Service との通信のデフォルトポートは 8083 です。競合によるポート番号の変更については、「ポート番号の変更」を参照してください。(https://docs.citrix.com/ja-jp/licensing/current-release/manage/change-port-numbers.html) | 読み取り専用マップパラメーター |
supported-bootloaders |
XenServer ホストがサポートするブートローダーのリスト。例: pygrub、eliloader |
読み取り専用セットパラメーター |
memory-total |
XenServer ホスト上の物理 RAM の合計量 (バイト単位) | 読み取り専用 |
memory-free |
VMに割り当て可能な残りの物理RAMの総量（バイト単位） | 読み取り専用 |
host-metrics-live |
ホストが稼働中の場合はtrue、それ以外の場合はfalse | 読み取り専用 |
logging |
syslog_destinationキーは、リモートのリスニングsyslogサービスのホスト名に設定できます。 |
読み取り/書き込みマップパラメータ |
allowed-operations |
この状態が許可する操作をリストします。このリストは参考情報であり、クライアントがこのフィールドを読み取るまでにホストの状態が変更されている可能性があります。 | 読み取り専用セットパラメータ |
current-operations |
現在処理中の操作をリストします。このリストは参考情報であり、クライアントがこのフィールドを読み取るまでにホストの状態が変更されている可能性があります。 | 読み取り専用セットパラメータ |
patches |
ホストパッチのセット | 読み取り専用セットパラメータ |
blobs |
バイナリデータストア | 読み取り専用 |
memory-free-computed |
ホスト上で利用可能な最大メモリ量の控えめな推定値 | 読み取り専用 |
ha-statefiles |
すべてのHA状態ファイルのUUID | 読み取り専用 |
ha-network-peers |
障害発生時にこのホスト上のVMをホストできるすべてのホストのUUID | 読み取り専用 |
external-auth-type |
外部認証のタイプ。例: Active Directory。 | 読み取り専用 |
external-auth-service-name |
外部認証サービスの名前 | 読み取り専用 |
external-auth-configuration |
外部認証サービスの構成情報。 | 読み取り専用マップパラメータ |
XenServerホストには、パラメータリストを持つ他のオブジェクトも含まれています。
XenServerホストのCPUには、以下のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
CPUの一意の識別子/オブジェクト参照 | 読み取り専用 |
number |
XenServerホスト内の物理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のファミリー番号 | 読み取り専用 |
XenServer ホストのクラッシュダンプには、次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
クラッシュダンプの一意の識別子/オブジェクト参照 | 読み取り専用 |
host |
クラッシュダンプが対応するXenServerホスト | 読み取り専用 |
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=premium-per-socket|standard-per-socket|cloud]
XenServerライセンスをホストサーバーに割り当てます。ライセンスを割り当てると、XenServerはライセンスサーバーに接続し、指定された種類のライセンスを要求します。ライセンスが利用可能な場合、ライセンスサーバーからチェックアウトされます。
初期ライセンス設定については、
license-server-address および license-server-port も参照してください。
エディションの値には、「cloud」、「free」、「premium-per-socket」、「standard-per-socket」が含まれます。将来的には、「cloud」のみがサポートされます。
host-backup
xe host-backup file-name=backup_filename host=host_name
指定されたXenServerホストのコントロール ドメインのバックアップを、コマンドが呼び出されたマシンにダウンロードします。
file-name という名前のファイルとして保存します。
重要:
xe host-backup コマンドはローカルホストで実行した場合（つまり、特定のホスト名を指定しない場合）でも機能しますが、この方法で使用しないでください。そうすると、コントロール ドメインのパーティションがバックアップファイルでいっぱいになってしまいます。このコマンドは、バックアップファイルを保持するスペースがあるリモートのオフホストマシンからのみ使用してください。
host-bugreport-upload
xe host-bugreport-upload [host-selector=host_selector_value...] [url=destination_url http-proxy=http_proxy_name]
新しいバグレポートを生成し（
xen-bugtool を使用し、すべてのオプションファイルを含めて）、サポートFTPサイトまたはその他の場所にアップロードします。
この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクター を参照）を使用して選択されます。オプションの引数には、このセクションの冒頭にリストされているホストパラメータ の任意の数を指定できます。
オプションパラメータは、
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で指定されたホストのクラッシュダンプをXenServerホストから削除します。
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...]
指定されたXenServerホストを無効にし、新しいVMがそれらで起動するのを防ぎます。このアクションは、XenServerホストをシャットダウンまたは再起動する準備をします。そのホストが再起動した後、有効化のすべての条件（例えば、ストレージが利用可能であること）が満たされていれば、ホストは自動的に再有効化されます。
host-disable-display
xe host-disable-display uuid=host_uuid
ホストのディスプレイを無効にします。
host-disable-local-storage-caching
xe host-disable-local-storage-caching
指定されたホストでローカルストレージキャッシュを無効にします。
host-emergency-ha-disable
xe host-emergency-ha-disable [--force]
ローカルホストでHAを無効にします。破損したHA設定を持つプールを回復する場合にのみ使用します。
host-emergency-management-reconfigure
xe host-emergency-management-reconfigure interface=uuid_of_management_interface_pif
このXenServerホストの管理インターフェースを再構成します。このコマンドは、XenServerホストが緊急モードの場合にのみ使用してください。緊急モードとは、ホストがリソースプールの一員であり、そのプールコーディネーターがネットワークから消失し、複数回の再試行後も連絡が取れない状態を指します。
host-emergency-reset-server-certificate
xe host-emergency-reset-server-certificate
コマンドが実行されるXenServerホストに自己署名証明書をインストールします。
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...]
実行中のすべてのVMをプール内の他の適切なホストにライブマイグレーションします。まず、
host-disableコマンドを使用してホストを無効にします。
退避されたホストがプールコーディネーターである場合、別のホストをプールコーディネーターとして選択する必要があります。HAが無効な状態でプールコーディネーターを変更するには、
pool-designate-new-masterコマンドを使用します。詳細については、pool-designate-new-masterを参照してください。
HAが有効な場合、唯一の選択肢はXenServerホストをシャットダウンすることです。これにより、HAはランダムに新しいプールコーディネーターを選出します。詳細については、host-shutdownを参照してください。
host-forget
xe host-forget uuid=host_uuid
XAPIエージェントは、指定されたXenServerホストに明示的に連絡することなく、そのホストを忘れます。
この操作を本当に実行するかどうかの確認を求められるのを避けるには、
--forceパラメーターを使用します。
警告:
プールでHAが有効になっている場合は、このコマンドを使用しないでください。まずHAを無効にし、ホストを忘れた後で再度有効にしてください。
このコマンドは、「忘れる」XenServerホストが停止している場合に役立ちます。ただし、XenServerホストが稼働中でプールの一部である場合は、代わりに
xe pool-ejectを使用してください。
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-get-system-status-capabilities
xe host-get-system-status-capabilities [host-selector=host_selector_value...]
指定されたホストのシステムステータス機能を取得します。機能は、次の例に似たXMLフラグメントとして返されます。
<?xml version="1.0" ?>
<system-status-capabilities>
<capability content-type="text/plain" default-checked="yes" key="xenserver-logs" \
max-size="150425200" max-time="-1" min-size="150425200" min-time="-1" \
pii="maybe"/>
<capability content-type="text/plain" default-checked="yes" \
key="xenserver-install" max-size="51200" max-time="-1" min-size="10240" \
min-time="-1" pii="maybe"/>
...
</system-status-capabilities>
各機能エンティティは、以下の属性を持つことができます。
-
key機能の一意の識別子。 -
content-typetext/plain または application/data のいずれかです。UI が人間が利用できるようにエントリをレンダリングできるかどうかを示します。 -
default-checkedyes または no のいずれかです。UI がこのエントリをデフォルトで選択するかどうかを示します。 -
min-size,max-sizeこのエントリのサイズ（バイト単位）のおおよその範囲を示します。-1 はサイズが重要ではないことを示します。 -
min-time,max-timeこのエントリの収集にかかる時間（秒単位）のおおよその範囲を示します。-1 は時間が重要ではないことを示します。 -
pii個人を特定できる情報。エントリにシステム所有者を特定できる情報、またはそのネットワークトポロジの詳細が含まれているかどうかを示します。この属性は、以下のいずれかの値を持つことができます。-
no: これらのエントリには PII は含まれていません -
yes: これらのエントリには PII が含まれている可能性が高いか、確実に含まれています -
maybe: これらのエントリに PII が含まれていないか監査することをお勧めします -
if_customizedファイルが変更されていない場合、PII は含まれていません。ただし、これらのファイルの編集を推奨しているため、そのようなカスタマイズによって PII が導入された可能性があります。この値は、特にコントロール ドメインのネットワーク スクリプトで使用されます。
パスワードは、PII の宣言に関わらず、いかなるバグ報告にも含めてはなりません。 -
この操作を実行するホストは、標準の選択メカニズム（上記の ホストセレクター を参照）を使用して選択されます。
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
特定のホストの退避を妨げるVMのリストを返し、それぞれの理由を表示します。
host-is-in-emergency-mode
xe host-is-in-emergency-mode
CLIが通信しているホストが緊急モードの場合、
trueを返します。それ以外の場合はfalseを返します。このCLIコマンドは、プールコーディネーターが存在しない場合でも、プールメンバーホストで直接動作します。
host-license-view
xe host-license-view [host-uuid=host_uuid]
XenServerホストライセンスの内容を表示します。
host-logs-download
xe host-logs-download [file-name=logfile_name] [host-selector=host_selector_value...]
指定されたXenServerホストのログのコピーをダウンロードします。コピーはデフォルトで、
hostname-yyyy-mm-dd T hh:mm:ssZ.tar.gzという名前のタイムスタンプ付きファイルに保存されます。オプションパラメーター file-name を使用して、別のファイル名を指定できます。
この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。
重要:
xe host-logs-downloadコマンドはローカルホストで実行した場合（つまり、特定のホスト名を指定しない場合）でも機能しますが、この方法では使用しないでください。そうすると、ログのコピーでコントロールドメインパーティションが乱雑になります。このコマンドは、ログのコピーを保持するスペースがあるリモートのオフホストマシンからのみ使用してください。
host-management-disable
xe host-management-disable
外部管理ネットワークインターフェースでリッスンしているホストエージェントを無効にし、接続されているすべてのAPIクライアント（XenCenterなど）を切断します。このコマンドは、CLIが接続されているXenServerホストで直接動作します。メンバーXenServerホストに適用された場合、このコマンドはプールコーディネーターに転送されません。
警告:
このCLIコマンドをオフホストで使用する場合は注意してください。このコマンドを実行した後、ネットワーク経由でリモートからコントロールドメインに接続してホストエージェントを再度有効にすることはできません。
host-management-reconfigure
xe host-management-reconfigure [interface=device] [pif-uuid=uuid]
XenServerホストを再構成して、指定されたネットワークインターフェースを管理インターフェースとして使用します。これは、XenCenterに接続するために使用されるインターフェースです。このコマンドは、
/etc/xensource-inventoryのMANAGEMENT_INTERFACEキーを書き換えます。
インターフェースのデバイス名（IPアドレスを持つ必要があります）が指定されている場合、XenServerホストは直ちに再バインドします。このコマンドは、通常モードと緊急モードの両方で機能します。
PIFオブジェクトのUUIDが指定されている場合、XenServerホストは自身に再バインドするIPアドレスを決定します。このコマンドの実行中は、緊急モードであってはなりません。
警告:
このCLIコマンドをオフホストで使用する場合は注意し、新しいインターフェースでネットワーク接続が確立されていることを確認してください。まず
xe pif-reconfigureを使用して設定してください。そうしないと、その後のCLIコマンドがXenServerホストに到達できなくなります。
host-power-on
xe host-power-on [host=host_uuid]
ホスト電源オン機能が有効になっているXenServerホストの電源をオンにします。このコマンドを使用する前に、ホストで
host-set-power-onを有効にしてください。
host-reboot
xe host-reboot [host-selector=host_selector_value...]
指定されたXenServerホストを再起動します。指定されたホストは、まず
xe host-disableコマンドを使用して無効にする必要があります。そうしないと、HOST_IN_USEエラーメッセージが表示されます。
この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭にリストされているホストパラメータの任意の数を指定できます。
指定されたXenServerホストがプールメンバーである場合、シャットダウン時の接続喪失は処理され、XenServerホストが復帰するとプールは回復します。他のメンバーとプールコーディネーターは引き続き機能します。
プールコーディネーターをシャットダウンすると、次のいずれかのアクションが発生するまでプールは機能停止します。
-
メンバーの1つをプールコーディネーターにする
-
元のプールコーディネーターが再起動され、オンラインに戻る。プールコーディネーターがオンラインに戻ると、メンバーは再接続し、プールコーディネーターと同期します。
host-restore
xe host-restore [file-name=backup_filename] [host-selector=host_selector_value...]
XenServerホスト制御ソフトウェアの
file-nameという名前のバックアップを復元します。ここでの「復元」という言葉は、通常の意味での完全な復元を意味するものではなく、圧縮されたバックアップファイルが解凍され、セカンダリパーティションに展開されたことを意味するにすぎません。xe host-restoreを実行した後、インストールCDを起動し、「バックアップから復元」オプションを使用する必要があります。
host-send-debug-keys
xe host-send-debug-keys host-uuid=host_uuid keys=keys
指定されたハイパーバイザーデバッグキーを指定されたホストに送信します。
host-server-certificate-install
xe host-server-certificate-install certificate=path_to_certificate_file private-key=path_to_private_key [certificate-chain=path_to_chain_file] [host=host_name | uuid=host_uuid]
XenServerホストにTLS証明書をインストールします。
host-set-hostname-live
xe host-set-hostname-live host-uuid=uuid_of_host host-name=new_hostname
host-uuidで指定されたXenServerホストのホスト名を変更します。このコマンドは、制御ドメインデータベース内のホスト名と、XenServerホストの実際の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" | "IPMI" | "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 ]
リモート電源ソリューションと互換性のあるXenServerホストで、ホスト電源オン機能を有効にするために使用します。
host-set-power-onコマンドを使用する場合、ホスト上の電源管理ソリューションのタイプ（つまり、電源オンモード）を指定する必要があります。次に、power-on-config引数とその関連するキーと値のペアを使用して構成オプションを指定します。
パスワードを保存するためにシークレット機能を使用するには、キー
"power_on_password_secret"を指定します。詳細については、シークレットを参照してください。
host-shutdown
xe host-shutdown [host-selector=host_selector_value...]
指定されたXenServerホストをシャットダウンします。指定されたXenServerホストは、まず
xe host-disableコマンドを使用して無効にする必要があります。そうしないと、HOST_IN_USEエラーメッセージが表示されます。
この操作を実行するホストは、標準の選択メカニズムを使用して選択されます（上記のホストセレクターを参照）。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。
指定されたXenServerホストがプールに属している場合、シャットダウン時の接続喪失は処理され、XenServerホストが復帰するとプールは回復します。他のメンバーとプールコーディネーターは引き続き機能します。
プールコーディネーターをシャットダウンすると、以下のいずれかの操作が行われるまでプールは機能停止状態になります。
-
メンバーの1つをプールコーディネーターにする
-
元のプールコーディネーターが再起動され、オンラインに戻る。プールコーディネーターがオンラインに戻ると、メンバーは再接続し、プールコーディネーターと同期します。
プールでHAが有効になっている場合、メンバーの1つが自動的にプールコーディネーターになります。HAが無効になっている場合、
pool-designate-new-masterコマンドを使用して、目的のXenServerホストをプールコーディネーターとして手動で指定する必要があります。詳細については、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-data-source-list
xe host-data-source-list [host-selectors=host selector value...]
ホストに記録できるデータソースを一覧表示します。
標準の選択メカニズム (ホストセレクターを参照) を使用して、この操作を実行するホストを選択します。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのホストで実行されます。
データソースには、
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-data-source-forget
メッセージコマンド
メッセージを操作するためのコマンド。メッセージは、重要なイベントをユーザーに通知するために作成され、XenCenterでアラートとして表示されます。
メッセージオブジェクトは、標準のオブジェクトリストコマンド（
xe message-list）でリストでき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、低レベルパラメーターコマンドを参照してください。
メッセージパラメーター
| パラメーター名 | 説明 | タイプ |
|---|---|---|
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
ネットワークコマンド
ネットワークを操作するためのコマンド。
ネットワークオブジェクトは、標準のオブジェクトリストコマンド (
xe network-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
ネットワークパラメーター
ネットワークには次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
ネットワークの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
ネットワークの名前 | 読み取り/書き込み |
name-description |
ネットワークの説明テキスト | 読み取り/書き込み |
VIF-uuids |
VMからこのネットワークに接続されているVIF（仮想ネットワークインターフェース）の一意の識別子のリスト | 読み取り専用セットパラメータ |
PIF-uuids |
XenServerホストからこのネットワークに接続されているPIF（物理ネットワークインターフェース）の一意の識別子のリスト | 読み取り専用セットパラメータ |
bridge |
ローカルのXenServerホスト上でこのネットワークに対応するブリッジの名前 | 読み取り専用 |
default-locking-mode |
ARPフィルタリングのためにVIFオブジェクトと共に使用されるネットワークオブジェクト。VIFに関連付けられているすべてのフィルタリングルールを削除するには、unlockedに設定します。VIFがすべてのトラフィックを破棄するようにするには、disabledに設定します。 |
読み取り/書き込み |
purpose |
XenServerホストがこのネットワークを使用する目的のセット。NBD接続を行うためにネットワークを使用するには、nbdに設定します。 |
読み取り/書き込み |
other-config:staticroutes |
サブネットをルーティングするゲートウェイアドレスを指定する、サブネット/ネットマスク/*ゲートウェイ*形式のエントリのコンマ区切りリスト。たとえば、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 |
スキャッターギャザーを有効にするには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ネットワークからVMにVFを割り当てます。
SDNコントローラーコマンド
SDNコントローラーを操作するためのコマンド。
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-create
xe tunnel-create pif-uuid=pif_uuid network-uuid=network_uuid
ホスト上に新しいトンネルを作成する。
tunnel-destroy
xe tunnel-destroy uuid=uuid
トンネルを破棄する。
パッチコマンド
パッチを操作するためのコマンド。
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 は、XenServer ホストがストレージリポジトリ (SR) にアクセスするためのソフトウェアオブジェクトです。
PBD オブジェクトは、標準のオブジェクトリストコマンド (
xe pbd-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
PBD パラメーター
PBD には次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
PBD の一意の識別子/オブジェクト参照。 | 読み取り専用 |
sr-uuid |
PBD が指すストレージリポジトリ | 読み取り専用 |
device-config |
ホストのSRバックエンドドライバーに提供される追加設定情報 | 読み取り専用マップパラメータ |
currently-attached |
このホストにSRがアタッチされている場合は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]
XenServerホスト上にPBDを作成します。読み取り専用の
device-configパラメータは、作成時にのみ設定できます。
'path'から'/tmp'へのマッピングを追加するには、コマンドラインに引数
device-config:path=/tmpが含まれていることを確認してください。
各SRタイプでサポートされているdevice-configキーと値のペアの完全なリストについては、ストレージを参照してください。
pbd-destroy
xe pbd-destroy uuid=uuid_of_pbd
指定されたPBDを破棄します。
pbd-plug
xe pbd-plug uuid=uuid_of_pbd
PBDをXenServerホストにプラグインしようとします。このコマンドが成功すると、参照されているSR（およびその中に含まれるVDI）がXenServerホストに表示されるようになります。
pbd-unplug
xe pbd-unplug uuid=uuid_of_pbd
PBDをXenServerホストからアンプラグしようとします。
PIFコマンド
PIF（物理ネットワークインターフェースを表すオブジェクト）を操作するためのコマンド。
PIFオブジェクトは標準のオブジェクトリストコマンド（
xe pif-list）でリストでき、パラメータは標準のパラメータコマンドで操作できます。詳細については、低レベルパラメータコマンドを参照してください。
PIFパラメータ
PIFには以下のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
PIFの一意の識別子/オブジェクト参照 | 読み取り専用 |
device machine-readable |
インターフェース名 (例: eth0) | 読み取り専用 |
MAC |
PIFのMACアドレス | 読み取り専用 |
other-config |
追加のPIF構成 name:value ペア。 |
読み取り/書き込みマップパラメータ |
physical |
trueの場合、PIFは実際の物理ネットワークインターフェースを指します | 読み取り専用 |
currently-attached |
PIFはこのホストに現在アタッチされていますか？ true または false |
読み取り専用 |
MTU |
PIFの最大転送単位（バイト単位）。 | 読み取り専用 |
VLAN |
このインターフェースを通過するすべてのトラフィックの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が接続されているXenServerホストの一意の識別子/オブジェクト参照 | 読み取り専用 |
host-name-label |
このPIFが接続されているXenServerホストの名前 | 読み取り専用 |
IP-configuration-mode |
使用されるネットワークアドレス構成のタイプ。DHCPまたは静的。 | 読み取り専用 |
IP |
PIFのIPアドレス。IP構成モードが静的の場合にここで定義され、DHCPの場合は未定義。 | 読み取り専用 |
netmask |
PIFのネットマスク。IP構成モードが静的の場合にここで定義され、DHCPによって提供される場合は未定義。 | 読み取り専用 |
gateway |
PIFのゲートウェイアドレス。IP構成モードが静的の場合にここで定義され、DHCPによって提供される場合は未定義。 | 読み取り専用 |
DNS |
PIFのDNSアドレス。IP構成モードが静的の場合にここで定義され、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のデュプレックスモード。全二重または半二重 | 読み取り専用 |
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 |
on に設定するとスキャッターギャザーが有効になり、off に設定すると無効になります | 読み取り/書き込み |
other-config:ethtool-tso |
on に設定するとTCPセグメンテーションオフロードが有効になり、off に設定すると無効になります | 読み取り/書き込み |
other-config:ethtool-ufo |
on に設定するとUDPフラグメントオフロードが有効になり、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
指定されたXenServerホスト上の物理インターフェースを表す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アドレスを変更します。静的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
XenServerホスト上の新しい物理インターフェースをスキャンします。
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
指定された物理インターフェースを停止しようとします。
プールコマンド
プールを操作するためのコマンド。プールは、1つ以上のXenServerホストの集合体です。プールは1つ以上の共有ストレージリポジトリを使用するため、プール内の1つのホストで実行されているVMを、ほぼリアルタイムでプール内の別のホストに移行できます。この移行は、VMが実行中のままで行われ、シャットダウンして再起動する必要はありません。
各XenServerホストは、デフォルトでは単一メンバーで構成されるプールです。XenServerホストがプールに参加すると、メンバーとして指定されます。ホストが参加しているプールが単一メンバーで構成されている場合、そのメンバーがプールコーディネーターになります。ホストが参加しているプールにすでに複数のメンバーがいる場合、これらのメンバーの1人がすでにプールコーディネーターであり、新しいホストがプールに参加してもその状態は維持されます。
シングルトンプールオブジェクトは、標準のオブジェクトリストコマンド (
xe pool-list) でリストできます。そのパラメータは、標準のパラメータコマンドで操作できます。詳細については、「低レベルパラメータコマンド」を参照してください。
プールパラメータ
プールには次のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
プールのユニークな識別子/オブジェクト参照 | 読み取り専用 |
name-label |
プールの名前 | 読み取り/書き込み |
name-description |
プールの説明文字列 | 読み取り/書き込み |
master |
プールのコーディネーターとして指定されたXenServerホストのユニークな識別子/オブジェクト参照 | 読み取り専用 |
default-SR |
プールのデフォルトSRのユニークな識別子/オブジェクト参照 | 読み取り/書き込み |
crash-dump-SR |
プールメンバーのクラッシュダンプが保存されるSRの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
metadata-vdis |
プール用の既知のすべてのメタデータVDI | 読み取り専用 |
suspend-image-SR |
プールメンバー上の中断されたVMが保存されるSRの一意の識別子/オブジェクト参照 | 読み取り/書き込み |
other-config |
プール用の追加の構成パラメータを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメータ |
other-config:default_ha_timeout |
高可用性タイムアウト（秒単位）。 | 読み取り/書き込み |
supported-sr-types |
このプールが使用できるSRタイプ | 読み取り専用 |
ha-enabled |
HAがプールで有効になっている場合はtrue、それ以外の場合はfalse | 読み取り専用 |
ha-configuration |
将来の使用のために予約されています。 | 読み取り専用 |
ha-statefiles |
HAがストレージの健全性を判断するために使用しているVDIのUUIDをリストします | 読み取り専用 |
ha-host-failures-to-tolerate |
システムアラートを送信するまでに許容するホスト障害の数 | 読み取り/書き込み |
ha-plan-exists-for |
HAアルゴリズムの計算に従って、実際に処理できるホスト障害の数 | 読み取り専用 |
ha-allow-overcommit |
プールがオーバーコミットを許可されている場合はtrue、それ以外の場合はfalse | 読み取り/書き込み |
ha-overcommitted |
プールがオーバーコミットされている場合はtrue | 読み取り専用 |
ha-reboot-vm-on-internal-shutdown |
クリーンシャットダウン時に保護されたVMが再起動される場合はtrue、それ以外の場合はfalse。 | 読み取り/書き込み |
blobs |
バイナリデータストア | 読み取り専用 |
live-patching-disabled |
ライブパッチを有効にするにはfalseに設定します。ライブパッチを無効にするにはtrueに設定します。 | 読み取り/書き込み |
igmp-snooping-enabled |
IGMPスヌーピングを有効にするにはtrueに設定します。IGMPスヌーピングを無効にするにはfalseに設定します。 | 読み取り/書き込み |
https-only |
管理APIを使用する外部クライアントが、ポート443経由のHTTPSまたはポート80経由のHTTPのいずれかを使用してXenServerに接続できるようにするには、falseに設定します。ポート80をブロックし、クライアントがポート443経由のHTTPSのみを使用して接続するように要求するには、trueに設定します。 | 読み取り/書き込み |
migration-compression |
XenServerプールで移行ストリーム圧縮を有効にするにはtrueに設定します。移行ストリーム圧縮を無効にするにはfalseに設定します。デフォルトはfalseです。vm-migrateコマンドのcompressパラメーターで上書きできます。 |
読み取り/書き込み |
pool-apply-edition
xe pool-apply-edition edition=cloud|standard-per-socket|premium-per-socket [uuid=uuid] [license-server-address=address] [license-server-port=port]
プール全体にエディションを適用します。エディションの値には、「cloud」、「standard-per-socket」、「premium-per-socket」が含まれます。今後は「cloud」のみがサポートされます。
pool-certificate-install
xe pool-certificate-install filename=file_name
プール全体にTLS証明書をインストールします。
pool-certificate-list
xe pool-certificate-list
プール内のインストールされているすべてのTLS証明書を一覧表示します。
pool-certificate-sync
xe pool-certificate-sync
プールコーディネーターから他のプールメンバーへ、TLS証明書と証明書失効リストを同期します。
pool-certificate-uninstall
xe pool-certificate-uninstall name=name
TLS証明書をアンインストールします。
pool-crl-install
xe pool-crl-install filename=file_name
プール全体にTLS証明書失効リストをインストールします。
pool-crl-list
xe pool-crl-list
インストールされているすべてのTLS証明書失効リストを一覧表示します。
pool-crl-uninstall
xe pool-crl-uninstall name=name
TLS証明書失効リストをアンインストールします。
pool-deconfigure-wlb
xe pool-deconfigure-wlb
ワークロードバランシングの設定を完全に削除します。
pool-designate-new-master
xe pool-designate-new-master host-uuid=uuid_of_new_master
指定されたメンバーのXenServerホストに、既存のプールのコーディネーター（以前は「マスター」と呼ばれていました）になるよう指示します。このコマンドは、プールコーディネーターの役割をリソースプール内の別のホストに秩序正しく引き渡します。このコマンドは、現在のプールコーディネーターがオンラインの場合にのみ機能します。これは、以下にリストされている緊急モードコマンドの代替ではありません。
pool-disable-external-auth
xe pool-disable-external-auth [uuid=uuid] [config=config]
プール内のすべてのホストで外部認証を無効にします。
pool-disable-local-storage-caching
xe pool-disable-local-storage-caching uuid=uuid
プール全体でローカルストレージキャッシュを無効にします。
pool-disable-redo-log
xe pool-disable-redo-log
HAが有効になっていない限り、使用中の場合はリドゥログを無効にします。
pool-dump-database
xe pool-dump-database file-name=filename_to_dump_database_into_(on_client)
プールデータベース全体のコピーをダウンロードし、クライアント上のファイルにダンプします。
pool-enable-external-auth
xe pool-enable-external-auth auth-type=auth_type service-name=service_name [uuid=uuid] [config:=config]
プール内のすべてのホストで外部認証を有効にします。
auth-type の一部の値は、特定の config: の値を必要とすることに注意してください。
pool-enable-local-storage-caching
xe pool-enable-local-storage-caching uuid=uuid
プール全体でローカルストレージキャッシュを有効にします。
pool-enable-redo-log
xe pool-ensable-redo-log sr-uuid=sr_uuid
HAが有効になっていない限り、使用中の場合は指定されたSRでリドゥログを有効にします。
pool-eject
xe pool-eject host-uuid=uuid_of_host_to_eject
指定されたXenServerホストに既存のプールから離脱するよう指示します。
pool-emergency-reset-master
xe pool-emergency-reset-master master-address=address_of_pool_master
プールメンバーホストに、プールコーディネーターアドレスを新しい値にリセットし、それに接続を試みるよう指示します。このコマンドはプールコーディネーターでは実行しないでください。
pool-emergency-transition-to-master
xe pool-emergency-transition-to-master
メンバーのXenServerホストに、プールコーディネーター（以前は「プールマスター」と呼ばれていました）になるよう指示します。XenServerホストは、ホストが緊急モードに移行した後にのみこのコマンドを受け入れます。緊急モードとは、コーディネーターがネットワークから消失し、数回の再試行後も連絡が取れないプールのメンバーであることを意味します。
ホストがプールに参加して以来、ホストのパスワードが変更されている場合、このコマンドによりホストのパスワードがリセットされる可能性があります。詳細については、(ユーザーコマンド)を参照してください。
pool-ha-enable
xe pool-ha-enable heartbeat-sr-uuids=uuid_of_heartbeat_sr
指定されたSR UUIDを中央ストレージハートビートリポジトリとして使用し、リソースプールで高可用性を有効にします。
pool-ha-disable
xe pool-ha-disable
リソースプールで高可用性機能を無効にします。
pool-ha-compute-hypothetical-max-host-failures-to-tolerate
現在のプール構成で許容できるホスト障害の最大数を計算します。
pool-ha-compute-max-host-failures-to-tolerate
xe pool-ha-compute-hypothetical-max-host-failures-to-tolerate [vm-uuid=vm_uuid] [restart-priority=restart_priority]
提供された、提案されている保護対象VMを使用して、許容できるホスト障害の最大数を計算します。
pool-initialize-wlb
xe pool-initialize-wlb wlb_url=url wlb_username=wlb_username wlb_password=wlb_password xenserver_username=username xenserver_password=password
現在のプールに対して、ターゲットのワークロードバランシングサーバーを使用してワークロードバランシングを初期化します。
pool-join
xe pool-join master-address=address master-username=username master-password=password
XenServer ホストに既存のプールに参加するよう指示します。
pool-management-reconfigure
xe pool-management-reconfigure [network-uuid=network-uuid]
プール内のすべてのホストの管理インターフェースを、指定されたネットワークインターフェースを使用するように再構成します。これはXenCenterへの接続に使用されるインターフェースです。このコマンドは、プール内のすべてのホストに対して、
/etc/xensource-inventory 内の MANAGEMENT_INTERFACE キーを書き換えます。
インターフェースのデバイス名（IPアドレスを持つ必要がある）が指定された場合、XenServer プールコーディネーターは直ちに再バインドします。このコマンドは、通常モードと緊急モードの両方で機能します。
指定されたネットワークUUIDから、PIF オブジェクトのUUIDが識別され、XenServer ホストにマッピングされます。これにより、どのIPアドレスを自身に再バインドするかが決定されます。このコマンドの実行中は、緊急モードであってはなりません。
警告:
このCLIコマンドをオフホストで使用する際は注意し、新しいインターフェースでネットワーク接続があることを確認してください。まず、
xe pif-reconfigure を使用して設定してください。そうしないと、後続のCLIコマンドがXenServer ホストに到達できなくなります。
pool-recover-slaves
xe pool-recover-slaves
プールコーディネーターに、現在緊急モードで実行されているすべてのメンバーのアドレスをリセットするように試みるよう指示します。このコマンドは通常、
pool-emergency-transition-to-master が使用されてメンバーの1つが新しいプールコーディネーターとして設定された後に使用されます。
pool-restore-database
xe pool-restore-database file-name=filename_to_restore_from_on_client [dry-run=true|false]
データベースバックアップ（
pool-dump-database で作成されたもの）をプールにアップロードします。アップロードを受信すると、プールコーディネーターは新しいデータベースで自身を再起動します。
ドライラン オプションもあり、これにより、実際に操作を実行することなく、プールデータベースが復元可能であることを確認できます。デフォルトでは、
dry-run は false に設定されています。
pool-retrieve-wlb-configuration
xe pool-retrieve-wlb-configuration
Workload Balancingサーバーからプール最適化基準を取得します。
pool-retrieve-wlb-diagnostics
xe pool-retrieve-wlb-diagnostics [filename=file_name]
Workload Balancingサーバーから診断情報を取得します。
pool-retrieve-wlb-recommendations
xe pool-retrieve-wlb-recommendations
Workload Balancingサーバーから、プールに対するVM移行推奨事項を取得します。
pool-retrieve-wlb-report
xe pool-retrieve-wlb-report report=report [filename=file_name]
Workload Balancingサーバーからレポートを取得します。
pool-secret-rotate
xe pool-secret-rotate
プールシークレットをローテーションします。
プールシークレットは、プール内のXenServerホスト間で共有されるシークレットであり、ホストがプールへのメンバーシップを証明できるようにします。Pool Adminロールを持つユーザーは、SSH経由でホストに接続する際にこのシークレットを表示できます。これらのユーザーのいずれかが組織を離れるか、Pool Adminロールを失った場合は、プールシークレットをローテーションしてください。
pool-send-test-post
xe pool-send-test-post dest-host=destination_host dest-port=destination_port body=post_body
指定された本文を、HTTPSを使用して指定されたホストとポートに送信し、応答を出力します。これはTLSレイヤーのデバッグに使用されます。
pool-send-wlb-configuration
xe pool-send-wlb-configuration [config:=config]
Workload Balancingサーバーのプール最適化基準を設定します。
pool-sync-database
xe pool-sync-database
リソースプール内のすべてのホスト間でプールデータベースを強制的に同期します。データベースは定期的に自動的にレプリケートされるため、このコマンドは通常の操作では必要ありません。ただし、このコマンドは、一連の重要なCLI操作を実行した後、変更が迅速にレプリケートされることを保証するのに役立ちます。
https-onlyを設定
xe pool-param-set [uuid=pool-uuid] [https-only=true|false]
XenServerホストの管理インターフェースでポート80のブロックを有効または無効にします。
PVSアクセラレータコマンド
PVSアクセラレータを操作するためのコマンド。
pvs-cache-storage-create
xe pvs-cache-storage-create sr-uuid=sr_uuid pvs-site-uuid=pvs_site_uuid size=size
指定されたホストの指定されたSR上に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プロキシを使用するようにVM/VIFを構成します。
pvs-proxy-destroy
xe pvs-proxy-destroy uuid=uuid
このVIF/VMの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サイトを追加する。
ストレージマネージャーコマンド
ストレージマネージャープラグインを制御するためのコマンド。
ストレージマネージャーオブジェクトは、標準のオブジェクトリストコマンド (
xe sm-list) で一覧表示できます。パラメーターは、標準のパラメーターコマンドで操作できます。詳細については、低レベルパラメーターコマンドを参照してください。
SMパラメーター
SMには以下のパラメーターがあります:
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
SMプラグインの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
SMプラグインの名前 | 読み取り専用 |
name-description |
SMプラグインの説明文字列 | 読み取り専用 |
type |
このプラグインが接続するSRタイプ | 読み取り専用 |
vendor |
このプラグインを作成したベンダーの名前 | 読み取り専用 |
copyright |
このSMプラグインの著作権表示 | 読み取り専用 |
required-api-version |
XenServerホストで必要な最小SM APIバージョン | 読み取り専用 |
configuration |
デバイス構成キーの名前と説明 | 読み取り専用 |
capabilities |
SMプラグインの機能 | 読み取り専用 |
driver-filename |
SRドライバーのファイル名。 | 読み取り専用 |
ホストとプールでのSSHアクセスを管理する
概要
XenServer 8.4では、dom0へのSSHアクセスがデフォルトで有効になっています。このリリースでは、XenAPIまたはxeコマンドラインインターフェイス（CLI）を使用してSSHアクセスをプログラムで制御する機能が導入されました。
この機能強化により、管理者は個々のホストレベルとプール全体のレベルの両方でSSHアクセスを管理できるようになり、各サーバーコンソールとの手動でのやり取りが不要になります。
利点
-
自動管理: 個々のホストまたはプール全体でSSHをプログラムで有効または無効にします。
-
管理オーバーヘッドの削減: SSHアクセスの管理に必要な手動の管理作業を大幅に削減します。
-
ワークフローの強化: 既存の管理システムにSSH制御を統合することで、自動化スクリプトを改善し、セキュリティワークフローを強化します。
互換性と注意点
-
追加要件なし: この機能には、追加の構成や特定の互換性調整は必要ありません。
-
サービスの動作: SSHを無効にすると、指定されたホストでsshdサービスが停止され、無効になります。
-
既存のセッション: サービスを無効にした後でも、既存のSSHセッションはアクティブなままで中断されません。
-
新しい接続: SSHが無効になると、新しい接続試行は拒否されます。
-
プール全体の操作: プール全体で実行される操作は、プール内の1つ以上のホストで障害が発生した場合でも続行されます。
失敗した操作の詳細を示す要約メッセージが提供されます。
CLI設定
ホストでSSHを有効にする
xe host-enable-ssh host=<host_uuid_or_name_label>
ホストでSSHを無効にする
xe host-disable-ssh host=<host_uuid_or_name_label>
このコマンドは、指定されたホストでsshdサービスを停止し、無効にします。
プール内のすべてのホストでSSHを有効にする
xe pool-enable-ssh
このコマンドは、現在のプール内のすべてのホストでsshdサービスを開始し、有効にします。
プール内のすべてのホストでSSHを無効にする
xe pool-disable-ssh
このコマンドは、現在のプール内のすべてのホストでsshdサービスを停止し、無効にします。
出力例 (プールレベルの操作)
xe pool-enable-ssh
Some of hosts failed to enable SSH access.
hosts: d734ff47-f429-4bd4-93f7-245cffbdc79e (genus-35-003d)
ホストが失敗した場合、コマンドは残りのホストの処理を続行し、最後に失敗を報告します。
スナップショットコマンド
スナップショットを操作するためのコマンド。
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]
既存のVMをコピーして新しいテンプレートを作成しますが、ストレージレベルの高速ディスククローン操作 (利用可能な場合でも) は使用しません。コピーされたVMのディスクイメージは「フルイメージ」であることが保証されます。つまり、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]
選択したVMのディスクを一覧表示します。
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]
管理ツールスタックデータベース内でのみ、VMの電源状態を停止に強制します。このコマンドは、「中断」とマークされたスナップショットを回復するために使用されます。これは潜在的に危険な操作です。メモリイメージが不要であることを確認する必要があります。スナップショットを再開することはできなくなります。
snapshot-revert
xe snapshot-revert [uuid=uuid] [snapshot-uuid=snapshot_uuid]
既存のVMを以前のチェックポイントまたはスナップショットの状態に元に戻します。
snapshot-uninstall
xe snapshot-uninstall [uuid=uuid] [snapshot-uuid=snapshot_uuid] [--force]
スナップショットをアンインストールします。この操作により、RWとマークされ、このスナップショットにのみ接続されているVDIが破棄されます。VMレコードを単に破棄するには、snapshot-destroy を使用します。
SRコマンド
SR (ストレージリポジトリ) を制御するためのコマンド。
SRオブジェクトは、標準のオブジェクトリストコマンド (
xe sr-list) で一覧表示でき、パラメータは標準のパラメータコマンドで操作できます。詳細については、「低レベルパラメータコマンド」を参照してください。
SRパラメータ
SRには次のパラメータがあります。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
SRの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
SRの名前 | 読み取り/書き込み |
name-description |
SRの説明文字列 | 読み書き |
host |
ストレージリポジトリのホスト名 | 読み取り専用 |
allowed-operations |
この状態のSRで許可されている操作のリスト | 読み取り専用設定パラメーター |
current-operations |
このSRで現在進行中の操作のリスト | 読み取り専用設定パラメーター |
VDIs |
このSR内の仮想ディスクの一意の識別子/オブジェクト参照 | 読み取り専用設定パラメーター |
PBDs |
このSRに接続されているPBDの一意の識別子/オブジェクト参照 | 読み取り専用設定パラメータ |
virtual-allocation |
このストレージリポジトリ内のすべてのVDIの仮想サイズ値の合計（バイト単位） | 読み取り専用 |
physical-utilisation |
このSRで現在使用されている物理領域（バイト単位）。シンプロビジョニングされたディスク形式の場合、物理的な使用量は仮想割り当てよりも少ない場合があります。 | 読み取り専用 |
physical-size |
SRの合計物理サイズ（バイト単位） | 読み取り専用 |
type |
使用するSRバックエンドドライバを指定するために使用されるSRのタイプ | 読み取り専用 |
content-type |
SRのコンテンツのタイプ。ISOライブラリを他のSRと区別するために使用されます。ISOのライブラリを格納するストレージリポジトリの場合、content-type は iso に設定する必要があります。それ以外の場合、このパラメータは空にするか、文字列 user に設定することをお勧めします。 |
読み取り専用 |
shared |
このSRが複数のホスト間で共有できる場合はtrue、そうでない場合はfalseです。 | 読み取り/書き込み |
introduced-by |
SRを導入したdrtask (存在する場合) |
読み取り専用 |
is-tools-sr |
これがTools ISO VDIを含むSRである場合はtrue、そうでない場合はfalseです。 | 読み取り専用 |
other-config |
SRの追加設定パラメーターを指定するキーと値のペアのリスト | 読み取り/書き込みマップパラメーター |
sm-config |
SM依存データ | 読み取り専用マップパラメータ |
blobs |
バイナリデータストア | 読み取り専用 |
local-cache-enabled |
このSRがホストのローカルキャッシュとして割り当てられている場合はtrue、それ以外の場合はfalseです。 | 読み取り専用 |
tags |
分類目的のユーザー指定タグ | 読み書きセットパラメータ |
clustered |
SRが集約されたローカルストレージを使用している場合はtrue、それ以外の場合はfalseです。 | 読み取り専用 |
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]
ディスク上にSRを作成し、それをデータベースに導入し、SRをXenServerホストにアタッチするPBDを作成します。
sharedがtrueに設定されている場合、プール内の各XenServerホストに対してPBDが作成されます。sharedが指定されていないかfalseに設定されている場合、PBDはhost-uuidで指定されたXenServerホストに対してのみ作成されます。
sr-data-source-forget
xe sr-data-source-forget data-source=data_source
SRの指定されたデータソースの記録を停止し、記録されたすべてのデータを破棄します。
sr-data-source-list
xe sr-data-source-list
SRに記録できるデータソースを一覧表示します。
sr-data-source-query
xe sr-data-source-query data-source=data_source
SRデータソースから読み取られた最後の値を照会します。
sr-data-source-record
xe sr-data-source-record data-source=data_source
SRの指定されたデータソースを記録します。
sr-destroy
xe sr-destroy uuid=sr_uuid
XenServerホスト上の指定されたSRを破棄します。
sr-enable-database-replication
xe sr-enable-database-replication uuid=sr_uuid
指定された（共有）SRへのXAPIデータベースレプリケーションを有効にします。
sr-disable-database-replication
xe sr-disable-database-replication uuid=sr_uuid
指定されたSRへのXAPIデータベースレプリケーションを無効にします。
sr-forget
xe sr-forget uuid=sr_uuid
XAPIエージェントは、XenServerホスト上の指定されたSRを忘れます。XAPIエージェントがSRを忘れると、SRはデタッチされ、その上のVDIにアクセスできなくなりますが、ソースメディア上ではそのまま残ります（データは失われません）。
sr-introduce
xe sr-introduce name-label=name physical-size=physical_size type=type content-type=content_type uuid=sr_uuid
SRレコードをデータベースに配置するだけです。たとえば、
device-config:parameter_key=parameter_value の形式で追加パラメーターを指定するには、device-config を使用します。
xe sr-introduce device-config:device=/dev/sdb1
注:
このコマンドは通常の操作では使用されません。この高度な操作は、SRが作成後に共有として再構成される必要がある場合や、さまざまな障害シナリオからの回復に役立つ場合があります。
sr-probe
xe sr-probe type=type [host-uuid=host_uuid] [device-config:config_name=value]
指定された
device-config キーを使用して、バックエンドのスキャンを実行します。SRバックエンドの device-config が完了している場合、このコマンドはデバイス上に存在するSRのリスト（存在する場合）を返します。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タイプに対して同じ人間が読める形式で結果を返します。
sr-scan
xe sr-scan uuid=sr_uuid
SRスキャンを強制的に実行し、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 SRでシンプロビジョニングを有効にします。
サブジェクトコマンド
サブジェクトを操作するためのコマンド。
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
シークレットを破棄します。
タスクコマンド
長時間実行される非同期タスクを操作するためのコマンドです。これらのコマンドは、仮想マシンの起動、停止、一時停止などのタスクです。タスクは通常、要求された操作を達成するために、他のアトミックなサブタスクのセットで構成されています。
タスクオブジェクトは、標準のオブジェクトリストコマンド (
xe task-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
タスクパラメーター
タスクには次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
タスクの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
タスクの名前 | 読み取り専用 |
name-description |
タスクの説明文字列 | 読み取り専用 |
resident-on |
タスクが実行されているホストの一意の識別子/オブジェクト参照 | 読み取り専用 |
status |
タスクのステータス | 読み取り専用 |
progress |
Taskがまだ保留中の場合、このフィールドには0から1までの推定完了率が含まれます。Taskが成功または失敗にかかわらず完了した場合、値は1になります。 | 読み取り専用 |
type |
Taskが正常に完了した場合、このパラメータにはエンコードされた結果のタイプが含まれます。このタイプは、結果フィールドに参照があるクラスの名前です。それ以外の場合、このパラメータの値は未定義です。 | 読み取り専用 |
result |
Taskが正常に完了した場合、このフィールドには結果値（Voidまたはオブジェクト参照）が含まれます。それ以外の場合、このパラメータの値は未定義です。 | 読み取り専用 |
error_info |
Taskが失敗した場合、このパラメータには関連するエラー文字列のセットが含まれます。それ以外の場合、このパラメータの値は未定義です。 | 読み取り専用 |
allowed_operations |
この状態で許可されている操作のリスト | 読み取り専用 |
created |
タスクが作成された時刻 | 読み取り専用 |
finished |
タスクが完了した時刻（成功または失敗）。タスクステータスが保留中の場合、このフィールドの値は意味を持ちません。 | 読み取り専用 |
subtask_of |
このタスクがサブタスクであるタスクのUUIDが含まれます | 読み取り専用 |
subtasks |
このタスクのすべてのサブタスクのUUIDが含まれます | 読み取り専用 |
task-cancel
xe task-cancel [uuid=task_uuid]
指定されたタスクをキャンセルして戻るように指示します。
テンプレートコマンド
VMテンプレートを操作するためのコマンド。
テンプレートは、本質的に
is-a-templateパラメーターがtrueに設定されたVMです。テンプレートは、特定のVMをインスタンス化するためのさまざまな構成設定をすべて含む「ゴールドイメージ」です。XenServerには、OSベンダーのインストールCD（例：RHEL、CentOS、SLES、Windows）を起動できる汎用的な「生の」VMである基本テンプレートセットが付属しています。VMを作成し、特定のニーズに合わせて標準形式で構成し、将来のVM展開のためにそれらのコピーをテンプレートとして保存できます。
テンプレートオブジェクトは、標準のオブジェクトリストコマンド (
xe template-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
注:
テンプレートは、
is-a-templateパラメーターをfalseに設定することで、VMに直接変換することはできません。is-a-templateパラメーターをfalseに設定することはサポートされておらず、起動できないVMになります。
VMテンプレートパラメーター
テンプレートには次のパラメーターがあります。
-
uuid(読み取り専用) テンプレートの一意の識別子/オブジェクト参照 -
name-label(読み取り/書き込み) テンプレートの名前 -
name-description(読み取り/書き込み) テンプレートの説明文字列 -
user-version(読み取り/書き込み) VMおよびテンプレートの作成者がバージョン情報を記述するための文字列 -
is-a-template(読み取り/書き込み) このVMがテンプレートである場合はtrue。 テンプレートVMは起動できず、他のVMのクローン作成にのみ使用されます。この値がtrueに設定された後は、falseにリセットすることはできません。テンプレートVMは、このパラメーターを使用してVMに変換することはできません。VMをテンプレートに変換するには、次を使用します。xe vm-param-set uuid=<vm uuid> is-a-template=true -
is-control-domain(読み取り専用) これが制御ドメイン（ドメイン0またはドライバー ドメイン）である場合はtrue -
power-state(読み取り専用) 現在の電源状態。テンプレートの場合、値は常にhaltedです。 -
memory-dynamic-max(読み取り専用) 動的な最大メモリ（バイト単位）。 現在は使用されていませんが、変更する場合は次の制約に従う必要があります:memory_static_max>=memory_dynamic_max>=memory_dynamic_min>=memory_static_min。 -
memory-dynamic-min(読み取り/書き込み) 動的な最小メモリ（バイト単位）。 現在は使用されていませんが、変更する場合はmemory-dynamic-maxと同じ制約に従う必要があります。 -
memory-static-max(読み取り/書き込み) 静的に設定された（絶対）最大メモリ（バイト単位）。このフィールドは、VMに割り当てられるメモリ量を決定するために使用される主要な値です。 -
memory-static-min(読み取り/書き込み) 静的に設定された（絶対）最小メモリ（バイト単位）。 このフィールドは絶対最小メモリを表し、memory-static-minはmemory-static-maxより小さくなければなりません。 この値は通常操作では使用されませんが、上記の制約に従う必要があります。 -
suspend-VDI-uuid(読み取り専用) サスペンドイメージが保存されるVDI（テンプレートには意味がありません） -
VCPUs-params(読み取り/書き込みマップパラメータ) 選択されたvCPUポリシーの構成パラメータ。 -
VCPUs-max(読み取り/書き込み) vCPUの最大数 -
VCPUs-at-startup(読み取り/書き込み) 起動時のvCPU数 -
actions-after-crash(読み取り/書き込み) このテンプレートに基づくVMがクラッシュした場合に実行するアクション -
console-uuids(読み取り専用セットパラメータ) 仮想コンソールデバイス -
platform(読み取り/書き込みマップパラメータ) プラットフォーム固有の構成ゲストのパラレルポートエミュレーションを無効にするには：xe vm-param-set uuid=<vm_uuid> platform:parallel=noneシリアルポートエミュレーションを無効にするには：xe vm-param-set uuid=<vm_uuid> platform:hvm_serial=noneUSBコントローラーとUSBタブレットデバイスのエミュレーションを無効にするには：xe vm-param-set uuid=<vm_uuid> platform:usb=false
xe vm-param-set uuid=<vm_uuid> platform:usb_tablet=false -
allowed-operations(読み取り専用セットパラメータ) この状態で許可される操作のリスト -
current-operations(読み取り専用設定パラメータ) このテンプレートで現在進行中の操作のリスト -
allowed-VBD-devices(読み取り専用設定パラメータ) 使用可能なVBD識別子のリスト。0～254の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。 -
allowed-VIF-devices(読み取り専用設定パラメータ) 使用可能なVIF識別子のリスト。0～6の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。 -
HVM-boot-policy(読み取り/書き込み) ゲストのブートポリシー。BIOS順序または空の文字列のいずれか。 -
HVM-boot-params(読み取り/書き込みマップパラメータ) 順序キーはゲストのブート順序を制御します。各文字がブート方法を表す文字列として表現されます。CD/DVDの場合はd、ルートディスクの場合はc、ネットワークPXEブートの場合はn。デフォルトはdcです。 -
PV-kernel(読み取り/書き込み) カーネルへのパス -
PV-ramdisk(読み取り/書き込み)initrdへのパス -
PV-args(読み取り/書き込み) カーネルコマンドライン引数の文字列 -
PV-legacy-args(読み取り/書き込み) このテンプレートに基づくレガシーVMを起動させるための引数の文字列 -
PV-bootloader(読み取り/書き込み) ブートローダーの名前またはパス -
PV-bootloader-args(読み取り/書き込み) ブートローダー用のその他の引数の文字列 -
last-boot-CPU-flags(読み取り専用) このテンプレートに基づくVMが最後に起動されたときのCPUフラグを記述します。テンプレートには設定されません。 -
resident-on(読み取り専用) このテンプレートに基づくVMが常駐するXenServerホスト。テンプレートの場合はnot in databaseとして表示されます。 -
affinity(読み取り/書き込み) このテンプレートに基づくVMが実行を優先するXenServerホスト。xe vm-startコマンドによってVMを実行する場所を決定するために使用されます。ホームサーバーとも呼ばれます。 -
groups(読み取り/書き込み) このVMが属するVMグループ。VMグループは、XenServerがVMを起動しようとする場所、またはVMを退避させる場所を定義します。 -
other-config(読み書きマップパラメータ) テンプレートの追加設定パラメータを指定するキーと値のペアのリスト -
start-time(読み取り専用) このテンプレートに基づくVMのメトリクスが読み取られた日時を示すタイムスタンプ。形式はyyyymmddThh:mm:ss zで、zは1文字の軍事タイムゾーンインジケータ（例: UTC(GMT)の場合はZ）です。テンプレートの場合は1 Jan 1970 Z(Unix/POSIXエポックの開始) に設定されます。 -
install-time(読み取り専用) このテンプレートに基づくVMのメトリクスが読み取られた日時を示すタイムスタンプ。形式はyyyymmddThh:mm:ss zで、zは1文字の軍事タイムゾーンインジケータ（例: UTC (GMT) の場合はZ）です。テンプレートの場合は1 Jan 1970 Z(Unix/POSIXエポックの開始) に設定されます。 -
memory-actual(読み取り専用) このテンプレートに基づくVMが使用している実際のメモリ。テンプレートの場合は0 -
VCPUs-number(読み取り専用) このテンプレートに基づくVMに割り当てられた仮想CPUの数。テンプレートの場合は0 -
VCPUs-Utilization(読み取り専用マップパラメータ) 仮想CPUとその重みのリスト。読み取り専用マップパラメータos-version。このテンプレートに基づくVMのオペレーティングシステムのバージョン。テンプレートの場合はnot in databaseとして表示されます。 -
PV-drivers-version(読み取り専用マップパラメータ) このテンプレートに基づくVMの準仮想化ドライバーのバージョン。テンプレートの場合はnot in databaseとして表示されます。 -
PV-drivers-detected(読み取り専用) このテンプレートに基づくVMの準仮想化ドライバーの最新バージョンを示すフラグ。テンプレートの場合はnot in databaseとして表示されます。 -
memory(読み取り専用マップパラメータ) このテンプレートに基づくVM上のエージェントによって報告されるメモリメトリクス。テンプレートの場合はnot in databaseとして表示されます。 -
disks(読み取り専用マップパラメータ) このテンプレートに基づくVM上のエージェントによって報告されるディスクメトリクス。テンプレートの場合はnot in databaseとして表示されます。 -
networks(読み取り専用マップパラメータ) このテンプレートに基づくVM上のエージェントによって報告されるネットワークメトリクス。テンプレートの場合はnot in databaseとして表示されます。 -
other(読み取り専用マップパラメータ) このテンプレートに基づくVM上のエージェントによって報告されるその他のメトリクス。テンプレートの場合はnot in databaseとして表示されます。 -
guest-metrics-last-updated(読み取り専用) ゲスト内エージェントがこれらのフィールドに最後に書き込みを行った日時を示すタイムスタンプ。形式はyyyymmddThh:mm:ss zで、zは1文字の軍事タイムゾーンインジケータ（例: UTC (GMT) の場合はZ）です。 -
actions-after-shutdown(読み書き) VMがシャットダウンした後に実行するアクション -
actions-after-reboot(読み書き) VMが再起動した後に実行するアクション -
possible-hosts(読み取り専用) VMをホストできる可能性のあるホストのリスト -
HVM-shadow-multiplier(読み取り/書き込み) ゲストに利用可能になるシャドウの量に適用される乗数 -
dom-id(読み取り専用) ドメインID (利用可能な場合、それ以外の場合は-1) -
recommendations(読み取り専用) このVMのプロパティに対する推奨値と範囲のXML仕様 -
xenstore-data(読み取り/書き込みマップパラメータ) VM作成後にxenstoreツリー (/local/domain/*domid*/vmdata) に挿入されるデータ。 -
is-a-snapshot(読み取り専用) このテンプレートがVMスナップショットである場合、値はtrueです -
snapshot_of(読み取り専用) このテンプレートがスナップショットであるVMのUUID -
snapshots(読み取り専用) このテンプレートから取得されたすべてのスナップショットのUUID -
snapshot_time(読み取り専用) 取得された最新のVMスナップショットのタイムスタンプ -
memory-target(読み取り専用) このテンプレートに設定されたターゲットメモリ量 -
blocked-operations(読み取り/書き込みマップパラメータ) このテンプレートで実行できない操作をリストします -
last-boot-record(読み取り専用) このテンプレートの最後のブートパラメータの記録 (XML形式) -
ha-always-run(読み取り/書き込み) このテンプレートのインスタンスが、それが常駐するホストに障害が発生した場合に常に別のホストで再起動される場合、値はtrueです。このパラメータは現在非推奨です。代わりにha-restartpriorityパラメータを使用してください。 -
ha-restart-priority(読み取り専用) 再起動またはベストエフォートの読み取り/書き込みBLOBバイナリデータストア -
live(読み取り専用) 実行中のVMにのみ関連します。
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は破棄されます。
更新コマンド
次のセクションには、XenServerホストの更新コマンドが含まれています。
更新オブジェクトは、標準のオブジェクトリストコマンド (
xe update-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
更新パラメーター
XenServerホストの更新には、次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
更新の一意の識別子/オブジェクト参照 | 読み取り専用 |
host |
このアップデートが適用されるホストのリスト | 読み取り専用 |
host-uuid |
クエリ対象のXenServerホストの一意の識別子 | 読み取り専用 |
name-label |
アップデートの名前 | 読み取り専用 |
name-description |
アップデートの説明文字列 | 読み取り専用 |
applied |
アップデートが適用されたかどうか。trueまたはfalse | 読み取り専用 |
installation-size |
更新のサイズ（バイト単位） | 読み取り専用 |
after-apply-guidance |
XAPIツールスタックまたはホストが再起動を必要とするかどうか | 読み取り専用 |
version |
更新のバージョン | 読み取り専用 |
update-upload
xe update-upload file-name=update_filename
指定された更新ファイルをXenServerホストにアップロードします。このコマンドは、適用する更新を準備します。成功すると、アップロードされた更新のUUIDが表示されます。更新が以前にアップロードされている場合、代わりに
UPDATE_ALREADY_EXISTSエラーが返され、パッチは再度アップロードされません。
update-precheck
xe update-precheck uuid=update_uuid host-uuid=host_uuid
指定されたXenServerホスト上で、指定された更新に含まれる事前チェックを実行します。
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
指定された更新をプール内のすべてのXenServerホストに適用します。
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は、VMを仮想ディスクの内容を表すVDIに接続するソフトウェアオブジェクトです。VBDには、VDIをVMに結び付ける属性（起動可能か、読み取り/書き込みメトリックなど）があります。VDIには、仮想ディスクの物理属性（SRのタイプ、ディスクが共有可能か、メディアが読み取り/書き込み可能か読み取り専用かなど）に関する情報が含まれています。
VBDオブジェクトは標準のオブジェクトリストコマンド (
xe vbd-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
VBD パラメータ
VBD には以下のパラメータがあります:
| パラメータ名 | 説明 | タイプ |
|---|---|---|
uuid |
VBD の一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-uuid |
この VBD がアタッチされている VM の一意の識別子/オブジェクト参照 | 読み取り専用 |
vm-name-label |
この VBD がアタッチされている VM の名前 | 読み取り専用 |
vdi-uuid |
このVBDがマップされているVDIの一意の識別子/オブジェクト参照 | 読み取り専用 |
vdi-name-label |
このVBDがマップされているVDIの名前 | 読み取り専用 |
empty |
trueの場合、このVBDは空のドライブを表します |
読み取り専用 |
device |
ゲストから見えるデバイス。例: hda |
読み取り専用 |
userdevice |
vbd-create中にdeviceパラメータで指定されたデバイス番号。例えば、hdaの場合は0、hdbの場合は1など |
読み取り/書き込み |
bootable |
このVBDが起動可能である場合、値はtrueです | 読み取り/書き込み |
mode |
VBDがマウントされるモード | 読み取り/書き込み |
type |
VBDがVMにどのように表示されるか。例えば、ディスクまたはCD | 読み取り/書き込み |
currently-attached |
このホストにVBDがアタッチされている場合、値はtrue、それ以外の場合はfalseです | 読み取り専用 |
storage-lock |
ストレージレベルのロックが取得された場合、値はtrueです | 読み取り専用 |
status-code |
最後の接続操作に関連付けられたエラー/成功コード | 読み取り専用 |
status-detail |
最後の接続操作ステータスに関連付けられたエラー/成功情報 | 読み取り専用 |
qos_algorithm_type |
使用する優先順位付けアルゴリズム | 読み取り/書き込み |
qos_algorithm_params |
選択された優先順位付けアルゴリズムのパラメータ | 読み取り/書き込みマップパラメータ |
qos_supported_algorithms |
このVBDでサポートされている優先順位付けアルゴリズム | 読み取り専用セットパラメータ |
io_read_kbs |
このVBDの1秒あたりの平均読み取り速度（kB単位） | 読み取り専用 |
io_write_kbs |
このVBDの1秒あたりの平均書き込み速度（kB単位） | 読み取り専用 |
allowed-operations |
この状態が許可する操作のリスト。このリストは参考情報であり、クライアントがこのフィールドを読み取るまでにサーバーの状態が変更されている可能性があります。 | 読み取り専用設定パラメーター |
current-operations |
このオブジェクトを使用している実行中の各タスクを（参照によって）タスクの性質を記述するcurrent_operation列挙型にリンクします。 | 読み取り専用設定パラメーター |
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]
VM上にVBDを作成します。
deviceフィールドの許容値は0～254の整数で、各VMで一意である必要があります。現在の許容値は、指定されたVMのallowed-VBD-devicesパラメータで確認できます。これは、vbdパラメータではuserdeviceとして表示されます。
typeがDiskの場合、vdi-uuidが必要です。ディスクの場合、モードはROまたはRWにできます。
typeがCDの場合、vdi-uuidはオプションです。VDIが指定されていない場合、CD用に空のVBDが作成されます。CDの場合、モードは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
VMが実行状態にある間にVBDをアタッチしようとします。
vbd-unplug
xe vbd-unplug uuid=uuid_of_vbd
VMが実行状態にある間に、VBDをVMからデタッチしようとします。
VDIコマンド
VDI（仮想ディスクイメージ）を操作するためのコマンド。
VDIは、VMによって認識される仮想ディスクの内容を表すソフトウェアオブジェクトです。これはVBDとは異なります。VBDはVMをVDIに結び付けるオブジェクトです。VDIには、仮想ディスクの物理属性（SRのタイプ、ディスクが共有可能かどうか、メディアが読み書き可能か読み取り専用かなど）に関する情報が含まれています。VBDには、VDIをVMに結び付ける属性（起動可能かどうか、読み書きメトリックなど）が含まれています。
VDIオブジェクトは、標準のオブジェクトリストコマンド (
xe vdi-list) でリスト表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」を参照してください。
VDIパラメーター
VDIには次のパラメーターがあります。
| パラメーター名 | 説明 | タイプ |
|---|---|---|
uuid |
VDIの一意の識別子/オブジェクト参照 | 読み取り専用 |
name-label |
VDIの名前 | 読み取り/書き込み |
name-description |
VDIの説明文字列 | 読み取り/書き込み |
allowed-operations |
この状態で許可されている操作のリスト | 読み取り専用設定パラメーター |
current-operations |
このVDIで現在進行中の操作のリスト | 読み取り専用設定パラメーター |
sr-uuid |
VDIが存在するSR | 読み取り専用 |
vbd-uuids |
このVDIを参照するVBDのリスト | 読み取り専用設定パラメータ |
crashdump-uuids |
このVDIを参照するクラッシュダンプのリスト | 読み取り専用設定パラメータ |
virtual-size |
VMに提示されるディスクのサイズ（バイト単位）。ストレージバックエンドのタイプによっては、サイズが正確に反映されない場合があります | 読み取り専用 |
physical-utilisation |
VDIがSR上で占有している物理領域の量（バイト単位） | 読み取り専用 |
type |
VDI の種類。例: System または User | 読み取り専用 |
sharable |
この VDI が共有可能な場合は true、それ以外の場合は false | 読み取り専用 |
read-only |
この VDI が読み取り専用でしかマウントできない場合は true、それ以外の場合は false | 読み取り専用 |
storage-lock |
この VDI がストレージレベルでロックされている場合は true、それ以外の場合は false | 読み取り専用 |
parent |
この VDI がチェーンの一部である場合、親 VDI を参照します | 読み取り専用 |
missing |
SRスキャン操作がこの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がVMストレージスナップショットである場合、値はtrue、そうでない場合はfalse | 読み取り専用 |
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
指定された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を使用して指定できます。
注:
ディスクのシンプロビジョニングをサポートするSRタイプ（Local VHDやNFSなど）は、ディスクの仮想割り当てを強制しません。SR上で仮想ディスク領域を過剰に割り当てる場合は、細心の注意を払ってください。過剰に割り当てられたSRがいっぱいになった場合、ディスク領域はSRターゲット基盤上で利用可能にするか、SR内の未使用のVDIを削除することによって利用可能にする必要があります。
一部のSRタイプでは、
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 SRタイプの場合、
vdi-destroyではディスク領域はすぐに解放されませんが、ストレージリポジトリのスキャン操作中に定期的に解放されます。削除されたディスク領域を強制的に利用可能にする必要がある場合は、手動で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の変更ブロック追跡を有効にします。
注:
変更ブロック追跡は、XenServer 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-destroy(/ja-jp/xenserver/8/command-line-interface.html#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を指定されたSRに移行します。(ストレージライブマイグレーション)
詳細については、VMの移行を参照してください。
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の読み書きバージョンを生成します。VM内にバックアップソフトウェアをインストールして実行するのではなく、スナップショットを使用してバックアップを実行します。外部バックアップソフトウェアがスナップショットの内容をバックアップメディアにストリーミングしている間も、VMは実行を継続します。同様に、スナップショットはテンプレートのベースとなる「ゴールドイメージ」として使用できます。テンプレートは任意の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オブジェクトは標準のオブジェクトリストコマンド (
xe vif-list) で一覧表示でき、パラメータは標準のパラメータコマンドで操作できます。詳細については、「低レベルパラメータコマンド」を参照してください。
VIFパラメータ
VIFには次のパラメータがあります。
-
uuid(読み取り専用) VIFの一意の識別子/オブジェクト参照 -
vm-uuid(読み取り専用) このVIFが存在するVMの一意の識別子/オブジェクト参照 -
vm-name-label(読み取り専用) このVIFが存在するVMの名前 -
allowed-operations(読み取り専用セットパラメーター) この状態が許可する操作のリスト -
current-operations(読み取り専用セットパラメーター) このVIFで現在進行中の操作のリスト -
device(読み取り専用) このVIFの整数ラベル。VIFバックエンドが作成された順序を示す -
MAC(読み取り専用) VMに公開されるVIFのMACアドレス -
MTU(読み取り専用) VIFの最大伝送単位（バイト単位）。このパラメーターは読み取り専用ですが、other-configマップパラメーターを使用してmtuキーでMTU設定を上書きできます。たとえば、仮想NICのMTUをリセットしてジャンボフレームを使用するには、次のようにします。xe vif-param-set \
uuid=<vif_uuid> \
other-config:mtu=9000 -
currently-attached(読み取り専用) デバイスがアタッチされている場合はtrue -
qos_algorithm_type(読み取り/書き込み) 使用するQoSアルゴリズム -
qos_algorithm_params(読み取り/書き込みマップパラメーター) 選択されたQoSアルゴリズムのパラメーター -
qos_supported_algorithms(読み取り専用セットパラメーター) このVIFでサポートされているQoSアルゴリズム -
MAC-autogenerated(読み取り専用) VIFのMACアドレスが自動的に生成された場合はtrue -
other-config(読み取り/書き込みマップパラメーター) 追加の構成key:valueペア -
other-config:ethtoolrx(読み取り/書き込み) 受信チェックサムを有効にするにはonに設定し、無効にするにはoffに設定します -
other-config:ethtooltx(読み取り/書き込み) 送信チェックサムを有効にするにはonに設定し、無効にするにはoffに設定します -
other-config:ethtoolsg(read/write) オンに設定するとスカッターギャザーが有効になり、オフに設定すると無効になります -
other-config:ethtooltso(read/write) オンに設定するとTCPセグメンテーションオフロードが有効になり、オフに設定すると無効になります -
other-config:ethtoolufo(read/write) オンに設定するとUDPフラグメントオフロードが有効になり、オフに設定すると無効になります -
other-config:ethtoolgso(read/write) オンに設定すると汎用セグメンテーションオフロードが有効になり、オフに設定すると無効になります -
other-config:promiscuous(read/write) VIFがブリッジ上でプロミスキャスになり、ブリッジ上のすべてのトラフィックを認識するように設定します。仮想マシンで侵入検知システム（IDS）などを実行する場合に役立ちます。 -
network-uuid（読み取り専用）このVIFが接続されている仮想ネットワークの一意の識別子/オブジェクト参照 -
network-name-label(read only) このVIFが接続されている仮想ネットワークの記述名 -
io_read_kbs（読み取り専用）このVIFの平均読み取り速度（kB/秒） -
io_write_kbs（読み取り専用）このVIFの平均書き込み速度（kB/秒） -
locking_mode(read/write) MACアドレスとIPアドレスのリストに対するトラフィックのフィルタリング機能に影響します。追加のパラメーターが必要です。 -
locking_mode:default(read/write) VIFネットワークのデフォルトのロックモードによって異なります。default-locking-modeがdisabledに設定されている場合、XenServerはVIFがトラフィックを送受信できないようにフィルタリングルールを適用します。default-lockingmodeがunlockedに設定されている場合、XenServerはVIFに関連付けられているすべてのフィルタリングルールを削除します。詳細については、「Network Commands」を参照してください。 -
locking_mode:locked(read/write) 指定されたMACアドレスとIPアドレスに送信される、またはそこから送信されるトラフィックのみがVIFで許可されます。IPアドレスが指定されていない場合、トラフィックは許可されません。 -
locking_mode:unlocked(read/write) VIFとの間で送受信されるトラフィックには、フィルターは適用されません。 -
locking_mode:disabled(read/write) XenServerは、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]
VM上にVIFを作成します。
device フィールドの適切な値は、指定されたVMのパラメータ allowed-VIF-devices にリストされています。VIFがまだ存在しない場合、許可される値は0から6までの整数です。
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
VMが実行中の状態にある間にVIFをアタッチしようとします。
vif-unplug
xe vif-unplug uuid=uuid_of_vif
VMが実行中にVIFをVMからデタッチしようとします。
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（仮想ネットワーク）を操作するためのコマンドです。仮想インターフェースを一覧表示および編集するには、関連する仮想ネットワークがあることを示すVLANパラメーターを持つPIFコマンドを参照してください。詳細については、PIFコマンドを参照してください。例えば、VLANを一覧表示するには、
xe pif-listを使用します。
vlan-create
xe vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
XenServerホスト上にVLANを作成します。
pool-vlan-create
xe pool-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
プール内のすべてのホスト上にVLANを作成します。これは、指定されたネットワークがどのインターフェース（例えば、
eth0）上にあるか（各ホスト上で）を判断し、それに応じて各ホスト上に新しいPIFオブジェクトを作成して接続することによって行われます。
vlan-destroy
xe vlan-destroy uuid=uuid_of_pif_mapped_to_vlan
VLANを破棄します。VLANを表すPIFのUUIDが必要です。
VMコマンド
VMとその属性を制御するためのコマンドです。
VMセレクター
ここに記載されているコマンドのいくつかは、操作を実行する1つ以上のVMを選択するための共通のメカニズムを持っています。最も簡単な方法は、引数
vm=name_or_uuid を指定することです。実際のVMのUUIDを取得する簡単な方法は、例えば xe vm-list power-state=running を実行することです。(コマンド xe vm-list params=all を使用して、一致させることができるフィールドの完全なリストを取得します。) 例えば、power-state=halted を指定すると、power-state パラメーターが halted と等しいVMが選択されます。複数のVMが一致する場合は、オプション --multiple を指定して操作を実行します。一致させることができるパラメーターの完全なリストは、このセクションの冒頭で説明されています。
VMオブジェクトは、標準のオブジェクトリストコマンド (
xe vm-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、低レベルパラメーターコマンド を参照してください。
VMパラメーター
VMには以下のパラメーターがあります。
注記:
書き込み可能なすべてのVMパラメータ値は、VMの実行中に変更できますが、新しいパラメータは動的に 適用されず、VMが再起動されるまで適用できません。
-
appliance(読み取り/書き込み) VMが属するアプライアンス/vApp -
uuid(読み取り専用) VMの一意の識別子/オブジェクト参照 -
name-label(読み取り/書き込み) VMの名前 -
name-description(読み取り/書き込み) VMの説明文字列 -
order(読み取り/書き込み) vAppの起動/シャットダウン、およびHAフェイルオーバー後の起動用。順序値が0のVMが最初に起動され、次に順序値が1のVMが起動されます。 -
version(読み取り専用) このVMが回復された回数。新しいVMを古いバージョンで上書きしたい場合は、vm-recoverを呼び出します。 -
user-version(読み取り/書き込み) VMおよびテンプレートの作成者がバージョン情報を記述するための文字列 -
is-a-template(読み取り/書き込み) このVMがテンプレートでない限り、値はfalseです。テンプレートVMは起動できず、他のVMをクローンするためにのみ使用されます。この値がtrueに設定された後、falseにリセットすることはできません。テンプレートVMは、このパラメーターを使用してVMに変換することはできません。VMをテンプレートに変換するには、次を使用します。xe vm-param-set uuid=<vm uuid> is-a-template=true -
is-control-domain(読み取り専用) これがコントロール ドメイン (ドメイン 0 またはドライバー ドメイン) の場合、値は true です。 -
power-state(読み取り専用) 現在の電源状態 -
start-delay(読み取り/書き込み) VMの起動呼び出しが返されるまでの待機遅延時間 (秒単位) -
shutdown-delay(読み取り/書き込み) VMのシャットダウン呼び出しが返されるまでの待機遅延時間 (秒単位) -
memory-dynamic-max(読み取り/書き込み) 動的最大値 (バイト単位) -
memory-dynamic-min(読み取り/書き込み) 動的最小値 (バイト単位) -
memory-static-max(読み取り/書き込み) 静的に設定された (絶対) 最大値 (バイト単位)。この値を変更する場合は、VMをシャットダウンする必要があります。 -
memory-static-min(読み取り/書き込み) 静的に設定された (絶対) 最小値 (バイト単位)。この値を変更する場合は、VMをシャットダウンする必要があります。 -
suspend-VDI-uuid(読み取り専用) サスペンドイメージが保存されるVDI -
VCPUs-params(読み取り/書き込みマップパラメーター) 選択したvCPUポリシーの構成パラメーター。 -
VCPUs-max(読み取り/書き込み) 仮想CPUの最大数。 -
VCPUs-at-startup(読み取り/書き込み) 仮想CPUの起動数 -
actions-after-crash(読み取り/書き込み) VMがクラッシュした場合に実行するアクション。PVゲストの場合、有効なパラメーターは次のとおりです。-
preserve(分析専用) -
coredump_and_restart(コアダンプを記録してVMを再起動する) -
coredump_and_destroy(コアダンプを記録してVMを停止したままにする) -
restart(コアダンプなしでVMを再起動する) -
destroy(コアダンプなしでVMを停止したままにする)
-
-
console-uuids(読み取り専用設定パラメーター) 仮想コンソールデバイス -
platform(読み取り/書き込みマップパラメーター) プラットフォーム固有の構成VDAがWindows 10をタブレットモードに切り替えるのを無効にするには:xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=0VDAがWindows 10をタブレットモードに切り替えるのを有効にするには:xe vm-param-set uuid=<vm_uuid> platform:acpi_laptop_slate=1現在の状態を確認するには:xe vm-param-get uuid=<vm_uuid> param-name=platform param-key=acpi_laptop_slate -
allowed-operations(読み取り専用設定パラメーター) この状態で許可されている操作のリスト -
current-operations(読み取り専用設定パラメーター) 現在VMで進行中の操作のリスト -
allowed-VBD-devices(読み取り専用設定パラメーター) 使用可能なVBD識別子のリスト。0～254の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます (ただし、動作しない場合があります)。 -
allowed-VIF-devices(読み取り専用設定パラメーター) 使用可能なVIF識別子のリスト。0～6の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます (ただし、動作しない場合があります)。 -
HVM-boot-policy(読み取り/書き込み) ゲストのブートポリシー。BIOS Orderまたは空の文字列のいずれか。 -
HVM-boot-params(読み取り/書き込みマップパラメーター) 順序キーはゲストのブート順序を制御します。各文字がブート方法を表す文字列として表現されます: dはCD/DVD、cはルートディスク、nはネットワークPXEブート。デフォルトはdcです。 -
HVM-shadow-multiplier(read/write) VMに付与するシャドウメモリのオーバーヘッド量を制御する浮動小数点値。デフォルトは1.0（最小値）で、上級ユーザーのみこの値を変更してください。 -
PV-kernel(read/write) カーネルへのパス -
PV-ramdisk(read/write)initrdへのパス -
PV-args(read/write) カーネルコマンドライン引数の文字列 -
PV-legacy-args(read/write) レガシーVMを起動させるための引数の文字列 -
PV-bootloader(read/write) ブートローダーの名前またはパス -
PV-bootloader-args(read/write) ブートローダー用のその他の引数の文字列 -
last-boot-CPU-flags(read only) VMが最後に起動されたCPUフラグを記述します -
resident-on(read only) VMが常駐するXenServerホスト -
affinity(read/write) VMが実行を優先するXenServerホスト。xe vm-startコマンドがVMを実行する場所を決定するために使用されます。ホームサーバーとも呼ばれます。 -
groups(read/write) このVMが属するVMグループ。VMグループは、XenServerがVMを起動または退避させようとする場所を定義します。 -
other-config(read/write map parameter) VMの追加設定パラメータを指定するキーと値のペアのリスト。例えば、other-configキーと値のペアauto_poweron: trueは、プール内の任意のホストが起動した後にVMを自動的に起動するよう要求します。このパラメータは、プールのother-configにも設定する必要があります。これらのパラメータは現在非推奨です。代わりにha-restart-priorityパラメータを使用してください。 -
start-time(read only) VMのメトリックが読み取られた日時を示すタイムスタンプ。このタイムスタンプはyyyymmddThh:mm:ss zの形式で、zは単一文字の軍事タイムゾーンインジケータ（例：UTC (GMT)の場合はZ）です。 -
install-time(read only) VMのメトリックが読み取られた日時を示すタイムスタンプ。このタイムスタンプはyyyymmddThh:mm:ss zの形式で、zは単一文字の軍事タイムゾーンインジケータ（例：UTC (GMT)の場合はZ）です。 -
memory-actual(読み取り専用) VMが使用している実際のメモリ -
VCPUs-number(読み取り専用) Linux VMに割り当てられている仮想CPUの数。この数はVCPUS-maxと異なる場合があり、vm-vcpu-hotplugコマンドを使用してVMを再起動せずに変更できます。詳細については、vm-vcpu-hotplugを参照してください。Windows VMは常にvCPUの数がVCPUsmaxに設定されて実行され、この値を変更するには再起動する必要があります。XenServerホスト上の物理CPUの数よりも大きい値にVCPUs-numberを設定すると、パフォーマンスが大幅に低下します。 -
VCPUs-Utilization(読み取り専用マップパラメータ) 仮想CPUとその重みのリスト -
os-version(読み取り専用マップパラメータ) VMのオペレーティングシステムのバージョン -
PV-drivers-version(読み取り専用マップパラメータ) VMの準仮想化ドライバーのバージョン -
PV-drivers-detected(読み取り専用) VMの準仮想化ドライバーの最新バージョンのフラグ -
memory(読み取り専用マップパラメータ) VM上のエージェントによって報告されるメモリメトリック -
disks(読み取り専用マップパラメータ) VM上のエージェントによって報告されるディスクメトリック -
networks(読み取り専用マップパラメータ) VM上のエージェントによって報告されるネットワークメトリック -
other(読み取り専用マップパラメータ) VM上のエージェントによって報告されるその他のメトリック -
guest-metrics-lastupdated(読み取り専用) ゲスト内エージェントがこれらのフィールドに最後に書き込みを行ったときのタイムスタンプ。タイムスタンプはyyyymmddThh:mm:ss zの形式で、zは単一文字の軍事タイムゾーンインジケーター（例: UTC (GMT) の場合はZ）です。 -
actions-after-shutdown(読み取り/書き込み) VMがシャットダウンした後に実行するアクション -
actions-after-reboot(読み取り/書き込み) VMが再起動した後に実行するアクション -
possible-hostsこのVMの潜在的なホスト (読み取り専用) -
dom-id(読み取り専用) ドメインID (利用可能な場合、それ以外の場合は-1) -
recommendations(読み取り専用) このVMのプロパティに対する推奨値と範囲のXML仕様 -
xenstore-data(読み取り/書き込みマップパラメータ) VM作成後にxenstoreツリー (/local/domain/*domid*/vm-data) に挿入されるデータ -
is-a-snapshot(読み取り専用) このVMがスナップショットである場合、値はtrueです -
snapshot_of(読み取り専用) このスナップショットが対象とするVMのUUID -
snapshots(読み取り専用) このVMのすべてのスナップショットのUUID -
snapshot_time(読み取り専用) このVMスナップショットを作成したスナップショット操作のタイムスタンプ -
memory-target(読み取り専用) このVMに設定された目標メモリ量 -
blocked-operations(読み取り/書き込みマップパラメータ) このVMで実行できない操作をリストします -
last-boot-record(読み取り専用) このテンプレートの最後のブートパラメータの記録 (XML形式) -
ha-always-run(読み取り/書き込み) このVMが常駐するホストに障害が発生した場合、このVMが常に別のホストで再起動される場合に値はtrueです。このパラメータは現在非推奨です。代わりにha-restart-priorityパラメータを使用してください。 -
ha-restart-priority(読み取り/書き込み) 再起動またはベストエフォート -
blobs(読み取り専用) バイナリデータストア -
live(読み取り専用) VMが実行中の場合、値はtrueです。HAがVMが実行されていないと疑う場合、値はfalseです。
vm-assert-can-be-recovered
xe vm-assert-can-be-recovered uuid [database] vdi-uuid
このVMを回復するためにストレージが利用可能かどうかをテストします。
vm-call-plugin
xe vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]
指定されたVM上のプラグイン内の関数を、オプションの引数 (args:key=value) を付けて呼び出します。特殊文字 (例えば改行) を含む「value」文字列を渡すには、代替構文 args:key:file=local_file を使用できます。この場合、local_file の内容が取得され、「key」に全体として割り当てられます。
vm-cd-insert
xe vm-cd-insert cd-name=name_of_cd [vm-selector=vm_selector_value...]
仮想CDドライブにCDを挿入します。このコマンドは、VMに空のCDデバイスが1つだけ接続されている場合にのみ機能します。空のCDデバイスが2つ以上ある場合は、
xe vbd-insert コマンドを使用し、挿入するVBDとVDIのUUIDを指定してください。
vm-checkpoint
xe vm-checkpoint new-name-label=name_label [new-name-description=description]
既存のVMをチェックポイントします。利用可能な場合は、ストレージレベルの高速ディスクスナップショット操作を使用します。
vm-clone
xe vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]
既存のVMをクローンします。利用可能な場合は、ストレージレベルの高速ディスククローン操作を使用します。結果として作成されるクローンVMの名前とオプションの説明は、
new-name-labelおよびnew-name-description引数を使用して指定します。
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...]
既存のVMに割り当て可能な静的メモリの最大量を、物理RAMの総量を上限として計算します。オプションのパラメーター
approximateは、後でVMにvCPUを追加することを考慮して、計算に十分な追加メモリを予約します。
例:
xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`
このコマンドは、
xe host-listコマンドによって返されるmemory-freeパラメーターの値を使用して、testvmという名前のVMの最大メモリを設定します。
vm-compute-memory-overhead
xe vm-compute-memory-overhead
VMの仮想化メモリオーバーヘッドを計算します。
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...]
既存のVMをコピーしますが、ストレージレベルの高速ディスククローン操作を使用しません（このオプションが利用可能な場合でも）。コピーされたVMのディスクイメージは、フルイメージであることが保証されます。つまり、コピーオンライト（CoW）チェーンの一部ではありません。
結果としてコピーされるVMの名前とオプションの説明は、
new-name-labelとnew-name-description引数を使用して指定します。
結果としてコピーされるVMの宛先SRは、
sr-uuidを使用して指定します。このパラメーターが指定されていない場合、宛先は元のVMが存在するSRと同じになります。
vm-copy-bios-strings
xe vm-copy-bios-strings host-uuid=host_uuid
指定されたホストのBIOS文字列をVMにコピーします。
注:
VMを最初に起動した後、そのBIOS文字列を変更することはできません。VMを初めて起動する前に、BIOS文字列が正しいことを確認してください。
vm-crashdump-list
xe vm-crashdump-list [vm-selector=vm selector value...]
指定されたVMに関連付けられているクラッシュダンプを一覧表示します。
オプションの引数
paramsを使用すると、paramsの値は、表示したいこのオブジェクトのパラメーターのリストを含む文字列になります。あるいは、キーワードallを使用してすべてのパラメーターを表示することもできます。paramsが使用されていない場合、返されるリストには、利用可能なすべてのパラメーターのデフォルトのサブセットが表示されます。
vm-data-source-list
xe vm-data-source-list [vm-selector=vm selector value...]
VMに記録できるデータソースを一覧表示します。
標準の選択メカニズムを使用して、この操作を実行するVMを選択します。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのVMに対して実行されます。
データソースには、このコマンドの出力で確認できる2つのパラメーター（
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-data-source-query
vm-destroy
xe vm-destroy uuid=uuid_of_vm
指定されたVMを破棄します。これにより、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...]
指定されたVMにディスクを追加します。VMの
allowed-VBD-devicesパラメーターの値からdeviceパラメーターを選択します。
disk-sizeパラメーターは、バイト単位、またはIEC標準の接尾辞であるKiB、MiB、GiB、TiBを使用して指定できます。
vm-disk-list
xe vm-disk-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
指定されたVMに接続されているディスクを一覧表示します。
vbd-paramsとvdi-paramsパラメーターは、出力するそれぞれのオブジェクトのフィールドを制御します。パラメーターはコンマ区切りのリストとして指定するか、完全なリストの場合は特殊キーallを指定します。
vm-export
xe vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]
指定されたVM（ディスクイメージを含む）をローカルマシンのファイルにエクスポートします。VMをエクスポートするファイル名は、
filenameパラメーターを使用して指定します。慣例により、ファイル名には.xva拡張子が付いています。
metadataパラメーターがtrueの場合、ディスクはエクスポートされません。VMメタデータのみが出力ファイルに書き込まれます。このパラメーターは、基盤となるストレージが他のメカニズムを介して転送され、VM情報を再作成できる場合に使用します。詳細については、vm-importを参照してください。
vm-import
xe vm-import filename=export_filename [metadata=true|false] [preserve=true|false][sr-uuid=destination_sr_uuid]
以前にエクスポートしたファイルからVMをインポートします。
preserveがtrueに設定されている場合、元のVMのMACアドレスは保持されます。sr-uuidは、VMをインポートする宛先SRを決定します。このパラメーターが指定されていない場合、デフォルトのSRが使用されます。
metadataがtrueの場合、以前にエクスポートされたメタデータセットを、関連するディスクブロックなしでインポートできます。--forceオプションが指定されていない限り、VDIが見つからない場合（SRとVDI.locationで指定）、メタデータのみのインポートは失敗します。このオプションが指定されている場合は、インポートが続行されます。ディスクをミラーリングまたは帯域外で移動できる場合、メタデータのインポート/エクスポートは、分離されたプール間でVMを移動する高速な方法です。たとえば、災害復旧計画の一部として。
注:
複数のVMのインポートは、並列よりもシリアルで実行する方が高速です。
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]
テンプレートからVMをインストールまたはクローンします。テンプレート名は、
template-uuidまたはtemplate引数を使用して指定します。SRは、sr-uuidまたはsr-name-label引数を使用して指定します。BIOSロックされたメディアをインストールするには、copy-bios-strings-from引数を使用します。
注:
既存のディスクを持つテンプレートからインストールする場合、デフォルトでは、新しいディスクはこれらの既存のディスクと同じSRに作成されます。SRがサポートしている場合、これらのディスクは高速コピーです。コマンドラインで異なるSRが指定されている場合、新しいディスクはそこに作成されます。この場合、高速コピーは不可能であり、ディスクは完全なコピーになります。
既存のディスクを持たないテンプレートからインストールする場合、新しいディスクは指定されたSRに作成されるか、SRが指定されていない場合はプールデフォルトのSRに作成されます。
vm-is-bios-customized
xe vm-is-bios-customized
VMのBIOS文字列がカスタマイズされているかどうかを示します。
vm-memory-dynamic-range-set
xe vm-memory-dynamic-range-set min=min max=max
VMの動的メモリ範囲を設定します。動的メモリ範囲は、VMのメモリのソフトな下限と上限を定義します。VMが実行中または停止しているときにこれらのフィールドを変更できます。動的範囲は静的範囲内に収まる必要があります。
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のメモリ制限を設定します。
vm-memory-set
xe vm-memory-set memory=memory
VMのメモリ割り当てを構成します。
vm-memory-shadow-multiplier-set
xe vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]
指定されたVMのシャドウメモリ乗数を設定します。
これは、ハードウェア支援型VMに割り当てられるシャドウメモリの量を変更する高度なオプションです。
Citrix Virtual Apps™のような一部の特殊なアプリケーションワークロードでは、最高のパフォーマンスを達成するために追加のシャドウメモリが必要です。
このメモリはオーバーヘッドと見なされます。VMにメモリを割り当てるための通常のメモリ計算とは別に扱われます。このコマンドが呼び出されると、乗数に応じて空きホストメモリの量が減少し、
HVM_shadow_multiplierフィールドはXenがVMに割り当てた値で更新されます。十分なXenServerホストメモリが空いていない場合、エラーが返されます。
この操作を実行するVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。
vm-memory-static-range-set
xe vm-memory-static-range-set min=min max=max
VMの静的メモリ範囲を構成します。静的メモリ範囲は、VMのメモリの厳密な下限と上限を定義します。これらのフィールドは、VMが停止している場合にのみ変更できます。静的範囲は動的範囲を包含する必要があります。
vm-memory-target-set
xe vm-memory-target-set target=target
停止中または実行中のVMのメモリターゲットを設定します。指定された値は、VMのmemory_static_minおよびmemory_static_max値によって定義される範囲内である必要があります。
vm-migrate
xe vm-migrate [compress=true|false] [copy=true|false] [host-uuid=destination_host_uuid] [host=name_or_ uuid_of_destination_host] [force=true|false] [live=true|false] [vm-selector=vm_selector_value...] [remote-master=destination_pool_master_uuid] [remote-username=destination_pool_username] [remote-password=destination_pool_password] [remote-network=destination_pool_network_uuid ][vif:source_vif_uuid=destination_network_uuid] [vdi:vdi_uuid=destination_sr_uuid]
このコマンドは、指定されたVMを物理ホスト間で移行します。
compressパラメータは、xe pool-param-setのmigration-compressionプールパラメータを上書きします。
vm-migrateコマンドのhostパラメータには、XenServerホストの名前またはUUIDを指定できます。たとえば、VMディスクが両方のホストで共有されているストレージ上にある場合に、VMをプール内の別のホストに移行するには、次のようになります。
xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid
ストレージを共有しない同じプール内のホスト間でVMを移動する場合（ストレージライブマイグレーション）：
xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \
remote-master=192.0.2.35 remote-username=username remote-password=password
ストレージライブマイグレーションの場合、同じプール内で移行する場合でも、プールコーディネーターのホスト名またはIPアドレス、ユーザー名、およびパスワードを指定する必要があります。
各VDIが保存されるSRを選択できます。
xe vm-migrate uuid=vm_uuid remote-master=192.0.2.35 remote-username=username remote-password=password host-uuid=destination_host_uuid \
vdi:vdi_1=destination_sr1_uuid \
vdi:vdi_2=destination_sr2_uuid \
vdi:vdi_3=destination_sr3_uuid
さらに、移行後にVMを接続するネットワークを選択できます。
xe vm-migrate uuid=vm_uuid \
vdi1:vdi_1_uuid=destination_sr1_uuid \
vdi2:vdi_2_uuid=destination_sr2_uuid \
vdi3:vdi_3_uuid=destination_sr3_uuid \
vif:source_vif_uuid=destination_network_uuid
クロスプールマイグレーションの場合：
xe vm-migrate uuid=vm_uuid remote-master=192.0.2.35 \
remote-username=username remote-password=password \
host-uuid=destination_host_uuid \
vif:source_vif_uuid=destination_network_uuid \
vdi:vdi_uuid=destination_sr_uuid
ストレージライブマイグレーション、ライブマイグレーション、およびライブVDIマイグレーションの詳細については、「VMの移行」を参照してください。
注：
XenServerまたはCitrix Hypervisor™の以前のバージョンからアップグレードする場合、新しい仮想化機能が適用されるように、VMを移行した後にすべてのVMをシャットダウンして起動する必要がある場合があります。
デフォルトでは、VMは一時停止され、移行され、別のホストで再開されます。
liveパラメータはライブマイグレーションを選択します。ライブマイグレーションは、移行中にVMを実行し続けるため、VMのダウンタイムを最小限に抑えます。VM内で非常にメモリを大量に消費するワークロードなど、特定の状況では、ライブマイグレーションはデフォルトモードに戻り、メモリ転送を完了する前にVMを短時間一時停止します。
vm-pause
xe vm-pause
実行中のVMを一時停止します。この操作では、関連付けられたメモリは解放されないことに注意してください (
vm-suspendを参照)。
vm-recover
xe vm-recover vm-uuid [database] [vdi-uuid] [force]
指定されたVDIに含まれるデータベースからVMを復元します。
vm-reset-powerstate
xe vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}
この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。
これは、プール内のメンバーホストがダウンした場合にのみ使用される高度なコマンドです。このコマンドを使用して、プールコーディネーターにVMの電源状態を
haltedにリセットさせることができます。基本的に、このコマンドはVMとそのディスクにロックを強制し、別のプールホストで次に起動できるようにします。この呼び出しにはforceフラグの指定が必須であり、コマンドラインで指定されていない場合は失敗します。
vm-restart-device-models
xe vm-restart-device-models [vm-selector=vm_selector_value...]
ホスト上でこのVMのデバイスモデルを再起動します。デバイスモデルの再起動中は、VMの停止、起動、移行はできません。VMのエンドユーザーは、セッションでわずかな一時停止と再開を経験する可能性があります。
注:
Windows VMでデバイスモデルの再起動アクションがサポートされるためには、VMにXenServer VM Tools for Windowsがインストールされている必要があります。
vm-resume
xe vm-resume [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid]
指定されたVMを再開します。
この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。
VMがホストのプール内の共有SR上にある場合、
on引数を使用して、どのプールメンバーで起動するかを指定します。デフォルトでは、システムが適切なホストを決定しますが、これはプール内の任意のメンバーである可能性があります。
vm-retrieve-wlb-recommendations
xe vm-retrieve-wlb-recommendations
選択したVMのワークロードバランシングの推奨事項を取得します。
vm-snapshot
xe vm-snapshot new-name-label=name_label [new-name-description+name_description]
既存のVMのスナップショットを作成します。利用可能な場合は、ストレージレベルの高速ディスクスナップショット操作を使用します。
vm-start
xe vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]
指定されたVMを起動します。
この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。
VMがホストのプール内の共有SR上にある場合、
on引数を使用して、VMを起動するプールメンバーを指定します。デフォルトでは、システムが適切なホストを決定しますが、これはプール内の任意のメンバーである可能性があります。
vm-unpause
xe vm-unpause
一時停止したVMを再開します。
vm-vcpu-hotplug
xe vm-vcpu-hotplug new-vcpus=new_total_vcpu_count [vm-selector=vm_selector_value...]
実行中のLinux VMで利用可能なvCPUの数を動的に調整します。vCPUの数はパラメーター
VCPUs-maxによって制限されます。Windows VMは常にvCPUの数がVCPUs-maxに設定された状態で実行され、この値を変更するには再起動が必要です。
このコマンドの実行後に設定したい新しい合計vCPU数を定義するには、
new-vcpusパラメーターを使用します。追加したいvCPUの数を渡すためにこのパラメーターを使用しないでください。たとえば、VMに既存のvCPUが2つあり、さらに2つのvCPUを追加したい場合は、new-vcpus=4を指定します。
この操作が実行されるLinux VMまたはWindows VMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。
注:
XenServer VM ToolsがインストールされていないLinux VMを実行している場合、新しくホットプラグされたvCPUが使用されるように、VM上で
rootとして次のコマンドを実行します: # for i in /sys/devices/system/cpu/cpu[1-9]*/online; do if [ "$(cat $i)" = 0 ]; then echo 1 > $i; fi; done
スケジュールされたスナップショット
VMのスケジュール済みスナップショットとその属性を制御するためのコマンド。
vmssオブジェクトは標準のオブジェクトリストコマンド (xe vmss-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」(/ja-jp/xenserver/8/command-line-interface.html#low-level-parameter-commands)を参照してください。
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を作成します。VMを起動して、USBをVMにパススルーします。
vusb-unplug
xe vusb-unplug uuid=vusb_uuid
VMからUSBを抜きます。
vusb-destroy
xe vusb-destroy uuid=vusb_uuid
VMから仮想USBリストを削除します。
VMグループコマンド
VMグループとその属性を制御するためのコマンド。
VMグループパラメータ
-
uuid(読み取り専用) VMの一意の識別子/オブジェクト参照 -
name-labelVMの名前 (読み取り/書き込み) -
name-descriptionVMの説明文字列 (読み取り/書き込み) -
placementグループ内のVMに適用する配置ルールのタイプ (読み取り専用)。利用可能な値はanti-affinityとnormalです。
VMグループ一覧
xe vm-group-list
このプール内のすべてのVMグループを一覧表示します。
vm-group-create コマンド
xe vm-group-create placement=anti-affinity|normal name-label=<name-label> [name-description=<name-description>]
VMグループを作成します。
vm-group-destroy コマンド
xe vm-group-destroy uuid=<vm-group-uuid>
このVMグループを削除します。VMが含まれるVMグループを削除した場合、VMはグループに関連付けられなくなりますが、それ以外には影響しません。