A.3. CLI の出力の解析

A.3.1. 単一ジョブになるサブコマンド
A.3.2. 複数のジョブになるサブコマンド
A.3.3. user-search
A.3.4. user-show
A.3.5. user-desktops
A.3.6. group-list
A.3.7. group-show
A.3.8. token-search
A.3.9. token-show
A.3.10. token-desktops
A.3.11. pool-list
A.3.12. pool-show
A.3.13. pool-users
A.3.14. pool-desktops
A.3.15. pool-templates
A.3.16. desktop-search
A.3.17. template-revisions
A.3.18. provider-list
A.3.19. provider-list-hosts
A.3.20. provider-list-storage
A.3.21. provider-list-templates
A.3.22. provider-list-unmanaged
A.3.23. provider-list-networks
A.3.24. provider-show
A.3.25. provider-storage-orphans
A.3.26. directory-list
A.3.27. admin-list
A.3.28. admin-show
A.3.29. role-list
A.3.30. job-list
A.3.31. job-show

多数の vda サブコマンドで解析可能なオプションがサポートされるため、出力をコロン (「:」) 区切りのフィールドからなる行のリストに書式設定して簡単に解析できます。

このオプションの構文は次のとおりです。

-x, --parseable Display output suitable for programmatic parsing.

次のセクションでは、解析可能なオプションをサポートするサブコマンドの出力形式について説明します。

A.3.1. 単一ジョブになるサブコマンド

次の vda サブコマンドは、単一ジョブになります。

  • pool-hv-import: Microsoft Hyper-V デスクトップをプールにインポートします。

  • pool-vb-import: Oracle VM VirtualBox デスクトップをプールにインポートします。

  • pool-vb-import-unmanaged: 管理されていない Oracle VM VirtualBox デスクトップをプールにインポートします。

  • desktop-export: デスクトップをエクスポートします。

  • revision-create: リビジョンを作成します。

  • revision-export: リビジョンをエクスポートします。

  • revision-sysprep: Sysprep をリビジョンに適用します。

  • template-create: リビジョンを新しいテンプレートにコピーします。

  • template-desktop: テンプレートを新しいデスクトップにコピーします。

  • template-export: テンプレートをエクスポートします。

  • template-revert: テンプレートを直近のリビジョンに戻します。

  • provider-migrate-host: デスクトップをホストから移行します。

  • provider-replace-storage: ストレージを置き換えます。

  • provider-suspend-storage: ストレージを一時停止します。

解析可能な出力: 次の値が指定された 1 行。

データ形式

ジョブ ID

整数

A.3.2. 複数のジョブになるサブコマンド

次の vda サブコマンドは、複数のジョブになります。

  • pool-delete: プールとそのデスクトップを削除します。

  • pool-reset: プールの複製をリセットします。

  • desktop-delete: デスクトップを削除します。

  • desktop-duplicate: デスクトップを複製します。

  • desktop-restart: デスクトップを再起動します。

  • desktop-start: デスクトップを起動します。

  • desktop-stop: デスクトップを終了します。

  • desktop-suspend: デスクトップを中断します。

  • desktop-template: デスクトップをテンプレートに変換します。

  • revision-clone: デスクトップをリビジョンから複製します。

  • revision-delete: リビジョンを削除します。

  • revision-desktop: リビジョンをデスクトップにコピーします。

  • template-delete: テンプレートを削除します。

  • template-restart: テンプレートを再起動します。

  • template-start: テンプレートを起動します。

  • template-stop: テンプレートを終了します。

  • template-suspend: テンプレートを中断します。

  • provider-storage-orphan-delete: 孤立ディスクを削除します。

解析可能な出力: 次の値を含む行のリスト。

データ形式

ジョブ ID

整数

A.3.3. user-search

指定した検索条件に一致するユーザーまたはグループをユーザーディレクトリから検索します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ユーザーまたはグループの名前

文字列

オブジェクトの種類

User | Group

ユーザーまたはグループの DN

文字列

A.3.4. user-show

ユーザーが使用できるデスクトップを表示します。

ユーザーの場合に解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

プール名

文字列

デスクトップ名

文字列

デスクトップ ID

整数

割り当ての種類

User | Token token | Group group_name | Custom Group group_name

グループの場合に解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

プール名

文字列

A.3.5. user-desktops

ユーザーに割り当てられているデスクトップを表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトップ名

文字列

デスクトップ ID

整数

プール名

文字列

割り当ての種類

flexible | personal

デフォルトデスクトップかどうか

true | false

A.3.6. group-list

すべてのカスタムグループを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

カスタムグループ名

文字列

A.3.7. group-show

カスタムグループに割り当てられているプールを表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

プール名

文字列

A.3.8. token-search

検索条件に一致するトークンを検索します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

トークン

文字列

関連付けられているユーザーの名前

文字列

関連付けられているユーザーの DN

文字列

A.3.9. token-show

トークンが使用できるデスクトップを表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

プール名

文字列

デスクトップ名

文字列

デスクトップ ID

整数

割り当ての種類

User | Token | Group group_name | Custom Group group_name

A.3.10. token-desktops

トークンに割り当てられているデスクトップを表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトップ名

文字列

デスクトップ ID

整数

プール名

文字列

割り当ての種類

flexible | personal

デフォルトデスクトップかどうか

true | false

A.3.11. pool-list

すべてのプールを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

プール名

文字列

デスクトップ割り当ての種類

Personal | Flexible

デスクトップの数

整数

デスクトッププロバイダ名

文字列

ユーザーディレクトリ名

文字列

A.3.12. pool-show

プールに関する詳細情報を表示します。

PC プール以外の場合に解析可能な出力値: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

割り当てのステータス

Enabled | Disabled

デスクトップ割り当ての種類

Personal | Flexible

デスクトッププロバイダ名

文字列

複製のステータス

Enabled | Disabled

複製ジョブの数

整数

テンプレート

None | string

使用可能なデスクトップの数

整数

割り当てられているデスクトップの数

整数

デスクトップの総数

整数

ゲストプール

Enabled | Disabled

PC プールの場合に解析可能な出力値: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

割り当てのステータス

Enabled | Disabled

デスクトップ割り当ての種類

Personal | Flexible

デスクトッププロバイダ名

文字列

使用可能なデスクトップの数

整数

割り当てられているデスクトップの数

整数

デスクトップの総数

整数

ゲストプール

Enabled | Disabled

A.3.13. pool-users

プールのすべてのユーザーを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ユーザーまたはグループの名前

文字列

オブジェクトの種類

User | Group | Token | Custom Group

ユーザーまたはグループの DN

文字列

A.3.14. pool-desktops

プールのすべてのデスクトップを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトップ名

文字列

デスクトップ ID

ロング

マシンの状態

Running | Starting | Paused | Powered Off | Suspended | Stuck | Aborted | Unknown

デスクトップの状態

Used | Idle | Unresponsive | Reserved | Available

割り当てられているユーザーの DN

文字列

A.3.15. pool-templates

プールのすべてのテンプレートを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

テンプレート名

文字列

テンプレート ID

ロング

マシンの状態

Running | Starting | Paused | Powered Off | Suspended | Stuck | Aborted | Unknown

マスターのリビジョン

文字列

複製されたデスクトップ

文字列

A.3.16. desktop-search

デスクトップ (複数可) を検索します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトップ ID

ロング

プール名

文字列

デスクトップ名

文字列

マシンの状態

Running | Starting | Paused | Powered Off | Suspended | Stuck | Aborted | Unknown

デスクトップの状態

Available | Used | Idle | Unresponsive | Reserved

割り当てられているユーザーの DN

文字列

A.3.17. template-revisions

テンプレートのリビジョンを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

リビジョン名

文字列

リビジョン ID

ロング

作成日

タイムスタンプ

マスターかどうか

yes | no

複製されたデスクトップ

文字列

A.3.18. provider-list

すべてのデスクトッププロバイダを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトッププロバイダ名

文字列

プロバイダの種類

Oracle VM VirtualBox | VMware vCenter | Microsoft Hyper-V | Microsoft Remote Desktop | PC | Kiosk

状態

OK | Unresponsive | Major Issues | Critical

A.3.19. provider-list-hosts

Oracle VDI、Microsoft Hyper-V、または Microsoft リモートデスクトップのデスクトッププロバイダのすべてのホストを一覧表示します。

Oracle VDI と Microsoft Hyper-V プロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ホスト名

文字列

状態

Enabled | Disabled | Unresponsive | Maintenance | Preparing Maintenance | Failed Maintenance

有効になります

Enabled | Disabled

CPU 使用状況

xx% (x.x GHz|MHz)

メモリー使用量

xx% (x.x GB|MB)

デスクトップの数

整数

Microsoft リモートデスクトッププロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ホスト名

文字列

状態

OK | Unresponsive

CPU 使用状況

xx% (x.x GHz|MHz)

メモリー使用量

xx% (x.x GB|MB)

アクティブなセッションの数

整数

切断されているセッションの数

整数

A.3.20. provider-list-storage

デスクトッププロバイダのすべてのストレージサーバーを一覧表示します。

Oracle VDI と Microsoft Hyper-V プロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ストレージ名

文字列

状態

Enabled | Disabled | Unresponsive | Maintenance | Preparing Maintenance | Failed Maintenance

ZFS プール

文字列

容量

xxx.x GB

使用率

xx.x GB

デスクトップの数

整数

VMware vCenter プロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ストレージ名

文字列

ストレージ ID

文字列

ZFS プール

文字列

容量

xxx.x GB

使用率

xx.x GB

デスクトップの数

整数

A.3.21. provider-list-templates

デスクトッププロバイダのテンプレートを一覧表示します。

Oracle VDI と Microsoft Hyper-V プロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

テンプレート名

文字列

テンプレート ID

ロング

ユーザーディレクトリ名

文字列

VMware vCenter プロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

テンプレート名

文字列

テンプレート ID

文字列

パス

文字列

A.3.22. provider-list-unmanaged

どのデスクトッププロバイダにも管理されていない仮想化プラットフォームのデスクトップを一覧表示します。

Oracle VDI と Microsoft Hyper-V プロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ホスト名

文字列

デスクトップ名

文字列

デスクトップ ID

ロング

VMware vCenter プロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

デスクトップ名

文字列

デスクトップ ID

文字列

パス

文字列

A.3.23. provider-list-networks

デスクトッププロバイダのすべてのネットワークを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

サブネットラベル

文字列

サブネットアドレス

文字列

使用条件

All Hosts | Not on: comma_separated_list_of_hosts

A.3.24. provider-show

デスクトッププロバイダに関する詳細情報を表示します。

Oracle VDI と Microsoft Hyper-V プロバイダの解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

状態

OK | Major Issues | Critical

プール名

コンマ区切り文字列

デスクトップの総数

整数

使用中のデスクトップの数

整数

すべてのホストの CPU 使用状況

xx%

すべてのホストの総メモリー

xx.xx GB|MB

すべてのホストのメモリー使用状況

xx%

ストレージサーバーの数

整数

ストレージサーバーの全容量

xxx.x GB

ストレージサーバーの使用状況

xx%

ネットワークの数

整数

ネットワーク利用度

All Hosts | Not on some hosts

コメント

文字列

VMware vCenter プロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

状態

OK | Unresponsive

プール名

コンマ区切り文字列

デスクトップの総数

整数

使用中のデスクトップの数

整数

サーバー

文字列

データセンター

コンマ区切り文字列

ストレージサーバーの数

整数

ストレージサーバーの全容量

xxx.x GB

ストレージサーバーの使用状況

xx%

コメント

文字列

コロン (「:」) で区切られた次の値を含む行のリストが後続します。

データ形式

クラスタ名

文字列

使用中のクラスタ CPU

xx%(xx.xx MHz|GHz)

クラスタの総メモリー

xx.xx GB|MB

クラスタの使用メモリー

xx%(xx.xx MB|GB)

ファームリモートデスクトッププロバイダ以外に関する解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

状態

OK | Major Issues | Critical

プール名

コンマ区切り文字列

アクティブなセッションの数

整数

切断されているセッションの数

整数

ホストファーム

false

すべてのホストの CPU 使用状況

xx%

すべてのホストの総メモリー

xx.xx GB|MB

すべてのホストのメモリー使用状況

xx%

コメント

文字列

ファームリモートデスクトッププロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

状態

-

プール名

コンマ区切り文字列

ホストファーム

true

コメント

文字列

汎用プロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

プール名

コンマ区切り文字列

デスクトップの総数

整数

使用中のデスクトップの数

整数

コメント

文字列

キオスクプロバイダに関する解析可能な出力: コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

プール名

コンマ区切り文字列

セッションタイプ

Sun Java Desktop System 3 | Common Desktop Environment (Obsolete) | Sun Ray Connector for Windows OS | VMware View Manager Session | Xterm Terminal Session

コメント

文字列

A.3.25. provider-storage-orphans

ストレージの孤立ディスクを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ZFS ボリューム

zfs_pool/volume_id/

サイズ

xxx.x GB

使用サイズ

xxx.x GB

複製されたディスク

ロング

A.3.26. directory-list

すべてのユーザーディレクトリを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

名前

文字列

状態

OK | Unresponsive

AD ドメインまたはベース DN

文字列

A.3.27. admin-list

管理者のロールを持つすべての管理者を一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ユーザー名

文字列

ロール

コンマ区切り文字列

A.3.28. admin-show

管理者の詳細を表示します。

解析可能な出力:コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

ユーザーの説明

文字列

コロン (「:」) で区切られた次の値を含む行のリストが後続します。

データ形式

ロール名

文字列

ロールの説明

文字列

A.3.29. role-list

すべてのロールを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ロール名

文字列

ロールの説明

文字列

A.3.30. job-list

既存のジョブを一覧表示します。

解析可能な出力: コロン (「:」) で区切られた次の値を含む行のリスト。

データ形式

ジョブタイトル

ジョブのタイトル。例: Cloning Desktop desktop_name | Recycling Desktop desktop_name | Starting Desktop desktop_name | Powering Off Desktop desktop_name | Shutting Down Desktop desktop_name | Restarting Desktop desktop_name | Deleting Pool pool_name

ジョブのターゲット

文字列

ジョブのステータス

Queued | Running | Completed | Failed | Cancelling | Cancelled | Unknown

ジョブの ID

整数

取り消し可能

ジョブが取り消し可能である場合は「C」

A.3.31. job-show

ジョブの詳細を表示します。

解析可能な出力:コロン (「:」) で区切られた次の値を含む 1 つの行。

データ形式

ジョブタイトル

ジョブのタイトル。例: Cloning Desktop desktop_name | Recycling Desktop desktop_name | Starting Desktop desktop_name | Powering Off Desktop desktop_name | Shutting Down Desktop desktop_name | Restarting Desktop desktop_name | Deleting Pool pool_name

ジョブのターゲット

文字列

ジョブのステータス

Queued | Running | Completed | Failed | Cancelling | Cancelled | Unknown

開始時刻

hh:mm:ss

終了時刻

hh:mm:ss

ジョブの詳細

文字列

取り消し可能

true | false