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.
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 |
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 |
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 |
|
DN of the user or group | string |
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 |
|
Parsable Output for a Group: list of lines with the following values separated by a colon (':').
Value | Data Format |
---|---|
Pool Name | string |
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 |
|
Is Default Desktop |
|
Lists all custom groups.
Parsable Output: list of lines with the following values separated by a colon (':').
Value | Data Format |
---|---|
Custom Group Name | string |
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 |
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 |
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 |
|
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 |
|
Is Default Desktop |
|
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 |
|
Number of Desktops | integer |
Desktop Provider Name | string |
User Directory Name | string |
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 |
|
Type of Desktop Assignment |
|
Desktop Provider Name | string |
Cloning Status |
|
Number of Cloning Jobs | integer |
Template |
|
Number of Available Desktops | integer |
Number of Assigned Desktops | integer |
Total Number of Desktops | integer |
Guest Pool |
|
Parsable Output for PC Pools: one line with the following values separated by a colon (':').
Value | Data Format |
---|---|
Assignment Status |
|
Type of Desktop Assignment |
|
Desktop Provider Name | string |
Number of Available Desktops | integer |
Number of Assigned Desktops | integer |
Total Number of Desktops | integer |
Guest Pool |
|
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 |
|
DN of the User or Group | string |
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 |
|
Desktop State |
|
DN of Assigned User | string |
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 |
|
Master Revision | string |
Cloned Desktops | string |
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 |
|
Desktop State |
|
DN of Assigned User | string |
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 |
|
Cloned Desktops | string |
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 |
|
Status |
|
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 |
|
CPU Usage |
|
Memory Usage |
|
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 |
|
Memory Usage |
|
Number of Active Sessions | integer |
Number of Disconnected Sessions | integer |
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 |
|
ZFS Pool | string |
Capacity |
|
Usage |
|
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 |
|
Usage |
|
Number of Desktops | integer |
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 |
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 |
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 |
|
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 |
|
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 |
|
Comment | string |
Parsable Output for VMware vCenter Providers: one line with the following values separated by a colon (':').
Value | Data Format |
---|---|
Status |
|
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 |
|
Pool Names | comma-separated strings |
Number of Active Sessions | integer |
Number of Disconnected Sessions | integer |
Host Farm |
|
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 |
|
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 |
|
Comment | string |
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 |
|
Size |
|
Used Size |
|
Cloned Disks | long |
List all user directories.
Parsable Output: list of lines with the following values separated by a colon (':').
Value | Data Format |
---|---|
Name | string |
Status |
|
AD Domain or Base DN | string |
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 |
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 |
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 |
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, |
Target of the Job | string |
Status of the Job |
|
ID of the Job | integer |
Cancellable | 'C' if the job can be canceled |
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, |
Target of the Job | string |
Status of the Job |
|
Start Time | hh:mm:ss |
End Time | hh:mm:ss |
Job Details | string |
Cancellable |
|