|
Name
|
Type
|
Description
|
| userName | xsd:string |
User for this session.
- This property need not be set.
|
| machineOrRDSServerName | xsd:string |
Machine or RDSServer name for this session.
- This property need not be set.
|
| machineOrRDSServerDNS | xsd:string |
Machine or RDSServer DNS name for this session.
- This property need not be set.
|
| agentVersion | xsd:string |
The agent version.
Since Horizon 7.3
- This property need not be set.
- This property cannot be updated.
|
| desktopPoolCN | xsd:string |
Desktop Pool cn if this is a Desktop session, unset otherwise.
Note: This will not be set for RDS desktop session when using
GlobalSessionQueryService.
Since Horizon 7.5
- This property need not be set.
- This property cannot be updated.
|
| desktopName | xsd:string |
Desktop display name if this is a Desktop session, unset
otherwise.
Note: When using GlobalSessionQueryService, for RDS pool this
is set as the farmName.
- This property need not be set.
|
| desktopType | xsd:string |
Desktop type if this is a Desktop session, unset otherwise.
- This property need not be set.
-
This property will be one of:
|
Value
|
Description
|
| "AUTOMATED" | An automated desktop creates virtual machines cloned from a base
template or snapshot. |
| "MANUAL" | A manual machine desktop allows selection of existing virtual machines
and addition to the desktop of available machines to connect to. |
| "RDS" | An RDS Desktop Desktop. |
|
| desktopSource | xsd:string |
Desktop machine source if this is a Desktop session, unset otherwise.
- This property need not be set.
-
This property will be one of:
|
Value
|
Description
|
| "VIRTUAL_CENTER" | Virtual center virtual machines managed as view machines. This option
is valid for Automated and Manual Desktop. In case of Automated
Desktop, these refer to Full Virtual Machines that are created from a
vCenter Server template. |
| "VIEW_COMPOSER" | View composer linked clones managed as view machines. They share the
same base image and use less storage space than full virtual machines.
The user profile for linked clones can be redirected to persistent
disks that will be unaffected by OS updates and refreshes. This option
is only valid for Automated Desktop. |
| "INSTANT_CLONE_ENGINE" | Instant clone engine created 'instant clones' managed as view machines.
Instant clone engine uses vmfork technology to create the instant
clones, these clones take very less time for provisioning. Instant
clones have many similarities to linked clones like :-
- Both instant and linked clones share the same base image and use
less storage space than full virtual machines.
- The user profile for both types clones can be redirected to
persistent disks that will be unaffected by OS updates and refreshes.
This option is only valid for Automated Desktop. |
| "UNMANAGED" | Non-vCenter Server virtual machines managed as view machines. These can
include physical computers, non-vCenter Server virtual machines, and
blade PCs. This option is only valid for Manual Desktops. |
| "RDS" | This option is only valid for RDS Desktops. |
|
| farmName | xsd:string |
Farm display name for this RDS Desktop or Application session, unset
otherwise.
- This property need not be set.
|
| clientLocationID | xsd:string |
Client Location for this session.
- This property need not be set.
|
| clientType | xsd:string |
Client type for this session.
Since Horizon 7.7
- This property need not be set.
- This property cannot be updated.
-
This property will be one of:
|
Value
|
Description
|
| "Windows" | WINDOWS: client type is Windows client |
| "Mac" | MAC: client type is Mac client |
| "htmlaccess" | HTMLACCESS: client type is web client |
| "Linux" | LINUX: Client type is Linux client |
| "iOS" | IOS: Client type is iOS client |
| "Android" | ANDROID: Client type is Android client |
| "Other" | OTHER: Client type is other |
|
| clientAddress | xsd:string |
IP address of the client machine for this session.
Since Horizon 7.2
- This property need not be set.
|
| clientName | xsd:string |
Client machine name for this session.
Since Horizon 7.2
- This property need not be set.
|
| clientVersion | xsd:string |
Client version for this session.
Since Horizon 7.3
- This property need not be set.
|
| securityGatewayDNS | xsd:string |
Computer machine name or DNS name of the security gateway.
- This property need not be set.
|
| securityGatewayAddress | xsd:string |
IP address of the security gateway.
Since Horizon 7.3
- This property need not be set.
|
| securityGatewayLocation | xsd:string |
Location of the security gateway.
Since Horizon 7.7
- This property need not be set.
- This property cannot be updated.
-
This property will be one of:
|
Value
|
Description
|
| "External" | EXTERNAL: Gateway location is external |
| "Internal" | INTERNAL: Gateway location is internal |
| "Unknown" | UNKNOWN: Gateway location is unknown |
|
| applicationNames | xsd:string[] |
Names of the Applications launched in this session. This will be only
set when sessionType is set to APPLICATION.
Since Horizon 7.11
- This property need not be set.
- This property cannot be updated.
|