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

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

xe CLI の使用を開始する

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

XenServer ホスト上

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

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

ウィンドウズ上

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

xe コマンドを実行する際に使用する XenServer ホスト、ユーザー名、パスワードを定義するために、コマンドラインでパラメーターを使用できます。ただし、この情報を環境変数として設定するオプションもあります。例:

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

注記:

Linux上のリモートxe CLIは、セキュアな接続を介してコマンドを実行しようとし、これらのコマンドがファイル転送を伴う場合、ハングする可能性があります。その場合、--no-ssl パラメーターを使用して、XenServerホストへの安全でない接続を介してコマンドを実行できます。

xeコマンドに関するヘルプの取得

ホスト上でCLIコマンドの基本的なヘルプは、次のように入力することで利用できます。

xe help command
<!--NeedCopy-->

次のように入力すると、最も一般的に使用されるxeコマンドのリストが表示されます。

xe help
<!--NeedCopy-->

または、次のように入力すると、すべてのxeコマンドのリストが表示されます。

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

基本的なxe構文

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

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

各特定のコマンドには、argument=value の形式の独自の引数セットが含まれています。一部のコマンドには必須の引数があり、ほとんどのコマンドにはオプションの引数セットがあります。通常、コマンドはオプションの引数の一部が指定されずに呼び出された場合、デフォルト値を想定します。

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

server 引数はホスト名またはIPアドレスを指定するために使用されます。username および password 引数は資格情報を指定するために使用されます。

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

オプションの port 引数は、リモートXenServerホスト上のエージェントポートを指定するために使用できます (デフォルトは443です)。

例: ローカルXenServerホスト上:

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

例: リモートXenServerホスト上:

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

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

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

例: リモートのXenServerホストで:

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

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

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

このコマンドを実行すると、実行する各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 種類のパラメータは多値です。セット パラメータは値のリストを含みます。マップ パラメータはキーと値のペアのセットです。例として、指定された 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
<!--NeedCopy-->

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

オブジェクトのパラメータを操作するためのコマンドがいくつかあります: 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=value

  1つ以上のパラメータの値を設定します。

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

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

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

  マップからキーと値のペアを削除するか、セットからキーを削除します。

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

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

低レベルリストコマンド

class-list コマンドは、class 型のオブジェクトを一覧表示します。デフォルトでは、この種のコマンドはすべてのオブジェクトを一覧表示し、パラメータのサブセットを出力します。この動作は、以下の方法で変更できます。

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

出力されるパラメータを変更するには、引数 params を、必要なパラメータをコンマで区切ったリストとして指定します。例:

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

あるいは、すべてのパラメータを一覧表示するには、次の構文を使用します。

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

list コマンドは、計算コストが高い一部のパラメーターを表示しません。これらのパラメーターは、例えば次のように表示されます。

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

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

リストをフィルタリングするには、CLI はパラメーター値をコマンドラインで指定された値と照合し、指定されたすべての制約に一致するオブジェクトのみを出力します。例:

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

このコマンドは、フィールド 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
<!--NeedCopy-->

シークレット

XenServer は、パスワードがコマンドライン履歴や API オブジェクトに平文で保存されるのを避けるためのシークレットメカニズムを提供します。XenCenter はこの機能を自動的に使用し、パスワードを必要とするあらゆるコマンドに対して xe CLI からも使用できます。

注:

パスワードシークレットは、リモートの xe CLI インスタンスから XenServer ホストで認証するために使用することはできません。

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

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

シークレットが作成され、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"
<!--NeedCopy-->

コマンド履歴

一部の xe コマンド（例えば xe vm-migrate や xe pool-enable-external-auth）は、パスワードなどのシークレットをパラメーターとして受け取ります。これらはシェル履歴に残る可能性があり、コマンドの実行中はプロセス テーブルで可視になります。したがって、これらのコマンドは信頼できる環境でのみ実行することが重要です。

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

xeコマンド リファレンス

このセクションでは、コマンドが対象とするオブジェクト別にコマンドをグループ化しています。これらのオブジェクトはアルファベット順にリストされています。

アプライアンス コマンド

VMアプライアンス（vAppとも呼ばれる）を作成および変更するためのコマンドです。詳細については、vAppsを参照してください。

アプライアンス パラメーター

アプライアンス コマンドには次のパラメーターがあります。

appliance-assert-can-be-recovered

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

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

appliance-create

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

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

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

アプライアンスにVMを追加します：

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

appliance-destroy

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

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

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

appliance-recover

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

提供されたVDIに含まれるデータベースからVMアプライアンス/vAppを回復します。

appliance-shutdown

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

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

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

appliance-start

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

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

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

監査コマンド

監査コマンドは、プール内のRBAC監査ファイルの利用可能なすべてのレコードをダウンロードします。オプションパラメーター since が存在する場合、その特定の時点からのレコードのみをダウンロードします。

audit-log-get パラメーター

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

audit-log-get

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

例えば、正確なミリ秒単位のタイムスタンプ以降のプールの監査記録を取得するには、次のコマンドを実行します。

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

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

ボンディングコマンド

物理インターフェースのフェイルオーバーによる回復性のための、ネットワークボンディングを操作するコマンド。詳細については、「ネットワーキング」を参照してください。

ボンドオブジェクトは、マスター PIF と メンバー PIF を結合する参照オブジェクトです。マスター PIF は、ボンドを参照するための全体的な PIF として使用する必要があるボンディングインターフェースです。メンバー PIF は、2つ以上の物理インターフェースが結合されて高レベルのボンディングインターフェースになったものです。

ボンドパラメーター

ボンドには次のパラメーターがあります。

bond-create

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

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

• PIFがすでに別のボンドに属している場合
• いずれかのメンバーにVLANタグが設定されている場合
• 参照されているPIFが同じXenServerホスト上にない場合
• 2つ未満のPIFが提供された場合

bond-destroy

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

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

bond-set-mode

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

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

CDコマンド

XenServerホスト上の物理CD/DVDドライブを操作するためのコマンド。

CDパラメータ

CDには以下のパラメータがあります。

cd-list

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

XenServerホストまたはプール上のCDおよびISO (CDイメージファイル) を、オプション引数paramsでフィルタリングして一覧表示します。

オプション引数paramsが使用されている場合、paramsの値は、表示したいこのオブジェクトのパラメータのリストを含む文字列です。または、キーワードallを使用してすべてのパラメータを表示できます。paramsが使用されていない場合、返されるリストには、利用可能なすべてのパラメータのデフォルトのサブセットが表示されます。

任意の引数には、このセクションの冒頭に記載されているCDパラメータを複数指定できます。

GFS2クラスターコマンド

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

GFS2クラスター化プールは、クラスタリング機能が有効になっているリソースプールです。これらのプールはGFS2 SRで使用します。詳細については、GFS2クラスター化プールを参照してください。

クラスターオブジェクトとクラスターホストオブジェクトは、標準のオブジェクト一覧表示コマンド (xe cluster-list および xe cluster-host-list) を使用して一覧表示でき、パラメーターは標準のパラメーターコマンドを使用して操作できます。詳細については、低レベルパラメーターコマンドを参照してください。 GFS2クラスター化プールを操作するためのコマンド。

GFS2クラスターパラメーター

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

GFS2クラスター内のホスト (cluster-host) には、次のパラメーターがあります。

cluster-host-destroy

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

GFS2クラスターホストを破棄し、実質的にGFS2クラスターから離脱します。

cluster-host-disable

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

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

cluster-host-enable

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

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

cluster-host-force-destroy

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

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

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

cluster-pool-destroy

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

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

cluster-pool-force-destroy

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

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

cluster-pool-resync

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

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

コンソールコマンド

コンソールを操作するためのコマンド。

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

コンソールパラメーター

コンソールには次のパラメーターがあります。

console

xe console
<!--NeedCopy-->

特定のコンソールにアタッチします。

診断コマンド

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

diagnostic-compact

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

メジャーGCコレクションとヒープ圧縮を実行します。

diagnostic-db-stats

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

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

diagnostic-gc-stats

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

GC統計を出力します。

diagnostic-license-status

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

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

diagnostic-net-stats

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

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

diagnostic-timing-stats

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

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

diagnostic-vdi-status

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

VDIのロックおよび共有ステータスを照会します。

diagnostic-vm-status

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

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

災害復旧コマンド

災害後にVMを復旧するためのコマンド

drtask-create

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

災害復旧タスクを作成します。例えば、災害復旧に備えて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
<!--NeedCopy-->

注:

コマンド sr-whitelist は許可されているSR UUIDをリストします。drtask-create コマンドは、許可されているUUIDのいずれかを持つSRのみを導入し、接続します。

drtask-destroy

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

災害復旧タスクを破棄し、導入されたSRを忘却します。

vm-assert-can-be-recovered

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

このVMを復旧するためのストレージが利用可能かどうかをテストします。

appliance-assert-can-be-recovered

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

ストレージ（アプライアンス/vAPPディスクを含む）が可視であるかどうかを確認します。

appliance-recover

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

提供されたVDIに含まれるデータベースからアプライアンス/vAPPを復元します。

vm-recover

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

提供されたVDIに含まれるデータベースからVMを復元します。

sr-enable-database-replication

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

指定された（共有）SRへのXAPIデータベースレプリケーションを有効にします。

sr-disable-database-replication

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

指定されたSRへのXAPIデータベースレプリケーションを無効にします。

使用例

以下の例は、DR CLIコマンドをコンテキストで示しています。

プライマリサイトで、データベースレプリケーションを有効にします。

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

災害後、セカンダリサイトで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
<!--NeedCopy-->

SR上のデータベースVDIを探します。

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

データベースVDIに存在するVMを照会します。

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

VMを復元する:

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

DRタスクを破棄します。DRタスクによって導入され、VMに不要なSRはすべて破棄されます:

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

イベントコマンド

イベントを操作するためのコマンド。

イベントクラス

イベントクラスは次の表に示されています:

event-wait

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

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

例: 特定のVMが実行中になるまで待機します。

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

myvmという名前のVMがpower-state「実行中」になるまで、他のコマンドをブロックします。

例: 特定のVMが再起動するまで待機します:

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

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) には、次のパラメータがあります:

pgpu-disable-dom0-access

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

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

pgpu-enable-dom0-access

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

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

GPUグループのパラメータ

GPUグループには次のパラメータがあります。

GPUグループ操作

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

gpu-group-create

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

pGPUを移動できる新しい（空の）GPUグループを作成します。

gpu-group-destroy

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

GPUグループを破棄します。空のグループにのみ許可されます。

gpu-group-get-remaining-capacity

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

このGPUグループで、指定されたタイプの仮想GPUをあといくつインスタンス化できるかを返します。

gpu-group-param-set

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

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

仮想GPUパラメーター

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

仮想GPUタイプパラメータ

注:

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

仮想GPUタイプには、次のパラメータがあります。

仮想GPU操作

vgpu-create

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

仮想GPUを作成します。このコマンドは、VMを指定されたGPUグループにアタッチし、オプションで仮想GPUタイプを指定します。仮想GPUタイプが指定されていない場合、「パススルー」タイプが想定されます。

vgpu-destroy

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

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

仮想GPUを使用するVMのVNCを無効にする

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

falseを使用すると、disablevnc=1をディスプレイエミュレーターに渡すため、VMのVNCコンソールが無効になります。デフォルトでは、VNCは有効になっています。

ホストコマンド

XenServerホストと対話するためのコマンド。

XenServerホストは、XenServerソフトウェアを実行する物理サーバーです。これらには、制御ドメインまたはドメイン0として知られる、特別な特権を持つ仮想マシン（Virtual Machine）の制御下で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ホストには、次のパラメーターがあります。

例:

• xe host-param-set uuid=<uuid> ntp-mode=Factory
• xe host-param-set uuid=<uuid> ntp-custom-servers=server1,server2
• xe host-param-set uuid=<uuid> timezone=UTC
• xe host-param-set uuid=<uuid> max-cstate=1

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

XenServerホスト上のCPUは、以下のパラメータを持ちます:

XenServerホスト上のクラッシュダンプには、以下のパラメータがあります。

host-all-editions

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

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

host-apply-edition

xe host-apply-edition [host-uuid=host_uuid] [edition=premium-per-socket|standard-per-socket|cloud]
<!--NeedCopy-->

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

指定された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]
<!--NeedCopy-->

新しいバグレポートを生成し（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]
<!--NeedCopy-->

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

host-compute-free-memory

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

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

host-compute-memory-overhead

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

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

host-cpu-info

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

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

host-crashdump-destroy

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

UUIDで指定されたホストのクラッシュダンプをXenServerホストから削除します。

host-crashdump-upload

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

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

host-declare-dead

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

ホストに明示的に連絡することなく、ホストが停止していることを宣言します。

警告:

この呼び出しは危険であり、ホストが実際に停止していない場合、データ損失を引き起こす可能性があります。

host-disable

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

指定されたXenServerホストを無効にし、新しいVMがそれらで起動するのを防ぎます。このアクションは、XenServerホストをシャットダウンまたは再起動する準備をします。そのホストが再起動した後、有効化のすべての条件（例えば、ストレージが利用可能であること）が満たされていれば、ホストは自動的に再有効化されます。

この操作を実行するホストは、標準の選択メカニズム（ホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

host-disable-display

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

ホストのディスプレイを無効にします。

host-disable-local-storage-caching

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

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

host-dmesg

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

指定されたXenServerホストからXen dmesg（カーネルリングバッファの出力）を取得します。

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

host-emergency-ha-disable

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

ローカルホストでHAを無効にします。HA設定が破損したプールを回復する場合にのみ使用します。

host-emergency-management-reconfigure

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

このXenServerホストの管理インターフェースを再構成します。このコマンドは、XenServerホストが緊急モードの場合にのみ使用してください。緊急モードとは、ホストがリソースプールの一員であり、そのプールコーディネーターがネットワークから消失し、複数回の再試行後も連絡が取れない状態を意味します。

host-emergency-reset-server-certificate

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

コマンドが実行されるXenServerホストに自己署名証明書をインストールします。

host-enable

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

指定されたXenServerホストを有効にし、新しいVMをそれらのホストで起動できるようにします。

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

host-enable-display

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

ホストのディスプレイを有効にします。

host-enable-local-storage-caching

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

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

host-evacuate

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

実行中のすべての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
<!--NeedCopy-->

XAPIエージェントは、指定されたXenServerホストに明示的に連絡することなく、そのホストを忘れます。

この操作を本当に実行するかどうかの確認プロンプトが表示されないようにするには、--force パラメーターを使用します。

警告:

プールでHAが有効になっている場合は、このコマンドを使用しないでください。まずHAを無効にし、ホストを忘れた後に再度有効にしてください。

このコマンドは、「忘れる」対象のXenServerホストが停止している場合に役立ちます。ただし、XenServerホストが稼働中でプールの一部である場合は、代わりにxe pool-ejectを使用してください。

host-get-server-certificate

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

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

host-get-sm-diagnostics

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

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

host-get-system-status

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

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

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。

host-get-system-status-capabilities

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

指定されたホストのシステムステータス機能を取得します。機能は、次の例のようなXMLフラグメントとして返されます。

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

各機能エンティティは、次の属性を持つことができます。

• key 機能の一意の識別子。
• content-type text/plain または application/data のいずれかです。UI が人間が利用できるようにエントリをレンダリングできるかどうかを示します。
• default-checked yes または no のいずれかです。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
<!--NeedCopy-->

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

host-get-vms-which-prevent-evacuation

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

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

host-is-in-emergency-mode

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

CLIが通信しているホストが緊急モードの場合、trueを返します。それ以外の場合はfalseを返します。このCLIコマンドは、プールコーディネーターが存在しない場合でも、プールメンバーホストで直接動作します。

host-license-view

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

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

host-logs-download

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

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

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。

重要:

xe host-logs-downloadコマンドはローカルホストで実行した場合（つまり、特定のホスト名を指定しない場合）でも機能しますが、この方法では使用しないでください。そうすると、ログのコピーでコントロールドメインパーティションが乱雑になります。このコマンドは、ログのコピーを保持するスペースがあるリモートのオフホストマシンからのみ使用してください。

host-management-disable

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

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

警告:

このCLIコマンドをオフホストで使用する際は注意してください。このコマンドを実行した後、ネットワーク経由でリモートからコントロールドメインに接続してホストエージェントを再度有効にすることはできません。

host-management-reconfigure

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

XenCenterへの接続に使用されるインターフェースである、指定されたネットワークインターフェースを管理インターフェースとして使用するようにXenServerホストを再構成します。このコマンドは、/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]
<!--NeedCopy-->

ホスト電源オン機能が有効になっているXenServerホストの電源をオンにします。このコマンドを使用する前に、ホストでhost-set-power-onを有効にしてください。

host-reboot

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

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

この操作を実行するホストは、標準の選択メカニズムを使用して選択されます（上記のホストセレクターを参照）。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

指定されたXenServerホストがプールメンバーである場合、シャットダウン時の接続喪失は処理され、XenServerホストが復帰するとプールは回復します。他のメンバーとプールコーディネーターは機能し続けます。

プールコーディネーターをシャットダウンした場合、プールは、以下のいずれかのアクションが発生するまで機能停止します。

• いずれかのメンバーをプールコーディネーターにする

• 元のプールコーディネーターが再起動され、オンラインに戻る。

  プールコーディネーターがオンラインに戻ると、メンバーは再接続し、プールコーディネーターと同期します。

host-restore

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

XenServerホスト制御ソフトウェアのfile-nameという名前のバックアップを復元します。ここで「復元」という言葉を使用しても、通常の意味での完全な復元を意味するものではなく、圧縮されたバックアップファイルが解凍され、セカンダリパーティションに展開されたことを意味するにすぎません。xe host-restoreを実行した後、インストールCDを起動し、「バックアップから復元」オプションを使用する必要があります。

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

host-send-debug-keys

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

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

host-server-certificate-install

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

XenServerホストにTLS証明書をインストールします。

host-set-hostname-live

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

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

リモート電源ソリューションと互換性のあるXenServerホストで、ホスト電源オン機能を有効にするために使用します。host-set-power-onコマンドを使用する場合、ホスト上の電源管理ソリューションのタイプ（つまり、power-on-mode）を指定する必要があります。次に、power-on-config引数とその関連するキーと値のペアを使用して構成オプションを指定します。

パスワードを保存するためにシークレット機能を使用するには、キー"power_on_password_secret"を指定します。詳細については、シークレットを参照してください。

host-shutdown

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

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

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭に記載されているホストパラメータの任意の数を指定できます。

指定されたXenServerホストがプールに属している場合、シャットダウン時の接続喪失は処理され、XenServerホストが復帰するとプールは回復します。他のメンバーとプールコーディネーターは引き続き機能します。

プールコーディネーターをシャットダウンすると、以下のいずれかのアクションが発生するまでプールは機能停止状態になります。

• いずれかのメンバーをプールコーディネーターにする

• 元のプールコーディネーターが再起動され、オンラインに戻る。

  プールコーディネーターがオンラインに戻ると、メンバーは再接続し、プールコーディネーターと同期します。

プールで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]
<!--NeedCopy-->

ホスト上のストレージデータパスを破棄し、クリーンアップを試みます。allow-leak=trueが指定されている場合、データパスが正常にシャットダウンされていなくても、そのすべてのレコードを削除します。

host-sync-data

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

プールコーディネーターに保存されているデータを指定されたホストと同期します。これにはデータベースデータは含まれません)。

host-syslog-reconfigure

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

指定されたXenServerホスト上のsyslogデーモンを再構成します。このコマンドは、ホストのloggingパラメーターで定義された構成情報を適用します。

この操作を実行するホストは、標準の選択メカニズム（上記のホストセレクターを参照）を使用して選択されます。オプションの引数には、このセクションの冒頭にリストされているホストパラメーターの任意の数を指定できます。

host-data-source-list

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

ホストに記録できるデータソースを一覧表示します。

標準の選択メカニズム (ホストセレクターを参照) を使用して、この操作を実行するホストを選択します。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのホストで実行されます。

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

• データソースの enabled が true に設定されている場合、メトリックは現在パフォーマンスデータベースに記録されています。
• データソースの standard が true に設定されている場合、メトリックはデフォルトでパフォーマンスデータベースに記録されます。このデータソースでは、enabled の値も true に設定されます。
• データソースの standard が false に設定されている場合、メトリックはデフォルトではパフォーマンスデータベースに記録されません。このデータソースでは、enabled の値も false に設定されます。

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

host-data-source-record

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

ホストの指定されたデータソースを記録します。

この操作は、データソースからの情報を、指定されたホストの永続的なパフォーマンスメトリックデータベースに書き込みます。パフォーマンス上の理由から、このデータベースは通常のエージェントデータベースとは異なります。

標準の選択メカニズム (ホストセレクターを参照) を使用して、この操作を実行するホストを選択します。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのホストで実行されます。

host-data-source-forget

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

ホストの指定されたデータソースの記録を停止し、記録されたすべてのデータを破棄します。

標準の選択メカニズム (ホストセレクターを参照) を使用して、この操作を実行するホストを選択します。オプションの引数には、このセクションの冒頭に記載されているホストパラメーターの任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのホストで実行されます。

host-data-source-query

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

ホストの指定されたデータソースを表示します。

標準の選択メカニズム (ホストセレクターを参照) を使用して、この操作を実行するホストを選択します。オプションの引数には、このセクションの冒頭に記載されている ホストパラメーター の任意の数を指定できます。ホストを選択するパラメーターが指定されていない場合、操作はすべてのホストで実行されます。

メッセージコマンド

メッセージを操作するためのコマンド。メッセージは、重要なイベントをユーザーに通知するために作成され、XenCenterでアラートとして表示されます。

メッセージオブジェクトは、標準のオブジェクトリストコマンド (xe message-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、低レベルパラメーターコマンド を参照してください。

メッセージパラメーター

message-create

xe message-create name=message_name body=message_text [[host-uuid=uuid_of_host] | [sr-uuid=uuid_of_sr] | [vm-uuid=uuid_of_vm] | [pool-uuid=uuid_of_pool]]
<!--NeedCopy-->

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

message-destroy

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

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

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

ネットワークコマンド

ネットワークを操作するためのコマンド。

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

ネットワークパラメータ

ネットワークには次のパラメータがあります。

network-create

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

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

network-destroy

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

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

SR-IOV コマンド

SR-IOV を操作するためのコマンド。

network-sriov オブジェクトは、標準のオブジェクトリストコマンド (xe network-sriov-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「Low-level parameter commands」を参照してください。

SR-IOV パラメーター

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

network-sriov-create

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

指定された物理PIFのSR-IOVネットワークオブジェクトを作成し、その物理PIFでSR-IOVを有効にします。

network-sriov-destroy

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

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

SR-IOV VFを割り当てる

xe vif-create device=device_index mac=vf_mac_address network-uuid=sriov_network vm-uuid=vm_uuid
<!--NeedCopy-->

SR-IOVネットワークからVMにVFを割り当てます。

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

SDNコントローラーを操作するためのコマンド。

sdn-controller-forget

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

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

sdn-controller-introduce

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

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

トンネルコマンド

トンネルを操作するためのコマンド。

tunnel-create

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

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

tunnel-destroy

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

トンネルを破棄します。

パッチコマンド

パッチを操作するためのコマンド。

patch-apply

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

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

patch-clean

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

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

patch-destroy

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

未適用パッチのレコードとファイルをホストから削除します。

patch-pool-apply

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

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

patch-pool-clean

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

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

patch-precheck

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

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

patch-upload

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

パッチファイルをホストにアップロードします。

PBD コマンド

PBD (物理ブロックデバイス) を操作するためのコマンド。PBD は、XenServer ホストがストレージリポジトリ (SR) にアクセスするためのソフトウェアオブジェクトです。

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

PBD パラメータ

PBD には次のパラメータがあります。

pbd-create

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

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

‘path’ から ‘/tmp’ へのマッピングを追加するには、コマンドラインに引数 device-config:path=/tmp が含まれていることを確認してください。

各 SR タイプでサポートされている device-config キーと値のペアの完全なリストについては、ストレージ を参照してください。

pbd-destroy

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

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

pbd-plug

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

PBD を XenServer ホストに接続しようとします。このコマンドが成功すると、参照されている SR (およびその中に含まれる VDI) が XenServer ホストに表示されるようになります。

pbd-unplug

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

XenServer ホストから PBD を切断しようとします。

PIF コマンド

PIF (物理ネットワークインターフェースを表すオブジェクト) を操作するためのコマンド。

PIF オブジェクトは、標準のオブジェクトリストコマンド (xe pif-list) で一覧表示でき、パラメータは標準のパラメータコマンドで操作できます。詳細については、低レベルパラメータコマンド を参照してください。

PIF パラメータ

PIF には次のパラメータがあります。

注:

PIFのother-configフィールドに加えられた変更は、再起動後にのみ有効になります。または、xe pif-unplugおよびxe pif-plugコマンドを使用して、PIF構成を再書き込みします。

pif-forget

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

特定のホスト上の指定されたPIFオブジェクトを破棄します。

pif-introduce

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

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

pif-plug

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

指定された物理インターフェースの起動を試みます。

pif-reconfigure-ip

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

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

注:

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

pif-reconfigure-ipv6

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

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

pif-scan

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

XenServerホスト上の新しい物理インターフェースをスキャンします。

pif-set-primary-address-type

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

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

pif-unplug

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

指定された物理インターフェースを停止しようとします。

プールコマンド

プールを操作するためのコマンド。プールとは、1つ以上のXenServerホストの集合体です。プールは1つ以上の共有ストレージリポジトリを使用するため、プール内の1つのホストで実行されているVMを、ほぼリアルタイムでプール内の別のホストに移行できます。この移行は、VMが実行中のままで行われ、シャットダウンして再起動する必要はありません。

各XenServerホストは、デフォルトでは単一メンバーで構成されるプールです。XenServerホストがプールに参加すると、メンバーとして指定されます。ホストが参加しているプールが単一メンバーで構成されている場合、そのメンバーがプールコーディネーターになります。ホストが参加しているプールにすでに複数のメンバーがいる場合、これらのメンバーの1つがすでにプールコーディネーターであり、新しいホストがプールに参加してもその状態は維持されます。

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

プールパラメーター

プールには次のパラメーターがあります。

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

プール全体にエディションを適用します。エディションの値には、「cloud」、「standard-per-socket」、「premium-per-socket」が含まれます。将来的には、「cloud」のみがサポートされます。

pool-certificate-install

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

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

pool-certificate-list

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

プール内のインストールされているすべてのTLS証明書を一覧表示します。

pool-certificate-sync

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

プールコーディネーターから他のプールメンバーへ、TLS証明書と証明書失効リストを同期します。

pool-certificate-uninstall

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

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

pool-crl-install

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

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

pool-crl-list

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

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

pool-crl-uninstall

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

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

pool-deconfigure-wlb

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

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

pool-designate-new-master

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

指定されたメンバーのXenServerホストに、既存のプールのコーディネーター（以前は「マスター」と呼ばれていました）になるよう指示します。このコマンドは、プールコーディネーターの役割をリソースプール内の別のホストに秩序正しく引き渡します。このコマンドは、現在のプールコーディネーターがオンラインの場合にのみ機能します。以下にリストされている緊急モードコマンドの代替ではありません。

pool-disable-external-auth

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

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

pool-disable-local-storage-caching

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

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

pool-disable-redo-log

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

HAが有効でない限り、使用中の場合はリドゥログを無効にします。

pool-dump-database

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

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

pool-enable-external-auth

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

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

pool-enable-local-storage-caching

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

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

pool-enable-redo-log

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

HAが有効でない限り、使用中の場合は指定されたSRでリドゥログを有効にします。

pool-eject

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

指定されたXenServerホストに既存のプールから離脱するよう指示します。

pool-emergency-reset-master

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

プールメンバーホストに、プールコーディネーターアドレスを新しい値にリセットし、それに接続を試みるよう指示します。このコマンドはプールコーディネーターでは実行しないでください。

pool-emergency-transition-to-master

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

メンバーのXenServerホストに、プールコーディネーター（以前は「プールマスター」と呼ばれていました）になるよう指示します。XenServerホストは、ホストが緊急モードに移行した後にのみこのコマンドを受け入れます。緊急モードとは、コーディネーターがネットワークから消失し、数回の再試行後も連絡が取れないプールのメンバーであることを意味します。

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

pool-ha-enable

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

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

pool-ha-disable

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

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

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

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

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

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

提供された提案済みの保護対象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
<!--NeedCopy-->

現在のプールに対して、ターゲットのワークロードバランシングサーバーでワークロードバランシングを初期化します。

pool-join

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

既存のプールに参加するようにXenServerホストに指示します。

pool-management-reconfigure

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

プール内のすべてのホストの管理インターフェースを、指定されたネットワークインターフェース（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
<!--NeedCopy-->

緊急モードで現在実行中のすべてのメンバーのアドレスをリセットするようにプールコーディネーターに指示します。このコマンドは通常、pool-emergency-transition-to-masterを使用してメンバーの1つを新しいプールコーディネーターとして設定した後に使用されます。

pool-restore-database

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

データベースバックアップ（pool-dump-databaseで作成）をプールにアップロードします。アップロードを受信すると、プールコーディネーターは新しいデータベースで自身を再起動します。

また、ドライランオプションもあり、実際に操作を実行せずにプールデータベースが復元できることを確認できます。デフォルトでは、dry-runはfalseに設定されています。

pool-retrieve-wlb-configuration

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

Workload Balancing サーバーからプール最適化基準を取得します。

pool-retrieve-wlb-diagnostics

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

Workload Balancing サーバーから診断情報を取得します。

pool-retrieve-wlb-recommendations

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

Workload Balancing サーバーからプールに対するVM移行の推奨事項を取得します。

pool-retrieve-wlb-report

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

Workload Balancing サーバーからレポートを取得します。

pool-secret-rotate

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

プールシークレットをローテーションします。

プールシークレットは、プール内の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
<!--NeedCopy-->

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

pool-send-wlb-configuration

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

Workload Balancing サーバーのプール最適化基準を設定します。

pool-sync-database

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

リソースプール内のすべてのホスト間でプールデータベースを強制的に同期します。データベースは定期的に自動的にレプリケートされるため、通常操作ではこのコマンドは必要ありません。ただし、大規模なCLI操作セットを実行した後、変更が迅速にレプリケートされることを保証するのに役立ちます。

https-onlyを設定

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

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

指定されたホストの指定されたSR上にPVSキャッシュを構成します。

pvs-cache-storage-destroy

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

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

pvs-proxy-create

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

PVSプロキシを使用するようにVM/VIFを構成します。

pvs-proxy-destroy

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

このVIF/VMのPVSプロキシを削除（または無効化）します。

pvs-server-forget

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

PVSサーバーを忘却します。

pvs-server-introduce

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

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

pvs-site-forget

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

PVSサイトを忘れます。

pvs-site-introduce

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

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

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

ストレージマネージャープラグインを制御するためのコマンド。

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

SMパラメーター

SMには次のパラメーターがあります。

ホストとプールでの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>
<!--NeedCopy-->

このコマンドは、指定されたホストでsshdサービスを開始し、有効にします。 有効なhostセレクターについては、ホストセレクターを参照してください。 。

ホストでSSHを無効にする

xe host-disable-ssh host=<host_uuid_or_name_label>
<!--NeedCopy-->

このコマンドは、指定されたホストでsshdサービスを停止し、無効にします。

プール内のすべてのホストでSSHを有効にする

xe pool-enable-ssh
<!--NeedCopy-->

このコマンドは、現在のプール内のすべてのホストでsshdサービスを開始し、有効にします。

プール内のすべてのホストでSSHを無効にする

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

このコマンドは、現在のプール内のすべてのホストでsshdサービスを停止し、無効にします。

出力例（プールレベル操作）

xe pool-enable-ssh

Some of hosts failed to enable SSH access.
hosts: d734ff47-f429-4bd4-93f7-245cffbdc79e (genus-35-003d)
<!--NeedCopy-->

ホストが失敗した場合、コマンドは残りのホストの処理を続行し、最後に失敗を報告します。

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

スナップショットを操作するためのコマンド。

snapshot-clone

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

既存のスナップショットをクローンして新しいテンプレートを作成します。利用可能な場合は、ストレージレベルの高速ディスククローン操作を使用します。

snapshot-copy

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

既存のVMをコピーして新しいテンプレートを作成しますが、ストレージレベルの高速ディスククローン操作（利用可能な場合でも）は使用しません。コピーされたVMのディスクイメージは、「フルイメージ」、つまりCoWチェーンの一部ではないことが保証されます。

snapshot-destroy

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

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

snapshot-disk-list

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

選択したVMのディスクを一覧表示します。

snapshot-export-to-template

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

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

snapshot-reset-powerstate

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

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

snapshot-revert

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

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

snapshot-uninstall

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

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

SRコマンド

SR（ストレージリポジトリ）を制御するためのコマンド。

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

SRパラメータ

SRには以下のパラメータがあります。

sr-create

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

ディスク上にSRを作成し、それをデータベースに導入し、SRをXenServerホストにアタッチするPBDを作成します。sharedがtrueに設定されている場合、プール内の各XenServerホストに対してPBDが作成されます。sharedが指定されていないかfalseに設定されている場合、host-uuidで指定されたXenServerホストに対してのみPBDが作成されます。

正確なdevice-configパラメータは、デバイスtypeによって異なります。異なるストレージバックエンドにおけるこれらのパラメータの詳細については、SRの作成を参照してください。

sr-data-source-forget

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

SR の指定されたデータソースの記録を停止し、記録されたすべてのデータを破棄します。

sr-data-source-list

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

SR に記録できるデータソースを一覧表示します。

sr-data-source-query

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

SR データソースから読み取られた最後の値を照会します。

sr-data-source-record

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

SR の指定されたデータソースを記録します。

sr-destroy

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

XenServer ホスト上の指定された SR を破棄します。

sr-enable-database-replication

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

指定された（共有）SR への XAPI データベースレプリケーションを有効にします。

sr-disable-database-replication

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

指定された SR への XAPI データベースレプリケーションを無効にします。

sr-forget

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

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

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

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

注:

このコマンドは通常の操作では使用されません。この高度な操作は、SRが作成後に共有として再構成される必要がある場合や、さまざまな障害シナリオから回復するのに役立つ場合があります。

sr-probe

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

提供されたdevice-configキーを使用して、バックエンドのスキャンを実行します。SRバックエンドのdevice-configが完了している場合、このコマンドはデバイス上に存在するSRのリストを返します（存在する場合）。device-configパラメータが部分的な場合、バックエンド固有のスキャンが実行され、残りのdevice-configパラメータを改善するための結果が返されます。スキャン結果は、バックエンドに固有のXMLとしてCLIに表示されます。

正確なdevice-configパラメータは、デバイスのtypeによって異なります。さまざまなストレージバックエンドにおけるこれらのパラメータの詳細については、Storageを参照してください。

sr-probe-ext

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

ストレージプローブを実行します。device-configパラメータは、例えばdevice-config:devs=/dev/sdb1のように指定できます。sr-probeとは異なり、このコマンドはすべてのSRタイプに対して同じ人間が読める形式で結果を返します。

sr-scan

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

SRスキャンを強制実行し、基盤となるストレージ基盤に存在するVDIとXAPIデータベースを同期します。

sr-update

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

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

lvhd-enable-thin-provisioning

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

LVHD SR でシンプロビジョニングを有効にします。

サブジェクトコマンド

サブジェクトを操作するためのコマンド。

session-subject-identifier-list

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

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

session-subject-identifier-logout

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

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

session-subject-identifier-logout-all

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

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

subject-add

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

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

subject-remove

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

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

subject-role-add

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

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

subject-role-remove

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

主体からロールを削除します。

secret-create

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

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

secret-destroy

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

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

タスクコマンド

長時間実行される非同期タスクを操作するためのコマンド。これらのコマンドは、仮想マシンの起動、停止、一時停止などのタスクです。タスクは通常、要求された操作を達成するために、他のアトミックなサブタスクのセットで構成されています。

タスクオブジェクトは標準のオブジェクトリストコマンド (xe task-list) で一覧表示でき、パラメータは標準のパラメータコマンドで操作できます。詳細については、低レベルパラメータコマンド を参照してください。

タスクパラメータ

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

task-cancel

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

指定されたタスクにキャンセルして戻るよう指示します。

テンプレートコマンド

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

• is-control-domain (読み取り専用) これが制御ドメイン（ドメイン0またはドライバー・ドメイン）である場合はtrue
• power-state (読み取り専用) 現在の電源状態。テンプレートの場合、値は常にhaltedです。
• memory-dynamic-max (読み取り専用) 動的最大メモリ（バイト単位）。 現在使用されていませんが、変更する場合は次の制約に従う必要があります: memory_static_max >= memory_dynamic_max >= memory_dynamic_min >= memory_static_min。
• memory-dynamic-min (読み取り/書き込み) バイト単位の動的最小メモリ。 現在使用されていませんが、変更された場合はmemory-dynamic-maxと同じ制約に従う必要があります。
• memory-static-max (読み取り/書き込み) バイト単位で静的に設定された (絶対) 最大メモリ。このフィールドは、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
   <!--NeedCopy-->
  

  シリアルポートのエミュレーションを無効にするには:

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

  USBコントローラーとUSBタブレットデバイスのエミュレーションを無効にするには:

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

• allowed-operations (読み取り専用セットパラメータ) この状態が許可する操作のリスト
• current-operations (読み取り専用セットパラメータ) このテンプレートで現在進行中の操作のリスト
• allowed-VBD-devices (読み取り専用セットパラメータ) 使用可能なVBD識別子のリストで、0～254の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。
• allowed-VIF-devices (読み取り専用セットパラメータ) 使用可能なVIF識別子のリストで、0～6の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。
• HVM-boot-policy (読み取り/書き込み) ゲストのブートポリシー。BIOS Orderまたは空の文字列のいずれか。
• HVM-boot-params (読み取り/書き込みマップパラメータ) 順序キーはゲストのブート順序を制御します。各文字がブート方法を表す文字列として表現されます。dはCD/DVD、cはルートディスク、nはネットワークPXEブートです。デフォルトは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
<!--NeedCopy-->

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

template-uninstall

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

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

更新コマンド

以下のセクションには、XenServerホストの更新コマンドが含まれています。

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

更新パラメータ

XenServerホストの更新には、以下のパラメータがあります。

update-upload

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

指定された更新ファイルをXenServerホストにアップロードします。このコマンドは、適用される更新を準備します。成功すると、アップロードされた更新のUUIDが表示されます。更新が以前にアップロードされている場合、代わりにUPDATE_ALREADY_EXISTSエラーが返され、パッチは再度アップロードされません。

update-precheck

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

指定されたXenServerホスト上で、指定された更新に含まれる事前チェックを実行します。

update-destroy

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

適用されていない更新ファイルをプールから削除します。ホストに適用できない更新ファイルを削除するために使用できます。

update-apply

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

指定された更新ファイルを適用します。

update-pool-apply

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

指定された更新をプール内のすべてのXenServerホストに適用します。

update-introduce

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

更新VDIを導入します。

update-pool-clean

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

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

ユーザーコマンド

user-password-change

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

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

VBDコマンド

VBD（仮想ブロックデバイス）を操作するためのコマンド。

VBDは、VMをVDIに接続するソフトウェアオブジェクトであり、VDIは仮想ディスクの内容を表します。VBDには、VDIをVMに結び付ける属性（起動可能かどうか、読み取り/書き込みメトリックなど）があります。VDIには、仮想ディスクの物理属性（SRの種類、ディスクが共有可能かどうか、メディアが読み取り/書き込み可能か読み取り専用かなど）に関する情報が含まれています。

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

VBDパラメータ

VBDには以下のパラメーターがあります。

vbd-create

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

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

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

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

vbd-eject

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

VBDで表されるドライブからメディアを取り外します。このコマンドは、メディアがリムーバブルタイプ（物理CDまたはISO）の場合にのみ機能します。それ以外の場合は、エラーメッセージ VBD_NOT_REMOVABLE_MEDIA が返されます。

vbd-insert

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

VBDで表されるドライブに新しいメディアを挿入します。このコマンドは、メディアがリムーバブルタイプ（物理CDまたはISO）の場合にのみ機能します。それ以外の場合は、エラーメッセージ VBD_NOT_REMOVABLE_MEDIA が返されます。

vbd-plug

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

VMが実行状態にある間にVBDをアタッチしようとします。

vbd-unplug

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

VMが実行状態にある間にVBDをVMからデタッチしようとします。

VDIコマンド

VDI（仮想ディスクイメージ）を操作するためのコマンド。

VDIは、VMから見える仮想ディスクの内容を表すソフトウェアオブジェクトです。これは、VMをVDIに結び付けるオブジェクトであるVBDとは異なります。VDIには、仮想ディスクの物理属性（SRのタイプ、ディスクが共有可能かどうか、メディアが読み書き可能か読み取り専用かなど）に関する情報が含まれています。VBDには、VDIをVMに結び付ける属性（起動可能かどうか、読み書きメトリックなど）が含まれています。

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

VDIパラメータ

VDIには次のパラメータがあります。

vdi-clone

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

指定されたVDIの新しい書き込み可能なコピーを直接使用できるように作成します。これは、vdi-copy のバリアントであり、高速イメージクローン機能が存在する場合にそれを公開できます。

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

vdi-copy

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

指定された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
<!--NeedCopy-->

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

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

注:

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

vdi-destroy

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

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

注:

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

Local VHDおよびNFS SRタイプの場合、ディスク領域はvdi-destroyで即座に解放されず、ストレージリポジトリのスキャン操作中に定期的に解放されます。削除されたディスク領域を強制的に利用可能にする必要がある場合は、sr-scanを手動で呼び出してください。

vdi-disable-cbt

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

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

vdi-enable-cbt

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

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

注:

変更ブロック追跡を有効にできるのは、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]
<!--NeedCopy-->

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

• raw
• vhd

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

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

vdi-forget

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

ストレージバックエンドに触れることなく、データベースからVDIレコードを無条件に削除します。通常の操作では、代わりにvdi-destroyを使用してください。

vdi-import

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

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

• raw
• vhd

vdi-introduce

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

既存のストレージデバイスを表すVDIオブジェクトを作成します。ストレージの変更や作成は実際には行いません。このコマンドは、主にホットプラグされたストレージデバイスを自動的に導入するために内部的に使用されます。

vdi-list-changed-blocks

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

2つのVDIを比較し、変更されたブロックのリストをbase64エンコードされた文字列として返します。このコマンドは、変更ブロック追跡が有効になっているVDIでのみ機能します。

詳細については、「変更ブロック追跡」(/ja-jp/xenserver/developer/changed-block-tracking-guide.html)を参照してください。

vdi-pool-migrate

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

実行中のゲストにVDIがアタッチされている間に、VDIを指定されたSRに移行します。（ストレージライブマイグレーション）

詳細については、「VMの移行」(/ja-jp/xenserver/9/vms/migrate.html)を参照してください。

vdi-resize

xe vdi-resize uuid=vdi_uuid disk-size=new_size_for_disk
<!--NeedCopy-->

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

vdi-snapshot

xe vdi-snapshot uuid=uuid_of_the_vdi [driver-params=params]
<!--NeedCopy-->

VDIの読み書き可能なバージョンを生成します。これは、バックアップまたはテンプレート作成の目的、あるいはその両方の参照として使用できます。VM内にバックアップソフトウェアをインストールして実行するのではなく、スナップショットを使用してバックアップを実行します。外部バックアップソフトウェアがスナップショットの内容をバックアップメディアにストリーミングしている間も、VMは実行を継続します。同様に、スナップショットはテンプレートの基盤となる「ゴールドイメージ」として使用できます。テンプレートは任意のVDIを使用して作成できます。

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

スナップショットのクローンは常に書き込み可能なVDIを生成します。

vdi-unlock

xe vdi-unlock uuid=uuid_of_vdi_to_unlock [force=true]
<!--NeedCopy-->

指定されたVDIのロック解除を試みます。コマンドにforce=trueが渡されると、ロック解除操作が強制されます。

vdi-update

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

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

VIFコマンド

VIF（仮想ネットワークインターフェース）を操作するためのコマンド。

VIFオブジェクトは標準のオブジェクトリストコマンド (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
   <!--NeedCopy-->
  

• currently-attached (読み取り専用) デバイスがアタッチされている場合はtrue
• qos_algorithm_type (読み取り/書き込み) 使用するQoSアルゴリズム
• qos_algorithm_params (読み取り/書き込みマップパラメータ) 選択されたQoSアルゴリズムのパラメータ
• qos_supported_algorithms (読み取り専用セットパラメータ) このVIFでサポートされているQoSアルゴリズム
• MAC-autogenerated (読み取り専用) VIFのMACアドレスが自動生成された場合はtrue
• other-config (読み取り/書き込みマップパラメータ) 追加設定の key:value ペア
• other-config:ethtoolrx (読み取り/書き込み) 受信チェックサムを有効にするにはon、無効にするにはoffに設定
• other-config:ethtooltx (読み取り/書き込み) 送信チェックサムを有効にするにはon、無効にするにはoffに設定
• other-config:ethtoolsg (読み取り/書き込み) スカッターギャザーを有効にするにはon、無効にするにはoffに設定
• other-config:ethtooltso (読み取り/書き込み) TCPセグメンテーションオフロードを有効にするにはonに設定し、無効にするにはoffに設定します
• other-config:ethtoolufo (読み取り/書き込み) UDPフラグメントオフロードを有効にするにはonに設定し、無効にするにはoffに設定します
• other-config:ethtoolgso (読み取り/書き込み) 汎用セグメンテーションオフロードを有効にするにはonに設定し、無効にするにはoffに設定します
• other-config:promiscuous (読み取り/書き込み) VIFがブリッジ上でプロミスキャスになり、ブリッジ上のすべてのトラフィックを認識するようにするにはtrueに設定します。仮想マシン内で侵入検知システム (IDS) などを実行する場合に役立ちます。
• network-uuid (読み取り専用) このVIFが接続されている仮想ネットワークの一意の識別子/オブジェクト参照
• network-name-label (読み取り専用) このVIFが接続されている仮想ネットワークの記述名
• io_read_kbs (読み取り専用) このVIFの平均読み取り速度 (kB/秒)
• io_write_kbs (読み取り専用) このVIFの平均書き込み速度 (kB/秒)
• locking_mode (読み取り/書き込み) MACアドレスとIPアドレスのリストに対するVIFのトラフィックフィルタリング機能に影響します。追加のパラメーターが必要です。

• locking_mode:default (読み取り/書き込み) VIFネットワークのデフォルトのロックモードによって異なります。

  default-locking-modeがdisabledに設定されている場合、XenServerはVIFがトラフィックを送受信できないようにフィルタリングルールを適用します。default-lockingmodeがunlockedに設定されている場合、XenServerはVIFに関連付けられているすべてのフィルタリングルールを削除します。詳細については、ネットワークコマンドを参照してください。

• locking_mode:locked (読み取り/書き込み) 指定されたMACアドレスとIPアドレスに送信される、またはそこから送信されるトラフィックのみがVIFで許可されます。IPアドレスが指定されていない場合、トラフィックは許可されません。
• locking_mode:unlocked (読み取り/書き込み) VIFとの間で送受信されるトラフィックには、いかなるフィルターも適用されません。
• locking_mode:disabled (読み取り/書き込み) 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]
<!--NeedCopy-->

VM上にVIFを作成します。

指定されたVMのパラメーターallowed-VIF-devicesに、deviceフィールドの適切な値がリストされています。VIFがまだ存在しない場合、許可される値は0～6の整数です。

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

vif-destroy

xe vif-destroy uuid=uuid_of_vif
<!--NeedCopy-->

VIFを破棄します。

vif-move

xe vif-move uuid=uuid network-uuid=network_uuid
<!--NeedCopy-->

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

vif-plug

xe vif-plug uuid=uuid_of_vif
<!--NeedCopy-->

VMが実行中の状態のときにVIFをアタッチしようとします。

vif-unplug

xe vif-unplug uuid=uuid_of_vif
<!--NeedCopy-->

VMが実行中にVIFをVMからデタッチしようとします。

vif-configure-ipv4

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

xe vif-configure-ipv4 uuid=uuid_of_vif mode=static address=CIDR_address gateway=gateway_address
<!--NeedCopy-->

例:

VIF.configure_ipv4(vifObject,"static", " 192.168.1.10/24", " 192.168.1.1")
<!--NeedCopy-->

IPv4設定を以下のようにクリーンアップします。

xe vif-configure-ipv4 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

vif-configure-ipv6

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

xe vif-configure-ipv6 uuid=uuid_of_vif mode=static address=IP_address gateway=gateway_address
<!--NeedCopy-->

例:

VIF.configure_ipv6(vifObject,"static", "fd06:7768:b9e5:8b00::5001/64", "fd06:7768:b9e5:8b00::1")
<!--NeedCopy-->

IPv6設定を以下のようにクリアします。

xe vif-configure-ipv6 uuid=uuid_of_vif mode=none
<!--NeedCopy-->

VLANコマンド

VLAN（仮想ネットワーク）を操作するためのコマンド。仮想インターフェースを一覧表示および編集するには、関連する仮想ネットワークがあることを示す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
<!--NeedCopy-->

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

pool-vlan-create

xe pool-vlan-create pif-uuid=uuid_of_pif vlan=vlan_number network-uuid=uuid_of_network
<!--NeedCopy-->

プール内のすべてのホストでVLANを作成するには、各ホストで指定されたネットワークがどのインターフェース（例えば、eno12429np0）上にあるかを判断し、それに応じて各ホスト上に新しいPIFオブジェクトを作成して接続します。

vlan-destroy

xe vlan-destroy uuid=uuid_of_pif_mapped_to_vlan
<!--NeedCopy-->

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

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

  VDAがWindows 10をタブレットモードに切り替えるのを有効にするには：

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

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

   xe vm-param-get uuid=<vm_uuid> param-name=platform param-key=acpi_laptop_slate
   <!--NeedCopy-->
  

• allowed-operations (読み取り専用設定パラメーター) この状態で許可されている操作のリスト
• current-operations (読み取り専用設定パラメーター) 現在VMで進行中の操作のリスト
• allowed-VBD-devices (読み取り専用設定パラメーター) 使用可能なVBD識別子のリスト。0～254の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。
• allowed-VIF-devices (読み取り専用設定パラメーター) 使用可能なVIF識別子のリスト。0～6の範囲の整数で表されます。このリストは情報提供のみを目的としており、他のデバイスも使用できます（ただし、動作しない場合があります）。
• HVM-boot-policy (読み取り/書き込み) ゲストのブートポリシー。BIOS順序または空の文字列のいずれか。
• HVM-boot-params (読み取り/書き込みマップパラメーター) 順序キーはゲストのブート順序を制御します。各文字がブート方法を表す文字列として表現されます。dはCD/DVD、cはルートディスク、nはネットワークPXEブートです。デフォルトはdcです。
• HVM-shadow-multiplier (読み取り/書き込み) VMに付与するシャドウメモリオーバーヘッドの量を制御する浮動小数点値。デフォルトは1.0（最小値）であり、上級ユーザーの場合にのみこの値を変更してください。
• 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ホスト
• affinity (読み取り/書き込み) VMが実行を優先するXenServerホスト。VMを実行する場所を決定するために xe vm-start コマンドによって使用されます。ホームサーバーとも呼ばれます。
• groups (読み取り/書き込み) このVMが属するVMグループ。VMグループは、XenServerがVMを起動しようとする場所、またはVMを退避させる場所を定義します。

• other-config (読み取り/書き込みマップパラメーター) VMの追加構成パラメーターを指定するキーと値のペアのリスト。

  たとえば、other-config キーと値のペア auto_poweron: true は、プール内の任意のホストが起動した後にVMを自動的に起動するように要求します。このパラメーターは、プールの other-config にも設定する必要があります。これらのパラメーターは現在非推奨です。代わりに ha-restart-priority パラメーターを使用してください。

• start-time (読み取り専用) VMのメトリックが読み取られた日時を示すタイムスタンプ。このタイムスタンプは yyyymmddThh:mm:ss z の形式で、z は単一文字の軍事タイムゾーンインジケーターです（例: UTC (GMT) の場合は Z）
• install-time (読み取り専用) 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は常にVCPUsmaxに設定されたvCPU数で実行され、この値を変更するには再起動が必要です。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
<!--NeedCopy-->

このVMを回復するためのストレージが利用可能かどうかをテストします。

vm-call-plugin

xe vm-call-plugin vm-uuid=vm_uuid plugin=plugin fn=function [args:key=value]
<!--NeedCopy-->

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

vm-cd-add

xe vm-cd-add cd-name=name_of_new_cd device=integer_value_of_an_available_vbd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

選択したVMに新しい仮想CDを追加します。device パラメーターを0～3から選択します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーターの任意の数にすることができます。

vm-cd-eject

xe vm-cd-eject [vm-selector=vm_selector_value...]
<!--NeedCopy-->

仮想CDドライブからCDを取り出します。このコマンドは、VMにCDが1つだけ接続されている場合にのみ機能します。CDが2つ以上ある場合は、コマンドxe vbd-ejectを使用してVBDのUUIDを指定します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーターの任意の数にすることができます。

vm-cd-insert

xe vm-cd-insert cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

仮想CDドライブにCDを挿入します。このコマンドは、VMに空のCDデバイスが1つだけ接続されている場合にのみ機能します。空のCDデバイスが2つ以上ある場合は、xe vbd-insertコマンドを使用して、挿入するVBDとVDIのUUIDを指定します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーターの任意の数にすることができます。

vm-cd-list

xe vm-cd-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMに接続されているCDを一覧表示します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーターの任意の数にすることができます。

リストするVBDおよびVDIパラメーターを選択することもできます。

vm-cd-remove

xe vm-cd-remove cd-name=name_of_cd [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMから仮想CDを削除します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-checkpoint

xe vm-checkpoint new-name-label=name_label [new-name-description=description]
<!--NeedCopy-->

既存のVMをチェックポイントします。利用可能な場合は、ストレージレベルの高速ディスクスナップショット操作を使用します。

vm-clone

xe vm-clone new-name-label=name_for_clone [new-name-description=description_for_clone] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

既存のVMをクローンします。利用可能な場合は、ストレージレベルの高速ディスククローン操作を使用します。結果として作成されるクローンVMの名前とオプションの説明は、new-name-labelおよびnew-name-description引数を使用して指定します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-compute-maximum-memory

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

既存のVMに割り当て可能な静的メモリの最大量を、物理RAMの総量を上限として計算します。オプションのパラメーターapproximateは、後でVMにvCPUを追加することを考慮して、計算で十分な追加メモリを予約します。

例:

xe vm-compute-maximum-memory vm=testvm total=`xe host-list params=memory-free --minimal`
<!--NeedCopy-->

このコマンドは、xe host-listコマンドによって返されるmemory-freeパラメーターの値を使用して、testvmという名前のVMの最大メモリを設定します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-compute-memory-overhead

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

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

既存のVMをコピーしますが、ストレージレベルの高速ディスククローン操作を使用しません（このオプションが利用可能な場合でも）。コピーされたVMのディスクイメージは、フルイメージであることが保証されます。つまり、コピーオンライト（CoW）チェーンの一部ではありません。

結果としてコピーされるVMの名前とオプションの説明を、new-name-label および new-name-description 引数を使用して指定します。

結果としてコピーされるVMの宛先SRを sr-uuid を使用して指定します。このパラメーターが指定されていない場合、宛先は元のVMが存在するSRと同じになります。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクター を参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーター の任意の数になります。

vm-copy-bios-strings

xe vm-copy-bios-strings host-uuid=host_uuid
<!--NeedCopy-->

指定されたホストのBIOS文字列をVMにコピーします。

注:

VMを最初に起動した後、そのBIOS文字列を変更することはできません。VMを初めて起動する前に、BIOS文字列が正しいことを確認してください。

vm-crashdump-list

xe vm-crashdump-list [vm-selector=vm selector value...]
<!--NeedCopy-->

指定されたVMに関連付けられているクラッシュダンプを一覧表示します。

オプションの引数 params を使用すると、params の値は、表示したいこのオブジェクトのパラメーターのリストを含む文字列になります。あるいは、キーワード all を使用してすべてのパラメーターを表示することもできます。params が使用されていない場合、返されるリストは、利用可能なすべてのパラメーターのデフォルトのサブセットを表示します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクター を参照してください。オプションの引数は、このセクションの冒頭に記載されているVMパラメーター の任意の数になります。

vm-data-source-list

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

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

指定されたVMのデータソースを記録します。

この操作は、データソースからの情報を、指定されたVMの永続的なパフォーマンスメトリックデータベースに書き込みます。パフォーマンス上の理由から、このデータベースは通常のエージェントデータベースとは異なります。

標準の選択メカニズムを使用して、この操作を実行するVMを選択します。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメータの任意の数を指定できます。ホストを選択するためのパラメータが指定されていない場合、操作はすべてのVMに対して実行されます。

vm-data-source-forget

xe vm-data-source-forget data-source=name_description_of_data-source [vm-selector=vm selector value...]
<!--NeedCopy-->

指定されたVMのデータソースの記録を停止し、記録されたすべてのデータを破棄します。

標準の選択メカニズムを使用して、この操作を実行するVMを選択します。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメータの任意の数を指定できます。ホストを選択するためのパラメータが指定されていない場合、操作はすべてのVMに対して実行されます。

vm-data-source-query

xe vm-data-source-query data-source=name_description_of_data-source [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMのデータソースを表示します。

標準の選択メカニズムを使用して、この操作を実行するVMを選択します。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメータの任意の数を指定できます。ホストを選択するためのパラメータが指定されていない場合、操作はすべてのVMに対して実行されます。

vm-destroy

xe vm-destroy uuid=uuid_of_vm
<!--NeedCopy-->

指定された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...]
<!--NeedCopy-->

指定されたVMにディスクを追加します。VMのallowed-VBD-devicesパラメーターの値からdeviceパラメーターを選択します。

disk-sizeパラメーターは、バイト単位、またはIEC標準のサフィックス（KiB、MiB、GiB、TiB）を使用して指定できます。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-disk-list

xe vm-disk-list [vbd-params] [vdi-params] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMに接続されているディスクを一覧表示します。vbd-paramsおよびvdi-paramsパラメーターは、出力するそれぞれのオブジェクトのフィールドを制御します。パラメーターはコンマ区切りのリストとして指定するか、完全なリストの場合は特殊キーallを指定します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-disk-remove

xe vm-disk-remove device=integer_label_of_disk [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMからディスクを削除し、破棄します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-export

xe vm-export filename=export_filename [metadata=true|false] [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVM（ディスクイメージを含む）をローカルマシンのファイルにエクスポートします。VMをエクスポートするファイル名は、filenameパラメーターを使用して指定します。慣例として、ファイル名には.xva拡張子が付いています。

metadataパラメーターがtrueの場合、ディスクはエクスポートされません。VMメタデータのみが出力ファイルに書き込まれます。このパラメーターは、基盤となるストレージが他のメカニズムを介して転送され、VM情報を再作成できる場合に使用します。詳細については、vm-importを参照してください。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-import

xe vm-import filename=export_filename [metadata=true|false] [preserve=true|false][sr-uuid=destination_sr_uuid]
<!--NeedCopy-->

以前にエクスポートされたファイルからVMをインポートします。preserveがtrueに設定されている場合、元のVMのMACアドレスは保持されます。sr-uuidは、VMをインポートする宛先SRを決定します。このパラメーターが指定されていない場合、デフォルトのSRが使用されます。

もしmetadataがtrueの場合、以前にエクスポートされたメタデータセットを、関連するディスクブロックなしでインポートできます。SRとVDI.locationによって指定されたVDIが見つからない場合、メタデータのみのインポートは失敗します。ただし、--forceオプションが指定されている場合は、インポートは続行されます。ディスクをミラーリングしたり、帯域外で移動したりできる場合、メタデータのインポート/エクスポートは、分離されたプール間で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]
<!--NeedCopy-->

テンプレートから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
<!--NeedCopy-->

VMのBIOS文字列がカスタマイズされているかどうかを示します。

vm-memory-dynamic-range-set

xe vm-memory-dynamic-range-set min=min max=max
<!--NeedCopy-->

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

VMのメモリ制限を設定します。

vm-memory-set

xe vm-memory-set memory=memory
<!--NeedCopy-->

VMのメモリ割り当てを設定します。

vm-memory-shadow-multiplier-set

xe vm-memory-shadow-multiplier-set [vm-selector=vm_selector_value...] [multiplier=float_memory_multiplier]
<!--NeedCopy-->

指定された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
<!--NeedCopy-->

VMの静的メモリ範囲を設定します。静的メモリ範囲は、VMのメモリの厳密な下限と上限を定義します。これらのフィールドは、VMが停止している場合にのみ変更できます。静的範囲は動的範囲を包含する必要があります。

vm-memory-target-set

xe vm-memory-target-set target=target
<!--NeedCopy-->

停止中または実行中の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]
<!--NeedCopy-->

このコマンドは、指定された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
<!--NeedCopy-->

同じプール内でストレージを共有しないホスト間でVMを移動するには（ストレージライブマイグレーション）：

xe vm-migrate uuid=vm_uuid host-uuid=destination_host_uuid \
    remote-master=192.0.2.35 remote-username=username remote-password=password
<!--NeedCopy-->

ストレージライブマイグレーションの場合、同じプール内で移行する場合でも、プールコーディネーターのホスト名またはIPアドレス、ユーザー名、パスワードを指定する必要があります。

各VDIが保存される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
<!--NeedCopy-->

さらに、移行後に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
<!--NeedCopy-->

クロスプールマイグレーションの場合：

xe vm-migrate uuid=vm_uuid remote-master=192.0.2.35 \
    remote-username=username remote-password=password \
    host-uuid=destination_host_uuid  \
    vif:source_vif_uuid=destination_network_uuid \
    vdi:vdi_uuid=destination_sr_uuid
<!--NeedCopy-->

ストレージライブマイグレーション、ライブマイグレーション、およびライブVDIマイグレーションの詳細については、「VMの移行」を参照してください。

注：

XenServerの以前のバージョンからアップグレードする場合、新しい仮想化機能が適用されるように、VMを移行した後、すべてのVMをシャットダウンして起動する必要がある場合があります。

デフォルトでは、VMは一時停止され、移行され、別のホストで再開されます。live パラメーターはライブマイグレーションを選択します。ライブマイグレーションは、移行中にVMを実行し続けるため、VMのダウンタイムを最小限に抑えます。VM内の非常にメモリを大量に消費するワークロードなど、特定の状況では、ライブマイグレーションはデフォルトモードにフォールバックし、メモリ転送が完了する前にVMを短時間一時停止します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、「VMセレクター」を参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-pause

xe vm-pause
<!--NeedCopy-->

実行中のVMを一時停止します。この操作では、関連付けられたメモリは解放されないことに注意してください (vm-suspend を参照)。

vm-reboot

xe vm-reboot [vm-selector=vm_selector_value...] [force=true]
<!--NeedCopy-->

指定されたVMを再起動します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、「VMセレクター」を参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

force引数を使用して、正常ではない再起動を実行します。シャットダウンは、物理サーバーの電源プラグを抜くのと同様です。

vm-recover

xe vm-recover vm-uuid [database] [vdi-uuid] [force]
<!--NeedCopy-->

指定されたVDIに含まれるデータベースからVMを復元します。

vm-reset-powerstate

xe vm-reset-powerstate [vm-selector=vm_selector_value...] {force=true}
<!--NeedCopy-->

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

これは、プール内のメンバーホストがダウンした場合にのみ使用される高度なコマンドです。このコマンドを使用して、プールコーディネーターにVMの電源状態をhaltedにリセットさせることができます。本質的に、このコマンドはVMとそのディスクにロックを強制し、次に別のプールホストで起動できるようにします。この呼び出しには、forceフラグの指定が必須であり、コマンドラインにない場合は失敗します。

vm-restart-device-models

xe vm-restart-device-models [vm-selector=vm_selector_value...]
<!--NeedCopy-->

ホスト上でこの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]
<!--NeedCopy-->

指定されたVMを再開します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

VMがホストのプール内の共有SR上にある場合、on引数を使用して、どのプールメンバーで起動するかを指定します。デフォルトでは、システムが適切なホストを決定しますが、これはプール内の任意のメンバーである可能性があります。

vm-retrieve-wlb-recommendations

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

選択したVMのワークロードバランシング推奨事項を取得します。

vm-shutdown

xe vm-shutdown [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

指定されたVMをシャットダウンします。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

物理サーバーの電源プラグを抜くのと同様に、force引数を使用して強制シャットダウンを実行します。

vm-snapshot

xe vm-snapshot new-name-label=name_label [new-name-description+name_description]
<!--NeedCopy-->

既存のVMのスナップショットを作成します。利用可能な場合は、ストレージレベルの高速ディスクスナップショット操作を使用します。

vm-start

xe vm-start [vm-selector=vm_selector_value...] [force=true|false] [on=host_uuid] [--multiple]
<!--NeedCopy-->

指定されたVMを起動します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

VMがホストプール内の共有SR上にある場合、on引数を使用して、VMを起動するプールメンバーを指定します。デフォルトでは、システムが適切なホストを決定します。これは、プール内の任意のメンバーである可能性があります。

vm-suspend

xe vm-suspend [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMを一時停止します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-uninstall

xe vm-uninstall [vm-selector=vm_selector_value...] [force=true|false]
<!--NeedCopy-->

VMをアンインストールし、そのメタデータレコードに加えて、そのディスク（RWとマークされ、このVMにのみ接続されているVDI）を破棄します。VMのメタデータのみを破棄するには、xe vm-destroyを使用します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

vm-unpause

xe vm-unpause
<!--NeedCopy-->

一時停止中のVMを再開します。

vm-vcpu-hotplug

xe vm-vcpu-hotplug new-vcpus=new_total_vcpu_count [vm-selector=vm_selector_value...]
<!--NeedCopy-->

実行中の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-vif-list

xe vm-vif-list [vm-selector=vm_selector_value...]
<!--NeedCopy-->

指定されたVMのVIFを一覧表示します。

この操作が実行されるVMは、標準の選択メカニズムを使用して選択されます。詳細については、VMセレクターを参照してください。セレクターはフィルタリング時にVMレコードに対して機能し、VIF値に対しては 機能しません。オプションの引数には、このセクションの冒頭に記載されているVMパラメーターの任意の数を指定できます。

スケジュールされたスナップショット

VMのスケジュールされたスナップショットとその属性を制御するためのコマンド。

vmssオブジェクトは、標準のオブジェクト一覧表示コマンド (xe vmss-list) で一覧表示でき、パラメーターは標準のパラメーターコマンドで操作できます。詳細については、「低レベルパラメーターコマンド」(/ja-jp/xenserver/9/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
<!--NeedCopy-->

プール内にスナップショットスケジュールを作成します。

例:

xe vmss-create retained-snapshots=9 enabled=true frequency=daily \
    name-description=sample name-label=samplepolicy type=snapshot \
    schedule:hour=10 schedule:min=30
<!--NeedCopy-->

スナップショットスケジュールには、次のパラメーターがあります。

vmss-destroy

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

プール内のスナップショットスケジュールを破棄します。

USBパススルー

USBパススルーは、以下のUSBバージョン (1.1、2.0、3.0) でサポートされています。

USBパススルーの有効化/無効化

xe pusb-param-set uuid=pusb_uuid passthrough-enabled=true/false
<!--NeedCopy-->

USBパススルーを有効/無効にします。

pusb-scan

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

PUSBをスキャンして更新します。

vusb-create

xe vusb-create usb-group-uuid=usb_group_uuid vm-uuid=vm_uuid
<!--NeedCopy-->

プール内に仮想USBを作成します。VMを起動して、USBをVMにパススルーします。

vusb-unplug

xe vusb-unplug uuid=vusb_uuid
<!--NeedCopy-->

VMからUSBを抜きます。

vusb-destroy

xe vusb-destroy uuid=vusb_uuid
<!--NeedCopy-->

VMから仮想USBリストを削除します。

VMグループコマンド

VMグループとその属性を制御するためのコマンド。

VMグループパラメータ

• uuid (読み取り専用) VMの一意の識別子/オブジェクト参照
• name-label (読み取り/書き込み) VMの名前
• name-description VMの記述文字列 (読み取り/書き込み)
• placement グループ内のVMに適用する配置ルールの種類 (読み取り専用)。利用可能な値は anti-affinity と normal です。

VMグループリスト

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

このプール内のすべてのVMグループを一覧表示します。

VMグループ作成

xe vm-group-create placement=anti-affinity|normal name-label=<name-label> [name-description=<name-description>]
<!--NeedCopy-->

VMグループを作成します。

VMグループ破棄

xe vm-group-destroy uuid=<vm-group-uuid>
<!--NeedCopy-->

このVMグループを削除します。VMを含むVMグループを削除した場合、VMはグループに関連付けられなくなりますが、それ以外には影響を受けません。