A.3. Parsing the Output of the CLI

A.3.1. Subcommands That Result in a Single Job
A.3.2. Subcommands That Result in a Multiple Jobs
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-desktops
A.3.14. pool-templates
A.3.15. desktop-search
A.3.16. template-revisions
A.3.17. provider-list
A.3.18. provider-list-hosts
A.3.19. provider-list-storage
A.3.20. provider-list-templates
A.3.21. provider-list-unmanaged
A.3.22. provider-list-networks
A.3.23. provider-show
A.3.24. provider-storage-orphans
A.3.25. directory-list
A.3.26. admin-list
A.3.27. admin-show
A.3.28. role-list
A.3.29. job-list
A.3.30. job-show

A number of the vda subcommands support a parsable option so that the output is formatted for easy parsing as a list of lines of colon-separated (':') fields.

The syntax of the option is:

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

The following sections describe the format of output for the subcommands that support the parsable option.

A.3.1. Subcommands That Result in a Single Job

The following vda subcommands result in a single job:

  • pool-hv-import: Import Microsoft Hyper-V desktops into the pool.

  • pool-vb-import: Import Oracle VM VirtualBox desktops into the pool.

  • pool-vb-import-unmanaged: Import unmanaged Oracle VM VirtualBox desktops into the pool.

  • desktop-export: Export a desktop.

  • revision-create: Create a revision

  • revision-export: Export a revision.

  • revision-sysprep: Sysprep a revision.

  • template-create: Copy a revision to a new template.

  • template-desktop: Copy the template to a new desktop.

  • template-export: Export a template.

  • template-revert: Revert a template to the most recent revision.

  • provider-migrate-host: Migrate desktops from a host.

  • provider-replace-storage: Replace a storage.

  • provider-suspend-storage: Suspend a storage.

Parsable Output: one line with the following value.

Value

Data Format

Job ID

integer

A.3.2. Subcommands That Result in a Multiple Jobs

The following vda subcommands result in multiple jobs:

  • pool-delete: Delete pools and their desktops.

  • pool-reset: Reset cloning for the pool.

  • desktop-delete: Delete desktops.

  • desktop-duplicate: Duplicate desktops.

  • desktop-restart: Restart desktops.

  • desktop-start: Start desktops.

  • desktop-stop: Stop desktops.

  • desktop-suspend: Suspend desktops.

  • desktop-template: Convert the desktops to templates.

  • revision-clone: Clone desktops from revisions.

  • revision-delete: Delete revisions.

  • revision-desktop: Copy revisions to desktops.

  • template-delete: Delete templates.

  • template-restart: Restart templates.

  • template-start: Start templates.

  • template-stop: Stop templates.

  • template-suspend: Suspend templates.

  • provider-storage-orphan-delete: Delete orphan disks.

Parsable Output: list of lines with the following values.

Value

Data Format

Job ID

integer

A.3.3. user-search

Search for users or groups in the user directory that match the specified search criteria.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Name of the user or group

string

Kind of object

User | Group

DN of the user or group

string

A.3.4. user-show

Show the desktops available for the user.

Parsable Output for a User: list of lines with the following values separated by a colon (':').

Value

Data Format

Pool Name

string

Desktop Name

string

Desktop ID

integer

Kind of Assignment

User | Token token | Group group_name | Custom Group group_name

Parsable Output for a Group: list of lines with the following values separated by a colon (':').

Value

Data Format

Pool Name

string

A.3.5. user-desktops

Show the desktops assigned to the user.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop Name

string

Desktop ID

integer

Pool Name

string

Type of Assignment

flexible | personal

Is Default Desktop

true | false

A.3.6. group-list

Lists all custom groups.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Custom Group Name

string

A.3.7. group-show

Show the pools assigned to the custom group.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Pool Name

string

A.3.8. token-search

Search for tokens that match the search criteria.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Token

string

Name of the Associated User

string

DN of the Associated User

string

A.3.9. token-show

Show the desktops available for the token.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Pool Name

string

Desktop Name

string

Desktop ID

integer

Kind of Assignment

User | Token | Group group_name | Custom Group group_name

A.3.10. token-desktops

Show the desktops assigned to the token.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop Name

string

Desktop ID

integer

Pool Name

string

Type of Assignment

flexible | personal

Is Default Desktop

true | false

A.3.11. pool-list

List all pools.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Pool Name

string

Type of Desktop Assignment

Personal | Flexible

Number of Desktops

integer

Desktop Provider Name

string

User Directory Name

string

A.3.12. pool-show

Show detailed information about the pool.

Parsable Output for non-PC Pools: one line with the following values separated by a colon (':').

Value

Data Format

Assignment Status

Enabled | Disabled

Type of Desktop Assignment

Personal | Flexible

Desktop Provider Name

string

Cloning Status

Enabled | Disabled

Number of Cloning Jobs

integer

Template

None | string

Number of Available Desktops

integer

Number of Assigned Desktops

integer

Total Number of Desktops

integer

Guest Pool

Enabled | Disabled

Parsable Output for PC Pools: one line with the following values separated by a colon (':').

Value

Data Format

Assignment Status

Enabled | Disabled

Type of Desktop Assignment

Personal | Flexible

Desktop Provider Name

string

Number of Available Desktops

integer

Number of Assigned Desktops

integer

Total Number of Desktops

integer

Guest Pool

Enabled | Disabled

A.3.13. pool-desktops

List all desktops from the pool.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop Name

string

Desktop ID

long

Machine State

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

Desktop State

Available | Used | Idle | Unresponsive | Reserved

DN of Assigned User

string

A.3.14. pool-templates

List all templates from the pool.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Template Name

string

Template ID

long

Machine State

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

Master Revision

string

Cloned Desktops

string

A.3.15. desktop-search

Search for a desktop or desktops.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop ID

long

Pool Name

string

Desktop Name

string

Machine State

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

Desktop State

Available | Used | Idle | Unresponsive | Reserved

DN of Assigned User

string

A.3.16. template-revisions

List the revisions of the template.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Revision Name

string

Revision ID

long

Creation Date

timestamp

Is It Master

yes | no

Cloned Desktops

string

A.3.17. provider-list

List all desktop providers.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop Provider Name

string

Provider Type

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

Status

OK | Unresponsive | Major Issues | Critical

A.3.18. provider-list-hosts

List all hosts for the Oracle VDI, Microsoft Hyper-V, or Microsoft Remote Desktop desktop providers.

Parsable Output for Oracle VDI and Microsoft Hyper-V Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Host Name

string

Status

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

Enabled

Enabled | Disabled

CPU Usage

xx% (x.x GHz|MHz)

Memory Usage

xx% (x.x GB|MB)

Number of Desktops

integer

Parsable Output for Microsoft Remote Desktop Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Host Name

string

Status

OK | Unresponsive

CPU Usage

xx% (x.x GHz|MHz)

Memory Usage

xx% (x.x GB|MB)

Number of Active Sessions

integer

Number of Disconnected Sessions

integer

A.3.19. provider-list-storage

List all storage servers for the desktop provider.

Parsable Output for Oracle VDI and Microsoft Hyper-V Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Storage Name

string

Status

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

ZFS Pool

string

Capacity

xxx.x GB

Usage

xx.x GB

Number of Desktops

integer

Parsable Output for VMware vCenter Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Storage Name

string

Storage ID

string

ZFS Pool

string

Capacity

xxx.x GB

Usage

xx.x GB

Number of Desktops

integer

A.3.20. provider-list-templates

List the templates for the desktop provider.

Parsable Output for Oracle VDI and Microsoft Hyper-V Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Template Name

string

Template ID

long

User Directory Name

string

Parsable Output for VMware vCenter Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Template Name

string

Template ID

string

Path

string

A.3.21. provider-list-unmanaged

List the desktops from the virtualization platform that are not managed by any desktop provider.

Parsable Output for Oracle VDI and Microsoft Hyper-V Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Host Name

string

Desktop Name

string

Desktop ID

long

Parsable Output for VMware vCenter Providers: list of lines with the following values separated by a colon (':').

Value

Data Format

Desktop Name

string

Desktop ID

string

Path

string

A.3.22. provider-list-networks

List all networks for the desktop provider.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Subnet Label

String

Subnet Address

String

Availability

All Hosts | Not on: comma_separated_list_of_hosts

A.3.23. provider-show

Show detailed information about the desktop provider.

Parsable Output for Oracle VDI and Microsoft Hyper-V Providers: one line with the following values separated by a colon (':').

Value

Data Format

Status

OK | Major Issues | Critical

Pool Names

comma-separated strings

Total Number of Desktops

integer

Number of Used Desktops

integer

CPU Usage of all Hosts

xx%

Total Memory of all Hosts

xx.xx GB|MB

Memory Usage of all Hosts

xx%

Number of Storage Servers

integer

Total Capacity of the Storage Servers

xxx.x GB

Usage of the Storage Servers

xx%

Number of Networks

integer

Network Availability

All Hosts | Not on some hosts

Comment

string

Parsable Output for VMware vCenter Providers: one line with the following values separated by a colon (':').

Value

Data Format

Status

OK | Unresponsive

Pool Names

comma-separated strings

Total Number of Desktops

integer

Number of Used Desktops

integer

Server

string

Datacenters

comma-separated strings

Number of Storage Servers

integer

Total Capacity of the Storage Servers

xxx.x GB

Usage of the Storage Servers

xx%

Comment

string

Followed by a list of lines with the following values separated by a colon (':').

Value

Data Format

Cluster Name

string

Cluster CPU Used

xx%(xx.xx MHz|GHz)

Cluster Total Memory

xx.xx GB|MB

Cluster Used Memory

xx%(xx.xx MB|GB)

Parsable Output for Non-Farm Remote Desktop Providers: one line with the following values separated by a colon (':').

Value

Data Format

Status

OK | Major Issues | Critical

Pool Names

comma-separated strings

Number of Active Sessions

integer

Number of Disconnected Sessions

integer

Host Farm

false

CPU Usage of all Hosts

xx%

Total Memory of all Hosts

xx.xx GB|MB

Memory Usage of all Hosts

xx%

Comment

string

Parsable Output for Farm Remote Desktop Providers: one line with the following values separated by a colon (':').

Value

Data Format

Status

-

Pool Names

comma-separated strings

Host Farm

true

Comment

string

Parsable Output for Generic Providers: one line with the following values separated by a colon (':').

Value

Data Format

Pool Names

comma-separated strings

Total Number of Desktops

integer

Number of Used Desktops

integer

Comment

string

Parsable Output for Kiosk Providers: one line with the following values separated by a colon (':').

Value

Data Format

Pool Names

comma-separated strings

Session Type

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

Comment

string

A.3.24. provider-storage-orphans

List the orphaned disks of the storage.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

ZFS Volume

zfs_pool/volume_id/

Size

xxx.x GB

Used Size

xxx.x GB

Cloned Disks

long

A.3.25. directory-list

List all user directories.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Name

string

Status

OK | Unresponsive

AD Domain or Base DN

string

A.3.26. admin-list

List all administrators with their roles.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Username

string

Roles

comma-separated string

A.3.27. admin-show

Show details for the administrator.

Parsable Output: one line with the following values separated by a colon (':').

Value

Data Format

User Description

string

Followed by a list of lines with the following values separated by a colon (':').

Value

Data Format

Role Name

string

Role Description

string

A.3.28. role-list

List all roles.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Role Name

string

Role Description

string

A.3.29. job-list

List the existing jobs.

Parsable Output: list of lines with the following values separated by a colon (':').

Value

Data Format

Job Title

The title of the job, for example, 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.

Target of the Job

string

Status of the Job

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

ID of the Job

integer

Cancellable

'C' if the job can be canceled

A.3.30. job-show

Show the job details.

Parsable Output: one line with the following values separated by a colon (':').

Value

Data Format

Job Title

The title of the job, for example, 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

Target of the Job

string

Status of the Job

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

Start Time

hh:mm:ss

End Time

hh:mm:ss

Job Details

string

Cancellable

true | false