A.2. Parsing vda Command Output

A.2. Parsing vda Command Output
Prev	Appendix A. Automated Administration Scripts	Next

In addition to the commands that result in jobs, the following vda commands have parsable output:

vda 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

vda 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

vda 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

vda 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

vda 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

vda 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

vda 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

vda 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`

vda 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	`Used` \| `Idle` \| `Unresponsive` \| `Reserved` \| `Available`
DN of Assigned User	string

vda 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

vda 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`

vda 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

vda pool-users

List all users of the pool.

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` \| `Token` \| `Custom Group`
DN of the User or Group	string

vda 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`

vda provider-list-hosts

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

Parsable Output for Oracle VM VirtualBox 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

vda 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`

vda provider-list-storage

List all storage servers for the desktop provider.

Parsable Output for Oracle VM VirtualBox 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

vda provider-list-templates

List the templates for the desktop provider.

Parsable Output for Oracle VM VirtualBox 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

vda provider-list-unmanaged

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

Parsable Output for Oracle VM VirtualBox 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

vda provider-show

Show detailed information about the desktop provider.

Parsable Output for Oracle VM VirtualBox 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

vda 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

vda 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

vda 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

vda 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`

vda 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

vda 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`

vda 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`

vda 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

vda 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

Prev	Up	Next
A.1. Parsing vda Commands that Result in Jobs	Home	A.3. Parsing vda-center Command Output