horizon daas platform 7.0 rest api - vmwareunderstanding the api 2 2 understanding the api the...

Horizon® DaaS® Platform 7.0 REST API

This document provides an overview of the Horizon DaaS Platform REST API.

February 2017

ii

Revision History

Date Version Description

2/23/2017 1.0 Initial release

© 2017 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

VMware, Inc.

3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com

iii

Contents

1 About This Document 1

1.1 Intended Audience 1 1.2 Organization of this Document 1 1.3 Questions 1

2 Understanding the API 2

2.1 Resources 2 2.2 Scope 2 2.3 Properties and Links 2 2.4 Link Attributes 3 2.5 HTTP Requests 3

3 Getting Started 5

3.1 Retrieve the Available DaaS Versions 5 3.2 Login and Save the HTTP Response Header Authorization 6 3.3 Get the DtSecurityManager 6 3.4 Retrieve All Users for a Domain 7 3.5 Get the DtInfrastructureManager 8 3.6 Retrieve the Mapped Pools or Pattern for a Specific User 8 3.7 Example Error 10

4 Resources 11

4.1 DtVersion 11 4.2 DtCredentials 12 4.3 DtHttpHeaders 12 4.4 DtInfrastructureManager 13

4.4.1 DtDataCenter 16 4.4.2 DtDesktopManagerCapacity 17 4.4.3 DtDesktopManagerNetwork 18 4.4.4 DtDesktopModel 18

4.4.4.1 DtLicenseEntitlement 19 4.4.5 DtHAPairReservationCreator 20 4.4.6 DtHypervisorManager 20

4.4.6.1 DtDatastore 21 4.4.7 DtComputePool 22

4.4.7.1 DtComputePoolProperty 23 4.4.8 DtNetwork 23 4.4.9 DtSessionQuota 24 4.4.10 DtStorageConfig 25 4.4.11 DtStorageSystem 25 4.4.12 DtTenantDesktopManager 26

4.5 DtInstallManager 26 4.5.1 DtAppliance 27

4.6 DtMaintenanceManager 28 4.6.1 DtInitSlonyParams 28 4.6.2 DtSlonyNode 29 4.6.3 DtUpgradeInfo 29 4.6.4 DtUpgradeRequest 29

4.7 DtMappingManager 30 4.8 DtNotificationManager 30

4.8.1 DtMaintenanceNotice 31 4.8.2 DtNotification 31 4.8.3 DtNotificationFilter 31

iv

4.8.4 DtVirtualMachineNotification 32 4.9 DtOrchestrationEngine 32 4.10 DtOrchestrationModel 32 4.11 DtOrchestrationParam 33 4.12 DtPoolManager 33

4.12.1 DtAgentUpdateStatus 37 4.12.2 DtAgentVmFabricStatus 37 4.12.3 DtApplication 38 4.12.4 DtApplicationIcon 38 4.12.5 DtApplicationSessionPool 39 4.12.6 DtApplicationWrapper 41 4.12.7 DtBackupInfo 41 4.12.8 DtDesktopMigrationParams 41 4.12.9 DtDesktopPool 42

4.12.9.1 DtPoolPolicy 44 4.12.10 DtDiscoveredAgent 45 4.12.11 DtDynamicDesktopPattern 46 4.12.12 DtGoldPattern 47 4.12.13 DtGuestOsTypes 49 4.12.14 DtMapping 50 4.12.15 DtPatternFilter 50 4.12.1 DtPool 50 4.12.2 DtPoolTask 52

4.12.2.1 DtPoolTaskHistory 52 4.12.3 DtPoolAgentUpdate 53 4.12.4 DtPoolAgentUpdateFilter 53 4.12.5 DtRemoteApplication 54 4.12.6 DtSessionPool 54 4.12.7 DtStaticDesktopPattern 56 4.12.8 DtUserDefinedApp 57 4.12.9 DtUserDefinedAppRequest 57 4.12.10 DtVirtualMachine 58 4.12.11 DtVirtualMachineFilter 59

4.13 DtQuotaManager 59 4.13.1 DtDesktopModelQuota 60 4.13.2 DtQuotaFilter 61 4.13.3 DtRemoteProtocolQuota 61 4.13.4 DtTemplateQuota 61

4.14 DtRSASecurIDAuthenticator 62 4.15 DtRSASecurIDNextToken 62 4.16 DtRSASecurIDPasscode 63 4.17 DtRSASecurIDPinChange 63 4.18 DtRADIUSAuthenticator 64 4.19 DtRADIUSChallenge 64 4.20 DtRADIUSPasscode 65 4.21 DtRADIUSServerConfiguration 65 4.22 DtReportingManager 66

4.22.1 DtBillingReportFilter 67 4.22.2 DtConcurrentUsersFilter 67 4.22.3 DtConcurrentUsersReport 67 4.22.4 DtQuotaBillingReport 68 4.22.5 DtReportFilter 69 4.22.6 DtReportingStatusInfo 69 4.22.7 DtSuperTenantBillingReport 69 4.22.8 DtTenantReport 70 4.22.9 DtTenantReportKey 70 4.22.10 DtUserActivity 71 4.22.11 DtUserEventReport 71 4.22.12 DtUserEventReportFilter 72

v

4.23 DtReservationStatusManager 72 4.23.1 DtReservation 73 4.23.2 DtReservationFilter 73 4.23.3 DtReservationTask 74

4.24 DtSecurityManager 75 4.24.1 DtCertificate 77 4.24.2 DtDomain 77

4.24.2.1 DtDomainAccount 79 4.24.2.2 DtGroup 79 4.24.2.3 DtRole 79 4.24.2.4 DtUser 80

4.24.3 DtDomainGroupInfo 81 4.24.4 DtIdentityProviderConfig 81 4.24.5 DtOrganization 82

4.24.5.1 DtContact 83 4.24.6 DtRoleAssignConfig 84 4.24.7 DtTwoFactorAuthenticator 84

4.25 DtSessionManager 85 4.25.1 DtActiveSession 85 4.25.2 DtSessionCountFilter 86 4.25.3 DtSessionFilter 86

4.26 DtSettingsManager 87 4.26.1 DtClientTimeoutConfig 88 4.26.2 DtFeatureSetting 88 4.26.3 DtTenantPortalConfig 89 4.26.4 DtTenantPortalTimeout 89

4.27 DtSystemManager 89 4.27.1 DtPlatform 90 4.27.2 DtSystemVersion 91 4.27.3 DtTermsOfService 91

4.28 DtTaskManager 92 4.28.1 DtTaskFilter 92

5 Enumerated Data Types 93

5.1 DtAgentInstallModeEnum 93 5.2 DtAgentUpdateStateEnum 93 5.3 DtApplianceType 93 5.4 DtAuthenticationStepType 94 5.5 DtColorDepth 94 5.6 DtComputePoolType 94 5.7 DtDaaSAgentState 94 5.8 DtDeploymentType 95 5.9 DtDisplayProtocol 95 5.10 DtDomainAccountType 95 5.11 DtEndpointPlatformType 95 5.12 DtError 96 5.13 DtGuestOS 109 5.14 DtNetworkType 110 5.15 DtNotificationType 110 5.16 DtPatternType 110 5.17 DtPoolSessionType 111 5.18 DtPoolSizeType 111 5.19 DtQuotaBillingType 111 5.20 DtRADIUSAuthenticationType 111 5.21 DtRDPClientType 112 5.22 DtReportingJobName 112 5.23 DtReportingStatus 112 5.24 DtRestoreTimeoutType 112

vi

5.25 DtSortingType 113 5.26 DtTaskStatus 113 5.27 DtTwoFactorAuthenticationType 113 5.28 DtUpgradeStatus 113 5.29 DtUserEvent 113 5.30 DtUserEventError 114 5.31 DtUserEventSortingCriteria 115 5.32 DtUserMappingSortingCriteria 115 5.33 DtVMLifeState 115 5.34 DtVmMappingSortingCriteria 116 5.35 DtVMPowerOperation 116 5.36 DtVMPowerState 116 5.37 DtVMwareToolsState 117

About This Document

1

1 About This Document

This document provides an overview of the Horizon DaaS Platform REST API.

1.1 Intended Audience

The audience for this document is those who want to programmatically use Horizon DaaS Platform APIs. This document assumes that you are familiar with:

● REST

● Software as a service

1.2 Organization of this Document

About This Document describes the content and intent of subsequent sections and introduces some terminology used in the remainder of the document.

Understanding the API introduces the architecture of the Horizon DaaS Platform API and the concepts you need to understand to use the API, such as the links through which you traverse the object model to retrieve resources.

Getting Started presents examples that explain the basics of using the API. The examples show you how to login, save the HTTP Response Header authorization for use in subsequent HTTP requests, and perform several actions by traversing the object model to obtain the URIs for those actions.

Resources lists the resources, their links, and their attributes.

Enumerated Data Types lists the enumerated types that are the legal values for certain resource attributes.

1.3 Questions

If you need assistance or have questions about any of the information in this document, contact VMware Customer Support.

Understanding the API

2

2 Understanding the API

The Horizon DaaS Platform API provides access to Horizon DaaS Platform features and functionality (resources) via REST-based web services. Exchanges between the caller and the platform take place using HTTP and HTTPS requests and the platform returns XML to the caller in the HTTP response.

2.1 Resources

Figure 1 shows the top-level entry points for the Horizon DaaS Platform REST API.

DtPlatform

DtSystemManagerDtSettingsManager

DtVersion

DtInstallManager DtReportingManagerDtNotificationManagerDtInfrastructureManager DtPoolManager

DtSessionManager

DtQuotaManager

DtTaskManagerDtSecurityManager

Figure 1: Top-Level Resource Tree

2.2 Scope

The Horizon DaaS Platform REST APIs have a common object model across its management appliances – service provider or tenant. However, there are some resources that are available only to service providers and others that are only available to the tenants. Among the resources that are common to both service provider and tenants, there is a scope associated with individual links in the resource instances that restricts the availability of some of the links to service providers or tenants. So the same resource will contain different links based on the context of its retrieval.

2.3 Properties and Links

Resources contain properties and links:

● Properties store values. For example, the DtUser resource has a loginName property that indicates the name used by a user to login.

● A link specifies a URI of a related resource or action. For example, the DtUser resource has a desktopPatterns link that retrieves the desktop patterns assigned to a user.


3

2.4 Link Attributes

A link has the following attributes:

● name – The unique name of the link. The name typically describes the purpose or target of the attribute.

● href – The URI relative to the server, webapp and version, for example /infrastructure/pool/1000

● method – The http method used with the href in the REST API invocation: GET, POST, PUT, or DELETE.

● rel – Describes the relationship between the link and the resource that contains the link. The rel attribute is for informational purposes and is not required when coding to the API. The table below defines the link relationships.

Table 2–1 Link Relationships

Relationship Description

ACTION Indicates that the URI performs an action with the resource

ASSOCIATION Indicates that the URI retrieves an associated resource

MAP Indicates that the URI retrieves a MAP between resources (one-one, one-many, many-many)

SELF Indicates that the URI is the URI of the container resource. A REST response always contains a link to itself. A GET on this URI returns the same URI

TOP Indicates that the URI is a top-level root resource

2.5 HTTP Requests

The HTTP request you use to retrieve a Horizon DaaS Platform resource is constructed as follows:

https://<host>/dt-rest/<version>/<URI>

● host is the IP address of the Enterprise Center or Service Center.

● version is the version of the REST API (See Section 3.1 on page 5 for information on retrieving available versions).

● URI is the path to the resource, constructed by traversing the object model and extracting path information from the href attribute of a link.

For example:

/infrastructure/manager/mapping/users/default?sep={sep}&users={users}&

Note the following features of URI syntax:

● The first component of the path is always the functional area of Horizon DaaS Platform: system, infrastructure, or security.

● The /manager component of the path is used only for top-level resources (infrastructure, system, and security) and links served by that resource.

● Curly braces are used to represent request parameter values which you must supply in the actual HTTP request. The href attribute uses the following syntax to represent request parameters:


4

?p1={p1}&p2={p2}

So for the preceding example, the actual values for the two request parameters (sep and users) might look as follows (where sep specifies the character you are using to delimit the user IDs in the request):

?sep=,&users=1234,5678&

● URL encoding is used to replace characters outside the ASCII set with a percent sign character (%) followed by two hexadecimal digits. For example, the question mark character (?) is replaced with %3F and the ampersand character (&) is replaced with %26.

Here is the complete HTTP request:

https://Host/dt-rest/v100/infrastructure/manager/mapping/users/default?sep=,&users=1234,5678&

Getting Started

5

3 Getting Started

This chapter gives you the basics you need to get started using the API, showing you how to:

● Retrieve the available DaaS versions via the published URL /system/platform

● Login and save the HTTP response headers.

● Get the Security Manager.

● Retrieve a domain and all users for that domain.

● Get the Infrastructure Manager.

● Retrieve the mapped pools or pattern for a specific user.

Before using the samples in this chapter to begin coding to the API, you will need the Tenant or Service Provider IP address.

3.1 Retrieve the Available DaaS Versions

To retrieve the available DaaS versions, submit the following HTTP request, where Host is the IP address of the Tenant or Service Provider appliance.

https://Host/dt-rest/system/platform

The response includes a single DtPlatform XML element which contains one DtVersion element for each available DaaS version. The latest version is the DtVersion element for which the attribute latest=”true”. For example:

<DtVersion latest="true" id="v100"> <DtLink href="/system" method="GET" name="DtSystemManager" rel="top"/> <DtLink href="/maintenance/manager" method="GET" name="DtMaintenanceManager" rel="top"/> <DtLink href="/install/manager" method="GET" name="DtInstallManager" rel="top"/> <DtLink href="/install/orchestrationengine" method="GET" name="DtOrchestrationEngine" rel="top"/> <DtLink href="/security/manager" method="GET" name="DtSecurityManager" rel="top"/> <DtLink href="/setting/manager" method="GET" name="DtSettingsManager" rel="top"/> <DtLink href="/infrastructure/manager" method="GET" name="DtInfrastructureManager" rel="top"/> <DtLink href="/session/manager" method="GET" name="DtSessionManager" rel="top"/> <DtLink href="/quota/manager" method="GET" name="DtQuotaManager" rel="top"/> <DtLink href="/mapping/manager" method="GET" name="DtMappingManager" rel="top"/> <DtLink href="/reservation/manager" method="GET" name="DtReservationStatusManager" rel="top"/> <DtLink href="/pool/manager" method="GET" name="DtPoolManager" rel="top"/> <DtLink href="/task/manager" method="GET" name="DtTaskManager" rel="top"/> <DtLink href="/reporting/manager" method="GET" name="DtReportingManager" rel="top"/> <DtLink href="/example/top" method="GET" name="DtTopLevelManagerImpl" rel="top"/> <DtLink href="/notification/manager" method="GET" name="DtNotificationManager" rel="top"/> <domainRegistrationURI>/v100/system/register/domain</domainRegistrationURI> <DtCredentials type="CREDENTIALS"> <DtLink href="/system/authenticate/credentials" method="POST" name="Submit" rel="action"/> </DtCredentials> </DtVersion>

The DtVersion element also defines the other top-level links you use to traverse the DaaS REST API, including DtSystemManager, DtInfrastructureManager, and DtSecurityManager.

Getting Started

6

3.2 Login and Save the HTTP Response Header Authorization

The API provides secure access via domain authentication or two-factor authentication if configured.

1. To form the URL for your login, copy and paste the href from the authentication step returned by DtVersion.

DtVersion returns an authentication step, which varies depending on what authentication is configured for the organization. For example, if only Active Directory authentication is configured, this will be DtCredentials, shown here with the href value bolded:

<DtCredentials type="CREDENTIALS"> <DtLink href="/system/authenticate/credentials" method="POST" name="Submit" rel="action"/> </DtCredentials>

2. To form the message to send for login, check the documentation for the appropriate resource and include required properties, as in the example below.

<DtCredentials type="CREDENTIALS"> <username>nnnnnnnnn</username> <password>xxxxxxxx</password> <domain>DEMO-TENANT</domain> </DtCredentials>

3. Send message as POST.

4. In the HTTP response header, note the following two values:

○ Authorization

○ x-dt-csrf-header

Note the following:

● You must include the Authorization key-value pair in the HTTP request header for every subsequent HTTP request you submit after login.

● If a request is a type other than GET, you must also include the x-dt-csrf-header key-value pair.

3.3 Get the DtSecurityManager

To retrieve the DtSecurityManager, use the path information specified by the DtSecurityManager link of the DtVersion element:

<DtLink href="/security/manager" method="GET" name="DtSecurityManager" rel="top">

The href attribute indicates the URI to append to the base URI. Using this information, you could construct the following HTTP request:

https://Host/dt-rest/v100/security/manager

The response contains the following XML:

<List type="DtLink"> <DtLink href="/security/manager" method="GET" name="DtSecurityManager" rel="self"></DtLink> <DtLink href="/security/manager/domains" method="GET" name="Domains" rel="association"> </DtLink> <DtLink href="/security/manager/organizations" method="GET" name="Organizations" rel="association"> </DtLink> </List>

This XML specifies three links you can traverse:

● The first link is a link to the DtSecurityManager itself.

Getting Started

7

● The second link indicates the URI to append to the base URL to retrieve all the domains.

● The third link indicates the URI to append to the base URL to retrieve all the organizations.

3.4 Retrieve All Users for a Domain

To retrieve all domains, use the path information specified by the Domains link of the DtSecurityManager element:

<DtLink href="/security/manager/domains" method="GET" name="Domains" rel="association"></DtLink>


https://Host/dt-rest/v100/security/manager/domains

The response contains one DtDomain element for each available domain, and each domain element contains four links:

● The first link is a link to the DtDomain itself.

● The second link indicates the URI to append to the save a domain.

● The third link indicates the URI to append to the base URL to retrieve all the groups in the domain.

● The fourth link indicates the URI to append to the base URL to retrieve all the users in the domain.

For example:

<DtLink href="/security/domain/DEV" method="GET" name="DtDomain" rel="self"></DtLink> <DtLink href="/security/domain/DEV/save" method="POST" name="Save" rel="action"></DtLink> <DtLink href="/security/domain/DEV/groups" method="GET" name="Groups" rel="association"></DtLink> <DtLink href="/security/domain/DEV/users" method="GET" name="Users" rel="association"></DtLink>

To retrieve all users for the DEV domain, use the path information specified by the Users link of the DtDomain element:

<DtLink href="/security/domain/DEV/users" method="GET" name="Users" rel="association"></DtLink>


https://Host/dt-rest/v100/security/domain/DEV/users

The response contains one XML DtUser element for each user. Each DtUser element specifies the links you can traverse to obtain properties for the User. The following XML fragment shows two of the returned links:

<DtLink href="/security/domain/DEV/user/563d81c8d85a6f46a6d7599ad7b6d1c5/pools" method="GET" name="DesktopPools" rel="association"></DtLink> <DtLink href="/security/domain/DEV/user/563d81c8d85a6f46a6d7599ad7b6d1c5/patterns" method="GET" name="DesktopPatterns" rel="association"></DtLink>

The user ID in this example is 563d81c8d85a6f46a6d7599ad7b6d1c5. To obtain information for this user, save the href attribute for use in subsequent calls (you can also save the self DtLink).

Getting Started

8

3.5 Get the DtInfrastructureManager

To retrieve the DtInfrastructureManager, use the path information specified by the DtSecurityManager link of the DtVersion element:

<DtLink href="/infrastructure/manager" method="GET" name="DtInfrastructureManager" rel="top"></DtLink>


https://Host/dt-rest/v100/infrastructure/manager

The response specifies the links you can traverse to obtain properties such as patterns, pools, desktop models, and quotas. The following XML fragment shows two of the returned links:

<DtLink href="/infrastructure/manager/dcs" method="GET" name="DataCenters" rel="association"></DtLink> <DtLink href="/infrastructure/manager/models" method="GET" name="DesktopModels" rel="association"></DtLink>

3.6 Retrieve the Mapped Pools or Pattern for a Specific User

To retrieve the mapped pools or pattern for a list of users, use the path information specified by the DefaultMappingOfUsers link of the DtInfrastructureManager:

<DtLink href="/infrastructure/manager/mapping/users/default?sep={sep}&users={users}&" method="GET" name="DefaultMappingOfUsers" rel="map"></DtLink>


https://Host/dt-rest/v100/infrastructure/manager/mapping/users/default?sep=,&users=563d81c8d85a6f46a6d7599ad7b6d1c5,bcce77ea74cdd148b9c2c08d84dfff2a&

The response contains one XML Entry element for each user. Each Entry element specifies the default pool or pattern for the user. For example:

<Map> <Entry> <key xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xs=http://www.w3.org/2001/XMLSchema xsi:type="xs:string">563d81c8d85a6f46a6d7599ad7b6d1c5</key> <DtDesktopPool id="1078"> <DtLink href="/infrastructure/pool/1078" method="GET" name="DtDesktopPool" rel="self"></DtLink> <DtLink href="/infrastructure/pool/1078/delete" method="DELETE" name="Delete" rel="action"></DtLink> <DtLink href="/infrastructure/pool/1078/update" method="PUT" name="Update" rel="action"></DtLink> <DtLink href="/infrastructure/pool/1078/patterns" method="GET" name="Patterns" rel="association"></DtLink> <DtLink href="/infrastructure/pool/1078/vms" method="GET" name="VirtualMachines" rel="association"></DtLink> <DtLink href="/infrastructure/pool/1078/assign/domain/%7BdId%7D/group/%7BgId%7D" method="PUT" name="AssignGroup" rel="action"></DtLink> <actualSize>0</actualSize> <dateCreated>2011-09-02T17:23:57.473Z</dateCreated> <DtDesktopModel id="28428506-fce0-43c3-a4be-13043c79b3f5"> <DtLink href="/infrastructure/model/28428506-fce0-43c3-a4be-13043c79b3f5" method="GET" name="DtDesktopModel" rel="self"></DtLink>

Getting Started

9

<defaultProtocol>RDP</defaultProtocol> <desktopMemoryInMBs>2048</desktopMemoryInMBs> <diskSpaceInGBs>0</diskSpaceInGBs> <enabled>true</enabled> <name>DebStaticDesktopModel</name> <numberOfCpus>2</numberOfCpus> <supportedProtocols>ICA RDP VNC</supportedProtocols> <type>static</type> </DtDesktopModel> <domainName>DEV</domainName> <DtGoldPattern id="G.1001.62"> <DtLink href="/infrastructure/pattern/gold/G.1001.62" method="GET" name="DtGoldPattern" rel="self"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/update" method="PUT" name="Update" rel="action"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/convert/desktop" method="POST" name="ConvertToDesktop" rel="action"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/pools" method="GET" name="DesktopPools" rel="association"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/rename?name=%7N%7D&" method="PUT" name="Rename" rel="action"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/vm" method="GET" name="VirtualMachine" rel="association"></DtLink> <DtLink href="/infrastructure/pattern/gold/G.1001.62/dcs" method="GET" name="DataCenters" rel="association"></DtLink> <deleted>false</deleted> <name>Deb_Gold_Pattern</name> <companyName>Desktone</companyName> <enabled>true</enabled> <key></key> <modified>false</modified> <notes></notes> <osType>Windows7_64</osType> <timeZoneId>EST</timeZoneId> <username>Administrator</username> <vmUuid>4222f9e2-0552-ade8-623b-6f77200599ab</vmUuid> </DtGoldPattern> <highlyAvailable>false</highlyAvailable> <lastUpdated>2011-11-14T20:25:39.937Z</lastUpdated> <name>DebUserPool</name> <DtOrganization id="1001"> <DtLink href="/security/organization/1001" method="GET" name="DtOrganization" rel="self"></DtLink> <DtLink href="/security/organization/1001/quotas" method="GET" name="DesktopModelQuotas" rel="association"></DtLink> <dateCreated>2011-09-01T20:20:50.216Z</dateCreated> <dateUpdated>2011-09-01T20:20:50.216Z</dateUpdated> <disabled>false</disabled> <name>Tenant1001</name> </DtOrganization> <patternType>S</patternType> <poolModeMessage></poolModeMessage> <poolOnline>true</poolOnline> <DtPoolPolicy id="2140429207"> <allocatorSessionTimeOut>3600000</allocatorSessionTimeOut> <allowFullDesktop>false</allowFullDesktop> <allowedToJoinDomain>true</allowedToJoinDomain> <assignedGroupNames></assignedGroupNames> <clipBoardRedirect>true</clipBoardRedirect> <comPortRedirect>false</comPortRedirect> <desktopDeallocAction></desktopDeallocAction> <drivesRedirect>true</drivesRedirect> <maxPoweredOnVMs>50</maxPoweredOnVMs>

Getting Started

10

<minPoweredOnVMs>10</minPoweredOnVMs> <nonPersistent>false</nonPersistent> <organizationalUnit></organizationalUnit> <printerRedirect>true</printerRedirect> <smartCardRedirect>false</smartCardRedirect> </DtPoolPolicy> <poolSizeType>Fixed</poolSizeType> <requestedSize>3</requestedSize> <supportedPoolProtocols>RDP</supportedPoolProtocols> <vmRootName>DebUserPool</vmRootName> </DtDesktopPool> </Entry> </Map>

3.7 Example Error

The table below shows the key-value pairs returned in the HTTP response to an incorrectly formulated HTTP request to retrieve non-existent pool information.

Table 3–1 Sample Error Code in HTTP Response

Key Value

x-dt-error-num 1

x-dt-error-code DT_RESOURCE_NOT_FOUND

X-dt-error-msg Cannot find desktop pool with ID nonexistent

When you receive an HTTP error, the XML returned contains a DtErrorInfo element. For example:

<DtErrorInfo> <errorCode>DT_RESOURCE_NOT_FOUND</errorCode> <errorMessage>Cannot find desktop model with id nonexistent</errorMessage> <errorTime>2011-09-29T14:23:07.031-04:00</errorTime> </DtErrorInfo>

Resources

11

4 Resources

4.1 DtVersion

This interface represents a Horizon DaaS Platform REST API version. It provides version related information of the platform REST APIs.

Scope: All

Links

Name Description Method Relationship Scope

DtInfrastructureManager A top level entry point to traverse the Horizon DaaS Platform resources

GET Top All

DtInstallManager A top level entry point to traverse resources related to the installation of Horizon DaaS Platform appliances

GET Top SP

DtPoolManager A top level entry point to traverse desktop or session pool related resources

GET Top Tenant

DtReportingManager A top level entry point to retrieve reports GET Top All

DtSecurityManager A top level entry point to traverse the Horizon DaaS Platform security object model

GET Top All

DtSystemManager Represents Horizon DaaS Platform and provides various miscellaneous functionality and information about the current installation

GET Top All

Properties

Name Description Data Type

domainRegistrationURI URI used by clients to register a domain to the local appliance. This URI can only be used to register the first domain for the organization. Additional domains can be registered using DtSecurityManager’s RegisterDomain link

String

loginURI The URI used by clients to login to Horizon DaaS Platform with this version

String

Resources

12

4.2 DtCredentials

Representation of the credentials authentication step.

Scope: All

Links


DtCredentials Link to this resource. Self

Submit Submits the authentication step, retrieving the next authentication step.

POST Action All

Properties


domain Domain to log in with. String

password Password to log in with. String

type Type of the authentication step. DtAuthenicationStepType

username Username to log in with. String

usernameModifiable Indicates whether the username is modifiable or not. Boolean

4.3 DtHttpHeaders

This interface contains custom HTTP headers that may be found in the response headers returned by Horizon DaaS Platform REST API invocation.

Scope: All

Links

NA

Properties


dt_csrf_header Enumeration for ‘x-dt-csrf-header' String

dt_error_code Enumeration for ‘x-dt-error-code’ String

dt_error_message Enumeration for ‘x-dt-error-message’ String

dt_error_num Enumeration for ‘x-dt-error-num’ String

dt_error_time Enumeration for ‘x-dt-error-time’ String

Resources

13

4.4 DtInfrastructureManager

The top level entry point to traverse the Horizon DaaS Platform resources.

Scope: All

Links


AssignHostManagerToElement Assign the specified hypervisor manager to a tenant desktop manager (Service Provider only)

POST Action SP

AssignNetworkToDesktopManager Assign the specified network to the desktop manager

PUT Action SP

AssignStorageConfigToElement Create a storage mount point(datastore) based on the given storage config on all hosts used by a given tenant desktop manager (Service Provider only)

POST Action SP

ConvertToGoldPattern Deprecated.

Functionality has been moved the DtPoolManager

POST Action Tenant

CreateDataCenter Create a new datacenter. POST Action SP

CreateDesktopModel Deprecated.

Creates a new desktop model that you will be able to modify later

POST Action SP

CreateDesktopModelDefinition Creates a new desktop model definition.

GET Association Tenant

CreateDesktopPool Deprecated.

Functionality has been moved the DtPoolManager

POST Action Tenant

CreateNetwork Create a new network. POST Action SP

CreateOrUpdateDesktop ManagerDMQuota

Sets or updates a collection of quotas for a specified desktop model to the requested amount

POST Action SP

CreateOrUpdateDesktopModelQuota Creates new or updates a collection of quotas for desktop models for a tenant organization and datacenter to the requested amounts (Service Provider only)

POST Action SP

CreateOrUpdateRemoteProtocolQuota Creates a new remote protocol quota or updates an existing remote protocol quota (Service Provider only)

POST Action SP

CreateOrUpdateTemplateQuota Creates a new template quota or updates an existing template quota (Service Provider only)

POST Action SP

CreateOrUpdateSessionQuota Creates a new session quota or updates an existing session quota for a given tenant organization

POST Action SP

Resources

14

and datacenter (Service Provider only)

CreateReservationForAppliances Create Reservation for new appliance.

POST Action SP

CreateStorageConfig Creates a new storage mount point on a discovered storage system (Service Provider only)

POST Action SP

DiscoverHypervisorManager Discover a particular hypervisor manager (Service Provider only)

POST Action SP

DiscoverHypervisorManagerByAddress Discover a hypervisor manager for the given resource manager by its DNS address

Return Value: DtHypervisorManager

POST Action SP

DiscoverHypervisorManagerByAddress WithCertValidation

Parameters:

vmgrId - Resource manager id

address - IP address or dns address of the hypervisor manager

username - Username to access the hypervisor manager

password - Password of the user to access the hypervisor manager

virtualDataCenterName - Optional virtual datacenter name to use on the hypervisor manager

cert - Valid server certificate thumbprint

Returns:

The discovered hypervisor manager

POST Action SP

DiscoverHypervisorManager WithCertValidation

Discover a particular hypervisor manager.

POST Action SP

DiscoverStorageSystem Discover a storage system (Service Provider only)

POST Action SP

DtInfrastructureManager Link to this DtInfrastructureManager

GET Self All

GetDataCenters Retrieves a collection of all data centers in the platform

GET Association All

GetDesktopModelQuotas Retrieves a collection of all desktop model quotas

GET Association All

GetDesktopModels Retrieves a collection of all available desktop models

GET Association All

GetDesktopPools Deprecated. GET Association Tenant

Resources

15

Functionality has been moved the DtPoolManager. Using method getPools() will return similar results

GetHypervisorManagers Retrieves all the hypervisor managers currently discovered in this environment. (Service Provider only)

GET Association SP

GetPatterns Deprecated.

Functionality has been moved the DtPoolManager.


GetTenantDesktopManagers Retrieves the collection of tenant desktop managers in the current organization

GET Association All

GetTenantDesktopManagersByDataCenter Retrieves the collection of DtTenantDesktopManager objects filtered for a specified data center ID.


GetTenantNetworks Retrieves all networks assigned to the given tenant organization.

Return Value - Collection of DtNetwork resources

GET Association SP

PurgeRecyclePool Deprecated.


POST Action Tenant

RefreshDynamicPool Deprecated.


POST Action Tenant

RemoveStorageConfig Removes a storage mount point configuration in the environment (Service Provider only)

POST Action SP

RemoveStorageSystem Removes a storage system from the environment (Service Provider only)

POST Action SP

ReserveDesktopPattern Deprecated.


POST Action Tenant

RetrieveTemplateQuotaForTenant Retrieves the template quotas for all datacenters in the tenant organization (Service Provider only)

GET Action SP

RetrieveAllRemoteProtocolQuotas Retrieves the remote protocol quotas for all datacenters in the tenant organization (Service Provider only)

GET Action SP

RetrieveAllStorageConfigs Retrieves all storage mount point configurations (Service Provider only)

GET Action SP

RetrieveAllStorageSystems Retrieves all discovered storage systems (Service Provider only)

GET Action SP

Resources

16

Properties

NA

4.4.1 DtDataCenter

This interface represents a logical grouping of infrastructure elements, containing information about the server, network, and storage components that are logically grouped to aid administration and provisioning of services.

Scope: All

Links


DtDataCenter Link to this resource GET Self All

Properties


appliancePassword Appliance password of this datacenter. String

assignedOrganizationIds The organizations assigned to this data center Long

backBoneNetworkId The backbone network ID that is used for internal communications and management of the data center appliances

String

RetrieveInternalTenantNetworks Retrieves all internal Tenant Networks defined.


RetrieveSessionQuotaForTenant Retrieves the session quota for all datacenters in the tenant organization (Service Provider only)

GET Action SP

RetrieveStorageConfigsForStorageSystem Retrieve all storage configs belonging to the specified storage system (Service Provider only)

GET Action SP

SetApplianceTemplate Assigns a virtual machine as an appliance template

Return value - no return value (void)

POST Action SP

UnassignHostManagerFromElement Remove the assignment of the specified hypervisor manager from the given tenant desktop manager (Service Provider only)

POST Action SP

UnassignNetworkFromDesktopManager Unassign the specified network to the desktop manager

PUT Action SP

UnassignStorageConfigFromElement Remove the specified datastore config from each host of the given tenant desktop manager (Service Provider only)

POST Action SP

Resources

17

backBoneNetworkType The network type of the backbone network (VLAN ID or network name)

String

creationDate The date of creation of the data center String

defaultDomain Default domain of this data center. String

description Any description associated with this data center or its purpose

String

dnsServer The IP address of the DNS server of this data center String

friendlyName The human readable friendly name String

frontNetworkId The front-end network ID of this data center String

frontNetworkType The network type of the front-end network (VLAN ID or network name)

String

gateway The gateway IP address of this datacenter String

ipAddressBlock The IP address block served by this data center String

lastUpdate The last update time on this data center String

mcastAddress The multicast IP address for this data center String

mcastClusterName The multicast cluster name for this data center Integer

mcastPort The multicast port of this data center String

name The name of the data center String

ntpServers The list of NTP (Network Time Protocol) servers assigned to this data center

String

subnetMask The subnet mask of this data center String

vmgrId The virtualization manager for this data center String

vmgrUIDs The list of virtualization manager UUIDs of this datacenter String

4.4.2 DtDesktopManagerCapacity

This interface represents the capacity of a desktop manager.

Scope: All

Links

NA

Properties


capacityUsedPercent Percentage of overall capacity used on this Desktop Manager.

Integer

cpuAvailable Number of virtual CPUs available for use on this Desktop Manager.

Integer

cpuUsed Number of virtual CPUs consumed on this Desktop Manager.

Integer

Resources

18

cpuUsedPercent Percentage of virtual CPUs consumed on this Desktop Manager.

Integer

diskAvailableGB Amount of disk space available for use on this Desktop Manager.

Double

diskUsedGB Amount of disk space consumed on this Desktop Manager Double

diskUsedPercent Percentage of disk space consumed on this Desktop Manager.

Integer

ramAvailableGB Amount of RAM available for use on this Desktop Manager.

Double

ramUsedGB Amount of RAM consumed on this Desktop Manager. Double

ramUsedPercent Percentage of RAM consumed on this Desktop Manager. Integer

4.4.3 DtDesktopManagerNetwork

This interface represents a network associated with a Desktop Manager.

Scope: Tenant

Properties


DesktopManagerId Desktop Manager associated with this Network Mapping String

NetworkId Network ID of mapping associated with Desktop Manager String

NetworkName Network Name of mapping associated with Desktop Manager

String

4.4.4 DtDesktopModel

Provides information about a virtual desktop's hardware and software configuration. A desktop model is assigned to a desktop pool and is used by the pool when it creates virtual desktops.

Scope: All

Links


DtDesktopModel Link to this resource GET Self All

Save Persist the properties of this desktop model

POST Action All

Properties


currentDesktopCount The current count of desktops using this desktop model Long

dateCreated The date the organization was created String

defaultProtocol The default remote access protocol used by desktops using this desktop model, for example RDP

Integer

Resources

19

desktopMemoryInMBs The RAM size for the desktops using this desktop model Integer

desktopQuota The desktop quota of this desktop model Long

diskSpaceInGBs The disk space for desktops using this desktop model Long

enabled Specifies if this desktop model is enabled or disabled Boolean

lastUpdated The date the organization was last updated String

licenseEntitlements The license entitlement of this desktop model Collection of LicenseEntitlement

name The name of the desktop model, for example Normal String

numberOfCpus The number of CPUs in this desktop model Integer

refId The reference ID for the given desktop model String

sessionBased Assigns the session based attribute of the desktop model. Boolean

supportedProtocols The list of protocols supported by this desktop model: ICA, RDP, RGX, VNC, NX

Collection of DisplayProtocol

type The type of the desktop model, for example selectable String

4.4.4.1 DtLicenseEntitlement

This interface represents a license entitlement.

Scope: Tenant

Links

NA

Properties


dateCreated The date and time the license entitlement was created String

deleted Specifies if this license entitlement is deleted Boolean

desktopModelId The unique ID of the desktop model to which this license entitlement is applied

String

entitlementContentType The content-type of the entitlement file String

entitlementFileName The file name of the license entitlement String

fileLocation The entitlement file location String

lastUpdated The date the desktop model quota was last updated String

organizationId The ID of the organization to which the entitlement is applied

String

tenantUpdate Specifies if this is a tenant update Boolean

version The version of the license entitlement Float

Resources

20

4.4.5 DtHAPairReservationCreator

This interface represents a HA Pair Reservation creator resource that specifies information required for creating reservation for appliances.

Scope: SP

Links

NA

Properties


DataCenterName Retrieves the name of the data center. String

OrgId Retrieves the orgId. Long

ApplianceType Retrieves the type of appliance. DtApplianceType

PrimaryApplianceName Retrieves the name of primary appliance. String

SecondaryApplianceName Retrieves the name of secondary appliance. String

PrimaryApplianceIp Retrieves the IP of primary appliance. String

SecondaryApplianceIp Retrieves the IP of secondary appliance. String

PrimaryApplianceAccessPort Retrieves the access port of primary appliance. Int

SecondaryApplianceAccessPort Retrieves the access port of secondary appliance. Int

FloatingApplianceIp Retrieves the IP of Floating appliance. String

NetworkId Retrieves the ID of network. String

Date Retrieves the date on which reservation has been scheduled.

Date

isEnableAVMgr Returns whether AppVolumes manager is enabled or not.

Boolean

4.4.6 DtHypervisorManager

This interface represents a hypervisor manager.

Scope: SP

Links


AssignToElement DEPRECATED

Assign this hypervisor manager to a tenant desktop manager

POST Action SP

AssignToTenantDesktopManager Assigns a tenant desktop manager to this hypervisor manager so that compute pools from the hypervisor manager can be assigned to the specified desktop manager.

Return Value: DtTenantDesktopManager

POST Action SP

Resources

21

GetDatastores Retrieves all datastores associated with this hypervisor manager.

GET Association SP

Delete A link to delete this hypervisor manager

POST Action SP

DtHypervisorManager A link to this resource GET Self SP

GetComputePools Retrieves all compute pools managed by this hypervisor manager

GET Action SP

GetElements Retrieves all tenant desktop managers using this hypervisor manager

GET Association SP

UnassignFromElement Removes assignment of this hypervisor manager to a given tenant desktop manager

POST Action SP

Properties


address The DNS name or IP address of this hypervisor manager String

state The current assignment state of this hypervisor manager (Discovered or Assigned)

String

status Current status of the hypervisor (for example, Online) String

type The virtualization technology (for example, vCenter) String

url The URL for API invocations String

vendorId The unique identifier of the vendor String

4.4.6.1 DtDatastore

This interface represents information about a datastore.

Scope: SP

Links


BrowseDatastore Lists contents of datastore GET Action SP

Delete Deletes a path on the datastore DELETE Action SP

DtDatastore Link to this resource. GET Self SP

Mkdir Creates a directory on the datastore POST Action SP

Properties


Capacity Gets the capacity on a datastore Long

FreeSpace Gets the free space on a datastore Long

Name Gets the name of a datastore String

Resources

22

4.4.7 DtComputePool

This interface represents a pool of compute resources that serves virtual machines as appliances or desktops.

Scope: SP

Links


DtComputePool A link to this DtComputePool GET Self SP

GetHypervisorManager Retrieves the hypervisor manager that manages this compute pool

GET Association SP

GetTenantDesktopManager Retrieves the tenant desktop manager (element) assigned to use this compute pool, NULL for SP

GET Association SP

Update Persists updates to assign or unassign tenant desktop manager or organization to a compute pool.

Return Value: no return value (void)

PUT Action SP

UpdateOverutilizationRatios Updates the memory and CPU overallocation ratios using the parameters memoryOverallocationRate and cpuRatioVirtualToPhysical in the link’s URL

POST Action SP

Properties


computeRefId Unique ID that is used by the IaaS layer to uniquely reference the logical/physical instance this compute pool uses. It could be the UUID of an ESX hypervisor host, the unique cluster name or the org VDC name in vCloud

String

cpu Total number of CPUs offered by the underlying resource of this compute pool

Integer

cpuOverallocation The ratio of the virtual CPUs (that will be served by this hypervisor in its VMs) to its actual number of physical CPUs

Double

cpuPartition The number of CPUs offered by this compute pool. If the underlying resource of the compute pool is shared amongst multiple organizations then this would be a subset of the total CPUs of the underlying resource

Integer

dcId The datacenter in which this compute pool will serve appliances or desktops

String

displayName The public display name for this compute pool String

memoryOverallocation The ratio of the virtual RAM (that will be served by this hypervisor in its VMs) to its actual physical memory

Double

Resources

23

memoryPartitionInMBs The amount of memory in MBs offered by this compute pool. If the underlying resource of the compute pool is shared amongst multiple organizations then this would be a subset of the total CPUs of the underlying resource

Long

organizationId Unique identifier of the organization of this compute pool

Long

partitioned Specifies whether this hypervisor host is partitioned or not

Boolean

properties A collection of DtComputePoolProperties that represent the variable properties of this compute pool based on the type

DtComputePoolProperty

tenantDesktopManagerId The unique ID of the tenant desktop manager that is using this compute pool, NONE if unassigned

String

type The type of the hypervisor host, for example esx String

4.4.7.1 DtComputePoolProperty

Scope: SP

Links

NA

Properties


computePoolId Unique ID that is used by the IaaS layer to uniquely reference the logical/physical instance this compute pool uses. It could be the UUID of an ESX hypervisor host, the unique cluster name or the org VDC name in vCloud.

String

name Name of the compute pool property e.g. status String

role The role that this host is in (active, standby, reserved) String

status The high level status as reported from the AP String

swDescription The long description of the software running on this host String

swVersion The version of the software running on this host String

totalCpuCount The total number of physical CPUs on this host Integer

value Property value for this name String

4.4.8 DtNetwork

This resource represents a network.

Scope: SP

Links


Delete Deletes network. PUT Action SP

Resources

24

DtNetwork Link to this resource GET Self SP

Properties


datacenterId Datacenter where this network operates String

dateCreated Date network was created Date

dateUpdated Date network was last updated Date

defaultVlan Specifies if this network is the default network of a tenant organization

Boolean

dnsServer Address of the DNS server in this network String

gateway Address of the gateway for this network String

networkId Unique ID of this network (VLAN for a network type; VLAN and name for a SDN)

String

networkLabel User-defined network label String

networkType DtNetworkType of this network DtNetworkType

orgId Organization of this network Long

privateBackbonePort Private backbone port if applicable Long

subnetMask Subnet mask of this network String

4.4.9 DtSessionQuota

Session quota assigned to a tenant cluster (organization + datacenter).

Scope: All

Links

NA

Properties


DCId Unique ID of the datacenter of this session quota String

dateCreated Creation date this session quota Date

dateUpdated Last update of this session quota Date

orgId Unique ID of the organization of this session quota Long

quota The maximum number of sessions allowed for this tenant cluster

Long

Resources

25

4.4.10 DtStorageConfig

This interface represents a storage mount point configuration upon a discovered storage system.

Scope: SP

Links


DtStorageConfig A link to this resource GET Self SP

Properties


localMountPoint Path to local mount point of the storage configuration on the host

String

name Name of this mount point on the host String

ownerId The unique ID of the owner of this storage configuration (e.g. organization ID)

Long

remoteMountPoint Path to remote mount point of the storage configuration on the storage system

String

storageSystemId The unique ID of the storage system where this storage configuration resides

String

tenantDesktopManagerIds Unique IDs of all tenant desktop managers using this storage configuration to create end-user desktops

Collection of String

4.4.11 DtStorageSystem

This interface represents a storage system discovered and assigned to resource managers. Storage mount points on this storage system persist virtual machines (management appliances or desktops).

Scope: SP

Links


DtStorageSystem A link to this storage system instance GET Self SP

StorageConfigs Retrieves all storage mount points configured for this storage system instance for the given resource manager

GET Association SP

Properties


address IP or DNS address of the storage system String

type Type of the storage system (Local, NFS, Desktone, Netapp, Nexenta, Isilon, WSS)

String

vendorId Vendor ID that uniquely identifies the vendor of this storage system

String

Resources

26

4.4.12 DtTenantDesktopManager

This interface represents an element in the infrastructure that manages tenant desktops.

Scope: All

Links


GetAgentAccessibleIps Retrieves the list of IP address for the desktop manager pair which are accessible to external agents.

GET Map Tenant

GetCapacity Retrieves capacity information for this Desktop Manager.


GetNetworks Retrieves the networks assigned to this desktop manager.

GET Action All

Properties


dataCenterId The datacenter that contains the tenant desktop manager String

dateCreated The date of creation of the tenant desktop manager String

VmgrId The resource manager ID that this desktop manager is associated to

String

lastMonitorTime The last time this tenant desktop manager was contacted by the monitoring host

String

lastUpdated The last update time on this tenant desktop manager String

monitoringHost The unique ID of the host currently monitoring this tenant desktop manager

String

name The friendly name of this tenant desktop manager String

organizationId The organization ID of this tenant desktop manager Long

state The current operational state of this tenant desktop manager

String

4.5 DtInstallManager

This interface represents a top level entry point to manage all management appliances and associated resources and actions.

Scope: SP

Links


DtInstallManager A link to this resource GET Self SP

GetAllAppliances Retrieves a collection of all appliances managed by the service provider organization

GET Association SP

GetDeploymentType GET Association All

Resources

27

Properties

NA

4.5.1 DtAppliance

This interface represents a management appliance.

Scope: SP

Links


DtAppliance A link to this resource GET Self SP

GetResourceManagerId Retrieves the unique ID of the resource manager that this appliance uses to interface with computing resources.

GET Action SP

Restore Restores the management appliance by deleting it and recreating and reinstalling it. (CAUTION – all snapshots of the appliance are lost if restore is performed)

POST Action SP

Properties


capabilities Bit-wise value representing all capabilities of this management appliance (possible values are SP_FABRIC = 0, TRANSIT_SERVER=1, VMGR=2, APPLIANCE_TEMPLATE=3, Tenant_FABRIC=4, EMGR=5, PRIMARY_NODE=6, PRIMARY_NODE_ACROSS_DCS=7)

Long

computePoolId Unique ID of the compute pool that hosts this management appliance

String

datacenterId Unique ID of the datacenter where this management appliance resides

String

displayName Management appliance’s human readable display name String

lastMonitorTime Time when the management appliance was last monitored Date

lifeState Life state of this management appliance (Online, Offline, Unknown)

String

monitoringHost Unique ID of the monitoring host of this management appliance

String

name Management appliance’s name String

numMissedHeartbeats Number of missed heartbeats from this management appliance

Integer

organizationId Unique ID of the organization that this management appliance serves

String

state State of this appliance (Reserved, Created, Installed, Disabled, Deleted)

String

version Version of this management appliance String

Resources

28

virtualMachineId Unique ID of the virtual machine in the hypervisor host that operates this management appliance

String

4.6 DtMaintenanceManager

This interface represents a top level entry point to manage software updates and other maintenance operations on the deployment.

Scope: SP

Links


AreTenantsUpgradable This method tests if the tenants are upgradable.

GET Action SP

DtMaintenanceManager Link to this resource. GET self

FailOverDataCenter Provides a new IP to a data center. POST Action SP

InitSlony Initializes slony. POST Action SP

ReconfigureNetworking This method reconfigures networks on all network interfaces.

POST Action SP

RemoveSlonyNode Removes a slony node. POST Action SP

RetrieveAllSlonyNodes Retrieves a collection of slony nodes. GET Association SP

RetrieveMasterSlonyNode Retrieves a master slony node. GET Association SP

RollBackOrg Reverts an Org to the last snapshot. POST Action SP

Upgrade DEPRECATED POST Action SP

GetUpgradeStatus DEPRECATED GET Action SP

Properties

NA

4.6.1 DtInitSlonyParams

This interface represents parameters for slony initialization.

Scope: SP

Links

NA

Properties


DataCenterId Data center ID String

ElementId Element ID String

DbType Database type String

OrgId Org ID Long

Resources

29

SlonyInitOpType Slony initialization operation type.

1 = OP_TYPE_INIT_SLONY_SP_MASTER

2 = OP_TYPE_INIT_SLONY_FOR_ORG

3 = OP_TYPE_INIT_ SLONY_FOR_DESKTOP_MANAGER

4 = OP_TYPE_INIT_ SLONY_FOR_APP_VOL

Integer

4.6.2 DtSlonyNode

This interface represents a slony node. Slony is used for replication as well as syncing of DB lying across appliances.

Scope: SP

Links

NA

Properties


active Retrieves the state of node. Takes Boolean, returns unboxed Boolean.

Boolean

comment Retrieves comment. String

id Retrieves node’s ID. Returns string; set takes an int. String

4.6.3 DtUpgradeInfo

This interface represents the status of an upgrade task.

Scope: SP

Links

NA

Properties


orgId Retrieves the organization ID associated with this status. Long

status Retrieves the organization's upgrade status (Get only). DtUpgradeStatus

4.6.4 DtUpgradeRequest

This interface represents an upgrade request.

Scope: SP

Links

NA

Properties

Resources

30


targetOrgIds Retrieves the list of organization IDs to be upgraded. List<String>

4.7 DtMappingManager

This interface represents a top level entry point to retrieve user mapping information.

Scope: Tenant

Links


CreateUserMappingReportFilter Creates a report filter for retrieving a set of User Mapping Reports by various criteria.

GET Action Tenant

CreateVMMappingReportFilter Creates a report filter for retrieving a set of VM Mapping Reports by various criteria.

GET Action Tenant

DtMappingManager Link to this resource. GET Self Tenant

GetDesktopMappingReport Retrieves a report for all the virtual machines.

POST Action Tenant

GetMappedUsers This API supports paged responses (pagination) and filters.

POST Action Tenant

GetUserMappingReport This API supports paged responses (pagination) and filters.

POST Action Tenant

VMMappingReport Retrieves a report for all the virtual machines.

POST Action Tenant

Properties

NA

4.8 DtNotificationManager

This interface represents a top level entry point to handle notifications. It provides methods to retrieve existing notifications.

Scope: Tenant

Links


CreateNotificationFilter Creates a notification filter GET Association Tenant

DtNotificationManager Link to this resource GET Self Tenant

GetNotifications Retrieves all notifications that match the specified filter


Properties

NA

Resources

31

4.8.1 DtMaintenanceNotice

Representation of a maintenance notice.

Scope: Tenant

Links

NA

Properties


type Type of notification String

dateCreated Date the maintenance notice was created Date

dateUpdated Date the maintenance notice was last updated Date

expirationDate Date the notice expires Date

message Message of the maintenance notice String

startDate Date the notice becomes active Date

4.8.2 DtNotification

Generic representation of a notification.

Scope: Tenant

Links

NA

Properties


type Type of notification DtNotificationType

4.8.3 DtNotificationFilter

Representation of a notification filter.

Scope: Tenant

Links

NA

Properties


active Indicates whether to retrieve only active notification Boolean

type Type of notifications to retrieve DtNotificationType

Resources

32

4.8.4 DtVirtualMachineNotification

Representation of a virtual machine notification.

Scope: Tenant

Links


VMs Retrieves the VMs affected by the notification


Properties


count Number of VMs affected by the notification Int

4.9 DtOrchestrationEngine

This interface represents a top level entry point to perform installation on management appliances related to SmartNode.

Scope: SP

Links


DtOrchestrationEngine Link to this resource. GET self

Initialize Main entry point for starting orchestration work.

POST Action SP

Properties

NA

4.10 DtOrchestrationModel

This interface represents a deployment model for the orchestration engine. It encapsulates a set of configuration parameters and a deployment type.

Scope: SP

Links


Initialize Main entry point for starting orchestration work.

POST Action SP

Properties


deploymentType Gets the deployment type which describes the type of deployment that will be done for this orchestration model.

DtDeploymentType

Resources

33

settings Gets the configuration settings. Collection<DtOrchestrationParam>

4.11 DtOrchestrationParam

This interface represents an orchestration engine configuration parameter.

Scope: SP

Links

NA

Properties


key Retrieves the key that identifies the setting. String

value Retrieves the value of the configuration parameter. String

4.12 DtPoolManager

This interface represents a top level entry point to manage desktop and session pools of tenants and associated resources and actions.

Scope: Tenant

Links


AssignUserToStaticDesktopPattern Assigns a static desktop to the given user from the given static pool. Repeated invocations for the same input will return the user's existing static desktop assignment. If invoked on a pool where there are no more static desktops available, will return DT_RESOURCE_ASSIGNMENT_FAILED. The pool must be a static desktop pool, otherwise will return DT_INVALID_PATTERN_TYPE.

Note this method may be invoked by a non-admin user, provided that the logged in user is the same as the user loginName specified. In other words, it can only be invoked by a non-admin user to perform the assignment to the same user.

The user must be already be entitled to the specified pool.

Parameters:

poolId - the ID of the static pool to assign the desktop pattern from

PUT Action Tenant

Resources

34

loginName - the loginName of the user to assign the desktop to

Returns:

DtStaticDesktopPattern assigned to the user

ConvertToGoldPattern Converts a static desktop pattern to a gold pattern.

POST Action Tenant

CreateApplicationSessionPool Persists the given instance of an application session based pool as a new object into the database.

POST Action Tenant

CreateApplicationSessionPool ForElementId

Creates an application session pool for selected desktop manager.

POST Action Tenant

CreateDesktopPool Creates a new pool of desktops or sessions.

POST Action Tenant

CreateDesktopPoolForElement Creates a desktop pool for selected desktop manager.

POST Action Tenant

CreatePatternFilter Creates an empty pattern filter. GET Action Tenant

CreateSessionPool Persists the given instance of a session based pool as a new object into the database.

POST Action Tenant

CreateUserDefinedApp Creates an Application entry in the Application catalog of the specified Gold Patterns.

Parameters:

request – DtUserDefinedAppRequest wrapper for components and gold patterns catalogs to be pushed to.

Returns:

String User Defined Application Reference ID for created applications.

POST Action Tenant

CreateVirtualMachineFilter Creates an empty virtual machine filter. GET Action Tenant

DeleteUserDefinedApp Deletes the User Defined Application from all catalogs

Parameters:

refId – String user defined reference ID for the application

POST Action Tenant

DtPoolManager Link to this resource GET Self Tenant

FindApplications Retrieves all the applications. GET Association Tenant

FindDesktopPatterns Finds desktop patterns which matches filter criteria.

POST Association Tenant

FindVirtualMachines Finds virtual machines which matches filter criteria.


GetAvailableAgentUpdateOnPool Retrieves all agent updates available for a selected pool.


Resources

35

GetDefaultMappingOfUsers Retrieves the default mappings of a list of users

GET map Tenant

GetDesktopManagerIdForPoolId Returns desktop manager for a pool

Parameters:

poolId- - ID of the pool


GetDesktopPoolOfUsers Retrieves the desktop pools assigned to this user

GET map Tenant

GetDesktopPoolsOfGroups Retrieves the pool mappings of a list of groups

GET map Tenant

GetGoldPatterns Retrieves the list of gold patterns associated with a specific desktop manager(for backward compatibility)


GetGoldPatternsForDesktopModel Retrieves the list of gold patterns associated with a specific desktop manager and desktop model.


GetPatterns Retrieves all patterns that belong to the current organization of the specified type. Specify one of the following types of patterns:

• G - A pattern based on a template of the hypervisor.

• D – A pattern that describes a dynamic virtual desktop machine.

• S – A pattern that describes a static virtual desktop machine 4) U User - A pattern that describes a non-VM desktop machine.

A – A pattern that describes a desktop or application served by an app server that describes a non-VM desktop machine.


GetPatternsOfUsers Retrieves the pattern mappings of a list of users.

GET Map Tenant

GetPool Retrieves the pool specified by the poolId.


GetPools Retrieves a collection of all available desktop pools.


GetPoolsWithEntitledUserCounts Retrieves a collection of all available pools with entitled user counts per pool computed.


GetPoolWithEntitledUserCount Retrieves the pool specified by the poolId along with the entitled user count populated.


GetRDP Gets an RDP connection to the VM associated with the pattern.

GET Action Tenant

Resources

36

GetVirtualMachine Retrieves a virtual machine by virtual machine ID and pattern ID


GetVirtualMachines Retrieves a collection of all available virtual machines


LastGPConversionError This method fetches that last error occurred in Gold pattern conversion for a particular tenant.


MigrateDesktopPatterns API to migrate desktops to another pool The rules are:

- Allow migration from any Pool to "Recycle" pool

- Allow migration from any pool to "Pattern pool" as long as there is Template Quota available

- Allow migration from the "Imported Desktops" pool to any pool that is NOT "Pattern" pool AND has the same element as the moving pattern

- Allow migration from the "Recycle" pool back to the previous pool

- Allow migration between pools that have the same desktop model

- Allow migration between Utility and Imported pool, disallow all other movements for Utility

- Disallow migration of dynamic patterns (dynamic patterns in Imported pool will show as Static Patterns)

- Disallow migration from any pool to a session pool

- Disallow any other migrations; throws an exception on failure.

PUT Action All

ModifyUserDefinedApp Modifies the User Defined Application in Application catalogs and updates mappings according to request.

PUT Action Tenant

PerformPoolBatchPowerOperation Performs power operation on selected VMs in pool.

POST Action Tenant

PurgeRecyclePool Purges the recycle pool. Static patterns are moved to the recycle pool when a user does not want the virtual desktop any more. The purge recycle pool action goes ahead and deletes virtual desktops in the recycle pool from the hypervisor.

POST Action Tenant

RefreshDynamicPool Starts a Dynamic Pool Refresh task for the given gold pattern and dynamic pool

POST Action Tenant

ReserveDesktopPattern Reserves a static pattern so it can then become eligible for gold pattern conversion. (Tenant only)

POST Action Tenant

Resources

37

ResyncPool Starts a Pool Resync task for the given poolId.

POST Action Tenant

UnreservePattern Migrates the specified static pattern back to the pool it came from and creates a new static pattern

POST Action Tenant

UploadUserDefinedAppIcon Uploads the Icon for a User Defined Application using the Reference ID.

PUT Action Tenant

Properties

NA

4.12.1 DtAgentUpdateStatus

This class is a "generic" class representing AgentUpdate task status.

Scope: Tenant

Links

NA

Properties


state DtTaskStatus

stateDescription String

4.12.2 DtAgentVmFabricStatus

This interface represents information in the fabric database for the agent on a VM.

Scope: Tenant

Links

NA

Properties


VmId ID of the VM String

VmName Name of the VM String

InternalVmName Internal name of the VM String

AgentName Name of agent String

AgentVersion Version of agent String

InstallStatus Install status of agent String

Resources

38

4.12.3 DtApplication

Application information to provide applications sessions to users.

Scope: Tenant

Links


DtApplication Link to this resource GET Self Tenant

Update Persists the properties of this application PUT Action Tenant

Properties


applicationFilePath Application file path of the application String

applicationName Application name of the application String

commandline Command line arguments of the application String

dateCreated Date the application was created Date

dateUpdated Date the application was last updated Date

displayName Display name of the application String

hidden Whether the application is hidden or not Boolean

icons Icons for the application Collection

numberOfPoolsUsing Number of pools using the application Int

pattern Gold pattern of the application DtGoldPattern

patternVersionId Pattern version ID for the application Long

publisher Publisher of the application String

version Version of the application String

4.12.4 DtApplicationIcon

Data object representing an application icon.

Scope: Tenant

Links


DtApplicationIcon Link to this resource GET Self Tenant

GetIconData Retrieves the icon data for the application icon.

GET Action Tenant

Properties


height Height of the application icon Int

md5Sum MD5 sum for the application icon String

Resources

39

width Width of the application icon Int

4.12.5 DtApplicationSessionPool

This interface represents a pool of RDS servers which only provide applications to users - not desktops.

Scope: Tenant

Links


AssignGroup Assigns the specified user group to this desktop pool

PUT Action Tenant

AssignUserToPool Assigns a specific user to a virtual desktop pool

PUT Action Tenant

Delete Deletes this desktop pool and any relationships this pool had with other resources

DELETE Action Tenant

DtApplicationSessionPool Link to this resource GET Self Tenant

GetApplications Retrieves all remote applications configuration for this pool


GetCommandLineParam Retrieves command line for remote application.

GET Action Tenant

GetGroupsOfPool Retrieves the groups currently assigned to the pool


GetUsersAssignedByAdmin Retrieves the users administrator assigned to pool regardless of whether they have a desktop mappings or not. Users that are not directly assigned to this pool, via a group mapping, will not be returned.


GetUsersOfPool Retrieves users of pool GET Association Tenant

GetVirtualMachines Retrieves VMs in pool GET Association Tenant

IsVMRefreshRequired Indicates if VM refreshed is required. GET Association Tenant

RemoteApplications [Deprecated]

DtRemoteApplication will no longer be the application listing utility. getApplications should be used instead.


RemoveGroup Removes the specified user group from this pool

PUT Action Tenant

RemoveUserFromPool Removes a specific user from a pool PUT Action Tenant

SetCommandLineParam For a specific application session pool, sets the command line parameters for remote application(s).

PUT Action Tenant

Update Updates this pool and any new relationships this pool has with other resources

PUT Action Tenant

Resources

40

UpdateServerDensity Updates the existing Session pool with a new Server Density

POST Action Tenant

UpdateWithApplications [Deprecated]

Updates this pool and any new application relationships this pool

PUT Action Tenant

Properties


actualSize Actual size of the pool (i.e. the actual number of provisioned virtual desktops that are available)

Long

applicationIds IDs of the applications associated with this pool String

customerId Unique ID that identifies the tenant using this pool in a supertenant deployment.

String

dateCreated Date the pool was created Date

defaultPoolProtocol Default remote display protocol for this pool DtDisplayProtocol

desktopModel Performance settings for desktops in pool DtDesktopModel

domainName Security domain name for the desktops in this pool String

entitledUserCount Count of entitled users for the pool Integer

goldPattern Gold pattern used to provision VMs in this pool DtGoldPattern

highlyAvailable Specifies if the pool has high availability Boolean

lastUpdated Date the pool was last updated Date

minimumAvailable Minimum number of desktops that need to started and available for logins

Long

name Pool name String

organization Organization that owns this pool DtOrganization

patternType Pattern type of this pool (static or dynamic) DtPatternType

poolModeMessage Reason that the pool is online or offline String

poolOnline Specifies if the pool is online or offline Boolean

poolPolicy Policy used for provisioning and pool management DtPoolPolicy

poolSessionType Pool session type (e.g. desktop, application, both) DtPoolSessionType

poolSizeType Pool size type (e.g. Fixed, Elastic) DtPoolSizeType

preferredClientType The preferred type of client used to launch applications and desktops

DtPreferredClientType

serverCount Number of servers to be provisioned for this pool Long

serverDensity Number of users that can be supported by RDS Server in the pool

Long

sessionBased Indicates whether the pool is session-based Boolean

supportedPoolProtocols Remote access protocols that can be used to access virtual desktops from this pool. This list must be a subset (or the same) as the supported protocols in the pool's DtDesktopModel.

List<DtDisplayProtocol>

Resources

41

usedByDataCenterIds IDs of data centers where this pool can have desktop instances

Collection

vmRootName Base name for all virtual machines provisioned from this pool

String

4.12.6 DtApplicationWrapper

This interface represents a remote application.

Scope: Tenant

Links

NA

Properties


applications Gets collection of objects of type DtApplication. Collection<DtApplication>

4.12.7 DtBackupInfo

This interface represents a BackupInfo resource that specifies information required for a VM backup.

Scope: Tenant

Links

NA

Properties


id Retrieves the ID of the backup. String

note Retrieves the note of the backup. String

date Date that VM was backed up Date

4.12.8 DtDesktopMigrationParams

This interface contains methods used to create an object that is used as a parameter for the desktop migration API.

Scope: Tenant

Links

NA

Properties


poolId Retrieves the destination pool for desktop migration. String

patternIds Retrieves the pattern IDs of the desktops being migrated. List<String>

Resources

42

4.12.9 DtDesktopPool

This interface represents a pool of virtual desktops or sessions. Every pool has a gold pattern that serves as the base image to create desktops in the pool. A pool can be static or dynamic - a static pool has a static pattern for each virtual desktop that typically resides on a persistent disk so that user activity is preserved over multiple sessions. A dynamic pool has a single dynamic pattern that is applied to every virtual desktop in the pool typically in a non-persistent disk so every user session resets the virtual machine to its original image.

Scope: Tenant

Links


AssignGroup Assigns group to pool

PUT Action Tenant

AssignUserToPool Assigns user to pool PUT Action Tenant

GetGroupsOfPool Retrieves groups in pool


DtDesktopPool A link to this resource

GET Self Tenant

GetPatterns Retrieves the patterns in this desktop pools


GetRemoteApplications [Deprecated]

Retrieves all remote applications configured for this pool


GetUserDesktopMappings Retrieves User Desktop Mappings for Static Desktop Pools


GetUsersAssignedByAdmin Retrieves users of pool


GetUsersOfPool Retrieves users of pool


GetVirtualMachines Retrieves VMs in pool


IsVMRefreshRequired Indicates if VM refreshed is required


RemoveGroup Removes group from pool

PUT Action Tenant

Resources

43

RemoveGroupAndAutoAssignedPatternMappings For static desktop pools only, removes the specified user group from the desktop pool, and also removes any static desktop pattern mappings for users who were automatically assigned to desktops via initial connection to the pool

PUT Action Tenant

RemoveGroupAndCreateUserPoolMappings For static desktop pools only, removes the specified user group from the desktop pool, and also creates user to pool mappings from any desktop pattern mappings for users who were automatically assigned desktops via initial connection to the pool.

PUT Action Tenant

RemoveUserFromPool Removes users from pool

PUT Action Tenant

Update Updates this desktop pool and any new relationships this pool has with other resources

PUT Action Tenant

Properties


actualSize Actual size of the pool (i.e. actual number of provisioned VMs that are available)

Long


dateCreated Date pool was created Date

defaultPoolProtocol Default display protocol for VMs in pool DtDisplayProtocol


domainName NETBIOS domain name for all desktops in this pool String




lastUpdated Date pool was last updated Date

Resources

44


Long

name Friendly name of pool String


patternType Type of pattern (G, S, or D) DtPatternType

poolModeMessage Describes why pool is online or offline String

poolOnline Indicates whether pool is online or offline Boolean


poolSessionType Indicates type of session pool can support (Application only, Desktop only, or Both)

DtPoolSessionType

poolSizeType Pool size type (Fixed or Elastic) DtPoolSizeType



requestedSize The requested size of the pool Long

sessionBased

Specifies if the pool is a desktop or a session pool. True or false

Boolean

supportedPoolProtocols List of supported displayed protocols for VMs in the pool


usedByDataCenterIds A list of data center IDs where this pool can have desktop instances

String

virtualMachines The Virtual Machines in this desktop pool Collection of DtVirtualMachine

4.12.9.1 DtPoolPolicy

Configuration and initial setup options for desktop pools. Each desktop pool has one pool policy and is used for provisioning and pool management operations.

Scope: Tenant

Links

NA

Properties


allocatorSessionTimeOut The session timeout for allocators in the pool using this policy

Long

allowedToJoinDomain Specifies the desktop pool is allowed to join a security domain

Boolean

allowFullDesktop Connecting to the full desktop is allowed from clients (in addition to remote applications) for virtual desktops in the pool using this policy

Boolean

assignedGroups The domain groups assigned to the pool with this policy Collection

assignedGroupNames The domain group names assigned to the pool with this policy


Resources

45

assignedNetworks Tenant networks (network ids) assigned to this pool. All desktops in the pool will be provisioned to these networks.


comPortRedirect Specifies remote access settings have enabled mapping client's local com ports to the virtual desktop.

Boolean

drivesRedirect Specifies remote access settings have enabled mapping client's local drives to the virtual desktop.

Boolean

licenseKey The license key for the desktop pool that uses this policy. String

maxPoweredOnVMs The maximum number of virtual machines that can be PoweredOn state in the pool that has this policy.

Integer

minPoweredOnVMs The minimum number of virtual machines that must be PoweredOn in the pool that has this policy.

Integer

nonPersistent Specifies the virtual desktops in the pool using this policy use non-persistent disks.

Boolean

organizationalUnit The AD organization unit of the pool using this policy. String

printerRedirect Specifies remote access settings have enabled mapping client's printers to the virtual desktop.

Boolean

registeredTo Used to populate the registered owner and registered organization properties of a windows desktop in that pool.

String

smartCardRedirect Specifies remote access settings have enabled mapping client's smart cards to the virtual desktop.

Boolean

timezone The time zone of the pool that uses this policy. String

video3DEnabled Indicates whether a pool is 3D video enabled or not. Boolean

4.12.10 DtDiscoveredAgent

Contains information about an Agent available for upgrade such as its type and version.

Scope: Tenant

Links

NA

Properties


dateReleased Date agent was released String

displayName Display name of agent file String

installMetadata Install metadata for agent file String

isHotpatch Indicates whether update is hotpatch or not Boolean

isValid Indicates whether update is valid or not Boolean

name Name of agent file String

takesInstallerArgs Indicates whether agent installer can take command-line arguments

Boolean

Resources

46

version Version of agent file String

4.12.11 DtDynamicDesktopPattern

This interface represents a virtual desktop that does not have specific user assignments. Any authorized user can use the virtual desktops from a pool of desktops.

Scope: Tenant

Links


DtDynamicDesktopPattern A link to this resource GET Self Tenant

GetVirtualMachines Retrieves the virtual machines associated with this pattern

GET Action Tenant

SetNumberOfInstances Sets the number of instances of this desktop pattern that exist at this location


Properties


dataCenterName The name of the data center where this pattern is available String

dateCreated The date the pattern was created String

deleted Specifies if this pattern is deleted Boolean

dependantPoolIds A collection of pool IDs where the pattern is being currently used


desktopPoolId The ID of the desktop pool of this desktop pattern String

lastUpdated The last update time and date String

name The name of the pattern as known by the hypervisor (e.g. the VM name or the template name)

String

numberOfInstances The number of instances of this desktop pattern at this location

Integer

previousDesktopPoolId The pool ID of this pattern prior to migration to another pool

String

templateId The templateId of the pattern String

Resources

47

4.12.12 DtGoldPattern

This interface represents a reserved virtual machine that can be cloned to create virtual desktops. A DtGoldPattern is created by reserving a virtual desktop. DtGoldPatterns are assigned to pools that create virtual desktops from them depending upon the desktop pool properties and desktop model

Scope: Tenant

Links


ConvertToDesktop Converts this gold pattern to a desktop.

PUT Action Tenant

CopyFromGoldPattern Clones a desktop from this gold pattern.

POST Action Tenant

CreateAgentUpdateFilter Creates an agent update filter for the gold pattern

GET Action Tenant

DataCenters Retrieves the data centers of this pattern


Delete Deletes the pattern and its associated virtual machine

POST Action Tenant

DeleteBackup Deletes the backup of a VM. POST Action Tenant

DtGoldPattern A link to this resource GET Self Tenant

GetApplications Retrieves the desktop pools using this gold pattern


GetAvailableAgentUpdateOnPattern Retrieves available agent updates for gold pattern

GetBackupCount Retrieves backup count for gold pattern

GET Action Tenant

GetBackupInfo Retrieves the backup information.

GET Action Tenant

GetPools Retrieves the desktop pools using this gold pattern


GetUpdateAgentStatusOnPattern Retrieves agent update status for gold pattern


PerformBackup Performs the backup of a VM.

POST Action Tenant

PerformRollback Performs the rollback of a VM.

POST Action Tenant

Rename Assigns a name to the pattern as would be known in the hypervisor (e.g. the VM name or the template name)

PUT Action Tenant

Update Updates this gold pattern with its current properties by persisting it and performing any other changes.

PUT Action Tenant

Resources

48

UpdateAgentsOnGoldPattern Updates agents on gold pattern.

POST Action Tenant

ValidateForGoldPattern Runs a series of checks against this pattern's VM to confirm that it is valid. Validates that the Gold pattern is in the correct state and is still a valid gold pattern

GET Action Tenant

ValidateGoldPatternForElement Runs a series of checks against this pattern's VM to validate that it is valid.

GET Action Tenant

VirtualMachine Retrieves the virtual machine associated with this pattern


Properties


companyName The company name String

dataCenterName The name of the data center where this pattern is available

String





desktopPools The desktop pools using this gold pattern Collection of DtDesktopPool

enabled Specifies if this pattern can be used for pool creation Boolean

hostManagerId The host manager’s ID String

inventoryPath The inventory path of the gold pattern String

key The windows key for the virtual machine referenced by the pattern

String


md5sum The MD5 checksum of this gold pattern String

modified Specifies if the pattern has been modified Boolean


String

notes The notes associated with this gold pattern String

osType The operating system type of this gold pattern String

parentId The ID of the parent pattern from which this gold pattern is derived

String


timeZoneId The time zone ID of this gold pattern String

Resources

49

username The local admin username String

version Gold Pattern Version Long

vmUuid The UUID of the VM referenced by this pattern String

4.12.13 DtGuestOsTypes

This interfaces lists a set of guest operating systems supported as virtual desktops.

Scope: Tenant

Links

NA

Properties


OS_TYPE_LINUX_32 Linux 32-bit String

OS_TYPE_LINUX_64 Linux 64-bit String

OS_TYPE_OTHER Other String

OS_TYPE_UBUNTU_32 Ubuntu 32-bit String

OS_TYPE_UBUNTU_64 Ubuntu 64-bit String

OS_TYPE_WIN_XP Windows XP String

OS_TYPE_WIN_VISTA Windows Vista String

OS_TYPE_WIN_7 Windows 7 String

OS_TYPE_WIN_7_64 Windows 7 64-bit String





OS_TYPE_WIN_SERVER_2K8R2_64 Windows 2008 R2 64-bit String

OS_TYPE_WIN_SERVER_2K12_64 Windows 2012 64-bit String

OS_TYPE_DESKTONE_APPLIANCE Desktone Appliance String

DESKTOP_OS_TYPES List of supported OS types for cloning and converting to an image.

Set<String>

Resources

50

4.12.14 DtMapping

This interface represents a mapping of a user.

Scope: Tenant

Links

NA

Properties


autoGenerated Indicates mapping was auto generated or not. Boolean

deleted Current state of mapping. If pattern is deleted the mapping will be flagged as deleted.

Boolean

pattern Desktop pattern associated with this mapping DtStaticDesktopPattern

user User associated with this mapping DtUser

4.12.15 DtPatternFilter

This interface is used as a filtering criteria to search desktop patterns.

Scope: Tenant

Links

NA

Properties


desktopmanagerId Desktop manager ID for the filter String

goldPatternCapableOnly Indicates whether filter criteria is set to search only patterns are applicable for gold pattern conversion or not

boolean

poolIds Pool IDs assigned for the filter List<Long>

searchName Search name for the filter String

4.12.1 DtPool

This interface represents a pool.

Scope: Tenant

Links


AssignGroup Assigns group to pool PUT Action Tenant

AssignUserToPool Assigns user to pool PUT Action Tenant

GetGroupsOfPool Retrieves groups in pool GET Association Tenant

GetUsersAssignedByAdmin Retrieves users of pool GET Association Tenant

Resources

51

GetUsersOfPool Retrieves users of pool GET Association Tenant

GetVirtualMachines Retrieves VMs in pool GET Association Tenant

IsVMRefreshRequired Indicates if VM refreshed is required GET Association Tenant

RemoveGroup Removes group from pool PUT Action Tenant

RemoveUserFromPool Removes users from pool PUT Action Tenant

Properties


actualSize Actual size of the pool (i.e. actual number of provisioned VMs that are available)

Long


String

dateCreated Date pool was created Date

defaultPoolProtocol Default display protocol for VMs in pool DtDisplayProtocol


domainName NETBIOS domain name for all desktops in this pool String




lastUpdated Date pool was last updated Date


Long

name Friendly name of pool String


patternType Type of pattern (G, S, or D) DtPatternType

poolModeMessage Describes why pool is online or offline String

poolOnline Indicates whether pool is online or offline Boolean


poolSessionType Indicates type of session pool can support (Application only, Desktop only, or Both)

DtPoolSessionType

poolSizeType Pool size type (Fixed or Elastic) DtPoolSizeType



supportedPoolProtocols List of supported displayed protocols for VMs in the pool


usedByDatacenterIds List of datacenter IDs where this pool can have desktop instances

Collection<String>

vmRootName Base name for all VMs provisioned from this pool String

Resources

52

4.12.2 DtPoolTask

This interface represents an asynchronous task performed on a pool. Contains information about the task, the targets, the progress of the task, and the result after the task completes.

Scope: Tenant

Links


DtPoolTask A link to this resource GET Self Tenant

GetTaskHistory Retrieves the history of a given task. GET Action Tenant

Refresh Refreshes the task's status with latest information about the progress of the task

POST Action Tenant

Properties


desktopPoolId The pool that the task acts upon String

percentageComplete The percentage of the task that is complete Int

pool Link to the pool DtLink

startDate Start date and time of task Date

status The current status of this pool task. DtTaskStatus

statusDescription The description of the current state, including reasons for failures

String

type The type of the pool task String

4.12.2.1 DtPoolTaskHistory

This interface represents a pool task History resource that specifies history about a particular task.

Scope: Tenant

Links

NA

Properties


DateUpdated Retrieves the date on which task was updated. Date

DateUpdatedLocaleString Retrieves the date on which task was updated. String

Description Retrieves the description of the task. String

ErrorCode Retrieves the error code explaining the reason for task failure.

String

ObjectId Retrieves the object ID of task. String

PercentageCompleted Retrieves the percentage completion of the task. Integer

State Retrieves the state of task. String

TaskId Retrieves the ID of the task. String

Resources

53

4.12.3 DtPoolAgentUpdate

This interface represents an available agent update on a pool.

Scope: Tenant

Links

NA

Properties


adminActionTime Time that admin action occurred String

agentInstallTime Time of agent install String

agentUpdateStatus Status of agent update DtAgentUpdateStatus

cmdLineArgs Raw command-line argument passed directly to the agent installer on each vm during the upgrade process.

String

dateCreated Date that the update first became available String

dateEulaAccepted Date that the End User License Agreement (EULA) was accepted.

String

dateUpdated Date that db record was last updated String

discoveredAgent Container for the agent data for the agent that is available for this pool.

DtDiscoveredAgent

eulaAccepted Indicates whether the EULA has been accepted Boolean

installMode Agent install mode. Values can be:

AT_LOGOFF

INSTALL_NOW

SCHEDULED

UNINITIALIZED

DtAgentInstallModeEnum

isValid Indicates whether the agent update is valid Boolean

poolId ID of the pool Long

updateAvailableTime Time that the update is available String

updateState State of update task DtAgentUpdateStateEnum

4.12.4 DtPoolAgentUpdateFilter

This interface gets the task ID for an agent update filter.

Scope: Tenant

Links

NA

Properties


taskId Retrieves the task ID for this filter. Long

Resources

54

4.12.5 DtRemoteApplication

This interface represents a remote application used by desktop pools.

Scope: Tenant

Links


DtRemoteApplication A link to this resource GET Self Tenant

Properties


commandLine Command to launch this remote application using CLI String

iconLocation Location of the icon that would represent this remote application. Limitation: may not be longer than 2048 characters

String

name Name of this remote application String

poolId Unique identifier of the desktop or session pool that serves this remote application

Long

primaryFileLocation Location of the primary executable file String

4.12.6 DtSessionPool

This interface represents a pool of RDS Servers providing session to users.

Scope: Tenant

Links

AssignGroup Assigns the specified user group to this desktop pool

PUT Action Tenant

AssignUserToPool Assigns a specific user to a virtual desktop pool

PUT Action Tenant

Delete Deletes this desktop pool and any relationships this pool had with other resources

DELETE Action Tenant

DtSessionPool Link to this resource GET Self Tenant

GetGroupsOfPool Retrieves the groups currently assigned to the pool


GetUsersAssignedByAdmin Retrieves users of pool GET Association Tenant

GetUsersOfPool Retrieves the users currently assigned to the pool. Users that are not directly assigned to this pool, via a group or only a desktop mapping, will not be returned.


GetVirtualMachines Retrieves the Virtual Machines in specified desktop pool


IsVMRefreshRequired Indicates if VM refreshed is required GET Association Tenant

Resources

55

RemoveGroup Removes the specified user group from this desktop pool

PUT Action Tenant

RemoveUserFromPool Removes a specific user from a virtual desktop pool

PUT Action Tenant

Update Updates this pool and any new relationships this pool has with other resources

PUT Action Tenant

UpdateServerDensity Updates the existing session pool with a new server density

POST Action Tenant

Properties


actualSize Actual size of the pool (i.e. the actual number of provisioned virtual desktops that are available)

Long

dateCreated Date the pool was created Date

defaultPoolProtocol Default remote display protocol for this pool DtDisplayProtocol


domainName Security domain name for the desktops in this pool String




lastUpdated Date the pool was last updated Date


Long

name Pool name String


patternType Pattern type of this pool (static or dynamic) DtPatternType

poolModeMessage Reason that the pool is online or offline String

poolOnline Specifies if the pool is online or offline Boolean


poolSessionType Pool session type (e.g. desktop, application, both) DtPoolSessionType

poolSizeType Pool size type (e.g. Fixed, Elastic) DtPoolSizeType



serverCount Number of servers to be provisioned for this pool Long

serverDensity Number of users that can be supported by RDS Server in the pool

Long

sessionBased Indicates whether the pool is session-based Boolean

Resources

56

supportedPoolProtocols Remote access protocols that can be used to access virtual desktops from this pool. This list must be a subset (or the same) as the supported protocols in the pool's DtDesktopModel.


usedByDataCenterIds IDs of data centers where this pool can have desktop instances

Collection

vmRootName Base name for all virtual machines provisioned from this pool

String

4.12.7 DtStaticDesktopPattern

This interface represents a virtual desktop with static user assignments. The virtual desktop is available only to users explicitly assigned to it.

Scope: Tenant

Links


AssignUserToDesktopPattern Assign a specific user to a static virtual desktop

PUT Action Tenant

AssignedUsers Retrieves all users in the given domain that have been assigned the use of this static desktop pattern

GET Action Tenant

DataCenters Retrieves the data centers of this pattern


Delete Deletes the pattern and its backing virtual machine

POST Action Tenant

DtStaticDesktopPattern A link to this resource GET Self Tenant

Rename Assigns a name to the pattern as would be known in the hypervisor (e.g. the VM name or the template name)

PUT Action Tenant

RemoveUserFromDesktopPattern Remove a specific user from a static virtual desktop.

PUT Action Tenant

ValidateForGoldPattern Runs a series of checks against this pattern's VM to confirm that it is valid and ready for conversion.

GET Action Tenant

VirtualMachine Retrieves the virtual machine associated with this pattern


Properties


dataCenterName The name of the data center where this pattern is available String



Resources

57



desktopPoolId The ID of the desktop pool of this desktop pattern String

hostmanagerId The host manager’s ID String


modified Specifies if the pattern has been modified Boolean


String

osType The operating system type of this pattern. String

previousDesktopPoolId The pool ID of this pattern prior to migration to another pool

String


vmUuid The UUID of the VM referenced by this pattern String

4.12.8 DtUserDefinedApp

This interface represents the application information to provide applications. Every application of this type is defined by an Administrator manually and is then tied to one or more gold patterns.

Scope: Tenant

Links


Delete Removes this application record. POST Action Tenant

Properties


UserDefinedRefId Retrieves the User Defined Reference ID for this application.

String

4.12.9 DtUserDefinedAppRequest

Wrapper class used to request changes to or creation of DtUserDefinedApplications. Required components: Application Name, Application File Path, some indicator of Gold Pattern mapping Interaction. Upload of Icons is not implemented yet.

Scope: Tenant

Links

NA

Properties


applicationFilePath Application File path for User Defined Application. String

applicationName Application Name for User Defined Application. String

Resources

58

associatedGoldPatternIds The list of Gold Pattern IDs to be associated with the User Defined Application Not referenced if PushToAllGoldPatterns is set to true.

List<String>

commandline Application command line parameters for User Defined Application.

String

displayName Display Name for User Defined Application For now, this value is not used during creation or modification.

String

publisher Application publisher for User Defined Application. String

pushToAllGoldPatterns Sets whether to push the requested Application to all Gold Pattern with Application catalogs.

Boolean

userDefinedRefId User Defined Reference ID for this request. Only used during modification requests; creation does not reference this value.

String

version Application version for User Defined Application. String

4.12.10 DtVirtualMachine

This interface represents an active virtual machine used by the end-user as a virtual desktop or virtual server. It provides information about a virtual machine as it is used on a hypervisor.

Scope: Tenant

Links


DtVirtualMachine A link to this resource GET Self Tenant

GetGPName Retrieves the name of the GP the given VM was cloned from.

GET Action Tenant

PerformOperation Executes the specified power operation upon this virtual machine

POST Action Tenant

Properties


computePoolId Compute Pool ID for the virtual machine String

daaSAgentState DaaS Agent state for the virtual machine DtDaaSAgentState

daaSAgentVersion DaaS Agent Version for the virtual machine Long

description Description of the VM String

goldPatternVersion Gold Pattern Version of the VM Long

guestOS Guest OS for the virtual machine DtGuestOS

inventoryPath Inventory path of the VM String

ipAddress VM IP address String

memorySizeMB Memory size in MB for the virtual machine Int

name VM name String

networkId Retrieves the Network ID for the virtual machine String

Resources

59

numCPUs Number of CPUs Int

patternId Pattern ID String

powerOnDate Date the last time this VM was powered on Date

refId VM reference ID String

sealDate Date this VM was sealed on for use as a Gold Pattern Date

templateId ID of the template String

threeDEnabled State of Soft 3D Graphics enablement Boolean

type VM type String

vmHardwareVersion VMware vmx version (hardware version) for the virtual machine

String

vmId VM ID String

vmLifeState VM life state DtVMLifeState

vmPath VM path String

vmPowerState VM power state DtVMPowerState

vmwareToolsState VMware Tools State for the virtual machine DtVMLifeState

4.12.11 DtVirtualMachineFilter

Filtering criteria to search virtual machines.

Scope: Tenant

Links

NA

Properties


searchName Search name for this filter String

4.13 DtQuotaManager

This interface represents a top level entry point to manage tenant quotas.

Scope: All

Links


CreateOrUpdateDesktopManagerDMQuota Sets or updates a collection of Quotas for specified a Desktop Model to the requested amount for specified Desktop Manger

POST Action SP

CreateQuotaFilter Creates an empty DtQuotaFilter

GET Action All

Resources

60

DesktopModelQuotasByFilter Retrieves a collection of desktop model quotas based on the filter parameters

POST Association All

GetDesktopModelQuotas Retrieves a collection of all desktop model quotas

GET Association All

GetProtocolQuota Retrieves the Remote Protocol Quota for this Tenant


GetTemplateQuota Retrieves the Template Quota associated with the specified Tenant Datacenter "Tenant Cluster"

GET Association All

GetTemplateQuotas Retrieves a collection of all template quotas

GET Association All

Properties

NA

4.13.1 DtDesktopModelQuota

Contains information about the number of virtual infrastructure components (like virtual machines) allowed for a tenant.

Scope: All

Links

NA

Properties


dataCenterId The data center ID of this desktop model quota String

dateCreated The date the desktop model quota was created String

desktopManagerId The desktop manager ID associated with this desktop model quota.

String

desktopModelId The unique ID of the desktop model to which this quota is attached

String

lastUpdated The date the desktop model quota was last updated String

organizationId The organization ID of this desktop model quota String

quota The quota associated with this desktop model for the associated Tenant Desktop Manager

Long

remainingVMCount Count for remaining VMs that can be provisioned with this desktop model quota

Long

vmCount The virtual machine count of this desktop model quota Long

Resources

61

4.13.2 DtQuotaFilter

Filtering criteria for quota information.

Scope: All

Links

NA

Properties


datacenterId Datacenter ID for this filter String

desktopManagerId Desktop Manager ID for this filter String

desktopModelId List of Desktop Model IDs for this filter List<String>

orgId Organization ID for this filter Long

4.13.3 DtRemoteProtocolQuota

Remote protocol quota assigned to tenant clusters (datacenter + organization) on the usage of remote protocols.

Scope: Tenant

Links

NA

Properties


dcId Unique ID of the datacenter of this remote protocol quota String

displayProtocol Display protocol of this remote protocol quota DtDisplayProtocol

numVms The quota amount that applies to this display protocol for the given datacenter and organization

Long

orgId Unique identifier of the organization of this remote protocol quota

Long

protocolId Unique identifier of the protocol of this remote protocol quota

Long

Unlimited Specifies if the quota is unlimited Boolean

4.13.4 DtTemplateQuota

Template quota assigned to a tenant cluster (organization + datacenter).

Scope: All

Links

NA

Resources

62

Properties


DCId Unique ID of the datacenter of this template quota. String

dateCreated Creation date of this template quota. Date

dateUpdated Last update of this template quota. Date

numTemplates The maximum number of templates allowed for this tenant cluster.

Long

orgId Unique ID of the organization of this templates quota. Long

remainingCount The remaining available template quota Long

4.14 DtRSASecurIDAuthenticator

Representation of the RSA SecurID two factor authenticator.

Scope: Tenant

Links


DtRSASecurIDAuthenticator Link to this resource. GET Self Tenant

ClearLocalNodeSecretFile Clears this tenant appliance's node secret file and restarts the local RSA Authentication Agent.

POST Action Tenant

ClearOfflineFiles Clears the JAStatus.1 files from all tenant appliances.

POST Action Tenant

RestartRSAAgent Restarts the local RSA Authentication Agent instance.

POST Action Tenant

TestAuthentication Tests the configured RSA authenticator.

POST Action Tenant

UploadConfigFile Uploads the RSA SecurID configuration file contents.

POST Action Tenant

Properties

NA

4.15 DtRSASecurIDNextToken

Representation of the RSA SecurID Next Token authentication step.

Scope: All

Links



POST Action All

Resources

63

Properties


nextToken Next token. String

4.16 DtRSASecurIDPasscode

Representation of the RSA SecurID passcode authentication step.

Scope: All

Links



POST Action All

Properties


username RSA username. String

passcode RSA passcode. String

4.17 DtRSASecurIDPinChange

Representation of the RSA SecurID PIN change authentication step.

Scope: All

Links


submit Submits the authentication step, retrieving the next authentication step.

POST Action All

Properties


minimumLength Minimum length of the new PIN. Integer

maximumLength Maximum length of the new PIN. Integer

pin New PIN. String

Resources

64

4.18 DtRADIUSAuthenticator

Representation of the configured RADIUS authenticator.

Scope: All

Links


CreateServerConfiguration Creates an empty DtRADIUSServerConfiguration object.

PUT Action Tenant

DtRADIUSAuthenticator Link to this resource. GET Self Tenant

TestAuthentication Tests the configured RADIUS authenticator.

GET Action Tenant

Update Update PUT Action Tenant

Properties


createServerConfiguration Creates an empty DtRADIUSServerConfiguration object.

DtRADIUSServerConfiguration

providerName Retrieves the provider name of the RADIUS authenticator.

String

primaryServerConfiguration Retrieves the primary RADIUS server configuration.


secondaryServerConfiguration Retrieves the secondary RADIUS server configuration.


4.19 DtRADIUSChallenge

Representation of the RADIUS Challenge Response authentication step.

Scope: All

Links



POST Action All

Properties


ProviderName Retrieves the name of the RADIUS authenticator. String

ChallengeMessage Retrieves the RADIUS challenge message. String

ChallengeResposne Retrieves the RADIUS challenge response. String

Resources

65

4.20 DtRADIUSPasscode

Representation of the RADIUS passcode authentication step.

Scope: All

Links


DtRADIUSPasscode Link to this resource. GET self All


POST action All

Properties


ProviderName Retrieves the name of the RADIUS authenticator. String

Username Retrieves the RADIUS username. String

Passcode Retrieves the RADIUS passcode. String

SameUsernameRequired Retrieves whether the same user is required in the next authentication step.

Boolean

4.21 DtRADIUSServerConfiguration

Representation of the RADIUS two factor authenticator server configuration.

Scope: All

Links

NA

Properties


AccountingPort Retrieves the accounting port of the RADIUS server.

Int

AuthenticationPort Retrieves the authentication port of the RADIUS server.

Int

AuthenticationType Retrieves the authentication type used by the RADIUS server.

DtRADIUSAuthenticationType

Hostname Retrieves the hostname of the RADIUS server. String

MaxRetries Retrieves the maximum number of retries for connections to the RADIUS server.

Int

RealmPrefix Realm Prefix for RADIUS Authentication server. String

RealmSuffix Retrieves the realm suffix for RADIUS authentication.

String

ServerTimeout Retrieves the server timeout (in seconds) for connections to the RADIUS server.

Int

SharedSecret Retrieves the shared secret of the RADIUS server. String

Resources

66

4.22 DtReportingManager

This interface represents a top level entry point to manage reporting features in Horizon DaaS Platform.

Scope: All

Links


AvailableReportDates Retrieves all available report dates for tenant organization (Tenant only)


CreateBillingReportFilter Creates an empty DtBillingReportFilter to retrieve billing reports

GET Action All

CreateConcurrentUsersFilter Creates a new filter to retrieve concurrent users report

GET Action SP

CreateReportFilter Creates a generic Report Filter GET Action All

CreateReportKey Creates a generic Report Key GET Action All

CreateUserEventReportFilter Creates a filter to help retrieve specific groups of user events

POST Action All

CurrentReportDate Retrieves the active cycle's report date in format yyyyMM

GET Action All

DownloadFile Downloads the reporting job user events file.

GET Action Tenant

DownloadVidmReport Downloads the vIDM logs. GET Action Tenant

DtReportingManager A link to this resource GET Self All

InitReportingJob Initiates User Event File Download Request.

POST Action Tenant

LastCompletedReportDate Retrieves last month's report date in format yyyyMM

GET Action All

MaxConcurrentUsersReport Retrieves the maximum concurrent users for a given DtConcurrentUsersFilter

POST Association SP

QuotaBillingReports Retrieves a list of the latest quota billing reports based on the given DtBillingReportFilter

POST Association SP

SuperTenantBillingReports Retrieves a list of super tenant billing reports based on the given DtBillingReportFilter


TenantReports Retrieves all tenant reports filtered by the given report filter


UserActivityReport Retrieves a list of DtUserEventReport objects which match the criteria in the specified filter.

POST Action All

UserEventReports Retrieves user event reports based on a given UserEventReportFilter

POST Action All

Properties

NA

Resources

67

4.22.1 DtBillingReportFilter

This interface represents a filter object that specifies the criterion to retrieve billing reports.

Scope: All

Links

NA

Properties


customerIds List of customer IDs to restrict the results while retrieving billing reports. This must be used only in conjunction with super tenants. The customer IDs are URL encoded. (Super Tenant only)

Collection of Strings

organizationIds List of organization IDs to restrict the results while retrieving billing reports. (Service Provider only)

Collection of Longs

4.22.2 DtConcurrentUsersFilter

This interface represents a filter object that specifies the criterion to retrieve concurrent users.

Scope: SP

Links

NA

Properties


beginDate The start date to filter concurrent users when retrieving reports within a time-window. The date should be in the format – “2013-06-14T12:00:00.000Z”

Date

endDate The end date to filter concurrent users when retrieving reports within a time-window. The date should be in the format – “2013-06-14T12:00:00.000Z”

Date

4.22.3 DtConcurrentUsersReport

This interface represents a report of the maximum number of concurrent users in a given time window.

Scope: SP

Links

NA

Properties


maxConcurrentUsersCount The count of the maximum number of users concurrently connected

Long

Resources

68

tenantExceptions A comma-separated string of tenant organization IDs that were not reachable at the time of computing the max concurrent users count

String

4.22.4 DtQuotaBillingReport

Service provider report that provides billing information related to quotas (desktop model quota, session quota, protocol quota and template quota).

Scope: SP

Links

NA

Properties


datacenterId datacenter ID pertaining to this report String

disabled Specifies if the organization is currently disabled Boolean

errorReport Specifies if this is an error report Boolean

inUseCount The count of the amount of quota in use by the organization

Long

organizationId Organization ID of the super tenant Long

protocolType The protocol type of this report, available only if the quotaType is DtQuotaBillingType.PROTOCOL

DtDisplayProtocol

quota Assigned quota to the organization for this quota type, -1 indicates unlimited quota

Long

quotaId The ID of the quota associated with this billing record, if applicable

String

quotaType The type of the quota for this record DtQuotaBillingType

refId Reference ID for this report String

snapShotId Retrieves the snapshot ID for this report. It is formatted as “YYYYMMddhhmm”

String

Resources

69

4.22.5 DtReportFilter

This interface represents a filter object that specifies the criterion to retrieve tenant reports.

Scope: All

Links

NA

Properties


reportKeys A collection of DtTenantReportKey instances that defines the filter

Collection of DtTenantReportKey

4.22.6 DtReportingStatusInfo

Handles reporting status events from user.

Scope: All

Links

NA

Properties


date Retrieves the date on which job was created. Date

endDate Retrieves the data. String

errorCode Retrieves the message on which job was created. String

id Retrieves the ID of the job. String

jobName Retrieves the name of the job. DtReportingJobName

percentageCompleted Retrieves the percentage of job completed. Long

startDate Retrieves the data. String

status Retrieves the request reporting status. DtReportingStatus

4.22.7 DtSuperTenantBillingReport

Collects billing data for super tenants by their customer ids.

Scope: All

Links

NA

Properties


customerId Sub-tenant customer ID pertaining to this record String

Resources

70

desktopCount List of desktop model to the in-use count of those desktop models by this customer in a super tenant. Count for each desktop model is wrapped within DtDesktopCountWrapper instances.

Collection of DtDesktopCountWrapper

organizationId Organization ID of the super tenant Long

sessionCount Count of the number of sessions allocated to this customer

Long

4.22.8 DtTenantReport

Tenant report for billing purposes. Each instance contains information about a single month’s activities.

Scope: All

Links


DtTenantReport A link to this resource GET Self All

Properties


desktopLoginCount Number of logins per (VDI) desktop Long

desktopRemoteAppLoginCount Number of remote application logins serviced by (VDI) desktops

Long

reportKey ReportKey containing the organization and the date of the report

DtTenantReportKey

sessionLoginCount Number of logins to session based desktops Long

sessionRemoteAppLoginCount Number of remote application logins served by session based desktop

Long

4.22.9 DtTenantReportKey

Specifies the organization ID and report date used to filter tenant reports.

Scope: All

Links

NA

Properties


orgId Unique ID of an organization Long

reportDate The report cycle month for a report in the format yyyyMM Integer

Resources

71

4.22.10 DtUserActivity

This interface represents a User Activity Event Report. It contains all the data pertaining to a specific user event. See DtUserEvent for the event types represented by this interface.

Scope: All

Links

NA

Properties


userEventReportCount Retrieves the count of user event reports. Long

userEventReports Retrieves a list of user event reports. Collection<DtUserEventReport>

userEventReportTotalCount Retrieves the total count of user event reports.

Long

4.22.11 DtUserEventReport

Contains data pertaining to a user event. See DtUserEvent for all supported event types.

Scope: All

Links


DtUserEventReport A link to this resource GET Self All

Properties


datacenterName Name of the datacenter where the event originated String

displayProtocol Display protocol associated with the event DtDisplayProtocol

endpointIPAddress IP address of the endpoint that originated this event String

endpointPlatformType Endpoint type DtEndpointPlatformType

eventError Error during the event, if any DtUserEventError

eventErrorDetails Details about the event error, if any String

virtualMachineName Name of virtual machine associated with the event String

patternId Pattern ID associated with this event String

poolName Name of the pool associated with the event String

remoteAppName Name of remote application associated with the event

String

reportTimestamp Timestamp of the report Date

userEvent Event type DtUserEvent

userGuid GUID of the user associated with the event String

virtualMachineId ID of virtual machine associated with the event String

Resources

72

vMSessionId The virtual machine session ID of this event, or ‘unavailable’ if there’s none

String

4.22.12 DtUserEventReportFilter

This interface represents a filter object that specifies the criterion to retrieve user event reports.

Scope: All

Links

NA

Properties


displayProtocol The display protocol to filter in the event reports DtDisplayProtocol

eventTypes List of DtUserEvent types to filter Collection of DtUserEvent

includePoolName Indicates whether the pool name will be included in the output.

Boolean

includeVirtualMachineName Indicates whether the virtual machine name will be included in the output.

Boolean

numberReportDays The number of report days from the current day (inclusive) to fetch. One day is interpreted as 24 hours from the current date and time.

Integer

patternId The pattern ID to filter String

poolId The pool ID to filter String

remoteAppName Name of the remote application to filter String

userGuid The GUID of the user to filter String

virtualMachineId The virtual machine’s UUID to filter String

4.23 DtReservationStatusManager

This interface represents a top level entry point to manage Reservation Status.

Scope: SP

Links


DtReservationStatusManager Link to this resource. GET Self

Properties

NA

Resources

73

4.23.1 DtReservation

This interface represents a reservation created in the system.

Scope: SP

Links


DtReservation Link to the resource. GET Self SP

Properties


dateCreated Retrieves date created for Reservation. Date

dateScheduled Retrieves date scheduled for reservation. Date

dateUpdated Retrieves when the reservation was updated. Date

id ID used by this reservation String

lifeState Possible values are:

LIFE_STATE_CREATED,

LIFE_STATE_RESCHEDULED,

LIFE_STATE_STARTED,

LIFE_STATE_RESTARTED,

LIFE_STATE_COMPLETED,

LIFE_STATE_CANCELED,

LIFE_STATE_PAUSED

String

name Retrieves the name used by this reservation. String

organizationId Retrieves organizationId for reservation. Long

resultState Possible values are:

RESULT_STATE_SUCCESSFUL,

RESULT_STATE_PARTIALLY_SUCCESSFUL,

RESULT_STATE_FAILED,

RESULT_STATE_UNKNOWN

String

resultStateDescription Retrieves a brief description of result state. String

taskPercentage Retrieves the overall task percentage for tasks. Integer

4.23.2 DtReservationFilter

This interface is used as a set of filtering criteria for retrieving reservations.

Scope: SP

Links

NA

Properties


beginDate Retrieves the start date to filter concurrent users when retrieving reports within a time-window.

Date

Resources

74

endDate Retrieves the end date to filter concurrent users when retrieving reports within a time-window.

Date

4.23.3 DtReservationTask

This interface represents a reservation task.

Scope: SP

Links


DtReservationTask Link to this resource. GET Self SP

Properties


applianceId Retrieves appliance ID used by reservation task. String

dateCreated Retrieves data created used by reservation task. Date

dateUpdated Retrieves data updated used by reservation task. Date

id Retrieves the ID used by this reservation task. String

lifeState Retrieves life state used by reservation task. String

reservationId Retrieves reservation ID used by reservation task. String

resultState Retrieves result state used by reservation task. String

resultStateDescription Retrieves result state used by reservation task. String

taskPercentage Retrieves task Percentage used by reservation task. Integer

type Retrieves type used by reservation task. String

userDefinition1 Retrieves user Definition 1 used by reservation task. String



Resources

75

4.24 DtSecurityManager

This interface represents a top level entry point to traverse the Horizon DaaS Platform security object model.

Scope: All

Links


AssignRole Assigns role to the list of admin groups.

PUT Action Tenant

CreateOrganization Creates a new organization. POST Action SP

CreateOrUpdateIdentityProvider Creates a new Identity Provider if the ID field is not populated and no MetaDataURL matches the requested setup. Updates an Identity Provider if the ID field is populated or an Identity Provider can be found with the MetaDataURL. Configures the Registered Tenant Address.

PUT Action Tenant

DefaultDomain Sets a default domain for the local appliance datacenter

PUT Action Tenant

DeleteIdentityProvider Removes the Identity Provider specified by the configuration ID.

GET Action Tenant

DtSecurityManager Link to this resource GET Self All

GetAgentSecurePairingMode Gets the policy on the appliances that controls if older agents are supported or not.

GET Action Tenant

GetAllAdminGroupsForRole Gets all the admin groups for a given role.

GET Action Tenant

GetAllTenantRoles Gets all the roles valid for tenant. GET Action Tenant

GetDomains Retrieves a collection of security domains

GET Association All

GetLocalAdminAccountEnabled Retrieves the local admin account status.

GET Action SP

GetLocalAdminAccountPassword Retrieves the tenant's local admin account password.

GET Action SP

GetServerCertificateByAddress Gets server certificate. GET Action SP

GetIdentityProviderConfigs Retrieves the registered Identity Providers and their Tenant Addresses.

GET Action Tenant

GetOrganizations Retrieves collection of all available organizations

GET Association All

GetTwoFactorAuthenticator Retrieves the Tenant's two factor authenticator.


GetUserById Retrieves a DtUser by its userId (GUID)

GET Action All

Resources

76

GetUsersByIds Retrieves multiple DtUsers by their userIds (GUID)

POST Map All

RegenerateCollectorWSCredentials This method regenerates the collector web service's secondary authentication credentials.

POST Action Tenant

RegisterDomain Registers a new domain to the local appliance's organization. The registration would enable authentication checks against the directory service specified in the domain. The first domain must be registered using the DtSystemManager’s RegisterDomain link.

POST Action All

RetrieveIdentityProviderTolerance Retrieves the Tolerance level in MS for Saml Authentication used by the DaaS Tenant.

GET Action Tenant

SaveDomainAdminGroupInfo Saves a domain's admin group info to the local appliance's organization.

POST Action Tenant

SaveDomainJoinInfo Saves the domain's join info. POST Action All

SetAgentPairingMode Sets the agent secure pairing mode.

PUT Action Tenant

SetLocalAdminAccountEnabled Enables and disables tenant's local admin account.

PUT Action Tenant

SetLocalAdminAccountPassword Assigns the tenant's local admin account password. Password length cannot be more than 512 characters.

POST Action Tenant

UpdateDomainGroupInfo Update a domain's group info with a list of added or deleted admin groups and user groups in the local appliance's organization.

POST Action Tenant

UpdateIdentityProviderTolerance Sets the Tolerance level in MS for Saml Authentication used by the DaaS Tenant.

GET Action Tenant

UploadCertificates Assigns the tenant's SSLCertificate, CACertificate, and SSLCertificateKey

PUT Action Tenant

Properties

NA

Resources

77

4.24.1 DtCertificate

This interface represents a certificate.

Scope: All

Links

NA

Properties


issuer Retrieves the issuer. String

notValidAfter Retrieves the notvalidafter date. Date

notValidBefore Retrieves the notvalidbefore date. Date

subject Retrieves the subject. String

thumbprint Retrieves the thumbprint. String

4.24.2 DtDomain

This interface represents a security domain.

Scope: All

Links


DtDomain A link to this Domain GET Self All

Groups Retrieves groups in this domain

GET Association All

GroupsMatchingSubstring Retrieves groups in this domain matching search string

GET Association All

GroupsMatchingSubstringFromCache Retrieves groups in tenant cache matching search string

GET Association All

PingTime Gives the current ping time to the given active directory.

GET Action Tenant

ReplaceDomainBindInfo Replaces the current domain bind data with a new domain bind data to the local appliance's organization.

POST Action All

Save Persist the properties of this domain

POST Action All

SaveImageOU Persists user defined ImageOU for NGVC in case of smart-node.

PUT Action Tenant

UserNames Retrieves the user login names registered in this domain.

GET Action Tenant

Resources

78

Users Retrieves the user account names registered in this domain

GET Association All

UserByLoginName Retrieves the user registered to this domain with the given login name

GET Action All

UsersMatchingSubstring Retrieves user registered to this domain matching search string

GET Association All

UsersMatchingSubstringFromCache Retrieves users internet cache matching search string

GET Association All

Properties


adminGroups A collection of groups with administrative privileges. Collection of DtGroup

contextRoot The context root of the directory server associated with this domain.

String

dateCreated The date the domain was created domain. String

directoryAccessPort The directory server access port for this domain. String

directoryAccessProtocol The directory access protocol of this domain. String

directoryServerIps A list of directory server IPs used by this domain Collection of String

directoryServerName The directory server name of this domain String

dnsServers The list of DNS servers for this domain String

domainSuffix The domain suffix String

lastUpdated The date the domain was last updated String

maxQueryRange The maximum number of attributes returned when doing an LDAP query in this domain

String

name The name of the Domain String

serviceAccounts A collection of service accounts of the domain on the directory server

Collection of DtDomainAccount

sysPrepAccounts A collection of accounts used to prepare images for virtual desktop creation

Collection of DtDomainAccount

userGroups A collection of groups with user privileges Collection of DtGroup

Resources

79

4.24.2.1 DtDomainAccount

This interface represents an account used by a domain, containing information, such as unique identifier and the password.

Scope: All

Links

NA

Properties


type The type of this domain account DtDomainAccountType

4.24.2.2 DtGroup

This interface represents a security group with a role that can be assigned to users to give them privileges.

Scope: All

Links


AssignPool Assigns this group to a desktop pool PUT Action Tenant

DtGroup A link to this resource GET Self All

RemovePool Removes a desktop pool assignment from this group

PUT Action Tenant

UpdateTenantRole Updates a role for a give admin group. PUT Action Tenant

Properties


domainName The container security domain name of this group, for example DEV

String

name The name of the group, for example cn=enterprise admins,cn=users

String

role A set of permissions or privileges that can be assigned to a group. There is a one-one association between a group and a role

DtRole

4.24.2.3 DtRole

This interface represents a set of permissions or privileges that can be assigned to a group.

Scope: All

Links


DtRole A link to this resource GET Self All

Resources

80

Properties


creationDate The date of creation of the role String

lastUpdate The date of the last update to the role String

name The name of the role String

permissions The permissions that a group of users possess when this role is assigned to the group

String

4.24.2.4 DtUser

This interface represents a security domain user. A user or its group is typically assigned to a desktop pool that serves the virtual desktop for the user. However, a user may or may not have an active session. And a user may or may not have an associated virtual machine.

Scope: All

Links


AssignPool Assigns this user to a desktop pool PUT Action Tenant

AssignStaticDesktop Assigns a virtual desktop to this user

PUT Action Tenant

DtUser A link to this resource GET Self All

GetDefaultMapping Retrieves this user’s default desktop pattern or pool


GetDesktopPatterns Retrieves the desktop patterns assigned to this user


GetDesktopPools [Deprecated]

Retrieves the desktop pools assigned to this user


GetDisplayProtocol Retrieves the display protocol preference of this group for the given desktop pattern

GET Action Tenant

GetPools Retrieves the pools assigned to this user


GetRoleOfUser Retrieves role of the given user. GET Action Tenant

RemovePool Removes a desktop pool assignment from this user

PUT Action Tenant

RemoveStaticDesktop Removes a virtual desktop assigned to this user

PUT Action Tenant

SetDefaultMapping Assigns the default pattern or pool to be used for desktops associated with this user

PUT Action Tenant

SetDisplayProtocol Assigns the given protocol as a preferred display protocol for this user

PUT Action Tenant

Resources

81

UpdateStaticDesktopAssignment Updates the static desktop mapping of a user from an existing assignment to a new static desktop

PUT Action Tenant

Properties


domainName The security domain of the user, for example DEV String

loginName The name used by the user to login String

userDn The LDAP distinguished name of the user String

4.24.3 DtDomainGroupInfo

This interface gets and sets information for user and admin groups in a domain.

Scope: Tenant

Links

NA

Properties


addedAdminGroups Collection of newly deleted groups with administrative privileges

Collection<DtGroup>

addedUserGroups Collection of newly deleted groups with user priv. Collection<DtGroup>

deletedAdminGroups Collection of newly added groups with user priv. Collection<DtGroup>

domainName Collection of newly added groups with administrative privileges

Collection<DtGroup>

4.24.4 DtIdentityProviderConfig

This interface represents an identity provider configuration.

Scope: Tenant

Links

NA

Properties


dataCenterId Retrieves the datacenter associated with this Identity Provider. String

id Retrieves Identity Provider ID. String

timeout Assigns the DaaS Tenant address registered with VIDM instance. This should be the Floating IP of Tenant or Access point.

Int

tenantAddress Retrieves the DaaS Tenant address registered with VIDM instance. String

Resources

82

vidmStatus Retrieves the vIDM status of the Identity Provider. Boolean

workspaceAddress Timeout in MS for connecting to VIDM Service during configuration. String

4.24.5 DtOrganization

This interface represents a completely separate business entity with its own set of resources.

Scope: All

Links


CreateInternalNetwork Creates a new internal network. POST Action SP

DeleteInternalNetwork Deletes an internal network. DELETE Action SP

DtOrganization A link to this resource GET Self All

GetAdminContact Retrieves the administrative contact of this organization.

GET Action Tenant

GetAllAppliances Retrieves all appliances for the organization

GET Action SP

GetDesktopModelQuotas A list of desktop model quotas available to this organization

GET Association All

GetOrganizationById Returns an organization for specified ID

GET All

GetTechnicalContact Retrieves the technical contact of this organization

GET Action Tenant

RetrieveInternalNetworks Retrieves the internal networks for the organization

GET Action SP

RetrieveMaxConcurrentRefresh Retrieves the organization max concurrent refresh value i.e., maximum number of concurrent VMs that can be refreshed as part of a Dynamic Pool Refresh as configured by the Service Provider.

PUT Action SP

SaveAdminContact Saves the admin contact information PUT Action Tenant

SaveMaxConcurrentRefresh Updates max concurrent refresh i.e., maximum number of concurrent VMs that can be refreshed as part of a Dynamic Pool Refresh as configured by the Service Provider.

PUT Action SP

SaveTechnicalContact Saves the technical contact information

PUT Action Tenant

Properties


adminContact The administrative contact of this organization (consists of email address, name, and phone number)

DtContact

brandedCSSURL The URL to the CSS file used for this specific organization String

Resources

83

businessUrl The business URL of this organization String

crmURL The Customer Relationship Management URL of this organization

String

customFields All custom fields in a key-value pair specific to this organization

Map of String

dateCreated The date the organization was created, for example 2011-09-01T20:04:27.207Z

String

dateUpdated The date the organization was last updated, for example 2011-09-01T20:04:27.207Z

String

disabled Specifies if this organization is disabled Boolean

diskQuota The disk quota of this organization Integer

helpDesk The help desk contact of this organization DtContact

jmxPassword The password used to use the dt-console JMX application for this organization

String

licenseFileURL The URL to the license file used for this specific organization.

String

name The name of this organization. String

superTenant Specifies if the organization is a super tenant Boolean

support The support contact of this organization DtContact

supportURL The support URL of this organization. String

technicalContact The technical contact of this organization. DtContact

vmQuota The virtual machine quota for this organization. Integer

4.24.5.1 DtContact

Contact details for various functions in an organization, such as admin and support.

Scope: All

Links

NA

Properties


cellPhone The contact name String

email The contact email address String

name The contact name String

phone The contact phone String

Resources

84

4.24.6 DtRoleAssignConfig

This interface represents a RoleAssignConfig resource that specifies parameters required to assign a role.

Scope: Tenant

Links

NA

Properties


adminGroups Retrieves the list of admin groups. Collection<String>

domainName Retrieves the name of the domain. String

roleName Retrieves the name of the role. String

4.24.7 DtTwoFactorAuthenticator

This interface represents the top level two factor authentication.

Scope: Tenant

Links


DtTwoFactorAuthenticator Link to this resource. GET Self Tenant

GetRSASecurIDAuthenticator Retrieves the RSA SecurID Configuration service.


RADIUSAuthenticator Retrieves the RADIUS Configuration service.


Update Updates the current two factor authenticator configuration.

PUT Action Tenant

Properties


requiredForExternalLoginOnly Indicates whether two factor authentication is required for external connections only.

Boolean

type The currently configured two factor authentication type.

String

usernameMatchingRequired Indicates whether username matching is required. Boolean

Resources

85

4.25 DtSessionManager

This interface represents a top level entry point to manage active sessions.

Scope: Tenant

Links


ActiveSessions Retrieves a collection of active sessions based on the criterion in the filter. DtSessionFilter must be posted as an argument.

POST Action Tenant

CountIdleSessions Counts the number of sessions who have been idle for at least idleTime

GET Action Tenant

CreateSessionCountFilter Retrieves a session count filter which reduces the number of methods in FabricDelegate.

GET Action Tenant

CreateSessionFilter Creates a session count filter which reduces the number of methods in FabricDelegate

GET Action Tenant

CountSessions Retrieves Long off all active sessions POST Action Tenant

Disconnect Disconnects an active session (URL parameter is sessionId)

POST Action Tenant

Logoff Logs off an active session (URL parameter is sessionId)

POST Action Tenant

Properties

NA

4.25.1 DtActiveSession

This interface represents all active sessions by user, pattern and user, pool and session host.

Scope: Tenant

Links


DtActiveSession Link to this resource GET Self Tenant

Properties


base64Id The base 64 ID for the session String

connectionType Connection type for the session String

domain Domain for the session String

elementId Element ID for the session String

lastActiveTime The last active time for the session Date

Resources

86

loginStatus Login status for the session String

loginTime Login time for the session Date

patternId Pattern ID for the session String

userId User ID for the session String

vmId VM ID for the session String

vmName VM name for the session String

4.25.2 DtSessionCountFilter

Filtering criteria for session count information.

Scope: Tenant

Links

NA

Properties


connectionType Connection type for this filter String

loginStatus Login status for this filter String

patternType Pattern type for this filter String

sessionBased Determines how sessions must be counted – desktop based only/session based only/both

Boolean

4.25.3 DtSessionFilter

Filtering criteria for session information.

Scope: Tenant

Links

NA

Properties


poolId Pool ID for this session filter Long

userId User ID for this session filter String

vmId Desktop Manager ID for this session filter String

Resources

87

4.26 DtSettingsManager

This interface represents a top level entry point to retrieve feature setting configurations and other setting information.

Scope: Tenant

Links


ChangeBlastClient Changes the Blast client in use.

PUT Action Tenant

ClientTimeoutConfig Retrieves the client timeout values.


GetFeatureSetting Gets the feature setting for the requested feature

GET Action Tenant

GetMinimumDaaSAgentVersionForGoldPatternConversion The minimum DaaS agent version required for gold pattern conversion

GET Action Tenant

RegisterClientTimeoutConfig Registers the updated client timeout values.

POST Action Tenant

RestoreDefaultClientTimeoutConfig Restores the default value of client timeout based on passed parameter.

PUT Action Tenant

SetSecondaryDataCenterIPAddress Assigns the given IP Address to the specified Data Center ID.

PUT Action SP

SetTenantPortalConfig Assigns the TenantFabric Config to rest client.

POST Action Tenant

SetUserPortalSessionTimeout Assigns a new user portal session timeout value.

POST Action Tenant

TenantPortalConfig Retrieves the TenantFabric configuration to the rest client.


ToggleBlastClientCredentialCleanup Enables/Disables Access client credential cleanup feature.

PUT Action Tenant

Resources

88

UserPortalSessionTimeout Retrieves user portal session timeout value.


Properties

NA

4.26.1 DtClientTimeoutConfig

This interface represents a ClientTimeoutConfig resource that specifies tenant client timeout values.

Scope: Tenant

Links

NA

Properties


brokerTimeoutInMinutes Broker time out interval Long

clientActivityHBInMinutes Activity heart beat interval Long

clientIdleTimeoutInMinutes Client idle time out interval Long

4.26.2 DtFeatureSetting

This interface represents a feature's enablement and settings. Specifically, this interface tells the caller whether certain features are enabled and if so whether they are required.

Scope: Tenant

Links

NA

Properties


enabled Specifies if the feature is enabled for use Boolean

featureName Feature Name associated with this setting.

Value can be: NON_DEFAULT_BLAST_CLIENT, POOL_NETWORK_MAPPING, SOFT_3D_GRAPHICS

String

required Specifies if the feature is a required component Boolean

Resources

89

4.26.3 DtTenantPortalConfig

This interface represents a TenantConfig model that provides information about a Tenant's user portal Configuration.

Scope: Tenant

Links

NA

Properties


adminEmail Retrieves the Admin - Helpdesk email. String

dateCreated Retrieves the date created. Date

dateUpdated Retrieves the date updated Date

externalCssUrl Retrieves the external style sheet URL. String

orgId Retrieves the organization ID. Long

ticketSystemUrl Retrieves the Trouble Ticket System URL. String

4.26.4 DtTenantPortalTimeout

This interface contains methods used to handle the portal settings.

Scope: Tenant

Links

NA

Properties


userPortalSessionTimeoutInMinutes Portal session timeout in minutes Integer

4.27 DtSystemManager

Represents Horizon DaaS Platform and provides various miscellaneous functionality and information about the current installation.

Scope: All

Links


BootStrapFile Returns the bootstrap file. POST Action Tenant

Certificate Returns the tenant certificate GET Action Tenant

DtSystemManager Link to this resource GET Self All

Resources

90

Login Performs basic authentication and includes the "Authorization" http header in the response that must be included in all http requests to secure resources and all REST API invocations

POST Action All

Logout Terminates any session associated with a previous login

DELETE Action All

PlatformInformation Retrieves Horizon DaaS Platform information including the supported versions by the platform

GET Top All

RegisterDomain Registers the first domain to the local appliance's organization. The registration would enable authentication checks against the directory service specified in the domain. This call does not require the user to be authenticated as no domain exists at the time of invocation. Domain registration using this method is disallowed if a domain already exists for the organization. In that case, use the authenticated invocation DtSecurityManager’s RegisterDomain.

POST Action All

SystemVersionInformation Gets the version information on the current system.

GET Top All

TermsOfService Gets the terms of service. GET Top Tenant

UpdateAppStacksPrefixRegex Updates regex for AppStacks assignment.

PUT Association All

UpdateDatastoreRegex Updates regex for datastore for each element.

PUT Association All

Properties

NA

4.27.1 DtPlatform

The DtPlatform resource is the entry point for the API, accessed by the URI /system/platform. Once you login, the first HTTP request you make should access the URI /system/platform.

Scope: All

Links

NA

Properties


defaultDomain Default domain String

Resources

91

domainNames Collection of domain names registered to this organization for this data center

Collection

version Collection of versions Collection

4.27.2 DtSystemVersion

Version information on the system.

Scope: All

Links

NA

Properties


appVersion Appliance version of the system String

buildDate Build date of the system String

buildInfo Build information of the system String

buildNumber Build number of the system int

majorVersion Major version of the system int

minorVersion Minor version of the system int

patchVersion Patch version of the system int

releaseName Name of the release running on the system String

svnId SVN ID of the system String

version Full version of the system String

4.27.3 DtTermsOfService

Information related to whether the logged in user has accepted the terms of service.

Scope: Tenant

Links


Accept Accept the current terms of service PUT Action Tenant

DtTermsOfService Link to this resource GET Self Tenant

Properties


accepted Indicates whether the logged in user has accepted the terms of service

Boolean

url URL of the terms of service (or null if no terms of service are specified)

String

Resources

92

4.28 DtTaskManager

This interface represents a task manager.

Scope: Tenant

Links


CreateTaskFilter Creates an empty Task Filter GET Action Tenant

Tasks Retrieves all tasks that match the specified filter


Properties

NA

4.28.1 DtTaskFilter

This interface filters tasks returned by DtTaskManager.

Scope: Tenant

Links

NA

Properties


fromDate Earliest date from which tasks should be returned Date

limit Maximum number of tasks to be returned Int

poolId Pools for which tasks should be returned Long

taskStatus Task statuses for which tasks should be returned Collection

toDate Latest date from which tasks should be returned Date

Enumerated Data Types

93

5 Enumerated Data Types

This chapter lists the enumerated types that are the legal values for certain resource attributes.

5.1 DtAgentInstallModeEnum

This class is the REST counterpart of fabric's AgentInstallModeEnum. As a result, the value here should match with fabric's AgentInstallModeEnum, with the exception of UNINITIALIZED. Otherwise, DtPoolAgentUpdateImpl::getInstallMode() will throw a run time exception. Values are described below.

5.2 DtAgentUpdateStateEnum

This class is the REST counterpart of fabric's AgentUpdateStateEnum. As a result, the value here should match with fabric's AgentUpdateStateEnum, with the exception of UNINITIALIZED. Otherwise, DtPoolAgentUpdateImpl::getUpdateState() will throw a run time exception. Values are described below.

5.3 DtApplianceType

Specifies type of appliance. Values are described below.

Value Description

AT_LOGOFF Install agent at logoff

INSTALL_NOW Install agent now

SCHEDULED Install agent at scheduled time

UNINITIALIZED Value returned for all updates when the Admin has not taken any action.

Value Description

APPROVED Agent install approved

AVAILABLE Agent install available

DECLINED Agent install declined

UNINITIALIZED Value returned for all updates when the Admin has not taken any action.

Value Description

APPLIANCE_TYPE_EMGR Element Manager

APPLIANCE_TYPE_RMGR Resource Manager

APPLIANCE_TYPE_SP Service Provider

APPLIANCE_TYPE_TENANT Tenant


94

5.4 DtAuthenticationStepType

Specifies type of authentication step. Values are described below.

Name Description

CREDENTIALS Credentials

RADIUS_CHALLENGE RADIUS challenge

RADIUS_PASSCODE RADIUS passcode

RSA_SECURID_NEXT_TOKEN RSA SecurID next token

RSA_SECURID_PASSCODE RSA SecurID passcode

RSA_SECURID_PIN_CHANGE RSA SecurID pin change

5.5 DtColorDepth

Specifies color depth (bits per pixel). Values are described below.

5.6 DtComputePoolType

Represents the list of compute pool types that can be discovered by Horizon DaaS Platform.

Properties

Name Description

ESX Direct ESX hypervisor host

VCENTER_CLUSTER vCenter cluster

VCLOUD_VDC vCloud virtual datacenter

5.7 DtDaaSAgentState

Specifies the state of the DaaS Agent for a VM DaaS Agent.

Values are described below.

Value Description

BPP_16 16 bit per pixel color



Value Description

ACTIVE Agent is online and active on the VM.

INACTIVE Agent is inactive on the VM.

UNKNOWN Agent state cannot be determined, agent may be offline or never have logged in.


95

5.8 DtDeploymentType

Specifies type of deployment. Values are described below.

5.9 DtDisplayProtocol

Represents the list of display protocols that can be used to access virtual desktops from remote clients. Values are described below.

Properties

Name Description

BLAST Vmware HTML5 Integration

RDP Remote desktop protocol

PCOIP Vmware PCoIP Integration

OTHER Other protocol

UNKNOWN Unknown protocol

5.10 DtDomainAccountType

Specifies the domain’s account type. Values are described below.

5.11 DtEndpointPlatformType

Represents the platform types of the endpoint (end-user) device used to access a virtual desktop or remote application. Values are described below.

Value Description

DAAS_SP Service provider deployment

DAAS_TENANT Tenant deployment

INVALID_DEPLOYMENT_TYPE Invalid deployment type

SMART_NODE_ORCHESTRATION SmartNode deployment

Value Description

SERVICE Service account

SYS_PREP Sysprep account

Value Description

ANDROID Android

IOS iOS

LINUX Linux

MAC Mac

OTHER_MOBILE Other mobile

OTHER_NON_MOBILE Other non-mobile


96

5.12 DtError

This represents the available error codes to be transmitted as a custom HTTP header in the response to the client. Values are described below.

Name Description

DT_7ZIP_ERROR 7zip command execution failed.

DT_ADMIN_GROUP_LIST_EMPTY Admin group is null or empty.

DT_ADMIN_GROUP_LIST_INVALID Admin group list is invalid.

DT_ADMIN_GROUPS_RETRIEVE_ERROR Platform is unable to retrieve admin groups for a given role.

DT_AGENT_VERSION_ERROR Gold pattern is invalid because the DaaS Agent version is too old.

DT_APPLIANCE_IP_INVALID Appliance IP is invalid or null.

DT_APPLIANCE_NAME_INVALID Appliance name is invalid or null.

DT_APPLIANCE_RESERVATION_CONDITION_ERRORS

Appliance reservation creation has failed due to conditional errors.

DT_APPLIANCE_RESERVATION_CREATION_

FAILED

Appliance reservation creation has failed.

DT_APPLIANCE_RESTORE_ERROR Error(s) occurred setting up the reservation and reservation tasks to restore the appliance.

DT_APPLIANCE_TYPE_INVALID Appliance name is invalid or null.

DT_APPLIANCES_EXIST_ON_NETWORK Appliances exist on the network you are attempting to delete.

DT_APPLICATION_NOT_FOUND At least one application ID specified could not be found in the application catalog for the associated image.

DT_APPLICATION_NOT_IN_APP_CATALOG Application(s) specified for pool creation/update were not in the gold pattern's app catalog.

DT_APPLICATION_NOT_IN_REMOTEAPP Application is not a remote application.

DT_AUTHENTICATION_FAILURE Invalid credentials provided during a restricted resource access or when trying to log in.

DT_AUTHENTICATION_REQUIRED Local or other admin account authentication is not done for non-smart nodes.

DT_BACKUP_INFO_RETRIEVAL_FAILED Backup info retrieval has failed.

DT_BRANDED_CSS_URL_INVALID Branded CSS URL is invalid.

DT_BUSINESS_URL_INVALID Business URL is invalid.

THIN_CLIENT Thin-client

UBUNTU Ubuntu

UNKNOWN Unknown

WINDOWS Windows


97

Name Description

DT_CANNOT_MIGRATE_DELETED_PATTERN A deleted pattern ID has been entered during a desktop migration request.

DT_CERT_ERROR A generic certificate error has occurred.

DT_CLIENT_SESSION_TIMEOUT_CONDITION_

FAILED

Client session timeout condition failed.

DT_CONTEXT_ROOT_EMPTY Context root is either null or empty.

DT_CONTEXT_ROOT_LENGTH_EXCEEDED Context root length exceeds 1000.

DT_CONVERT_GP_AGENT_NOT_ACTIVE Gold pattern conversion cannot proceed due to the DaaS Agent not having signed on or sent a heartbeat in the last minute.

DT_CONVERT_GP_INVALID_OS Gold pattern conversion failed due to an incompatible guest OS.

DT_CONVERT_GP_INVALID_POOL_STATE_

REFRESHING

Gold pattern conversion failed due to one or more dynamic pool refreshes running which utilize the given gold pattern.

DT_CONVERT_GP_INVALID_POWER_STATE Gold pattern conversion cannot proceed due to an invalid power state (not ON).

DT_CONVERT_GP_INVALID_TOOLS_STATE Gold pattern conversion cannot proceed due to an invalid VM tools state.

DT_CONVERT_GP_MISSING_COMPUTE Gold pattern conversion cannot proceed due to no associated compute resource (host).

DT_CREATE_DIRECTORY_ERROR Failure while creating a directory.

DT_CREATE_FILE_ERROR Failure while creating file.

DT_CREATE_USR_DEF_APP_FILE_PATH_EXISTS Request to create a User Defined Application cannot be fulfilled due to unique file path, pattern version, image ID constraint violation.

DT_CREATE_USR_DEF_APP_FILEPATH_TOO_

LONG

Request to create a User Defined Application fails because the Application filepath is too long.

DT_CREATE_USR_DEF_APP_IMAGE_HAS_NO_CATALOG

Request to create a User Defined Application fails because no Application catalog exists for the Image.

DT_CREATE_USR_DEF_APP_NAME_TOO_

LONG

Request to create a User Defined Application fails because the Application name is too long.

DT_CREATE_USR_DEF_APP_NO_CATALOGS_

FOUND

Request to create a User Defined Application fails because no application catalogs exist.

DT_CRM_URL_INVALID CRM URL is invalid.

DT_CSRF_ERROR CSRF filter found a problem with the expected CSRF token.

DT_DATA_CENTER_NAME_INVALID Data center name is empty or invalid.

DT_DATACENTER_FAILOVER_FAILED Failover of datacenter failed.

DT_DATACENTER_ID_INVALID Data center ID is invalid.

DT_DATACENTER_LOOKUP_ERROR Data center lookup failed.

DT_DEFAULT_PROTOCOL_UNSPECIFIED Default display protocol is not specified in a pool.


98

Name Description

DT_DESKTOP_MANAGER_OFFLINE System unable to communicate with the Desktop Manager as none are ONLINE.

DT_DESKTOP_MANAGER_RETRIEVAL_FAILED Desktop manager associated with the gold pattern or pool cannot be found.

DT_DESKTOP_MIGRATION_FAILED Requested desktop migration fails due to an unknown error

DT_DESKTOP_MODEL_RETRIEVAL_FAILED Desktop model retrieval fails.

DT_DIRECTORY_ACCESS_PORT_EMPTY Directory access port is either null or empty.

DT_DIRECTORY_ACCESS_PORT_LENGTH_

EXCEEDED

Directory access port length exceeds 6.

DT_DISPLAY_PROTOCOL_NOT_FOUND Display protocol for an entity could not be found.

DT_DNS_SERVERS_INVALID DNS servers is empty or invalid.

DT_DOMAIN_ACCOUNT_IS_NULL Can be reported when Image OU is updated for a given sysprep account/domain.

DT_DOMAIN_ACCOUNT_TYPE_IS_NULL Can be reported when Image OU is updated for a given sysprep account/domain.

DT_DOMAIN_ADMIN_GROUP_NAME_

DUPLICATE

Domain group you are attempting to save is has a duplicate administrator group name.

DT_DOMAIN_ADMIN_GROUP_NAME_

REQUIRED

Domain group you are attempting to save does not have an administrator group name.

DT_DOMAIN_ADMIN_GROUP_REQUIRED Domain group info you are attempting to save does not have any administrator group.

DT_DOMAIN_ADMIN_GROUP_ROLE_

REQUIRED

Domain administrator group you are attempting to save does not have any roles binded.

DT_DOMAIN_BIND_REPLACE_ERROR Error(s) occurred when replacing a security domain bind data for an organization.

DT_DOMAIN_INVALID_ADMIN_GROUP In the domain group info you are attempting to save/register, administrator group is invalid.

DT_DOMAIN_INVALID_ADMIN_GROUP_ROLE In the domain group info you are attempting to save/register, administrator group role is invalid.

DT_DOMAIN_INVALID_USER_GROUP In the domain group info you are attempting to save/register, user group is invalid.

DT_DOMAIN_JOIN_ERROR_OTHER Unexpected error occurred while saving domain join information.

DT_DOMAIN_JOIN_NO_DNS_SERVER_

ENTERED

No DNS servers were passed.

DT_DOMAIN_JOIN_PASSWORD_REQUIRED Domain join password is empty.

DT_DOMAIN_JOIN_SECONDARY_DNS_SERVER_SAME_AS_PRIMARY

Secondary DNS server's IP address is the same as the primary DNS server's.

DT_DOMAIN_JOIN_TOO_MANY_DNS_SERVERS More than 2 DNS servers were passed.

DT_DOMAIN_JOIN_USER_AUTHENTICATION_FAILURE

User cannot be authenticated because of incorrect username/password.


99

Name Description

DT_DOMAIN_JOIN_USER_INSUFFICIENT_

PRIVILEGES

User does not have sufficient privileges.

DT_DOMAIN_JOIN_USERNAME_MAX_

LENGTH_EXCEEDED

Length of username is greater than 1024.

DT_DOMAIN_JOIN_USERNAME_REQUIRED Domain join username is empty.

DT_DOMAIN_LOOKUP_ERROR Domain lookup failure.

DT_DOMAIN_NAME_EMPTY Domain name is either null or empty.

DT_DOMAIN_NAME_LENGTH_EXCEEDED Domain name length exceeds 15.

DT_DOMAIN_REGISTER_ERROR Error while registering a security domain for an organization.

DT_DOMAIN_REQUIRED At least one domain must be registered to perform the specified operation.

DT_DOMAIN_SAVE_GROUP_INFO_ERROR Error while saving domain group info.

DT_DOMAIN_SUFFIX_EMPTY Domain suffix is either null or empty.

DT_DOMAIN_SUFFIX_LENGTH_EXCEEDED Domain name length exceeds 500.

DT_DOMAIN_USER_GROUP_NAME_

DUPLICATE

Domain group you are attempting to save has duplicate user group name.

DT_DOMAIN_USER_GROUP_NAME_REQUIRED Domain group you are attempting to save does not have any user group name.

DT_DUPLICATE_CONTEXT_ROOT Domain is registered with duplicate context root.

DT_DUPLICATE_DOMAIN_NAME Domain name already exists.

DT_DUPLICATE_POOL_NAME Pool name specified duplicates that of another pool.

DT_DUPLICATE_VM_ROOT_NAME VM root name of a pool duplicates that of another pool.

DT_ELEMENT_LOOKUP_ERROR No element found for at least one of the input pattern IDs.

DT_ERROR_CMDLINEPARAM Error in API that handles command line parameters.

DT_ERROR_GETCMDLINE_PARAM Error while setting command line parameter for a remote application.

DT_ERROR_SETCMDLINE_PARAM Error while setting command line parameter for a remote application.

DT_EXPIRED_USER_CREDENTIALS User's last contact time is too old or the login has expired.

DT_FAILED_TO_REGENERATE_CREDENTIALS Failure in regenerating the collector web service's credentials.

DT_FAILED_TO_RETRIEVE_AGENT_PAIRING_MODE

Failure while retrieving the tenant's agent pairing mode.

DT_FAILED_TO_SET_AGENT_PAIRING_MODE Failure while setting the tenant's agent pairing mode.


100

Name Description

DT_FAILED_TO_TRANSMIT_APP_CHANGES System could not transmit the application updates to the created VMs.

DT_FAILED_TO_UPDATE_ELEMENT_ERROR Failure to update information on Element.

DT_FEATURE_DISABLED Feature support is not present in the appliance.

DT_FILE_WRITE_ERROR Failure while writing to file.

DT_FLOATING_IP_INVALID Floating IP is invalid or null.

DT_GOLD_PATTERN_DATACENTER_NOT_FOUND

Datacenter of a specified gold pattern cannot be retrieved.

DT_GOLD_PATTERN_DISABLED Unable perform operation; Gold pattern must be enabled to perform this task.

DT_GOLD_PATTERN_GRAPHICS_SETTING_UNSUPPORTED

Gold pattern is invalid because it has 3D graphics enabled, but the tenant is not enabled for the 3D functionality.

DT_GOLD_PATTERN_IN_USE Request cannot be completed as the gold pattern is actively used by a pool.

DT_GOLD_PATTERN_POWERED_ON_OR_REQUIRES_RESEAL

Gold pattern is either powered on or requires resealing.

DT_GOLD_PATTERN_VIRTUAL_MACHINE_NOT_FOUND

Specified gold pattern virtual machine cannot be found.

DT_GP_BACKUP_OPERATION_FAILED Gold pattern backup operation failed.

DT_GP_DELETE_BACKUP_OPERATION_FAILED Deletion of gold pattern backup operation failed.

DT_GP_ROLLBACK_OPERATION_FAILED Gold pattern rollback failed.

DT_GRAPHICS_UNSUPPORTED Pool creation or update fails due to the 3D graphics feature not having been enabled.

DT_GROUP_NOT_FOUND One of the specified user groups cannot be found.

DT_ILLEGAL_CHANGE_REFRESH Size change has been attempted on a pool that is currently being refreshed.

DT_ILLEGAL_CUSTOMER_ID Customer ID property of a pool is specified, but the tenant is not configured as a Super-Tenant.

DT_ILLEGAL_DESKTOP_MOVE_DC_ID Pattern and pool have incompatible datacenter IDs.

DT_ILLEGAL_DESKTOP_MOVE_INVALID_TYPE Requested desktop move is invalid.

DT_ILLEGAL_DESKTOP_MOVE_MISMATCH_ELEMENT

Destination pool's element ID doesn't match that associated with the patternId.

DT_ILLEGAL_DESKTOP_MOVE_MODEL_MISMATCH

Desktop model IDs do not match for pools.

DT_ILLEGAL_DESKTOP_MOVE_NETWORK_MISMATCH

Network ID of VM to migrate does not match that of destination pool.

DT_ILLEGAL_DESKTOP_MOVE_RESTORATION DT_ILLEGAL_DESKTOP_MOVE_RESTORATION is reported when an illegal desktop restoration is requested

DT_ILLEGAL_FULL_DESKTOP Unable to set Full Desktop allowed with Remote Applications populated.


101

Name Description

DT_ILLEGAL_GP_CHANGE Specified gold pattern cannot be used for a pool update because it is not managed by the same Desktop Manager.

DT_ILLEGAL_GRAPHICS_CHANGE Error during attempt to change the 3D graphics setting for the pool.

DT_ILLEGAL_REMOTE_APP_CHANGE_GP_

VERS

Changing Remote Applications is not allowed without an RDS Server refresh due to App Catalog changes.

DT_ILLEGAL_SIZE_CHANGE_TASK_CONFLICT Pool shrink and expansion are attempted or in progress simultaneously on the same pool.

DT_ILLEGAL_SIZE_CHANGE_USERS_LOGGED_IN

Attempt to shrink pool is rejected due to an insufficient number of unallocated VMs or sessions (that is, too many VMs or sessions are in use).

DT_IMAGE_OU_NAME_IS_NULL_OR_EMPTY This error can be reported when Image OU is updated for a given sysprep account/domain.

DT_IMAGE_OU_UPDATE_FAILED This error can be reported when Image OU is updated for a given sysprep account/domain.

DT_INCOMPATIBLE_GOLD_PATTERN_OS_

TYPE

Specified gold pattern OS is not compatible with the specified pool type (for example, when a non-Windows Server OS is on the gold pattern specified for a session pool).

DT_INCOMPATIBLE_POOL_DISK_PERSISTENCE_TYPE

Pool's disk persistence setting is not compatible with the pool type (for example, a session pool cannot be created with a non-persistent disk setting).

DT_INCOMPATIBLE_REMOTE_PROTOCOL One or more of the specified protocols is not compatible with the specified pool type (for example, when a non-session protocol such as VNC is specified for a session pool).

DT_INPUT_LENGTH_EXCEEDED Attempt has been made to save or update a field with more data than its limit (for example, 256 characters).

DT_INSUFFICIENT_COMPUTE_CAPACITY Available host capacity is insufficient to satisfy the provisioning request.

DT_INSUFFICIENT_DESKTOP_MODEL_QUOTA Remaining desktop model quota is insufficient to satisfy the pool provisioning request.

DT_INSUFFICIENT_PROTOCOL_QUOTA Protocol quota remaining for one or more selected protocols is insufficient to satisfy the pool provisioning request.

DT_INSUFFICIENT_TEMPLATE_QUOTA Remaining template quota is insufficient to satisfy the reserve request.

DT_INVALID_APPLIANCE_ID Appliance ID is not valid.

DT_INVALID_BACKUP_ID Backup ID is invalid.

DT_INVALID_CLIENT_SESSION_TIMEOUT_

VALUE

Client session timeout value in not correct.


102

Name Description

DT_INVALID_CMDLINE_INPUT Local or other admin account authentication is not done for non-smart nodes.

DT_INVALID_CONTACT_NAME Contact name is not valid.

DT_INVALID_CONTEXT_ROOT Context root entered is not valid.

DT_INVALID_CUSTOMER_ID Customer ID for the pool is invalid (if the tenant is a Super Tenant).

DT_INVALID_DESKTOP_MODEL_ID Desktop model ID is invalid.

DT_INVALID_DIRECTORY_ACCESS_PORT Access port entered is not valid.

DT_INVALID_DIRECTORY_ACCESS_

PROTOCOL

Access protocol entered is not valid.

DT_INVALID_DOMAIN Either the domain name is invalid, or it cannot be found as a registered domain.

DT_INVALID_DOMAIN_NAME Domain name entered is not valid.

DT_INVALID_DOMAIN_PARAMETER Domain value is either null or invalid.

DT_INVALID_DOMAIN_SUFFIX Domain suffix entered is not valid.

DT_INVALID_EMAIL_ERROR Email ID is not in proper format

DT_INVALID_GOLD_PATTERN_ID Gold pattern ID is invalid.

DT_INVALID_HA_PAIR_RESERVATION_

CREATOR_PARAMETER

Reservation pair creator parameter is invalid.

DT_INVALID_IDENTITY_PROVIDER_

PARAMETER

Identity provider parameter is either empty or null.

DT_INVALID_INPUT Input parameters provided are not supported or invalid.

DT_INVALID_INPUT_INTERNAL Generic system level error when an operation is passed unexpected argument by another internal module.

DT_INVALID_INTERNAL_NETWORK Invalid internal network is specified.

DT_INVALID_MAX_POWERED_ON_VMS Maximum number of VMs to be run in a pool is not a whole, positive number.

DT_INVALID_MIN_POWERED_ON_VMS Minimum number of VMs to be run in a pool is not a whole, positive number.

DT_INVALID_NETWORK_ASSIGNMENT Network being assigned to a pool is not a valid option.

DT_INVALID_NETWORK_CIDR Invalid CIDR network is specified.

DT_INVALID_NETWORK_PARAMETER Network is either empty or null.

DT_INVALID_ORGANIZATION_PARAMETER Organization is empty or null.

DT_INVALID_ORGANIZATIONAL_UNIT Domain organizational unit specified for a pool cannot be located by the system.

DT_INVALID_PASSWORD Password entered is not valid.

DT_INVALID_PATTERN_ID Pattern ID is null or invalid.


103

Name Description

DT_INVALID_PATTERN_TYPE Pattern type for a new pool is invalid.

DT_INVALID_POOL_NAME Pool name specified for pool creation is invalid.

DT_INVALID_POOL_SIZE Specified pool size is not a whole, positive number.

DT_INVALID_REMOTE_APP_NAME Pool remote application pool name is invalid.

DT_INVALID_REPORTING_JOB_ID Reporting job ID is not valid.

DT_INVALID_REQUEST_ACTIVE_SESSIONS Request cannot be completed as there are active sessions on the virtual machine.

DT_INVALID_REQUEST_ALREADY_IN_POOL Unable to change pool for pattern as it is already part of the specified pool

DT_INVALID_REQUEST_NO_BACKING_VM Request cannot be completed as the pattern has no backing VM.

DT_INVALID_REQUEST_USERS_ASSIGNED Request cannot be completed as there are users assigned to the virtual machine.

DT_INVALID_RESTORE_DEFAULT_

PARAMETER

Error while restoring default timeout values.

DT_INVALID_ROLE_CONFIG Role input parameter is invalid.

DT_INVALID_SERVER_COUNT Server count value is less than zero.

DT_INVALID_SERVER_DENSITY Server density value is less than zero.

DT_INVALID_SERVER_IP Directory server IP entered is not valid.

DT_INVALID_SESSION_PROFILE_ID Generated session profile ID for a session pool is either missing or invalid.

DT_INVALID_SESSION_TIMEOUT Allocator session timeout of a pool is not a whole, positive number.

DT_INVALID_SLONY_DB_INSTANCE_NAME Passed dbInstanceName is invalid for slony node add/remove operation.

DT_INVALID_SLONY_NODE_ADDRESS Passed address is invalid for slony node add/remove operation.

DT_INVALID_TASK_ID Task ID is null.

DT_INVALID_TIMEOUT_SSO_TOKEN Timeout SSO token is not a positive integer value.

DT_INVALID_UPGRADE_MGR Upgrade method was invoked on appliance other than the Primary SP Appliance.

DT_INVALID_URL_ERROR URL is not in proper format.

DT_INVALID_USER_DN User DN entered is not valid.

DT_INVALID_USER_ID User ID is null.

DT_INVALID_VM_ROOT_NAME VM root name of a pool is invalid.

DT_LICENSE_FILE_URL_INVALID License file URL is invalid.

DT_LOCAL_ADMIN_ACCOUNT_DISABLED SP attempted to get fetch local admin account password but local admin was disabled.

DT_LOCAL_ADMIN_PASSWORD_EMPTY Local admin password is empty or not set.


104

Name Description

DT_LOCAL_ADMIN_PASSWORD_EXPIRED Local admin password is expired due to time-based expiration (after 24 hours) or after first time usage.

DT_LOGIN_DOMAIN_USER_NOT_FOUND Either the domain or user specified in a request was not found.

DT_LOGOUT_FAILED Call to logout the session failed, possibly due to an invalid 'Authorization' http header in the request.

DT_MAPPED_USERS_RETRIEVAL_FAILED Mapped users could not be retrieved.

DT_MAX_BACKUP_COUNT_EXCEEDED Backup count has exceeded the max value.

DT_MAX_CONCURRENT_REFRESH_INVALID Max concurrent refresh specified is not valid.

DT_MISSING_APPLICATION_ID One or more applications to add to the pool are missing application IDs.

DT_MISSING_DAAS_TIMEOUT DaaS session timeout is not specified.

DT_MISSING_DC_ID_FOR_IDENT_PROVIDER Data center ID component is missing from the identity provider being modified.

DT_MISSING_GP Gold pattern ID is not specified.

DT_MISSING_ICON_DATA Icon Data required is missing.

DT_MISSING_ID_FOR_IDENT_PROVIDER Identity provider ID is not given.

DT_MISSING_MAX_FREE_RUNNING Maximum number of VMs to be run in a pool is not specified.

DT_MISSING_METADATA_URL_FOR_IDENT_

PROVIDER

URL for the identity provider is missing.

DT_MISSING_MIN_FREE_RUNNING Minimum number of VMs to be run in a pool is not specified.

DT_MISSING_POOL_NAME Pool name is not specified.

DT_MISSING_POOL_POLICIES Pool policy object is not specified.

DT_MISSING_REMOTE_APP_ID Remote application ID is empty.

DT_MISSING_REQUESTED_SIZE Requested pool size is not specified.

DT_MISSING_SERVER_COUNT Server count of a session pool is missing.

DT_MISSING_SERVER_DENSITY Server density of a session pool is missing.

DT_MISSING_TENANT_ADDR_FOR_IDENT_

PROVIDER

Registered Tenant address is missing.

DT_MISSING_VM_NAME_COMP VM root name is not specified.

DT_MODIFY_USR_DEF_APP_FILE_PATH_

EXISTS

Request to modify a User Defined Application cannot be fulfilled due to unique file path, pattern version, image ID constraint violation.

DT_MODIFY_USR_DEF_APP_FILEPATH_TOO_

LONG

Request to modify a User Defined Application fails because the Application filepath is too long.

DT_MODIFY_USR_DEF_APP_ID_NOT_FOUND Request to modify a User Defined Application cannot be fulfilled because the reference ID has no records.


105

Name Description

DT_MODIFY_USR_DEF_APP_IMAGE_HAS_NO_CATALOG

Request to modify a User Defined Application fails because no application catalog exists for the Image.

DT_MODIFY_USR_DEF_APP_NAME_TOO_

LONG

Request to modify a User Defined Application fails because the application name is too long.

DT_MODIFY_USR_DEF_APP_NO_CATALOGS_

FOUND

Request to modify a User Defined Application fails because no application catalogs exist.

DT_MULTIPLE_NETWORKS_PER_POOL_

UNSUPPORTED

Error during attempt to assign multiple networks to a pool.

DT_NETWORK_CREATION_FAILED Network creation failed.

DT_NETWORK_GATEWAY_INVALID Network gateway is empty or invalid.

DT_NETWORK_ID_INVALID Network ID is empty or invalid.

DT_NETWORK_LABEL_INVALID Network label is empty or invalid.

DT_NETWORK_NOT_ASSIGNED_TO_DESKTOP_MANAGER

Selected network assignment for a pool is not associated with the tenant desktop manager.

DT_NETWORK_POOL_ASSIGNMENT_NOT_

ENABLED

Network assignment for a pool is attempted but the functionality is not enabled.

DT_NETWORK_REQUIRED Network is required for the pool

DT_NETWORK_TYPE_INVALID Network type is empty or invalid.

DT_NO_APP_CATALOG_FOR_GOLD_PATTERN No applications can be added to a pool because no app catalog was found for the specified gold pattern.

DT_NO_SESSION_BASED_DESKTOP_MODELS_WITH_QUOTA_REMAINING

Remaining desktop model quota of session-based model(s) is insufficient to satisfy the pool provisioning request.

DT_NOTES_MAX_SIZE_EXCEEDED Size of notes exceeds 128 characters.

DT_ORG_ID_INVALID Org ID is null.

DT_ORG_ID_UPGRADE_ALREADY_RUNNING Upgrade of org ID is already running.

DT_ORGANIZATION_ALREADY_EXISTS Organization with the same name already exists.

DT_ORGANIZATION_CERTIFICATE__

MODULUS_VARIFICATION_FAILED

Certificate upload failed on organization due to failed verification of the modulus of the SSL certificate.

DT_ORGANIZATION_CERTIFICATE__PUBLIC_

PRIVATE_KEY_CHECK_FAILED

Certificate upload failed on organization due to failure of check for SSL private and public key.

DT_ORGANIZATION_CERTIFICATE_EXPIRED Certificate upload failed on organization due to certificates having expired.

DT_ORGANIZATION_CERTIFICATE_

SIGNATURE_CHECK_FAILED

Certificate upload failed on organization due to signature check failure.

DT_ORGANIZATION_CREATION_FAILED Creation of organization has failed.

DT_ORGANIZATION_DB_PASSWORD_EMPTY Organization DB password is empty or null.

DT_ORGANIZATION_DB_PASSWORD_INVALID Organization DB password is invalid.


106

Name Description

DT_ORGANIZATION_INVALID_CA_

CERTIFICATE

Certificate upload failed on organization due to invalid CA certificate.

DT_ORGANIZATION_INVALID_SSL_

CERTIFICATE

Certificate upload failed on organization due to invalid SSL certificate.

DT_ORGANIZATION_INVALID_SSL_

CERTIFICATE_KEY

Certificate upload failed on organization due to invalid SSL certificate key.

DT_ORGANIZATION_NAME_INVALID Organization name is empty or null.

DT_ORGANIZATION_UPLOAD_CERTFICATE_

FAILED

Certificate upload failed on organization.

DT_PASSWORD_CRITERIA_FAIL Either password is the same as previous password or password does not meet requirements:

At least eight characters in length

Contain at least one each of the following: uppercase character, lowercase character, numeric digit, special character (only visible ASCII characters including space (excluding non-printing control characters such as BEL, Nul, . . .)

DT_PASSWORD_LENGTH_EXCEEDED Password length exceeds 512.

DT_PATTERN_DATASTORE_NOT_FOUND Gold pattern is invalid because its data store is not configured on all tenant hosts.

DT_PATTERN_DELETED Operation cannot be performed because the pattern has been deleted.

DT_PATTERN_LOOKUP_ERROR Specified pattern's lookup failed.

DT_POOL_LOOKUP_ERROR Specified pool's lookup failed.

DT_POOL_PROTOCOL_MISMATCH Default display protocol is not in the list of available pool protocols.

DT_POOL_PROTOCOLS_UNSPECIFIED Pool you are attempting to save has no remote display protocols.

DT_POOLS_EXIST_ON_NETWORK Network you are attempting to delete contains pools.

DT_POWER_OPERATION_FAILED Error occurs during attempted power related operation on a virtual machine.

DT_PRIMARY_APPLIANCE_RESERVATION_

FAILED

Primary appliance reservation creation has failed.

DT_PRIVATE_BACKBONE_PORT_INVALID Private backbone port is invalid.

DT_PUBLIC_ACCESS_IP_INVALID Public access IP is empty or invalid.

DT_PURGE_RECYCLE_POOL_ERROR Error(s) occurred in the process of purging the recycle pool.

DT_RDP_INVALID_PATTERN_TYPE Internal RDP connection cannot be established due to an invalid pattern type (not Static or Gold).

DT_RDP_INVALID_POWER_STATE Internal RDP connection cannot be established due to an invalid VM power state.


107

Name Description

DT_RDP_INVALID_VM_STATE Internal RDP connection cannot be established due to an invalid VM IP address or other condition.

DT_RECONFIGURE_NETWORK_FAILED Network reconfiguration failed.

DT_REGISTER_CLIENT_TIMEOUT_ERROR Error while registering new timeout values.

DT_REPORTING_JOB_DOWNLOAD_FAILED Reporting job download failed.

DT_REPORTING_JOB_DOWNLOAD_FILE_NOT_PRESENT

File is not present for download.

DT_RESOURCE_ALREADY_EXIST Duplicate resources (id/name/guid) are not allowed.

DT_RESOURCE_ASSIGNMENT_FAILED Failure occurred while trying to relate one resource to another by assignment.

DT_RESOURCE_CONVERSION_ERROR Error occurred while converting a resource to another form.

DT_RESOURCE_COUNT_ERROR Error occurred while attempting to count a resource.

DT_RESOURCE_CREATE_ERROR Error occurred while attempting to create a new resource.

DT_RESOURCE_DELETE_ERROR Error occurred while attempting to delete a resource.

DT_RESOURCE_INCONSISTENT_STATE Platform service has inconsistent data.

DT_RESOURCE_NOT_FOUND Requested DtResource could not be located.

DT_RESOURCE_READ_ERROR Error(s) while attempting to retrieve resource(s) from its persistent location.

DT_RESOURCE_REMOVAL_FAILED Failure occurred while attempting to remove the relationship of between resources.

DT_RESOURCE_RENAME_ERROR Failure occurred while attempting to rename a resource.

DT_RESOURCE_SAVE_ERROR Error occurred while attempting to save a new or existing resource.

DT_RESOURCE_UPDATE_ERROR Error occurred while attempting to update an existing resource

DT_RESTORE_DEFAULT_TIMEOUT_ERROR Error occurred while restoring default timeout values.

DT_RETRIEVE_DESKTOP_MAPPING_ERROR Failure occurred while retrieving desktop mapping.

DT_RETRIEVE_ELEMENT_FOR_USER_

REPORTING_EVENTS_ERROR

Failure occurred while finding element ID for given user reporting events.

DT_RETRIEVE_PAGINATION_SIZE_ERROR Failure occurred while retrieving pagination size.

DT_RETRIEVE_USER_EVENT_ERROR Failure occurred while user events.

DT_RETRIEVE_USER_MAPPING_ERROR Failure occurred while retrieving user mapping.

DT_ROLE_ASSIGN_ERROR Error occurred while assigning roles to admin groups.


108

Name Description

DT_ROLE_RETRIVEAL_USER_FAILED Role could not be retrieved for a user.

DT_ROLLBACK_ORG_FAILED Rollback of an organization failed.

DT_SAVE_DOMAIN_BIND_INFO_ERROR Error occurred while saving domain bind information.

DT_SECONDARY_APPLIANCE_RESERVATION_FAILED

Secondary appliance reservation creation failed.

DT_SERVICE_ACCOUNT_EMPTY Service account is either null or empty.

DT_SERVICE_ACCOUNT_PASSWORD_EMPTY Service account password is either null or empty.

DT_SERVICE_NOT_FOUND Platform service could not be located.

DT_SESSION_NOT_FOUND Session ID does not exist.

DT_SESSION_PROFILE_INUSE_ERROR Delete action was called on a session profile which is in use in session pool.

DT_SESSION_PROFILE_ROLLBACK_ERROR Session pool update failed and the original session profile cannot be restored

DT_SET_USER_PORTAL_CONFIG_ERROR Error(s) occurred while attempting to set user portal configuration.

DT_SMARTNODE_LOCAL_AUTH_BIND_ERROR Local admin authentication failed because the Smartnode tried to save domain bind info during the registration of the first domain.

DT_SUBNET_MASK_INVALID Subnet mask is empty or invalid.

DT_SUPPORT_URL_INVALID Support URL is invalid.

DT_TASK_RETRIEVAL_FAILED Task history retrieval failed.

DT_TENANTS_UPGRADABLE_CHECK_FAILED Tenant upgradability check failed.

DT_TWO_FACTOR_AUTHENTICATION_

ENABLED

Two factor authentication is enabled.

DT_TWO_FACTOR_AUTHENTICATOR_NOT_

CONFIGURED

Requested two factor authentication method cannot be enabled as it has yet to be configured.

DT_UNABALE_TO_COMMUNICATE_WITH_

ORGANIZATION

Organization you are trying to access organization is disabled.

DT_UNABLE_TO_CONTACT_SPECIFIED_

DOMAIN_CONTROLLERS

Unable to contact specific domain controller.

DT_UNABLE_TO_ESTABLISH_AD_

CONNECTION

Error occurred while establishing AD connection.

DT_UNABLE_TO_REACH_AD Platform is unable to reach domain controller(s) need to satisfy the request.

DT_UNABLE_TO_REACH_ANY_DOMAIN_

CONTROLLERS

Platform is unable to reach any domain controller.

DT_UNABLE_TO_REACH_SP Platform is unable to reach service provider.

DT_UNABLE_TO_RESOLVE_DOMAIN_SUFFIX Domain suffix cannot be resolved.

DT_UNABLE_TO_RESTORE_TIMEOUT Error occurred while restoring default timeout values.


109

Name Description

DT_UNABLE_TO_RETRIEVE_GP_NAME System unable to find the name of the gold pattern the VM was cloned from.

DT_UNABLE_TO_RETRIEVE_IDENT_PROVIDER_TOLERANCE

Identity provider tolerance value could not be retrieved.

DT_UNABLE_TO_UPDATE_IDENT_PROVIDER_TOLERANCE

Identity provider tolerance value could not be updated.

DT_UNKNOWN_COMM_ERROR Generic communications error has occurred.

DT_UNKNOWN_INTERNAL_ERROR Unexpected failure due to no known cause.

DT_UNSUPPORTED_TYPE_ERROR Unexpected type of object was encountered in the process of execution.

DT_USER_DEF_APP_NOT_FOUND User Defined Application for a given reference ID cannot be found.

DT_USER_DN_EMPTY User distinguished name is either null or empty.

DT_USER_DN_LENGTH_EXCEEDED User DN length exceeds 1000.

DT_USER_NOT_ENTITLED_TO_POOL User cannot be assigned a static desktop from the specified pool because the user is not entitled to the pool.

DT_USER_SPECIFIED_NOT_LOGGED_IN Request cannot be invoked as a non-admin user differing from the specified user parameter.

DT_USERNAME_IS_NULL_OR_EMPTY Username is null or empty

DT_VM_MAPPING_REPORT_GENERATION_

FAILED

Generation of a VM mapping report fails.

DT_VM_NOT_POWERED_OFF VM is powered ON.

DT_VMS_EXIST_ON_NETWORK Network you are trying to delete has VMs registered on it.

5.13 DtGuestOS

Specifies the Guest OS for a VM. Values are described below.

Value Description

DAAS_APPLIANCE Desktone Appliance

Linux_32 Linux 32-bit

Linux_64 Linux 64-bit

Other Other

UBUNTU_32 Ubuntu 32-bit

UBUNTU_64 Ubuntu 64-bit

WIN_XP Windows XP

WIN_VISTA Windows Vista

WIN_7 Windows 7

WIN_7_64 - Windows 7 64-bit


110

5.14 DtNetworkType

Indicates the type of network. Values are described below.

5.15 DtNotificationType

Specifies type of notification. Values are described below.

5.16 DtPatternType

Specifies the types of patterns.

Properties

Name Description

A (App) A pattern that describes a desktop or application served by an app server that describes a non-VM desktop machine

D (Dynamic) A pattern that describes a dynamic virtual desktop machine

G (Gold) A pattern based off of a template from the hypervisor

S (Static) A pattern that describes a static virtual desktop machine

U U (User) A pattern that describes a non-VM desktop machine

WIN_8 Windows 8

WIN_8_64 Windows 8 64-bit

WIN_10 Windows 10

WIN_10_64 Windows 10 64-bit

WIN_SERVER_2K8R2_64 Windows Server 2008 R2 64-bit

WIN_SERVER_2K12_64 Windows Server 2012 64-bit

Value Description

SDN Software-defined network

VLAN VLAN network

VXLAN VXLAN network

Value Description

MAINTENANCE_NOTICE Maintenance notice

VMS_IN_BAD_AGENT_STATE Notice that agent is out of date

VMS_IN_BAD_TOOLS_STATE Notice that VM Tools is out of date

VMS_UNTRUSTED_DOMAIN Notice that VM is not in a valid domain


111

5.17 DtPoolSessionType

Indicates type of session which pool can support. Values are described below.

5.18 DtPoolSizeType

Specifies the types of pool sizes. Values are described below.

5.19 DtQuotaBillingType

Specifies the types of quota that can be used for billing reports. Values are described below.

5.20 DtRADIUSAuthenticationType

Specifies type of RADIUS authentication. Values are described below.

Value Description

Application Pool exposes application sessions only (VDI or RDSH).

Both Pool exposes both desktop and application sessions (VDI or RDSH).

Desktop Pool exposes desktop sessions only (VDI or RDSH with full Desktop Only).

Value Description

Elastic Pool size type is elastic

Fixed Pool size type is fixed

Value Description

DESKTOP_MODEL Desktop model

PROTOCOL Protocol

SESSION Session

TEMPLATE Template

Value Description

CHAP Challenge Handshake Authentication Protocol

MSCHAPV1 MS-CHAP version 1

Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) is a variant of CHAP that does not require a plaintext version of the password on the authenticating server.

MSCHAPV2 MS-CHAP version 2

Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) is a variant of CHAP that does not require a plaintext version of the password on the authenticating server.

PAP Password Authentication Protocol


112

5.21 DtRDPClientType

Specifies type of RDP client. Values are described below.

5.22 DtReportingJobName

Specifies the name of the reporting job. Values are described below.

5.23 DtReportingStatus

Specifies the status of the reporting job. Values are described below.

5.24 DtRestoreTimeoutType

Specifies restore timeout type. Values are described below.

Value Description

RICH_CLIENT_VIA_RDP Rich client

RICH_CLIENT_WITH_ACTIVEX Rich client with ActiveX

WTOS_THIN_CLIENT Thin client

Value Description

USER_EVENT User event

USER_EVENT_ALL User event - all

USER_MAPPING User mapping

VM_MAPPING VM mapping

Value Description

FAILURE Failure

PENDING Pending

RUNNING Running

SUCCESS Success

UNKNOWN Unknown

Value Description

ActivityHB Restore the value of activity heart beat interval.

Brokertimeout Restore the time out value of broker.

Idletimeout Restore the idle time out value.

RestoreAll Restore the value of all above mentioned timeout.


113

5.25 DtSortingType

Specifies type of sorting. Values are described below.

5.26 DtTaskStatus

Specifies the current status of this pool task. Values are described below.

5.27 DtTwoFactorAuthenticationType

Specifies the type of two-factor authentication currently selected. Values are described below.

5.28 DtUpgradeStatus

Indicates status of upgrade process. Values are described below.

5.29 DtUserEvent

Specifies the user event types that are reported by the platform. Values are described below.

Value Description

Ascending Sort in ascending order.

Descending Sort in descending order.

Value Description

FAILED Task has failed.

OTHER Statius is other.

QUEUED Task is in queue.

RUNNING Task is currently running.

SUCCESSFUL Task ran successfully.

Value Description

NONE No two-factor authentication configured.

RADIUS RADIUS

RSA_SECURID RSA SecureID

Value Description

FAILURE Upgrade has failed.

PENDING Upgrade is pending.

RUNNING Upgrade is running.

SUCCESS Upgrade ran successfully.

UNKNOWN Upgrade status is unknown.


114

5.30 DtUserEventError

Specifies the type of user event errors that can occur when desktop allocation fails. Values are described below.

Value Description

AGENT_STATE_ERROR DaaS Agent of the VM is not in the required state ("ACTIVE").

BROKER_PARAM_ERROR Internal error when a parameter required for allocation is incorrect or missing.

CONNECTION_TYPE_MISMATCH Session to a full desktop or a remote application currently exists and attempt has been made to connect with the other type (full desktop or remote application).

DESKTOP_NOT_RUNNING VM for allocation was not powered on.

DESKTOP_UNAVAILABLE VM or RDS session cannot be allocated because either no VMs in a pool are available or an unrecognized error occurred.

FAILED_TO_LOCK_VM VM for allocation could not be locked for exclusive access.

GUEST_OS_NOT_RUNNING Operating system of the VM is not running.

INCOMPATIBLE_PROTOCOL Reconnect to an existing VM or RDS session and requested protocol is not compatible with the one previously used to establish the session. User must be logged off of the existing session before proceeding with the new session.

IP_ADDRESS_UNKNOWN IP address of the VM to be allocated is not known or has not been reported by the hypervisor.

IP_ADDRESS_UNREACHABLE IP address of the VM to be allocated is not reachable.

PCOIP_AGENT_ERROR PCoIP agent is not active on the VM or there was an error with the PCoIP gateway on the VM.

RAM_SERVICE_FAILURE RAM service failure is when a desktop cannot be reached through the dtRAM appliance.

VM_STATE_ERROR Allocation state of the VM is not in the required state (generally, “AVAILABLE”).

VM_TOOLS_NOT_INSTALLED VM tools have not been installed on the VM for allocation.

VM_TOOLS_NOT_RUNNING VM tools are not running on the VM for allocation

Value Description

ALLOCATE VM or RDS session is allocated to a user successfully

ALLOCATE_FAILURE VM or RDS session fails to be allocated to a user

DISCONNECT User disconnects from a VM or RDS session

LOG_OFF User logs off of a VM or RDS session

LOG_ON User logs on to a VM or RDS session

RECONNECT User reconnects to an existing VM or RDS session

SESSION_TIMEOUT VM or RDS session times out due to lack of activity

UNKNOWN Unknown user event


115

5.31 DtUserEventSortingCriteria

Specifies sorting criteria for user events. Values are described below.

5.32 DtUserMappingSortingCriteria


5.33 DtVMLifeState

Specifies the various states of the virtual machine. Values are described below.

Value Description

DisplayProtocol Sorting by display protocol.

EndPointIPAddress Sorting by endpoint IP address.

EndPointPlatformType Sorting by endpoint platform type.

EventErrorDetails Sorting by event error details.

Id Sorting by User ID.

PatternId Sorting by pattern ID.

ReportTimeStamp Sorting by time stamp of report.

UserEvent Sorting by user event.

UserGuid Sorting by User GUID.

VirtualMachineId Sorting by VM ID.

VMSessionId Sorting by Session ID.

Value Description

Domain Sorting by Domain.

Id Sorting by User ID.

UserName Sorting by User name.

VmName Sorting by VM name.

Value Description

CLONE_FAILED Cloning has failed.

CLONING VM is cloning.

DESTROYING VM is being removed from storage.

JOINING_DOMAIN VM is joining a domain.

NOT_IN_DOMAIN VM is not in domain

OFF VM is off.

READY VM is ready to be used.

STARTING VM is starting.

UNKNOWN The VM is waiting to arrive in one of the other states.


116

5.34 DtVmMappingSortingCriteria


5.35 DtVMPowerOperation

Specifies VM power operations. Values are described below.

Value Description

POWEROFF Power off VM.

POWERON Power on VM.

REBOOT Reboot VM.

RESET Reset VM.

SHUTDOWN Shut down VM.

STANDBY Put VM on standby.

SUSPEND Suspend VM.

5.36 DtVMPowerState

Specifies the states of power for a VM. Values are described below.

Value Description

POWER_STATE_POWERING_OFF VM is powering off.

POWER_STATE_POWERING_ON VM is powering on.

POWER_STATE_RESETTING VM is resetting.

POWER_STATE_SUSPENDING VM is suspending.

POWERED_OFF VM is powered off.

POWERED_ON VM is powered on.

SUSPENDED VM is suspended.

Value Description

DesktopModel Sorting by desktop model.

DesktopType Sorting by desktop type.

PoolName Sorting by pool (assignment) name.

PoolType Sorting by pool (assignment) type.

VmName Sorting by VM name.


117

5.37 DtVMwareToolsState

Specifies the state of the VMware Tools for a VM DaaS Agent. Values are described below.

Value Description

NOT_INSTALLED Tools are not installed.

NOT_RUNNING Tools are not running.

OK Tools are up to date and working.

OUT_OF_DATE Tools are out of date.

UNKNOWN Tools state cannot be determined.

horizon daas platform 7.0 rest api - vmwareunderstanding the api 2 2 understanding the api the...

Documents