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 子命令都支持 parsable 选项,以便将输出格式化,从而便于解析为以冒号 (":") 分隔的字段的行列表。

该选项的语法为:

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

以下部分说明支持 parsable 选项的子命令的输出格式。

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:系统准备修订版。

  • template-create将修订版复制到新模板。

  • template-desktop:将模板复制到新桌面。

  • template-export导出模板。

  • template-revert将模板恢复到最新修订版。

  • provider-migrate-host:从主机迁移桌面。

  • provider-replace-storage:替换存储。

  • provider-suspend-storage:暂停存储。

可解析输出:包含以下值的一行内容。

数据格式

作业 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 池的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

分配状态

Enabled | Disabled

桌面分配类型

Personal | Flexible

桌面提供者名称

字符串

克隆状态

Enabled | Disabled

克隆作业数

整型

模板

None | 字符串

可用桌面数

整型

已分配桌面数

整型

桌面总数

整型

来宾池

Enabled | Disabled

PC 池的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

分配状态

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 Remote Desktop 桌面提供者的所有主机。

Oracle VDI 和 Microsoft Hyper-V 提供者的可解析输出:包含以冒号 (":") 分隔的以下值的行列表。

数据格式

主机名

字符串

状态

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

Enabled(已启用)

Enabled | Disabled

CPU 使用情况

xx% (x.x GHz|MHz)

内存使用情况

xx% (x.x GB|MB)

桌面数

整型

Microsoft Remote Desktop 提供者的可解析输出:包含以冒号 (":") 分隔的以下值的行列表。

数据格式

主机名

字符串

状态

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 提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

状态

OK | Major Issues | Critical

池名称

逗号分隔的字符串

桌面总数

整型

已用桌面数

整型

所有主机的 CPU 使用情况

xx%

所有主机的总内存

xx.xx GB|MB

所有主机的内存使用情况

xx%

存储服务器数

整型

存储服务器的总容量

xxx.x GB

存储服务器的使用情况

xx%

网络数

整型

网络可用性

All Hosts | Not on some hosts

注释

字符串

VMware vCenter 提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

状态

OK | Unresponsive

池名称

逗号分隔的字符串

桌面总数

整型

已用桌面数

整型

服务器

字符串

数据中心

逗号分隔的字符串

存储服务器数

整型

存储服务器的总容量

xxx.x GB

存储服务器的使用情况

xx%

注释

字符串

后跟包含以冒号 (":") 分隔的以下值的行列表。

数据格式

群集名称

字符串

使用的群集 CPU

xx%(xx.xx MHz|GHz)

群集总内存

xx.xx GB|MB

群集使用的内存

xx%(xx.xx MB|GB)

非群远程桌面提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

状态

OK | Major Issues | Critical

池名称

逗号分隔的字符串

活动会话数

整型

断开连接会话数

整型

主机群

false

所有主机的 CPU 使用情况

xx%

所有主机的总内存

xx.xx GB|MB

所有主机的内存使用情况

xx%

注释

字符串

群远程桌面提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

状态

-

池名称

逗号分隔的字符串

主机群

true

注释

字符串

通用提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

池名称

逗号分隔的字符串

桌面总数

整型

已用桌面数

整型

注释

字符串

Kiosk 提供者的可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

池名称

逗号分隔的字符串

会话类型

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

列出所有管理员及其角色。

可解析输出:包含以冒号 (":") 分隔的以下值的行列表。

数据格式

用户名

字符串

角色

comma-separated string

A.3.28. admin-show

显示管理员的详细信息。

可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

用户说明

字符串

后跟包含以冒号 (":") 分隔的以下值的行列表。

数据格式

角色名称

字符串

角色说明

字符串

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

显示作业详细信息。

可解析输出:包含以冒号 (":") 分隔的以下值的一行内容。

数据格式

作业标题

作业标题,例如 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